org.xmlactions.action.config

Interface IExecContext

All Superinterfaces:

java.util.Map<java.lang.String,java.lang.Object>

All Known Implementing Classes:

ExecContext, FileExecContext, NoPersistenceExecContext, NoPersistExecContext, PersistenceExecContext, SessionExecContext

public interface IExecContext
extends java.util.Map<java.lang.String,java.lang.Object>

A Manager for an Application Context.

This interface is used extensively throughout the framework code. It's purpose is to manage and maintain a set of static data and also session and request data.

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPLICATIONCONTEXT_REF use this to check if a Replacement string starts with "spring_ac:"
static java.lang.String	CODE_REF use this to execute a code call "code:"
static java.lang.String	CONTENT_TYPE_CSS Content Types that we may return to browser.
static java.lang.String	CONTENT_TYPE_HTML Content Types that we may return to browser.
static java.lang.String	CONTENT_TYPE_JS Content Types that we may return to browser.
static java.lang.String	CONTENT_TYPE_JSON Content Types that we may return to browser.
static java.lang.String	CONTENT_TYPE_KEY Content Types that we may return to browser.
static java.lang.String	CONTENT_TYPE_XML Content Types that we may return to browser.
static java.lang.String	DEBUG_LEVEL This is the key to the default locale file
static java.lang.String	DEFAULT_ACTION_MAP use this to check if a Replacement string starts with "lang:"
static java.lang.String	DEFAULT_ID This is the default identifier when getting a key value.
static java.lang.String	DEFAULT_LOCALE_FILE This is the key to the default locale file
static java.lang.String	DEFAULT_ROWS This is the key to the default rows for a list presentation
static java.lang.String	DEFAULT_STORAGE_CONFIG_REF Use this to get a default_theme_name setting from the configuration.
static java.lang.String	DEFAULT_THEME_MAP This is the name of the Map that we use to store themes.
static java.lang.String	DEFAULT_THEME_NAME Use this to get a default_theme_name setting from the configuration.
static java.lang.String	ENV_REF use this to get an java environment variable
static java.lang.String	LANG_REF use this to check if a Replacement string starts with "lang:"
static java.lang.String	MAP_STACKED_PAGES List of stacked pages - used for pager:insert_into action
static java.lang.String	PERSISTENCE_MAP use this to check if a Replacement string starts with "lang:"
static java.lang.String	PROP_REF use this to get an java property variable
static java.lang.String	REPLACE_REF use this to check if a Replacement string starts with "replace:"
static java.lang.String	SELECTED_THEME_NAME Use this to get a selected_theme_name setting from the configuration.
static java.lang.String	THEME_REF use this to check if a Replacement string starts with "theme:"

Method Summary

Modifier and Type	Method and Description
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	addXmlConfig(java.lang.String xmlResourceName) Append this xml resource to rootMap
void	clearNotices()
void	copyTo(IExecContext execContext)
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)
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)
void	loadFromPersistence()
void	persist(java.lang.String key, java.lang.Object value) Persist a value to permanent storage
java.lang.String	replace(java.lang.String content) Calls StrSubstutitor to replace any ${...} replacement markers using the execContent for the replacement map.
void	reset()
void	saveToPersistence()
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	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()

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Field Detail

PERSISTENCE_MAP

static final java.lang.String PERSISTENCE_MAP

use this to check if a Replacement string starts with "lang:"

See Also:

Constant Field Values

MAP_STACKED_PAGES

static final java.lang.String MAP_STACKED_PAGES

List of stacked pages - used for pager:insert_into action

See Also:

Constant Field Values

DEFAULT_ACTION_MAP

static final java.lang.String DEFAULT_ACTION_MAP

use this to check if a Replacement string starts with "lang:"

See Also:

Constant Field Values

DEFAULT_THEME_MAP

static final java.lang.String DEFAULT_THEME_MAP

This is the name of the Map that we use to store themes. The map is stored in the namedMaps.

See Also:

Constant Field Values

DEFAULT_THEME_NAME

static final java.lang.String DEFAULT_THEME_NAME

Use this to get a default_theme_name setting from the configuration.

See Also:

Constant Field Values

SELECTED_THEME_NAME

static final java.lang.String SELECTED_THEME_NAME

Use this to get a selected_theme_name setting from the configuration.

See Also:

Constant Field Values

DEFAULT_STORAGE_CONFIG_REF

static final java.lang.String DEFAULT_STORAGE_CONFIG_REF

Use this to get a default_theme_name setting from the configuration.

See Also:

Constant Field Values

LANG_REF

