org.xmlactions.action.config

Class ExecContext

java.lang.Object

org.xmlactions.action.config.ExecContext

All Implemented Interfaces:

java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>, IExecContext

Direct Known Subclasses:

FileExecContext, NoPersistenceExecContext, NoPersistExecContext, PersistenceExecContext, SessionExecContext

public abstract class ExecContext
extends java.lang.Object
implements IExecContext, java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields inherited from interface org.xmlactions.action.config.IExecContext

APPLICATIONCONTEXT_REF, CODE_REF, CONTENT_TYPE_CSS, CONTENT_TYPE_HTML, CONTENT_TYPE_JS, CONTENT_TYPE_JSON, CONTENT_TYPE_KEY, CONTENT_TYPE_XML, DEBUG_LEVEL, DEFAULT_ACTION_MAP, DEFAULT_ID, DEFAULT_LOCALE_FILE, DEFAULT_ROWS, DEFAULT_STORAGE_CONFIG_REF, DEFAULT_THEME_MAP, DEFAULT_THEME_NAME, ENV_REF, LANG_REF, MAP_STACKED_PAGES, PERSISTENCE_MAP, PROP_REF, REPLACE_REF, SELECTED_THEME_NAME, THEME_REF

Constructor Summary

Constructors

Constructor and Description
ExecContext(java.util.List<java.lang.Object> actionMaps, java.util.List<java.lang.Object> localMaps) Deprecated. - replaced with constructor ExecContext(List<Object> actionMaps, List<Object> localMaps, List<Object> themes)
ExecContext(java.util.List<java.lang.Object> actionMaps, java.util.List<java.lang.Object> localMaps, java.util.List<java.lang.Object> themes)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	_get(java.lang.Object key) Deprecated. - use new version
void	addActions(java.util.Map map) Append this map to default actions
void	addActions(java.util.Properties props) Append this properties to default actions
void	addMap(java.util.Map map) Append this map to rootMap
void	addNamedActions(java.lang.String actionMapName, java.util.Map map) Append this map to actions as a named
void	addNamedActions(java.lang.String actionMapName, java.util.Properties props) Append this properties to actions as a named map
void	addNamedMap(java.lang.String mapName, java.util.Map<java.lang.String,java.lang.Object> map) Add this map to namedMaos
void	addNotice(java.lang.String msg)
void	addProperties(java.util.Properties props) Append this map to rootMap
void	addThemes(java.util.Properties props)
void	addThemes(Theme newTheme)
void	addXmlConfig(java.lang.String xmlResourceName) Append this xml resource to rootMap
void	clear() Deprecated. does nothing don't make this call
void	clearNotices()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
void	copyTo(IExecContext dest) Deprecated. - use spring bean scope="session" or "request"
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>>	entrySet()
java.lang.Object	get(java.lang.Object key)
java.lang.Object	get(java.lang.Object key, int clientIndex) get a value for key.
java.lang.String	getAction(java.lang.String actionMapName, java.lang.String actionKey) Get the class name associated with the action key
BaseAction	getActionClass(java.lang.String actionMapName, java.lang.String actionKey)
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>	getActionMaps()
org.springframework.context.ApplicationContext	getApplicationContext()
java.lang.Object	getClassAsObject(java.lang.String actionMapName, java.lang.String actionKey) Returns a class that matches the xml action name.
java.lang.String	getLocalizedString(java.lang.String resource, java.lang.String key)
java.util.Map<java.lang.String,java.lang.Object>	getNamedMap(java.lang.String mapName) Get a Named Map
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>	getNamedMaps()
java.lang.Object	getPersisted(java.lang.String key) Get a persisted value from permanent storage
java.util.Map<java.lang.String,java.lang.Object>	getPersistenceMap()
java.util.Map<java.lang.String,java.lang.Object>	getRootMap()
Theme	getSelectedTheme()
java.lang.String	getString(java.lang.String key)
java.lang.String	getStringQuietly(java.lang.String key) Try and get a value for the key, if none found than return the key untouched
Theme	getThemes()
java.lang.String	getThemeValueQuietly(java.lang.String key)
boolean	isEmpty()
java.util.Set<java.lang.String>	keySet()
void	persist(java.lang.String key, java.lang.Object value) Stores a "key - value" into the persistence map.
java.lang.Object	put(java.lang.String key, java.lang.Object value)
void	putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> m)
java.lang.Object	remove(java.lang.Object key)
java.lang.String	replace(java.lang.String content) Calls StrSubstutitor to replace any ${...} replacement markers using the execContent for the replacement map.
void	setActionMaps(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> actionMaps)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setDefaultLocaleFileName(java.lang.String defaultLocaleFileName)
void	setNamedMaps(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> namedMaps)
void	setRootMap(java.util.Map<java.lang.String,java.lang.Object> rootMap)
java.lang.String	show()
int	size()
java.util.Collection<java.lang.Object>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xmlactions.action.config.IExecContext

