Package edu.internet2.middleware.grouper.changeLog

Class ChangeLogConsumerBase

java.lang.Object

edu.internet2.middleware.grouper.changeLog.ChangeLogConsumerBase

Direct Known Subclasses:

ChangeLogConsumerBaseImpl, ChangeLogConsumerToMessage, EsbConsumer, GroupSyncConsumer, PrintTest, RuleConsumer

public abstract class ChangeLogConsumerBase
extends Object

extend this class and register in the grouper-loader.properties to be a change log consumer

Constructor Summary

Constructors

Constructor	Description
ChangeLogConsumerBase()

Method Summary

Modifier and Type	Method	Description
boolean	callAtLeastOnce()	some change log consumers might want to be called even if nothing happened in change log e.g.
Integer	getBatchSize()	override the batch size configured in config file
String	getConsumerName()	consumer name in config file
abstract long	processChangeLogEntries(List<ChangeLogEntry> changeLogEntryList, ChangeLogProcessorMetadata changeLogProcessorMetadata)	process the change logs
void	setConsumerName(String consumerName)	consumer name in config file

Methods inherited from class java.lang.Object

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

Constructor Details

ChangeLogConsumerBase

public ChangeLogConsumerBase()

Method Details

getConsumerName

public String getConsumerName()

consumer name in config file

Returns:

setConsumerName

public void setConsumerName(String consumerName)

consumer name in config file

Parameters:

consumerName -

processChangeLogEntries

public abstract long processChangeLogEntries(List<ChangeLogEntry> changeLogEntryList,
 ChangeLogProcessorMetadata changeLogProcessorMetadata)

process the change logs

Parameters:

changeLogEntryList - NOTE, DO NOT CHANGE OR EDIT THE OBJECTS IN THIS LIST, THEY MIGHT BE SHARED!

changeLogProcessorMetadata -

Returns:

which sequence number it got up to (which sequence number was the last one processed). or -1 if none processed

getBatchSize

public Integer getBatchSize()

override the batch size configured in config file

Returns:

callAtLeastOnce

public boolean callAtLeastOnce()

some change log consumers might want to be called even if nothing happened in change log e.g. check messages in provisioners

Returns: