edu.internet2.middleware.grouper.pspng

Class ProvisionerConfiguration

java.lang.Object

edu.internet2.middleware.grouper.pspng.ProvisionerConfiguration

Direct Known Subclasses:

LdapProvisionerConfiguration

public class ProvisionerConfiguration
extends Object

Collects all the various properties and makes them available to the provisioner.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	areCacheSizeWarningsEnabled
protected boolean	areCacheSizeWarningsEnabled_defaultValue
protected boolean	areChangesToInternalGrouperSubjectsIgnored
protected boolean	areChangesToInternalGrouperSubjectsIgnored_defaultValue
protected Collection<String>	attributesUsedInGroupSelectionExpression
protected String	attributesUsedInGroupSelectionExpression_defaultValue
protected boolean	attributesUsedInGroupSelectionExpressionAreComparedToProvisionerName
protected boolean	attributesUsedInGroupSelectionExpressionAreComparedToProvisionerName_defaultValue
protected int	cacheFullnessWarningThreshold_percentage
protected int	cacheFullnessWarningThreshold_percentage_defaultValue
protected int	coordinationTimeout_secs
protected int	coordinationTimeout_secs_defaultValue
protected int	coordinationUpdateInterval_secs
protected int	coordinationUpdateInterval_secs_defaultValue
protected boolean	createMissingUsers_defaultValue
protected int	dataCacheTime_secs
protected int	dataCacheTime_secs_defaultValue
protected boolean	enabled_defaultValue
protected int	grouperGroupCacheSize_defaultValue
protected boolean	grouperIsAuthoritative_defaultValue
protected String	grouperMessagingSystemName_defaultValue
protected int	grouperSubjectCacheSize_defaultValue
protected int	groupSearch_batchSize_defaultValue
protected String	groupSelectionExpression
protected int	maxNumberOfTimesToRepeatedlyFullSyncGroup
protected int	maxNumberOfTimesToRepeatedlyFullSyncGroup_defaultValue
protected int	missingSubjectsWarningThreshold_percentage
protected int	missingSubjectsWarningThreshold_percentage_defaultValue
protected boolean	needsTargetSystemGroups_defaultValue
protected boolean	needsTargetSystemUsers_defaultValue
protected int	numberOfDataFetchingWorkers_defaultValue
static String	PARAMETER_NAMESPACE
protected String	provisionerName
protected int	sleepTimeAfterError_ms_defaultValue
protected boolean	supportsEmptyGroups_defaultValue
protected int	targetSystemGroupCacheSize_defaultValue
protected int	targetSystemUserCacheSize
protected int	targetSystemUserCacheSize_defaultValue
protected int	timeToSleepBetweenRepeatedFullSyncs_ms
protected int	timeToSleepBetweenRepeatedFullSyncs_ms_defaultValue
protected int	userSearch_batchSize_defaultValue

Constructor Summary

Constructors

Constructor and Description
ProvisionerConfiguration(String provisionerName)

Method Summary

Modifier and Type	Method and Description
boolean	areAttributesUsedInGroupSelectionExpressionComparedToProvisionerName() The groupSelectionExpression is an arbitrary jexl expression.
boolean	areCacheSizeWarningsEnabled()
boolean	areChangesToInternalGrouperSubjectsIgnored()
boolean	areEmptyGroupsSupported()
Collection<String>	getAttributesUsedInGroupSelectionExpression()
double	getCacheFullnessWarningThreshold_percentage()
int	getCoordinationTimout_secs()
int	getCoordinationUpdateInterval_secs()
int	getDataCacheTime_secs()
int	getGrouperGroupCacheSize()
String	getGrouperMessagingSystemName()
int	getGrouperSubjectCacheSize()
int	getGroupSearch_batchSize()
String	getGroupSelectionExpression()
int	getMaxNumberOfTimesToRepeatedlyFullSyncGroup()
int	getMissingSubjectsWarningThreshold_percentage()
int	getNumberOfDataFetchingWorkers()
long	getSleepTimeAfterError_ms()
int	getTargetSystemGroupCacheSize()
int	getTargetSystemUserCacheSize()
int	getTimeToSleepBetweenRepeatedFullSyncs_ms()
int	getUserSearch_batchSize()
protected String	groupSelectionExpression_defaultValue() This expression says that the provisionerName has to be in a group or stem provision_to attribute and NOT in neither a group or stem do_not_provision_to attribute
boolean	isCreatingMissingUsersEnabled()
boolean	isEnabled()
boolean	isGrouperAuthoritative()
boolean	needsTargetSystemGroups()
boolean	needsTargetSystemUsers()
void	populateElMap(Map<String,Object> variableMap)
void	readConfiguration() Populate the various settings from the configuration source(s).

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_NAMESPACE