loadFromPersistence, reset, saveToPersistence

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ExecContext

public ExecContext(java.util.List<java.lang.Object> actionMaps,
                   java.util.List<java.lang.Object> localMaps,
                   java.util.List<java.lang.Object> themes)

ExecContext

public ExecContext(java.util.List<java.lang.Object> actionMaps,
                   java.util.List<java.lang.Object> localMaps)

Deprecated. - replaced with constructor ExecContext(List<Object> actionMaps, List<Object> localMaps, List<Object> themes)

Parameters:

actionMaps -

localMaps -

Method Detail

copyTo

public void copyTo(IExecContext dest)

Deprecated. - use spring bean scope="session" or "request"

Specified by:

copyTo in interface IExecContext

put

public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)

Specified by:

put in interface java.util.Map<java.lang.String,java.lang.Object>

getString

public java.lang.String getString(java.lang.String key)

Specified by:

getString in interface IExecContext

getStringQuietly

public java.lang.String getStringQuietly(java.lang.String key)

Description copied from interface: IExecContext

Try and get a value for the key, if none found than return the key untouched

Specified by:

getStringQuietly in interface IExecContext

_get

public java.lang.Object _get(java.lang.Object key)

Deprecated. - use new version

get

public java.lang.Object get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.String,java.lang.Object>

get

public java.lang.Object get(java.lang.Object key,
                            int clientIndex)

get a value for key.

if key has : as in xxx:key then find the value in a map assigned to the xxx in maps.
e.g. get("session:id") returns the value of maps.get("session").get("id");

if the key has "lang:key:resouces:language:country:variant"
or "lang:key" uses the default resource file and the default locale
or "lang:key:resource" uses the resource file and the default locale
or "lang:key::language" uses the default resource file and the language locale
...

if the key has "replace:value:regex:replacement" perform a String.replaceAll

The replacementPattern format is "replace:value:regex:replacement"
"replace" replacement instruction
"value" the string to perform the replacement on
"regex" the expression for the replacement
"replacement" the replacement value

Returns:

the value for key or null if not found.

replace

public java.lang.String replace(java.lang.String content)

Description copied from interface: IExecContext

Calls StrSubstutitor to replace any ${...} replacement markers using the execContent for the replacement map.

Specified by:

replace in interface IExecContext

Returns:

the content with any replacement markers replaced.

getLocalizedString

public java.lang.String getLocalizedString(java.lang.String resource,
                                           java.lang.String key)

Specified by:

getLocalizedString in interface IExecContext

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface IExecContext

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext()

Specified by:

getApplicationContext in interface IExecContext

persist

public void persist(java.lang.String key,
                    java.lang.Object value)

Stores a "key - value" into the persistence map.

if the Key contains a named map it will insert it into the named map instead.

Values may be retrieved using 'persistence:xxx' where persistence is the persistent named map.

Specified by:

persist in interface IExecContext

getPersisted

public java.lang.Object getPersisted(java.lang.String key)

Get a persisted value from permanent storage

The permanent storage may be a HttpSession or database entry. Depends on how the persistence is managed.

Specified by:

getPersisted in interface IExecContext

getPersistenceMap

public java.util.Map<java.lang.String,java.lang.Object> getPersistenceMap()

Specified by:

getPersistenceMap in interface IExecContext

getNamedMap

public java.util.Map<java.lang.String,java.lang.Object> getNamedMap(java.lang.String mapName)

Description copied from interface: IExecContext

Get a Named Map

Specified by:

getNamedMap in interface IExecContext

addNamedMap

public void addNamedMap(java.lang.String mapName,
                        java.util.Map<java.lang.String,java.lang.Object> map)

Description copied from interface: IExecContext

Add this map to namedMaos

Specified by:

addNamedMap in interface IExecContext

addThemes

public void addThemes(java.util.Properties props)

addThemes

public void addThemes(Theme newTheme)

getThemes

public Theme getThemes()

Specified by:

getThemes in interface IExecContext

Returns:

Root theme containing all loaded child themes

getActionClass

public BaseAction getActionClass(java.lang.String actionMapName,
                                 java.lang.String actionKey)
                          throws java.lang.ClassNotFoundException,
                                 java.lang.InstantiationException,
                                 java.lang.IllegalAccessException

Specified by:

getActionClass in interface IExecContext

