Package edu.internet2.middleware.grouper.cfg

Class GrouperConfig

java.lang.Object

edu.internet2.middleware.grouperClient.config.ConfigPropertiesCascadeBase

edu.internet2.middleware.grouper.cfg.GrouperConfig

public class GrouperConfig
extends ConfigPropertiesCascadeBase

Grouper configuration information.

This class is being deprecated by the edu.internet2.middleware.grouper.cfg.Configuration interface.

Since:

?

Version:

$Id: GrouperConfig.java,v 1.9 2009-12-16 06:02:30 mchyzer Exp $

Nested Class Summary

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

ConfigPropertiesCascadeBase.ConfigFile, ConfigPropertiesCascadeBase.ConfigFileType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALL
static final String	ALL_NAME
static final String	ATTR_C
static final String	ATTR_CT
static final String	ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_ADMIN
static final String	ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_DEF_ATTR_READ
static final String	ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_DEF_ATTR_UPDATE
static final String	ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_OPTIN
static final String	ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_OPTOUT
static final String	ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_READ
static final String	ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_UPDATE
static final String	ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_VIEW
static final String	ATTRIBUTE_DESCRIPTION
static final String	ATTRIBUTE_DISPLAY_EXTENSION
static final String	ATTRIBUTE_DISPLAY_NAME
static final String	ATTRIBUTE_EXTENSION
static final String	ATTRIBUTE_NAME
static final String	BT
static final String	DEFAULT_DAO_FACTORY	Default DAO implementation to be used if an alternative is not configured.
static final String	EMPTY_STRING	String with value of "".
static final long	EPOCH	Epoch origin.
static final String	GCGAGAR
static final String	GCGAOI
static final String	GCGAOO
static final String	GCGAR
static final String	GCGAV
static final String	IST
static final String	LIST
static final String	MESSAGES_USE_TOOLTIPS	if tooltips should be substituted in messages
static final String	NL
static final String	PROP_DAO_FACTORY	Property containing name of DAO implementation to be used.
static final String	PROP_MAX_WHEEL_AGE	Property containing maximum age of cached wheel group.
static final String	PROP_USE_WHEEL_GROUP	Property determining whether wheel group is to be used.
static final String	PROP_WHEEL_GROUP	Property containing name of wheel group.
static final String	ROOT
static final String	ROOT_NAME
static final String	SCGAC
static final String	SCGASA
static final String	SCGASAR
static final String	SCGASAU
static final String	SCIDFRI
static final String	SCII
static final String	WHEEL_NAME

Method Summary

Modifier and Type	Method	Description
Set<String>	attributeDefIdsToIgnoreChangeLogAndAudit()	get the attribute def ids to ignore when sending to change log, and audit
Set<String>	attributeDefNameIdsToIgnoreChangeLogAndAudit()	get the attribute def name ids to ignore when sending to change log, and audit
void	clearCachedCalculatedValues()
Set<String>	deprovisioningAffiliations()	cache deprovisioning affiliations
static String	getGrouperUiUrl(boolean exceptionIfNull)	get the UI url with a slash on the end
static String	getHibernateProperty(String property)	Deprecated. use GrouperHibernateConfig.retrieveConfig().propertyValueString() instead
static int	getHibernatePropertyInt(String property, int defaultValue)	get the hibernate property value as an int, throw an exception if invalid value.
protected String	getHierarchyConfigKey()
protected String	getMainConfigClasspath()
protected String	getMainExampleConfigClasspath()
static String	getProperty(String property)	Deprecated. use GrouperConfig.retrieveConfig().propertyValueString instead
String	getProperty(String property, String defaultValue)
static boolean	getPropertyBoolean(String propertyName, boolean defaultValue)	Deprecated. use GrouperConfig.retrieveConfig().propertyValueBoolean(propertyName, defaultValue) instead
static int	getPropertyInt(String propertyName, int defaultValue)	Deprecated. use GrouperConfig.retrieveConfig().propertyValueInt
static Set<String>	getPropertyNames()	Deprecated. use GrouperConfig.retrieveConfig().propertyNames() instead
protected String	getSecondsToCheckConfigKey()
void	resetAttributeDefNameIdsToIgnoreChangeLogAndAudit()	For testing purposes
static GrouperConfig	retrieveConfig()	retrieve a config from the config file or from cache
TextBundleBean	textBundleDefault()	default bundle
Map<String,TextBundleBean>	textBundleFromCountry()	country to text bundle
Map<String,TextBundleBean>	textBundleFromLanguage()	country to text bundle
Map<String,TextBundleBean>	textBundleFromLanguageAndCountry()	country to text bundle

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

assertPropertyValueBoolean, assertPropertyValueClass, assertPropertyValueRequired, assignInitted, clearCache, clearCacheThisOnly, configExistsNotInBaseOrDatabase, containsKey, filesNeedReloadingBasedOnContents, getClassInSiblingJar, 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

