Package edu.internet2.middleware.grouperClient.config

Class GrouperUiApiTextConfig

java.lang.Object

edu.internet2.middleware.grouperClient.config.ConfigPropertiesCascadeBase

edu.internet2.middleware.grouperClient.config.GrouperUiApiTextConfig

public class GrouperUiApiTextConfig
extends ConfigPropertiesCascadeBase

save the text bundle for the session. Determine it based on the language and locale of the browser

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	TERM_PREFIX	in the text file, terms must start with this prefix.
static final String	TOOLTIP_PREFIX	in the text file, tooltips must start with this prefix.
static final String	TOOLTIP_TARGETTED_PREFIX	target a tooltip on a certain message
static final String	TOOLTIP_TARGETTED_REF_PREFIX	target a tooltip on a certain message, and make the value of the tooltip a reference to another tooltip

Constructor Summary

Constructors

Constructor	Description
GrouperUiApiTextConfig()

Method Summary

Modifier and Type	Method	Description
static void	clearCache()
void	clearCachedCalculatedValues()	if there are things that are calculated, clear them out (e.g. if an override is set)
protected String	getHierarchyConfigKey()	config key of the hierarchy value
protected String	getMainConfigClasspath()	get the main config classpath, e.g. grouper.properties
protected String	getMainExampleConfigClasspath()	get the example config classpath, e.g. grouper.example.properties
protected String	getSecondsToCheckConfigKey()	config key of the time in seconds to check config
static void	main(String[] args)
protected ConfigPropertiesCascadeBase	retrieveFromConfigFileOrCache()	see if there is one in cache, if so, use it, if not, get from config files
protected ConfigPropertiesCascadeBase	retrieveFromConfigFiles()	get the config object from config files
static GrouperUiApiTextConfig	retrieveText(Locale locale)	text config for a certain locale
static GrouperUiApiTextConfig	retrieveTextConfig()	text config for this user's locale
static GrouperUiApiTextConfig	retrieveTextConfigEnUs()	text config for this user's locale
static GrouperUiApiTextConfig	retrieveTextConfigFrFr()	text config for this user's locale
static void	servletRequestThreadLocalAssign(javax.servlet.ServletRequest servletRequest)	assign thread local from filter
static void	servletRequestThreadLocalClear()	clea thread local
List<String>	tooltipKeys()	init and return the tooltip keys
List<String>	tooltipValues()	init and return the tooltip keys

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

assertPropertyValueBoolean, assertPropertyValueClass, assertPropertyValueRequired, assignInitted, 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, 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

TERM_PREFIX

public static final String TERM_PREFIX

in the text file, terms must start with this prefix. multiple terms can exist for one tooltip

See Also:

• Constant Field Values

TOOLTIP_PREFIX

public static final String TOOLTIP_PREFIX

in the text file, tooltips must start with this prefix. there should be one and only one tooltip for a term. tooltips and terms are linked by the common name, which is the suffix of the text file key. e.g. tooltip.group=A group is a collection term.group=Group term.group=group these are linked because they all end in "group"

See Also:

• Constant Field Values

TOOLTIP_TARGETTED_PREFIX

public static final String TOOLTIP_TARGETTED_PREFIX

target a tooltip on a certain message

See Also:

• Constant Field Values

TOOLTIP_TARGETTED_REF_PREFIX

public static final String TOOLTIP_TARGETTED_REF_PREFIX

target a tooltip on a certain message, and make the value of the tooltip a reference to another tooltip

See Also:

• Constant Field Values

Constructor Details

GrouperUiApiTextConfig

public GrouperUiApiTextConfig()

Method Details

clearCache

public static void clearCache()

main

public static void main(String[] args)
                 throws Exception

Parameters:

args -

Throws:

Exception

retrieveTextConfigEnUs

public static GrouperUiApiTextConfig retrieveTextConfigEnUs()

text config for this user's locale

Returns:

the config for this user's locale

retrieveTextConfigFrFr

public static GrouperUiApiTextConfig retrieveTextConfigFrFr()

text config for this user's locale

Returns:

the config for this user's locale

retrieveTextConfig

public static GrouperUiApiTextConfig retrieveTextConfig()

text config for this user's locale

Returns:

the config for this user's locale

retrieveText

public static GrouperUiApiTextConfig retrieveText(Locale locale)

text config for a certain locale

Parameters:

locale -

Returns:

the config for this user's locale

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()

retrieveFromConfigFileOrCache

protected ConfigPropertiesCascadeBase retrieveFromConfigFileOrCache()

see if there is one in cache, if so, use it, if not, get from config files

Overrides:

retrieveFromConfigFileOrCache in class ConfigPropertiesCascadeBase

Returns:

the config from file or cache

retrieveFromConfigFiles

protected ConfigPropertiesCascadeBase retrieveFromConfigFiles()

Description copied from class: ConfigPropertiesCascadeBase

get the config object from config files

Overrides:

retrieveFromConfigFiles in class ConfigPropertiesCascadeBase

Returns:

the config object

tooltipKeys

public List<String> tooltipKeys()

init and return the tooltip keys

Returns:

the list of keys

tooltipValues

public List<String> tooltipValues()

init and return the tooltip keys

Returns:

the list of keys

servletRequestThreadLocalAssign

public static void servletRequestThreadLocalAssign(javax.servlet.ServletRequest servletRequest)

assign thread local from filter

Parameters:

servletRequest -

servletRequestThreadLocalClear

public static void servletRequestThreadLocalClear()

clea thread local