|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object | +--org.apache.struts.config.impl.ModuleConfigImpl
The collection of static configuration information that describes a Struts-based module. Multiple modules are identified by a prefix at the beginning of the context relative portion of the request URI. If no module prefix can be matched, the default configuration (with a prefix equal to a zero-length string) is selected, which is elegantly backwards compatible with the previous Struts behavior that only supported one module.
| Field Summary | |
protected java.util.List |
actionConfigList
The set of action configurations for this module, if any, listed in the order in which they are added. |
protected java.util.HashMap |
actionConfigs
The set of action configurations for this module, if any, keyed by the path property. |
protected java.lang.String |
actionFormBeanClass
The default class name to be used when creating action form bean instances. |
protected java.lang.String |
actionForwardClass
The default class name to be used when creating action forward instances. |
protected java.lang.String |
actionMappingClass
The default class name to be used when creating action mapping instances. |
protected boolean |
configured
Has this module been completely configured yet. |
protected ControllerConfig |
controllerConfig
The controller configuration object for this module. |
protected java.util.HashMap |
dataSources
The set of JDBC data source configurations for this module, if any, keyed by the key property. |
protected java.util.HashMap |
exceptions
The set of exception handling configurations for this module, if any, keyed by the type property. |
protected java.util.HashMap |
formBeans
The set of form bean configurations for this module, if any, keyed by the name property. |
protected java.util.HashMap |
forwards
The set of global forward configurations for this module, if any, keyed by the name property. |
protected ActionConfigMatcher |
matcher
Matches action config paths against compiled wildcard patterns |
protected java.util.HashMap |
messageResources
The set of message resources configurations for this module, if any, keyed by the key property. |
protected java.util.ArrayList |
plugIns
The set of configured plug-in Actions for this module, if any, in the order they were declared and configured. |
protected java.lang.String |
prefix
The prefix of the context-relative portion of the request URI, used to select this configuration versus others supported by the controller servlet. |
| Constructor Summary | |
ModuleConfigImpl()
Constructor for ModuleConfigImpl. |
|
ModuleConfigImpl(java.lang.String prefix)
Construct an ModuleConfigImpl object according to the specified parameter values. |
|
| Method Summary | |
void |
addActionConfig(ActionConfig config)
Add a new ActionConfig instance to the set associated
with this module. |
void |
addDataSourceConfig(DataSourceConfig config)
Add a new DataSourceConfig instance to the set associated
with this module. |
void |
addExceptionConfig(ExceptionConfig config)
Add a new ExceptionConfig instance to the set associated
with this module. |
void |
addFormBeanConfig(FormBeanConfig config)
Add a new FormBeanConfig instance to the set associated
with this module. |
void |
addForwardConfig(ForwardConfig config)
Add a new ForwardConfig instance to the set of global
forwards associated with this module. |
void |
addMessageResourcesConfig(MessageResourcesConfig config)
Add a new MessageResourcesConfig instance to the set
associated with this module. |
void |
addPlugInConfig(PlugInConfig plugInConfig)
Add a newly configured PlugInConfig instance to the set of
plug-in Actions for this module. |
ActionConfig |
findActionConfig(java.lang.String path)
Return the action configuration for the specified path, first looking a direct match, then if none found, a wildcard pattern match; otherwise return null. |
ActionConfig[] |
findActionConfigs()
Return the action configurations for this module. |
DataSourceConfig |
findDataSourceConfig(java.lang.String key)
Return the data source configuration for the specified key, if any; otherwise return null. |
DataSourceConfig[] |
findDataSourceConfigs()
Return the data source configurations for this module. |
ExceptionConfig |
findExceptionConfig(java.lang.String type)
Return the exception configuration for the specified type, if any; otherwise return null. |
ExceptionConfig[] |
findExceptionConfigs()
Return the exception configurations for this module. |
FormBeanConfig |
findFormBeanConfig(java.lang.String name)
Return the form bean configuration for the specified key, if any; otherwise return null. |
FormBeanConfig[] |
findFormBeanConfigs()
Return the form bean configurations for this module. |
ForwardConfig |
findForwardConfig(java.lang.String name)
Return the forward configuration for the specified key, if any; otherwise return null. |
ForwardConfig[] |
findForwardConfigs()
Return the form bean configurations for this module. |
MessageResourcesConfig |
findMessageResourcesConfig(java.lang.String key)
Return the message resources configuration for the specified key, if any; otherwise return null. |
MessageResourcesConfig[] |
findMessageResourcesConfigs()
Return the message resources configurations for this module. |
PlugInConfig[] |
findPlugInConfigs()
Return the configured plug-in actions for this module. |
void |
freeze()
Freeze the configuration of this module. |
java.lang.String |
getActionFormBeanClass()
The default class name to be used when creating action form bean instances. |
java.lang.String |
getActionForwardClass()
The default class name to be used when creating action forward instances. |
java.lang.String |
getActionMappingClass()
The default class name to be used when creating action mapping instances. |
boolean |
getConfigured()
Has this module been completely configured yet. |
ControllerConfig |
getControllerConfig()
The controller configuration object for this module. |
java.lang.String |
getPrefix()
The prefix of the context-relative portion of the request URI, used to select this configuration versus others supported by the controller servlet. |
void |
removeActionConfig(ActionConfig config)
Remove the specified action configuration instance. |
void |
removeDataSourceConfig(DataSourceConfig config)
Remove the specified data source configuration instance. |
void |
removeExceptionConfig(ExceptionConfig config)
Remove the specified exception configuration instance. |
void |
removeFormBeanConfig(FormBeanConfig config)
Remove the specified form bean configuration instance. |
void |
removeForwardConfig(ForwardConfig config)
Remove the specified forward configuration instance. |
void |
removeMessageResourcesConfig(MessageResourcesConfig config)
Remove the specified message resources configuration instance. |
void |
setActionFormBeanClass(java.lang.String actionFormBeanClass)
The default class name to be used when creating action form bean instances. |
void |
setActionForwardClass(java.lang.String actionForwardClass)
The default class name to be used when creating action forward instances. |
void |
setActionMappingClass(java.lang.String actionMappingClass)
The default class name to be used when creating action mapping instances. |
void |
setControllerConfig(ControllerConfig cc)
The controller configuration object for this module. |
void |
setPrefix(java.lang.String prefix)
The prefix of the context-relative portion of the request URI, used to select this configuration versus others supported by the controller servlet. |
| Methods inherited from class java.lang.Object |
|
| Field Detail |
protected java.util.HashMap actionConfigs
path property.protected java.util.List actionConfigList
protected java.util.HashMap dataSources
key property.protected java.util.HashMap exceptions
type property.protected java.util.HashMap formBeans
name property.protected java.util.HashMap forwards
name property.protected java.util.HashMap messageResources
key property.protected java.util.ArrayList plugIns
protected boolean configured
protected ControllerConfig controllerConfig
protected java.lang.String prefix
protected java.lang.String actionFormBeanClass
protected java.lang.String actionMappingClass
protected java.lang.String actionForwardClass
protected ActionConfigMatcher matcher
| Constructor Detail |
public ModuleConfigImpl()
public ModuleConfigImpl(java.lang.String prefix)
prefix - Context-relative URI prefix for this module| Method Detail |
public boolean getConfigured()
getConfigured in interface ModuleConfigpublic ControllerConfig getControllerConfig()
getControllerConfig in interface ModuleConfigpublic void setControllerConfig(ControllerConfig cc)
setControllerConfig in interface ModuleConfigcc - The controller configuration object for this module.public java.lang.String getPrefix()
getPrefix in interface ModuleConfigpublic void setPrefix(java.lang.String prefix)
setPrefix in interface ModuleConfigorg.apache.struts.config.ModuleConfigprefix - The prefix of the context-relative portion of the request URI.public java.lang.String getActionFormBeanClass()
getActionFormBeanClass in interface ModuleConfigpublic void setActionFormBeanClass(java.lang.String actionFormBeanClass)
setActionFormBeanClass in interface ModuleConfigactionFormBeanClass - default class name to be used when creating
action form bean instances.public java.lang.String getActionMappingClass()
getActionMappingClass in interface ModuleConfigpublic void setActionMappingClass(java.lang.String actionMappingClass)
setActionMappingClass in interface ModuleConfigactionMappingClass - default class name to be used when creating
action mapping instances.public void addActionConfig(ActionConfig config)
ActionConfig instance to the set associated
with this module.addActionConfig in interface ModuleConfigconfig - The new configuration instance to be addedjava.lang.IllegalStateException - if this module configuration
has been frozenpublic void addDataSourceConfig(DataSourceConfig config)
DataSourceConfig instance to the set associated
with this module.addDataSourceConfig in interface ModuleConfigconfig - The new configuration instance to be addedjava.lang.IllegalStateException - if this module configuration
has been frozenpublic void addExceptionConfig(ExceptionConfig config)
ExceptionConfig instance to the set associated
with this module.addExceptionConfig in interface ModuleConfigconfig - The new configuration instance to be addedjava.lang.IllegalStateException - if this module configuration
has been frozenpublic void addFormBeanConfig(FormBeanConfig config)
FormBeanConfig instance to the set associated
with this module.addFormBeanConfig in interface ModuleConfigconfig - The new configuration instance to be addedjava.lang.IllegalStateException - if this module configuration
has been frozenpublic java.lang.String getActionForwardClass()
getActionForwardClass in interface ModuleConfigpublic void setActionForwardClass(java.lang.String actionForwardClass)
setActionForwardClass in interface ModuleConfigactionForwardClass - default class name to be used when creating
action forward instances.public void addForwardConfig(ForwardConfig config)
ForwardConfig instance to the set of global
forwards associated with this module.addForwardConfig in interface ModuleConfigconfig - The new configuration instance to be addedjava.lang.IllegalStateException - if this module configuration
has been frozenpublic void addMessageResourcesConfig(MessageResourcesConfig config)
MessageResourcesConfig instance to the set
associated with this module.addMessageResourcesConfig in interface ModuleConfigconfig - The new configuration instance to be addedjava.lang.IllegalStateException - if this module configuration
has been frozenpublic void addPlugInConfig(PlugInConfig plugInConfig)
PlugInConfig instance to the set of
plug-in Actions for this module.addPlugInConfig in interface ModuleConfigplugInConfig - The new configuration instance to be addedpublic ActionConfig findActionConfig(java.lang.String path)
null.findActionConfig in interface ModuleConfigpath - Path of the action configuration to returnpublic ActionConfig[] findActionConfigs()
findActionConfigs in interface ModuleConfigpublic DataSourceConfig findDataSourceConfig(java.lang.String key)
null.findDataSourceConfig in interface ModuleConfigkey - Key of the data source configuration to returnpublic DataSourceConfig[] findDataSourceConfigs()
findDataSourceConfigs in interface ModuleConfigpublic ExceptionConfig findExceptionConfig(java.lang.String type)
null.findExceptionConfig in interface ModuleConfigtype - Exception class name to find a configuration forpublic ExceptionConfig[] findExceptionConfigs()
findExceptionConfigs in interface ModuleConfigpublic FormBeanConfig findFormBeanConfig(java.lang.String name)
null.findFormBeanConfig in interface ModuleConfigname - Name of the form bean configuration to returnpublic FormBeanConfig[] findFormBeanConfigs()
findFormBeanConfigs in interface ModuleConfigpublic ForwardConfig findForwardConfig(java.lang.String name)
null.findForwardConfig in interface ModuleConfigname - Name of the forward configuration to returnpublic ForwardConfig[] findForwardConfigs()
findForwardConfigs in interface ModuleConfigpublic MessageResourcesConfig findMessageResourcesConfig(java.lang.String key)
null.findMessageResourcesConfig in interface ModuleConfigkey - Key of the data source configuration to returnpublic MessageResourcesConfig[] findMessageResourcesConfigs()
findMessageResourcesConfigs in interface ModuleConfigpublic PlugInConfig[] findPlugInConfigs()
findPlugInConfigs in interface ModuleConfigpublic void freeze()
freeze in interface ModuleConfigpublic void removeActionConfig(ActionConfig config)
removeActionConfig in interface ModuleConfigconfig - ActionConfig instance to be removedjava.lang.IllegalStateException - if this module configuration
has been frozenpublic void removeExceptionConfig(ExceptionConfig config)
removeExceptionConfig in interface ModuleConfigconfig - ActionConfig instance to be removedjava.lang.IllegalStateException - if this module configuration
has been frozenpublic void removeDataSourceConfig(DataSourceConfig config)
removeDataSourceConfig in interface ModuleConfigconfig - DataSourceConfig instance to be removedjava.lang.IllegalStateException - if this module configuration
has been frozenpublic void removeFormBeanConfig(FormBeanConfig config)
removeFormBeanConfig in interface ModuleConfigconfig - FormBeanConfig instance to be removedjava.lang.IllegalStateException - if this module configuration
has been frozenpublic void removeForwardConfig(ForwardConfig config)
removeForwardConfig in interface ModuleConfigconfig - ForwardConfig instance to be removedjava.lang.IllegalStateException - if this module configuration
has been frozenpublic void removeMessageResourcesConfig(MessageResourcesConfig config)
removeMessageResourcesConfig in interface ModuleConfigconfig - MessageResourcesConfig instance to be removedjava.lang.IllegalStateException - if this module configuration
has been frozen
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||