Throws:

java.lang.ClassNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

getClassAsObject

public java.lang.Object getClassAsObject(java.lang.String actionMapName,
                                         java.lang.String actionKey)
                                  throws java.lang.ClassNotFoundException,
                                         java.lang.InstantiationException,
                                         java.lang.IllegalAccessException

Returns a class that matches the xml action name. This differs from the getActionClass in that it does not require the class to extend BaseAction.

Specified by:

getClassAsObject in interface IExecContext

Parameters:

actionMapName -

actionKey -

Returns:

matching class

Throws:

java.lang.ClassNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

getAction

public java.lang.String getAction(java.lang.String actionMapName,
                                  java.lang.String actionKey)

Description copied from interface: IExecContext

Get the class name associated with the action key

Specified by:

getAction in interface IExecContext

Returns:

the class name i.e. org.xmlactions.pager.actions.Echo

setDefaultLocaleFileName

public void setDefaultLocaleFileName(java.lang.String defaultLocaleFileName)

clear

public void clear()

Deprecated. does nothing don't make this call

Specified by:

clear in interface java.util.Map<java.lang.String,java.lang.Object>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.String,java.lang.Object>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.String,java.lang.Object>

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()

Specified by:

entrySet in interface java.util.Map<java.lang.String,java.lang.Object>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.String,java.lang.Object>

keySet

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

Specified by:

keySet in interface java.util.Map<java.lang.String,java.lang.Object>

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> m)

Specified by:

putAll in interface java.util.Map<java.lang.String,java.lang.Object>

remove

public java.lang.Object remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.String,java.lang.Object>

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.String,java.lang.Object>

values

public java.util.Collection<java.lang.Object> values()

Specified by:

values in interface java.util.Map<java.lang.String,java.lang.Object>

addXmlConfig

public void addXmlConfig(java.lang.String xmlResourceName)
                  throws org.apache.commons.configuration.ConfigurationException

Description copied from interface: IExecContext

Append this xml resource to rootMap

Specified by:

addXmlConfig in interface IExecContext

Throws:

org.apache.commons.configuration.ConfigurationException

addProperties

public void addProperties(java.util.Properties props)

Description copied from interface: IExecContext

Append this map to rootMap

Specified by:

addProperties in interface IExecContext

addMap

public void addMap(java.util.Map map)

Description copied from interface: IExecContext

Append this map to rootMap

Specified by:

addMap in interface IExecContext

addActions

public void addActions(java.util.Properties props)

Description copied from interface: IExecContext

Append this properties to default actions

Specified by:

addActions in interface IExecContext

addActions

public void addActions(java.util.Map map)

Description copied from interface: IExecContext

Append this map to default actions

Specified by:

addActions in interface IExecContext

addNamedActions

public void addNamedActions(java.lang.String actionMapName,
                            java.util.Properties props)

Description copied from interface: IExecContext

Append this properties to actions as a named map

Specified by:

addNamedActions in interface IExecContext

addNamedActions

public void addNamedActions(java.lang.String actionMapName,
                            java.util.Map map)

Description copied from interface: IExecContext

Append this map to actions as a named

Specified by:

addNamedActions in interface IExecContext

addNotice

public void addNotice(java.lang.String msg)

Specified by:

addNotice in interface IExecContext

clearNotices

public void clearNotices()

Specified by:

clearNotices in interface IExecContext

getRootMap

public java.util.Map<java.lang.String,java.lang.Object> getRootMap()

Specified by:

getRootMap in interface IExecContext

setRootMap

public void setRootMap(java.util.Map<java.lang.String,java.lang.Object> rootMap)

Specified by:

setRootMap in interface IExecContext

getNamedMaps

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> getNamedMaps()

Specified by:

getNamedMaps in interface IExecContext

setNamedMaps

public void setNamedMaps(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> namedMaps)

Specified by:

setNamedMaps in interface IExecContext

getActionMaps

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> getActionMaps()

Specified by:

getActionMaps in interface IExecContext

setActionMaps

public void setActionMaps(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> actionMaps)

Specified by:

setActionMaps in interface IExecContext

getThemeValueQuietly

public java.lang.String getThemeValueQuietly(java.lang.String key)

Specified by:

getThemeValueQuietly in interface IExecContext

Parameters:

key - used to select the theme css value

Returns:

the theme css value. May be empty if no theme has been selected or there is no matching key found in the theme.

getSelectedTheme

public Theme getSelectedTheme()

Specified by:

getSelectedTheme in interface IExecContext

Returns:

Selected or default theme. May be null

show

public java.lang.String show()

Specified by:

show in interface IExecContext