Field Details

DEFAULT_DAO_FACTORY

public static final String DEFAULT_DAO_FACTORY

Default DAO implementation to be used if an alternative is not configured.

Since:

1.2.0

EMPTY_STRING

public static final String EMPTY_STRING

String with value of "".

See Also:

• Constant Field Values

EPOCH

public static final long EPOCH

Epoch origin.

See Also:

• Constant Field Values

PROP_DAO_FACTORY

public static final String PROP_DAO_FACTORY

Property containing name of DAO implementation to be used.

Grouper will default to DEFAULT_DAO_FACTORY if this property is not set.

Since:

1.2.0

See Also:

• Constant Field Values

PROP_MAX_WHEEL_AGE

public static final String PROP_MAX_WHEEL_AGE

Property containing maximum age of cached wheel group.

See Also:

• Constant Field Values

PROP_WHEEL_GROUP

public static final String PROP_WHEEL_GROUP

Property containing name of wheel group.

See Also:

• Constant Field Values

PROP_USE_WHEEL_GROUP

public static final String PROP_USE_WHEEL_GROUP

Property determining whether wheel group is to be used.

See Also:

• Constant Field Values

ALL

public static final String ALL

See Also:

• Constant Field Values

ALL_NAME

public static final String ALL_NAME

See Also:

• Constant Field Values

ATTR_C

public static final String ATTR_C

See Also:

• Constant Field Values

ATTR_CT

public static final String ATTR_CT

See Also:

• Constant Field Values

ATTRIBUTE_DESCRIPTION

public static final String ATTRIBUTE_DESCRIPTION

See Also:

• Constant Field Values

ATTRIBUTE_DISPLAY_EXTENSION

public static final String ATTRIBUTE_DISPLAY_EXTENSION

See Also:

• Constant Field Values

ATTRIBUTE_DISPLAY_NAME

public static final String ATTRIBUTE_DISPLAY_NAME

See Also:

• Constant Field Values

ATTRIBUTE_EXTENSION

public static final String ATTRIBUTE_EXTENSION

See Also:

• Constant Field Values

ATTRIBUTE_NAME

public static final String ATTRIBUTE_NAME

See Also:

• Constant Field Values

BT

public static final String BT

See Also:

• Constant Field Values

GCGAOI

public static final String GCGAOI

See Also:

• Constant Field Values

GCGAOO

public static final String GCGAOO

See Also:

• Constant Field Values

GCGAR

public static final String GCGAR

See Also:

• Constant Field Values

GCGAV

public static final String GCGAV

See Also:

• Constant Field Values

GCGAGAR

public static final String GCGAGAR

See Also:

• Constant Field Values

ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_ADMIN

public static final String ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_ADMIN

See Also:

• Constant Field Values

ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_OPTIN

public static final String ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_OPTIN

See Also:

• Constant Field Values

ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_OPTOUT

public static final String ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_OPTOUT

See Also:

• Constant Field Values

ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_READ

public static final String ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_READ

See Also:

• Constant Field Values

ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_UPDATE

public static final String ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_UPDATE

See Also:

• Constant Field Values

ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_VIEW

public static final String ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_VIEW

See Also:

• Constant Field Values

ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_DEF_ATTR_READ

public static final String ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_DEF_ATTR_READ

See Also:

• Constant Field Values

ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_DEF_ATTR_UPDATE

public static final String ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_DEF_ATTR_UPDATE

See Also:

• Constant Field Values

IST

public static final String IST

See Also:

• Constant Field Values

LIST

public static final String LIST

See Also:

• Constant Field Values

NL

public static final String NL

ROOT

public static final String ROOT

See Also:

• Constant Field Values

ROOT_NAME

public static final String ROOT_NAME

See Also:

• Constant Field Values

SCGAC

public static final String SCGAC

See Also:

• Constant Field Values

SCGASA

public static final String SCGASA

See Also:

• Constant Field Values

SCGASAR

public static final String SCGASAR

See Also:

• Constant Field Values

SCGASAU

public static final String SCGASAU

See Also:

• Constant Field Values

SCII

public static final String SCII

See Also:

• Constant Field Values

SCIDFRI

public static final String SCIDFRI

See Also:

• Constant Field Values

WHEEL_NAME

public static final String WHEEL_NAME

See Also:

• Constant Field Values

MESSAGES_USE_TOOLTIPS

public static final String MESSAGES_USE_TOOLTIPS

if tooltips should be substituted in messages

See Also:

• Constant Field Values

Method Details

attributeDefIdsToIgnoreChangeLogAndAudit

public Set<String> attributeDefIdsToIgnoreChangeLogAndAudit()

get the attribute def ids to ignore when sending to change log, and audit

Returns:

the set of attribute definition ids

resetAttributeDefNameIdsToIgnoreChangeLogAndAudit