public static final String PARAMETER_NAMESPACE

See Also:

Constant Field Values

provisionerName

protected final String provisionerName

enabled_defaultValue

protected boolean enabled_defaultValue

grouperIsAuthoritative_defaultValue

protected boolean grouperIsAuthoritative_defaultValue

sleepTimeAfterError_ms_defaultValue

protected int sleepTimeAfterError_ms_defaultValue

dataCacheTime_secs

protected int dataCacheTime_secs

dataCacheTime_secs_defaultValue

protected int dataCacheTime_secs_defaultValue

grouperGroupCacheSize_defaultValue

protected int grouperGroupCacheSize_defaultValue

grouperSubjectCacheSize_defaultValue

protected int grouperSubjectCacheSize_defaultValue

groupSelectionExpression

protected String groupSelectionExpression

coordinationTimeout_secs

protected int coordinationTimeout_secs

coordinationTimeout_secs_defaultValue

protected int coordinationTimeout_secs_defaultValue

coordinationUpdateInterval_secs

protected int coordinationUpdateInterval_secs

coordinationUpdateInterval_secs_defaultValue

protected int coordinationUpdateInterval_secs_defaultValue

areChangesToInternalGrouperSubjectsIgnored

protected boolean areChangesToInternalGrouperSubjectsIgnored

areChangesToInternalGrouperSubjectsIgnored_defaultValue

protected boolean areChangesToInternalGrouperSubjectsIgnored_defaultValue

missingSubjectsWarningThreshold_percentage

protected int missingSubjectsWarningThreshold_percentage

missingSubjectsWarningThreshold_percentage_defaultValue

protected int missingSubjectsWarningThreshold_percentage_defaultValue

areCacheSizeWarningsEnabled

protected boolean areCacheSizeWarningsEnabled

areCacheSizeWarningsEnabled_defaultValue

protected boolean areCacheSizeWarningsEnabled_defaultValue

cacheFullnessWarningThreshold_percentage

protected int cacheFullnessWarningThreshold_percentage

cacheFullnessWarningThreshold_percentage_defaultValue

protected int cacheFullnessWarningThreshold_percentage_defaultValue

maxNumberOfTimesToRepeatedlyFullSyncGroup

protected int maxNumberOfTimesToRepeatedlyFullSyncGroup

maxNumberOfTimesToRepeatedlyFullSyncGroup_defaultValue

protected int maxNumberOfTimesToRepeatedlyFullSyncGroup_defaultValue

timeToSleepBetweenRepeatedFullSyncs_ms

protected int timeToSleepBetweenRepeatedFullSyncs_ms

timeToSleepBetweenRepeatedFullSyncs_ms_defaultValue

protected int timeToSleepBetweenRepeatedFullSyncs_ms_defaultValue

attributesUsedInGroupSelectionExpression

protected Collection<String> attributesUsedInGroupSelectionExpression

attributesUsedInGroupSelectionExpression_defaultValue

protected String attributesUsedInGroupSelectionExpression_defaultValue

attributesUsedInGroupSelectionExpressionAreComparedToProvisionerName

protected boolean attributesUsedInGroupSelectionExpressionAreComparedToProvisionerName

attributesUsedInGroupSelectionExpressionAreComparedToProvisionerName_defaultValue

protected boolean attributesUsedInGroupSelectionExpressionAreComparedToProvisionerName_defaultValue

needsTargetSystemUsers_defaultValue

protected boolean needsTargetSystemUsers_defaultValue

targetSystemUserCacheSize

protected int targetSystemUserCacheSize

targetSystemUserCacheSize_defaultValue

protected int targetSystemUserCacheSize_defaultValue

userSearch_batchSize_defaultValue

protected int userSearch_batchSize_defaultValue

createMissingUsers_defaultValue

protected boolean createMissingUsers_defaultValue

needsTargetSystemGroups_defaultValue

protected boolean needsTargetSystemGroups_defaultValue

targetSystemGroupCacheSize_defaultValue

protected int targetSystemGroupCacheSize_defaultValue

supportsEmptyGroups_defaultValue

protected boolean supportsEmptyGroups_defaultValue

groupSearch_batchSize_defaultValue

protected int groupSearch_batchSize_defaultValue

grouperMessagingSystemName_defaultValue

protected String grouperMessagingSystemName_defaultValue

numberOfDataFetchingWorkers_defaultValue

protected int numberOfDataFetchingWorkers_defaultValue

Constructor Detail

ProvisionerConfiguration

public ProvisionerConfiguration(String provisionerName)

Method Detail

groupSelectionExpression_defaultValue

protected String groupSelectionExpression_defaultValue()

This expression says that the provisionerName has to be in a group or stem provision_to attribute and NOT in neither a group or stem do_not_provision_to attribute

readConfiguration

public void readConfiguration()

Populate the various settings from the configuration source(s). This is separated from our constructor so that our subclasses can override default values. In other words, a subclass might construct us, change a _defaultValue ivar and then ask us to do 'readConfiguration'.

isEnabled

public boolean isEnabled()

getDataCacheTime_secs

public int getDataCacheTime_secs()

getGrouperGroupCacheSize

public int getGrouperGroupCacheSize()

getGrouperSubjectCacheSize

public int getGrouperSubjectCacheSize()

getTargetSystemUserCacheSize

public int getTargetSystemUserCacheSize()

getTargetSystemGroupCacheSize

public int getTargetSystemGroupCacheSize()

areAttributesUsedInGroupSelectionExpressionComparedToProvisionerName

public boolean areAttributesUsedInGroupSelectionExpressionComparedToProvisionerName()

The groupSelectionExpression is an arbitrary jexl expression. As such, it's hard to know exactly what it is doing with Group and Folder attributes. This method enables (fast) database filtering to occur when those Group and Folder attributes are being compared to the name of the provisioner.

Returns:

True if the Group-Selection expression compares the attributes to the provisioner name

isCreatingMissingUsersEnabled

public boolean isCreatingMissingUsersEnabled()

areEmptyGroupsSupported

public boolean areEmptyGroupsSupported()

getUserSearch_batchSize

public int getUserSearch_batchSize()

getGroupSearch_batchSize

public int getGroupSearch_batchSize()

needsTargetSystemUsers

public boolean needsTargetSystemUsers()

needsTargetSystemGroups

public boolean needsTargetSystemGroups()

getGroupSelectionExpression

public String getGroupSelectionExpression()

getAttributesUsedInGroupSelectionExpression

public Collection<String> getAttributesUsedInGroupSelectionExpression()

populateElMap

public void populateElMap(Map<String,Object> variableMap)

getSleepTimeAfterError_ms

public long getSleepTimeAfterError_ms()

isGrouperAuthoritative

public boolean isGrouperAuthoritative()

getCoordinationTimout_secs

public int getCoordinationTimout_secs()

getCoordinationUpdateInterval_secs

public int getCoordinationUpdateInterval_secs()

areChangesToInternalGrouperSubjectsIgnored

public boolean areChangesToInternalGrouperSubjectsIgnored()

getGrouperMessagingSystemName

public String getGrouperMessagingSystemName()

getNumberOfDataFetchingWorkers

public int getNumberOfDataFetchingWorkers()

getMissingSubjectsWarningThreshold_percentage

public int getMissingSubjectsWarningThreshold_percentage()

getCacheFullnessWarningThreshold_percentage

public double getCacheFullnessWarningThreshold_percentage()

areCacheSizeWarningsEnabled

public boolean areCacheSizeWarningsEnabled()

getMaxNumberOfTimesToRepeatedlyFullSyncGroup

public int getMaxNumberOfTimesToRepeatedlyFullSyncGroup()

getTimeToSleepBetweenRepeatedFullSyncs_ms

public int getTimeToSleepBetweenRepeatedFullSyncs_ms()