edu.internet2.middleware.grouper.changeLog.consumer

Class PrintChangeLogConsumer

java.lang.Object

edu.internet2.middleware.grouper.changeLog.ChangeLogConsumerBase

edu.internet2.middleware.grouper.changeLog.ChangeLogConsumerBaseImpl

edu.internet2.middleware.grouper.changeLog.consumer.PrintChangeLogConsumer

public class PrintChangeLogConsumer
extends ChangeLogConsumerBaseImpl

Example change log consumer based on ChangeLogConsumerBaseImpl. ChangeLogConsumerBaseImpl handles the mapping of change log event to methods, the processing loop, and exception handling.

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	eventsProcessed list used for testing

Fields inherited from class edu.internet2.middleware.grouper.changeLog.ChangeLogConsumerBaseImpl

CONFIG_FOLDER_NAME, CONSUMER_CLASS_NAME, SYNC_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor and Description
PrintChangeLogConsumer()

Method Summary

Modifier and Type	Method and Description
protected void	addGroup(Group group, ChangeLogEntry changeLogEntry) These methods are expected to be overidden in a subclass that is specific to a provisioning target.
protected void	addGroupAndMemberships(Group group, ChangeLogEntry changeLogEntry)
protected void	addMembership(Subject subject, Group group, ChangeLogEntry changeLogEntry)
protected boolean	isFullSyncRunning(String consumerName) expected to be overidden
protected void	removeDeletedGroup(PITGroup pitGroup, ChangeLogEntry changeLogEntry)
protected void	removeGroup(Group group, ChangeLogEntry changeLogEntry)
protected void	removeMembership(Subject subject, Group group, ChangeLogEntry changeLogEntry)
protected void	removeMovedGroup(String oldGroupName, ChangeLogEntry changeLogEntry) removeMovedGroup may be called for groups that have not previously been marked, need to check the target to be sure.
protected void	renameGroup(String oldGroupName, String newGroupName, ChangeLogEntry changeLogEntry) renameGroup may be called for groups that have not previously been marked, need to check the target to be sure.
protected void	updateGroup(Group group, ChangeLogEntry changeLogEntry)

Methods inherited from class edu.internet2.middleware.grouper.changeLog.ChangeLogConsumerBaseImpl

getConsumerName, processChangeLogEntries

Methods inherited from class edu.internet2.middleware.grouper.changeLog.ChangeLogConsumerBase

callAtLeastOnce, getBatchSize, setConsumerName

Methods inherited from class java.lang.Object

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

Field Detail

eventsProcessed

public static List<String> eventsProcessed

list used for testing

Constructor Detail

PrintChangeLogConsumer

public PrintChangeLogConsumer()

Method Detail

renameGroup

protected void renameGroup(String oldGroupName,
                           String newGroupName,
                           ChangeLogEntry changeLogEntry)

Description copied from class: ChangeLogConsumerBaseImpl

renameGroup may be called for groups that have not previously been marked, need to check the target to be sure. If the oldGroupName doesn't exist at the target, then add the newGroupName and all its memberships.

Overrides:

renameGroup in class ChangeLogConsumerBaseImpl

See Also:

ChangeLogConsumerBaseImpl.renameGroup(java.lang.String, java.lang.String, edu.internet2.middleware.grouper.changeLog.ChangeLogEntry)

removeMovedGroup

protected void removeMovedGroup(String oldGroupName,
                                ChangeLogEntry changeLogEntry)

Description copied from class: ChangeLogConsumerBaseImpl

removeMovedGroup may be called for groups that have not previously been marked, need to check the target to be sure. If the oldGroupName doesn't exist at the target, this call should be a no-op.

Overrides:

removeMovedGroup in class ChangeLogConsumerBaseImpl

See Also:

ChangeLogConsumerBaseImpl.removeMovedGroup(java.lang.String, edu.internet2.middleware.grouper.changeLog.ChangeLogEntry)

addGroup

protected void addGroup(Group group,
                        ChangeLogEntry changeLogEntry)

Description copied from class: ChangeLogConsumerBaseImpl

These methods are expected to be overidden in a subclass that is specific to a provisioning target. (e.g. Google Apps)

Overrides:

addGroup in class ChangeLogConsumerBaseImpl

See Also:

ChangeLogConsumerBaseImpl.addGroup(edu.internet2.middleware.grouper.Group, edu.internet2.middleware.grouper.changeLog.ChangeLogEntry)

addGroupAndMemberships

protected void addGroupAndMemberships(Group group,
                                      ChangeLogEntry changeLogEntry)

Overrides:

addGroupAndMemberships in class ChangeLogConsumerBaseImpl

See Also:

ChangeLogConsumerBaseImpl.addGroupAndMemberships(edu.internet2.middleware.grouper.Group, edu.internet2.middleware.grouper.changeLog.ChangeLogEntry)

updateGroup

protected void updateGroup(Group group,
                           ChangeLogEntry changeLogEntry)

Overrides:

updateGroup in class ChangeLogConsumerBaseImpl

See Also:

ChangeLogConsumerBaseImpl.updateGroup(edu.internet2.middleware.grouper.Group, edu.internet2.middleware.grouper.changeLog.ChangeLogEntry)

removeGroup

protected void removeGroup(Group group,
                           ChangeLogEntry changeLogEntry)

Overrides:

removeGroup in class ChangeLogConsumerBaseImpl

See Also:

ChangeLogConsumerBaseImpl.removeGroup(edu.internet2.middleware.grouper.Group, edu.internet2.middleware.grouper.changeLog.ChangeLogEntry)

removeDeletedGroup

protected void removeDeletedGroup(PITGroup pitGroup,
                                  ChangeLogEntry changeLogEntry)

Overrides:

removeDeletedGroup in class ChangeLogConsumerBaseImpl

See Also:

ChangeLogConsumerBaseImpl.removeDeletedGroup(edu.internet2.middleware.grouper.pit.PITGroup, edu.internet2.middleware.grouper.changeLog.ChangeLogEntry)

addMembership

protected void addMembership(Subject subject,
                             Group group,
                             ChangeLogEntry changeLogEntry)

Overrides:

addMembership in class ChangeLogConsumerBaseImpl

See Also:

ChangeLogConsumerBaseImpl.addMembership(edu.internet2.middleware.subject.Subject, edu.internet2.middleware.grouper.Group, edu.internet2.middleware.grouper.changeLog.ChangeLogEntry)

removeMembership

protected void removeMembership(Subject subject,
                                Group group,
                                ChangeLogEntry changeLogEntry)

Overrides:

removeMembership in class ChangeLogConsumerBaseImpl

See Also:

ChangeLogConsumerBaseImpl.removeMembership(edu.internet2.middleware.subject.Subject, edu.internet2.middleware.grouper.Group, edu.internet2.middleware.grouper.changeLog.ChangeLogEntry)

isFullSyncRunning

protected boolean isFullSyncRunning(String consumerName)

Description copied from class: ChangeLogConsumerBaseImpl

expected to be overidden

Overrides:

isFullSyncRunning in class ChangeLogConsumerBaseImpl

Returns:

See Also:

ChangeLogConsumerBaseImpl.isFullSyncRunning(java.lang.String)