edu.internet2.middleware.grouper.pspng

Class FullSyncProvisioner

java.lang.Object

edu.internet2.middleware.grouper.pspng.FullSyncProvisioner

public class FullSyncProvisioner
extends Object

This class manages a full-sync thread for a provisioner. This is expected to be instantiated within the Grouper Loader/Daemon jvm and it reads from the grouper-loader settings, but it is not triggered by any changelog or message harness. Instead, full-refreshes are triggered via Quartz and the processing interacts directly with the Group registry.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FullSyncProvisioner.FULL_SYNC_COMMAND
static class	FullSyncProvisioner.QUEUE_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
static String	FULL_SYNC_ALL_GROUPS
protected Provisioner<?,?,?>	provisioner

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FullSyncProvisioner(Provisioner provisioner) Constructor used by the getfullSyncer() factory method to construct a full-sync wrapper around a provisioner.

Method Summary

Modifier and Type	Method and Description
protected boolean	fullSyncGroup(GrouperGroupInfo _grouperGroupInfo, edu.internet2.middleware.grouper.pspng.FullSyncQueueItem fullSyncQueueItem) Workhorse method that handles the FullSync of a specific group.
org.joda.time.DateTime	getLastSuccessfulFullSyncDate(String groupName)
String	getName()
protected edu.internet2.middleware.grouper.pspng.FullSyncQueueItem	getNextFullSyncRequest() get the next full-sync request from our queues/subqueues.
Provisioner<?,?,?>	getProvisioner()
static boolean	isFullSyncRunning(String provisionerId)
protected boolean	processGroupCleanup(edu.internet2.middleware.grouper.pspng.FullSyncQueueItem queueItem)
protected void	processQueueItem(edu.internet2.middleware.grouper.pspng.FullSyncQueueItem queueItem)
protected edu.internet2.middleware.grouper.pspng.FullSyncQueueItem	queue(FullSyncProvisioner.QUEUE_TYPE queue, edu.internet2.middleware.grouper.pspng.FullSyncQueueItem queueItem)
protected List<edu.internet2.middleware.grouper.pspng.FullSyncQueueItem>	queueAllGroupsForFullSync(FullSyncProvisioner.QUEUE_TYPE queue, String externalReference, String reasonFormat, Object... reasonArgs) Go through the Grouper Groups and queue up the ones that match the provisioner's ShouldBeProvisioned filter.
protected edu.internet2.middleware.grouper.pspng.FullSyncQueueItem	requeue(edu.internet2.middleware.grouper.pspng.FullSyncQueueItem queueItem, boolean processingFailed) Requeue item either into GrouperMessaging or a local queue, depending on where the queueItem came from
edu.internet2.middleware.grouper.pspng.FullSyncQueueItem	scheduleGroupCleanup(FullSyncProvisioner.QUEUE_TYPE queue, String externalReference, String reasonFormat, Object... reasonArgs) Put a GROUP_CLEANUP_MARKER into the full-sync schedule.
edu.internet2.middleware.grouper.pspng.FullSyncQueueItem	scheduleGroupForSync(FullSyncProvisioner.QUEUE_TYPE queue, String groupName, String externalReference, String reasonFormat, Object... reasonArgs) Put the given group in a queue for full syncing
protected void	setUpGrouperMessagingQueue(FullSyncProvisioner.QUEUE_TYPE queueType)
protected void	start() Get the FullSync thread_manageFullSyncProcessing() thread running
JobStatistics	startFullSyncOfAllGroupsAndWaitForCompletion(Hib3GrouperLoaderLog hib3GrouploaderLog)
protected void	startMessageReadingThread(FullSyncProvisioner.QUEUE_TYPE queue_type) starts a thread that reads from a GrouperMessaging queue and puts the items in a local-memory subQueue (which defines the item's eventual priority).
protected void	thread_fullSyncMessageQueueReader(FullSyncProvisioner.QUEUE_TYPE queueType) Method that reads a full-sync queue (See Grouper Messaging) and forwards messages to an internal (in memory) subqueue.
protected void	thread_manageFullSyncProcessing() method that manages full-sync processing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FULL_SYNC_ALL_GROUPS

public static final String FULL_SYNC_ALL_GROUPS

See Also:

Constant Field Values

provisioner

protected final Provisioner<?,?,?> provisioner

Constructor Detail

FullSyncProvisioner

protected FullSyncProvisioner(Provisioner provisioner)

Constructor used by the getfullSyncer() factory method to construct a full-sync wrapper around a provisioner. In other words, do not call this constructor directly.

Parameters:

provisioner -

Method Detail

getProvisioner

public Provisioner<?,?,?> getProvisioner()

getName

public String getName()

start

protected void start()

Get the FullSync thread_manageFullSyncProcessing() thread running

startMessageReadingThread

protected void startMessageReadingThread(FullSyncProvisioner.QUEUE_TYPE queue_type)

starts a thread that reads from a GrouperMessaging queue and puts the items in a local-memory subQueue (which defines the item's eventual priority). The messages _are_not_ acknowledged by this thread, but are instead acknowledged when they are processed by the FullSync engine. Therefore, if the jvm dies while the messages are in-memory, they'll be retried eventually because they still live within GrouperMessaging.

Parameters:

queue_type -

thread_manageFullSyncProcessing

protected void thread_manageFullSyncProcessing()

method that manages full-sync processing. Most of the time you think of FullSync as what happens on a schedule (weekly full-sync, for example). However, sometimes incremental provisioning needs a specific group to be sanity checked. For example, if a +member change and a -member change are batched together, the desired order can be lost. Therefore, a full-sync of the group will make sure the result is accurate. This method will wait for any full-refreshes to be requested, either from incremental provisioning or from a quartz-scheduled thread that triggers all the groups to be sync'ed.

thread_fullSyncMessageQueueReader

protected void thread_fullSyncMessageQueueReader(FullSyncProvisioner.QUEUE_TYPE queueType)

Method that reads a full-sync queue (See Grouper Messaging) and forwards messages to an internal (in memory) subqueue. Note that the capcity of most subqueues is quite limited so that these Reader threads block and leave most messages in the upstream queues... so other daemons can fetch and process them. Note: each full-sync provisioner runs several of these, one for each of the different messaging queues

setUpGrouperMessagingQueue

protected void setUpGrouperMessagingQueue(FullSyncProvisioner.QUEUE_TYPE queueType)

processQueueItem

protected void processQueueItem(edu.internet2.middleware.grouper.pspng.FullSyncQueueItem queueItem)
                         throws PspException

Throws:

PspException

getNextFullSyncRequest

protected edu.internet2.middleware.grouper.pspng.FullSyncQueueItem getNextFullSyncRequest()

get the next full-sync request from our queues/subqueues. This method blocks until a request is received

isFullSyncRunning

public static boolean isFullSyncRunning(String provisionerId)

startFullSyncOfAllGroupsAndWaitForCompletion

public JobStatistics startFullSyncOfAllGroupsAndWaitForCompletion(Hib3GrouperLoaderLog hib3GrouploaderLog)
                                                           throws PspException

Throws:

PspException

queueAllGroupsForFullSync

protected List<edu.internet2.middleware.grouper.pspng.FullSyncQueueItem> queueAllGroupsForFullSync(FullSyncProvisioner.QUEUE_TYPE queue,
                                                                                                   String externalReference,
                                                                                                   String reasonFormat,
                                                                                                   Object... reasonArgs)
                                                                                            throws PspException

Go through the Grouper Groups and queue up the ones that match the provisioner's ShouldBeProvisioned filter.

Throws:

PspException

scheduleGroupForSync

public edu.internet2.middleware.grouper.pspng.FullSyncQueueItem scheduleGroupForSync(FullSyncProvisioner.QUEUE_TYPE queue,
                                                                                     String groupName,
                                                                                     String externalReference,
                                                                                     String reasonFormat,
                                                                                     Object... reasonArgs)

Put the given group in a queue for full syncing

Parameters:

queue - : What queue should be used?

groupName -

reasonArgs -

scheduleGroupCleanup

public edu.internet2.middleware.grouper.pspng.FullSyncQueueItem scheduleGroupCleanup(FullSyncProvisioner.QUEUE_TYPE queue,
                                                                                     String externalReference,
                                                                                     String reasonFormat,
                                                                                     Object... reasonArgs)

Put a GROUP_CLEANUP_MARKER into the full-sync schedule. This means that the target system will be checked for information about groups that either no longer exist or that are no longer selected to be provisioned to the system.

queue

protected edu.internet2.middleware.grouper.pspng.FullSyncQueueItem queue(FullSyncProvisioner.QUEUE_TYPE queue,
                                                                         edu.internet2.middleware.grouper.pspng.FullSyncQueueItem queueItem)

requeue

protected edu.internet2.middleware.grouper.pspng.FullSyncQueueItem requeue(edu.internet2.middleware.grouper.pspng.FullSyncQueueItem queueItem,
                                                                           boolean processingFailed)

Requeue item either into GrouperMessaging or a local queue, depending on where the queueItem came from

Parameters:

queueItem -

processingFailed - True when the event was actually processed and needs to have its retryCount and wakeTime updated

Returns:

the input queueItem after any adjustments

fullSyncGroup

protected boolean fullSyncGroup(GrouperGroupInfo _grouperGroupInfo,
                                edu.internet2.middleware.grouper.pspng.FullSyncQueueItem fullSyncQueueItem)

Workhorse method that handles the FullSync of a specific group.

Parameters:

_grouperGroupInfo - Group on which to do a Full Sync. The grouper group will be reread from database to make sure information is fresh.

fullSyncQueueItem - What is driving this sync

Returns:

true if changes to target system were made

processGroupCleanup

protected boolean processGroupCleanup(edu.internet2.middleware.grouper.pspng.FullSyncQueueItem queueItem)

getLastSuccessfulFullSyncDate

public org.joda.time.DateTime getLastSuccessfulFullSyncDate(String groupName)