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 edu.internet2.middleware.grouperClient.config.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 $

Author:

blair christensen.

Field Summary

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

Method Summary

java.util.Set<java.lang.String>	attributeDefIdsToIgnoreChangeLogAndAudit() get the attribute def ids to ignore when sending to change log, and audit
void	clearCachedCalculatedValues()
static java.lang.String	getGrouperUiUrl(boolean exceptionIfNull) get the UI url with a slash on the end
static java.lang.String	getHibernateProperty(java.lang.String property) Deprecated. use GrouperHibernateConfig.retrieveConfig().propertyValueString() instead
static int	getHibernatePropertyInt(java.lang.String property, int defaultValue) get the hibernate property value as an int, throw an exception if invalid value.
static java.lang.String	getProperty(java.lang.String property) Deprecated. use GrouperConfig.retrieveConfig().propertyValueString instead
java.lang.String	getProperty(java.lang.String property, java.lang.String defaultValue)
static boolean	getPropertyBoolean(java.lang.String propertyName, boolean defaultValue) Deprecated. use GrouperConfig.retrieveConfig().propertyValueBoolean(propertyName, defaultValue) instead
static int	getPropertyInt(java.lang.String propertyName, int defaultValue) Deprecated. use GrouperConfig.retrieveConfig().propertyValueInt
static java.util.Set<java.lang.String>	getPropertyNames() Deprecated. use GrouperConfig.retrieveConfig().propertyNames() instead
static GrouperConfig	retrieveConfig() retrieve a config from the config file or from cache

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

assertPropertyValueBoolean, assertPropertyValueClass, assertPropertyValueRequired, containsKey, properties, propertiesMap, propertiesOverrideMap, propertiesThreadLocalOverrideMap, propertyNames, propertyValueBoolean, propertyValueBoolean, propertyValueBooleanRequired, propertyValueInt, propertyValueInt, propertyValueIntRequired, propertyValueString, propertyValueString, propertyValueStringRequired

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DAO_FACTORY

public static final java.lang.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 java.lang.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 java.lang.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 java.lang.String PROP_MAX_WHEEL_AGE

Property containing maximum age of cached wheel group.

See Also:

Constant Field Values

PROP_WHEEL_GROUP

public static final java.lang.String PROP_WHEEL_GROUP

Property containing name of wheel group.

See Also:

Constant Field Values

PROP_USE_WHEEL_GROUP

public static final java.lang.String PROP_USE_WHEEL_GROUP

Property determining whether wheel group is to be used.

See Also:

Constant Field Values

ALL

public static final java.lang.String ALL

See Also:

Constant Field Values

ALL_NAME

public static final java.lang.String ALL_NAME

See Also:

Constant Field Values

ATTR_C

public static final java.lang.String ATTR_C

See Also:

Constant Field Values

ATTR_CT

public static final java.lang.String ATTR_CT

See Also:

Constant Field Values

ATTRIBUTE_DESCRIPTION

public static final java.lang.String ATTRIBUTE_DESCRIPTION

See Also:

Constant Field Values

ATTRIBUTE_DISPLAY_EXTENSION

public static final java.lang.String ATTRIBUTE_DISPLAY_EXTENSION

See Also:

Constant Field Values

ATTRIBUTE_DISPLAY_NAME

public static final java.lang.String ATTRIBUTE_DISPLAY_NAME

See Also:

Constant Field Values

ATTRIBUTE_EXTENSION

public static final java.lang.String ATTRIBUTE_EXTENSION

See Also:

Constant Field Values

ATTRIBUTE_NAME

public static final java.lang.String ATTRIBUTE_NAME

See Also:

Constant Field Values

BT

public static final java.lang.String BT

See Also:

Constant Field Values

GCGAOI

public static final java.lang.String GCGAOI

See Also:

Constant Field Values

GCGAOO

public static final java.lang.String GCGAOO

See Also:

Constant Field Values

GCGAR

public static final java.lang.String GCGAR

See Also:

Constant Field Values

GCGAV

public static final java.lang.String GCGAV

See Also:

Constant Field Values

GCGAGAR

public static final java.lang.String GCGAGAR

See Also:

Constant Field Values

ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_ADMIN

public static final java.lang.String ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_ADMIN

See Also:

Constant Field Values

ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_OPTIN

public static final java.lang.String ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_OPTIN

See Also:

Constant Field Values

ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_OPTOUT

public static final java.lang.String ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_OPTOUT

See Also:

Constant Field Values

ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_READ

public static final java.lang.String ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_READ

See Also:

Constant Field Values

ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_UPDATE

public static final java.lang.String ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_UPDATE

See Also:

Constant Field Values

ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_VIEW

public static final java.lang.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 java.lang.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 java.lang.String ATTRIBUTE_DEFS_CREATE_GRANT_ALL_ATTR_DEF_ATTR_UPDATE

See Also:

Constant Field Values

IST

public static final java.lang.String IST

See Also:

Constant Field Values

LIST

public static final java.lang.String LIST

See Also:

Constant Field Values

NL

public static final java.lang.String NL

ROOT

public static final java.lang.String ROOT

See Also:

Constant Field Values

ROOT_NAME

public static final java.lang.String ROOT_NAME

See Also:

Constant Field Values

SCGAC

public static final java.lang.String SCGAC

See Also:

Constant Field Values

SCGASA

public static final java.lang.String SCGASA

See Also:

Constant Field Values

SCGASAR

public static final java.lang.String SCGASAR

See Also:

Constant Field Values

SCGASAU

public static final java.lang.String SCGASAU

See Also:

Constant Field Values

SCII

public static final java.lang.String SCII

See Also:

Constant Field Values

SCIDFRI

public static final java.lang.String SCIDFRI

See Also:

Constant Field Values

WHEEL_NAME

public static final java.lang.String WHEEL_NAME

See Also:

Constant Field Values

MESSAGES_USE_TOOLTIPS

public static final java.lang.String MESSAGES_USE_TOOLTIPS

if tooltips should be substituted in messages

See Also:

Constant Field Values

Method Detail

attributeDefIdsToIgnoreChangeLogAndAudit

public java.util.Set<java.lang.String> attributeDefIdsToIgnoreChangeLogAndAudit()

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

Returns:

the set of attribute definition ids

retrieveConfig

public static GrouperConfig retrieveConfig()

retrieve a config from the config file or from cache

Returns:

the config object

getHibernateProperty

@Deprecated
public static java.lang.String getHibernateProperty(java.lang.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 java.lang.String getProperty(java.lang.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 java.util.Set<java.lang.String> getPropertyNames()

Deprecated. use GrouperConfig.retrieveConfig().propertyNames() instead

Get a Grouper config names

Returns:

set of names

getPropertyBoolean

@Deprecated
public static boolean getPropertyBoolean(java.lang.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(java.lang.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 java.lang.String getProperty(java.lang.String property,
                                    java.lang.String defaultValue)
                             throws java.lang.IllegalArgumentException

Parameters:

property -

defaultValue -

Returns:

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

Throws:

java.lang.IllegalArgumentException

getHibernatePropertyInt

public static int getHibernatePropertyInt(java.lang.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 java.lang.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 edu.internet2.middleware.grouperClient.config.ConfigPropertiesCascadeBase

See Also:

ConfigPropertiesCascadeBase.clearCachedCalculatedValues()