static final java.lang.String LANG_REF

use this to check if a Replacement string starts with "lang:"

See Also:

Constant Field Values

REPLACE_REF

static final java.lang.String REPLACE_REF

use this to check if a Replacement string starts with "replace:"

See Also:

Constant Field Values

THEME_REF

static final java.lang.String THEME_REF

use this to check if a Replacement string starts with "theme:"

See Also:

Constant Field Values

APPLICATIONCONTEXT_REF

static final java.lang.String APPLICATIONCONTEXT_REF

use this to check if a Replacement string starts with "spring_ac:"

See Also:

Constant Field Values

CODE_REF

static final java.lang.String CODE_REF

use this to execute a code call "code:"

See Also:

Constant Field Values

ENV_REF

static final java.lang.String ENV_REF

use this to get an java environment variable

See Also:

Constant Field Values

PROP_REF

static final java.lang.String PROP_REF

use this to get an java property variable

See Also:

Constant Field Values

DEFAULT_ID

static final java.lang.String DEFAULT_ID

This is the default identifier when getting a key value. If we have a default value it will be returned when null is found

See Also:

Constant Field Values

DEFAULT_LOCALE_FILE

static final java.lang.String DEFAULT_LOCALE_FILE

This is the key to the default locale file

See Also:

Constant Field Values

DEFAULT_ROWS

static final java.lang.String DEFAULT_ROWS

This is the key to the default rows for a list presentation

See Also:

Constant Field Values

DEBUG_LEVEL

static final java.lang.String DEBUG_LEVEL

This is the key to the default locale file

See Also:

Constant Field Values

CONTENT_TYPE_KEY

static final java.lang.String CONTENT_TYPE_KEY

Content Types that we may return to browser. These are set in the HttpPager class

See Also:

Constant Field Values

CONTENT_TYPE_HTML

static final java.lang.String CONTENT_TYPE_HTML

Content Types that we may return to browser. These are set in the HttpPager class

See Also:

Constant Field Values

CONTENT_TYPE_XML

static final java.lang.String CONTENT_TYPE_XML

Content Types that we may return to browser. These are set in the HttpPager class

See Also:

Constant Field Values

CONTENT_TYPE_JSON

static final java.lang.String CONTENT_TYPE_JSON

Content Types that we may return to browser. These are set in the HttpPager class

See Also:

Constant Field Values

CONTENT_TYPE_JS

static final java.lang.String CONTENT_TYPE_JS

Content Types that we may return to browser. These are set in the HttpPager class

See Also:

Constant Field Values

CONTENT_TYPE_CSS

static final java.lang.String CONTENT_TYPE_CSS

Content Types that we may return to browser. These are set in the HttpPager class

See Also:

Constant Field Values

Method Detail

getString

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

getStringQuietly

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

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

getLocalizedString

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

replace

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

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

Parameters:

content -

Returns:

the content with any replacement markers replaced.

addXmlConfig

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

Append this xml resource to rootMap

Throws:

org.apache.commons.configuration.ConfigurationException

addProperties

void addProperties(java.util.Properties props)

Append this map to rootMap

addMap

void addMap(java.util.Map map)

Append this map to rootMap

addActions

void addActions(java.util.Properties props)

Append this properties to default actions

addNamedActions

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

Append this properties to actions as a named map

addActions

void addActions(java.util.Map map)

Append this map to default actions

addNamedActions

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

Append this map to actions as a named

addNamedMap

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

Add this map to namedMaos

getNamedMap

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

Get a Named Map

persist

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

Persist a value to permanent storage

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

getPersisted

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.

getPersistenceMap

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

loadFromPersistence

void loadFromPersistence()

saveToPersistence

void saveToPersistence()

reset

void reset()

setApplicationContext

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

getApplicationContext

org.springframework.context.ApplicationContext getApplicationContext()

getAction

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

Get the class name associated with the action key

Parameters:

actionMapName -

actionKey -

Returns:

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

getActionClass

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

Throws:

java.lang.ClassNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

getClassAsObject

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

Throws:

java.lang.ClassNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

getThemes

Theme getThemes()

Returns:

Root theme containing all loaded child themes

getSelectedTheme

Theme getSelectedTheme()

Returns:

Selected or default theme. May be null

getThemeValueQuietly

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

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.

addNotice

void addNotice(java.lang.String msg)

clearNotices

void clearNotices()

copyTo

void copyTo(IExecContext execContext)

getRootMap

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

setRootMap

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

getNamedMaps

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

setNamedMaps

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

getActionMaps

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

setActionMaps

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

show

java.lang.String show()