|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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, if any; 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 |
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 |
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. |
Method Detail |
public boolean getConfigured()
public ControllerConfig getControllerConfig()
public void setControllerConfig(ControllerConfig cc)
cc
- The controller configuration object for this module.public java.lang.String getPrefix()
public void setPrefix(java.lang.String prefix)
prefix
- The prefix of the context-relative portion of the request URI.public java.lang.String getActionMappingClass()
public void setActionMappingClass(java.lang.String actionMappingClass)
actionMappingClass
- 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.
config
- The new configuration instance to be added
java.lang.IllegalStateException
- if this module configuration
has been frozenpublic void addDataSourceConfig(DataSourceConfig config)
DataSourceConfig
instance to the set associated
with this module.
config
- The new configuration instance to be added
java.lang.IllegalStateException
- if this module configuration
has been frozenpublic void addExceptionConfig(ExceptionConfig config)
ExceptionConfig
instance to the set associated
with this module.
config
- The new configuration instance to be added
java.lang.IllegalStateException
- if this module configuration
has been frozenpublic void addFormBeanConfig(FormBeanConfig config)
FormBeanConfig
instance to the set associated
with this module.
config
- The new configuration instance to be added
java.lang.IllegalStateException
- if this module configuration
has been frozenpublic void addForwardConfig(ForwardConfig config)
ForwardConfig
instance to the set of global
forwards associated with this module.
config
- The new configuration instance to be added
java.lang.IllegalStateException
- if this module configuration
has been frozenpublic void addMessageResourcesConfig(MessageResourcesConfig config)
MessageResourcesConfig
instance to the set
associated with this module.
config
- The new configuration instance to be added
java.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.
plugInConfig
- The new configuration instance to be addedpublic ActionConfig findActionConfig(java.lang.String path)
null
.
path
- Path of the action configuration to returnpublic ActionConfig[] findActionConfigs()
public DataSourceConfig findDataSourceConfig(java.lang.String key)
null
.
key
- Key of the data source configuration to returnpublic DataSourceConfig[] findDataSourceConfigs()
public ExceptionConfig findExceptionConfig(java.lang.String type)
null
.
type
- Exception class name to find a configuration forpublic ExceptionConfig[] findExceptionConfigs()
public FormBeanConfig findFormBeanConfig(java.lang.String name)
null
.
name
- Name of the form bean configuration to returnpublic FormBeanConfig[] findFormBeanConfigs()
public ForwardConfig findForwardConfig(java.lang.String name)
null
.
name
- Name of the forward configuration to returnpublic ForwardConfig[] findForwardConfigs()
public MessageResourcesConfig findMessageResourcesConfig(java.lang.String key)
null
.
key
- Key of the data source configuration to returnpublic MessageResourcesConfig[] findMessageResourcesConfigs()
public PlugInConfig[] findPlugInConfigs()
public void freeze()
public void removeActionConfig(ActionConfig config)
config
- ActionConfig instance to be removed
java.lang.IllegalStateException
- if this module configuration
has been frozenpublic void removeExceptionConfig(ExceptionConfig config)
config
- ActionConfig instance to be removed
java.lang.IllegalStateException
- if this module configuration
has been frozenpublic void removeDataSourceConfig(DataSourceConfig config)
config
- DataSourceConfig instance to be removed
java.lang.IllegalStateException
- if this module configuration
has been frozenpublic void removeFormBeanConfig(FormBeanConfig config)
config
- FormBeanConfig instance to be removed
java.lang.IllegalStateException
- if this module configuration
has been frozenpublic void removeForwardConfig(ForwardConfig config)
config
- ForwardConfig instance to be removed
java.lang.IllegalStateException
- if this module configuration
has been frozenpublic void removeMessageResourcesConfig(MessageResourcesConfig config)
config
- MessageResourcesConfig instance to be removed
java.lang.IllegalStateException
- if this module configuration
has been frozen
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |