Package edu.internet2.middleware.grouperClient.util

Class GrouperClientConfig

java.lang.Object

edu.internet2.middleware.grouperClient.config.ConfigPropertiesCascadeBase

edu.internet2.middleware.grouperClient.util.GrouperClientConfig

public class GrouperClientConfig
extends ConfigPropertiesCascadeBase

hierarchical config class for grouper.client.properties

Nested Class Summary

Nested classes/interfaces inherited from class edu.internet2.middleware.grouperClient.config.ConfigPropertiesCascadeBase

ConfigPropertiesCascadeBase.ConfigFile, ConfigPropertiesCascadeBase.ConfigFileType

Method Summary

Modifier and Type	Method	Description
void	clearCachedCalculatedValues()	if there are things that are calculated, clear them out (e.g.
protected Class<?>	getClassInSiblingJar()	if its ok to put the config file in the same directory as a jar, then return a class in the jar here
protected String	getHierarchyConfigKey()	config key of the hierarchy value
protected String	getMainConfigClasspath()	get the main config classpath, e.g.
protected String	getMainExampleConfigClasspath()	get the example config classpath, e.g.
protected String	getSecondsToCheckConfigKey()	config key of the time in seconds to check config.
static GrouperClientConfig	retrieveConfig()	retrieve a config from the config file or from cache
GrouperMessagingConfig	retrieveGrouperMessagingConfigNonNull(String systemName)	get a messaging config cant be null
Map<String,GrouperMessagingConfig>	retrieveGrouperMessagingConfigs()	process configs for messaging and return the map

Methods inherited from class edu.internet2.middleware.grouperClient.config.ConfigPropertiesCascadeBase

assertPropertyValueBoolean, assertPropertyValueClass, assertPropertyValueRequired, assignInitted, clearCache, clearCacheThisOnly, configExistsNotInBaseOrDatabase, containsKey, filesNeedReloadingBasedOnContents, getMainConfigFileName, getTimeToCheckConfigSeconds, hasExpressionLanguage, internalProperties, internalRetrieveConfigFiles, isInDatabase, logError, logInfo, needToCheckIfFilesNeedReloading, properties, propertiesFromResourceName, propertiesFromResourceName, propertiesHelper, propertiesMap, propertiesOverrideMap, propertiesThreadLocalOverrideMap, propertyConfigIds, propertyNames, propertyValueBoolean, propertyValueBoolean, propertyValueBoolean, propertyValueBooleanRequired, propertyValueInt, propertyValueInt, propertyValueInt, propertyValueIntRequired, propertyValueString, propertyValueString, propertyValueString, propertyValueStringHelper, propertyValueStringRequired, rawExpressionLanguage, retrieveConfig, retrieveFromConfigFileOrCache, retrieveFromConfigFiles, retrieveFromConfigFiles, substituteCommonVars, substituteLocalReferencesAndUnicode, substituteLocalReferencesOneField, substituteLocalReferencesOneSubstitution, substituteUnicode

Methods inherited from class java.lang.Object

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

Method Details

retrieveConfig

public static GrouperClientConfig retrieveConfig()

retrieve a config from the config file or from cache

Returns:

the config object

clearCachedCalculatedValues

public void clearCachedCalculatedValues()

Description copied from class: ConfigPropertiesCascadeBase

if there are things that are calculated, clear them out (e.g. if an override is set)

Specified by:

clearCachedCalculatedValues in class ConfigPropertiesCascadeBase

See Also:

• ConfigPropertiesCascadeBase.clearCachedCalculatedValues()

getHierarchyConfigKey

protected String getHierarchyConfigKey()

Description copied from class: ConfigPropertiesCascadeBase

config key of the hierarchy value

Specified by:

getHierarchyConfigKey in class ConfigPropertiesCascadeBase

Returns:

the classpath of the main config file

See Also:

• ConfigPropertiesCascadeBase.getHierarchyConfigKey()

getMainConfigClasspath

protected String getMainConfigClasspath()

Description copied from class: ConfigPropertiesCascadeBase

get the main config classpath, e.g. grouper.properties

Specified by:

getMainConfigClasspath in class ConfigPropertiesCascadeBase

Returns:

the classpath of the main config file

See Also:

• ConfigPropertiesCascadeBase.getMainConfigClasspath()

getMainExampleConfigClasspath

protected String getMainExampleConfigClasspath()

Description copied from class: ConfigPropertiesCascadeBase

get the example config classpath, e.g. grouper.example.properties

Specified by:

getMainExampleConfigClasspath in class ConfigPropertiesCascadeBase

Returns:

the classpath of the example config file

See Also:

• ConfigPropertiesCascadeBase.getMainExampleConfigClasspath()

getSecondsToCheckConfigKey

protected String getSecondsToCheckConfigKey()

Description copied from class: ConfigPropertiesCascadeBase

config key of the time in seconds to check config. -1 means dont check again

Specified by:

getSecondsToCheckConfigKey in class ConfigPropertiesCascadeBase

Returns:

config key

See Also:

• ConfigPropertiesCascadeBase.getSecondsToCheckConfigKey()

getClassInSiblingJar

protected Class<?> getClassInSiblingJar()

Description copied from class: ConfigPropertiesCascadeBase

if its ok to put the config file in the same directory as a jar, then return a class in the jar here

Overrides:

getClassInSiblingJar in class ConfigPropertiesCascadeBase

Returns:

the class or null if not available

See Also:

• ConfigPropertiesCascadeBase.getClassInSiblingJar()

retrieveGrouperMessagingConfigNonNull

public GrouperMessagingConfig retrieveGrouperMessagingConfigNonNull(String systemName)

get a messaging config cant be null

Parameters:

systemName -

Returns:

the config

retrieveGrouperMessagingConfigs

public Map<String,GrouperMessagingConfig> retrieveGrouperMessagingConfigs()

process configs for messaging and return the map

Returns:

the configs