public void resetAttributeDefNameIdsToIgnoreChangeLogAndAudit()

For testing purposes

attributeDefNameIdsToIgnoreChangeLogAndAudit

public Set<String> attributeDefNameIdsToIgnoreChangeLogAndAudit()

get the attribute def name ids to ignore when sending to change log, and audit

Returns:

the set of attribute def name ids

retrieveConfig

public static GrouperConfig retrieveConfig()

retrieve a config from the config file or from cache

Returns:

the config object

getHibernateProperty

@Deprecated
public static String getHibernateProperty(String property)

Deprecated.

use GrouperHibernateConfig.retrieveConfig().propertyValueString() instead

Get a Hibernate configuration parameter.

 String dialect = GrouperConfig.getHibernateProperty("hibernate.dialect");
 

Returns:

Value of configuration parameter or an empty string if parameter is invalid.

Since:

1.1.0

getProperty

@Deprecated
public static String getProperty(String property)

Deprecated.

use GrouperConfig.retrieveConfig().propertyValueString instead

Get a Grouper configuration parameter.

 String wheel = GrouperConfig.retrieveConfig().propertyValueString("groups.wheel.group");
 

Parameters:

property - is the property key

Returns:

Value of configuration parameter or an empty string if parameter is invalid.

Since:

1.1.0

getPropertyNames

@Deprecated
public static Set<String> getPropertyNames()

Deprecated.

use GrouperConfig.retrieveConfig().propertyNames() instead

Get a Grouper config names

Returns:

set of names

getPropertyBoolean

@Deprecated
public static boolean getPropertyBoolean(String propertyName,
 boolean defaultValue)

Deprecated.

use GrouperConfig.retrieveConfig().propertyValueBoolean(propertyName, defaultValue) instead

get the property value as a boolean, throw an exception if invalid value. Acceptable values are: t, f, true, false (case-insensitive)

Parameters:

propertyName -

defaultValue - if the property is blank or missing, return this value

Returns:

true or false

getPropertyInt

@Deprecated
public static int getPropertyInt(String propertyName,
 int defaultValue)

Deprecated.

use GrouperConfig.retrieveConfig().propertyValueInt

get the property value as an int, throw an exception if invalid value.

Parameters:

propertyName -

defaultValue - if the property is blank or missing, return this value

Returns:

the int

getProperty

public String getProperty(String property,
 String defaultValue)
                   throws IllegalArgumentException

Parameters:

property -

defaultValue -

Returns:

the property value, or the default value if the property value is blank

Throws:

IllegalArgumentException

getHibernatePropertyInt

public static int getHibernatePropertyInt(String property,
 int defaultValue)

get the hibernate property value as an int, throw an exception if invalid value.

Parameters:

property -

defaultValue -

Returns:

int

getGrouperUiUrl

public static String getGrouperUiUrl(boolean exceptionIfNull)

get the UI url with a slash on the end

Parameters:

exceptionIfNull -

Returns:

the UI URL

clearCachedCalculatedValues

public void clearCachedCalculatedValues()

Specified by:

clearCachedCalculatedValues in class ConfigPropertiesCascadeBase

See Also:

• ConfigPropertiesCascadeBase.clearCachedCalculatedValues()

getHierarchyConfigKey

protected String getHierarchyConfigKey()

Specified by:

getHierarchyConfigKey in class ConfigPropertiesCascadeBase

See Also:

• ConfigPropertiesCascadeBase.getHierarchyConfigKey()

getMainConfigClasspath

protected String getMainConfigClasspath()

Specified by:

getMainConfigClasspath in class ConfigPropertiesCascadeBase

See Also:

• ConfigPropertiesCascadeBase.getMainConfigClasspath()

getMainExampleConfigClasspath

protected String getMainExampleConfigClasspath()

Specified by:

getMainExampleConfigClasspath in class ConfigPropertiesCascadeBase

See Also:

• ConfigPropertiesCascadeBase.getMainExampleConfigClasspath()

getSecondsToCheckConfigKey

protected String getSecondsToCheckConfigKey()

Specified by:

getSecondsToCheckConfigKey in class ConfigPropertiesCascadeBase

See Also:

• ConfigPropertiesCascadeBase.getSecondsToCheckConfigKey()

deprovisioningAffiliations

public Set<String> deprovisioningAffiliations()

cache deprovisioning affiliations

Returns:

the affiliations

textBundleDefault

public TextBundleBean textBundleDefault()

default bundle

Returns:

the textBundleDefault

textBundleFromCountry

public Map<String,TextBundleBean> textBundleFromCountry()

country to text bundle

Returns:

the map

textBundleFromLanguage

public Map<String,TextBundleBean> textBundleFromLanguage()

country to text bundle

Returns:

the map

textBundleFromLanguageAndCountry

public Map<String,TextBundleBean> textBundleFromLanguageAndCountry()

country to text bundle

Returns:

the map