| java.lang.Object
 org.apache.struts.config.BaseConfig
org.apache.struts.config.impl.ModuleConfigImpl
| ModuleConfigImpl | | public class ModuleConfigImpl extends BaseConfig implements Serializable,ModuleConfig(Code) | | 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.
version:
$Rev: 471754 $ $Date: 2005-12-31 03:57:16 -0500 (Sat, 31 Dec 2005)
version:
$
since:
Struts 1.1 |
| actionConfigIds | | protected HashMap actionConfigIds(Code) | | The set of action configuration for this module, if any, keyed by
the actionId property.
|
| actionConfigList | | protected List actionConfigList(Code) | | The set of action configurations for this module, if any, listed in
the order in which they are added.
|
| actionConfigs | | protected HashMap actionConfigs(Code) | | The set of action configurations for this module, if any, keyed by
the path property.
|
| actionFormBeanClass | | protected String actionFormBeanClass(Code) | | The default class name to be used when creating action form bean
instances.
|
| actionForwardClass | | protected String actionForwardClass(Code) | | The default class name to be used when creating action forward
instances.
|
| actionMappingClass | | protected String actionMappingClass(Code) | | The default class name to be used when creating action mapping
instances.
|
| controllerConfig | | protected ControllerConfig controllerConfig(Code) | | The controller configuration object for this module.
|
| exceptions | | protected HashMap exceptions(Code) | | The set of exception handling configurations for this module, if
any, keyed by the type property.
|
| formBeans | | protected HashMap formBeans(Code) | | The set of form bean configurations for this module, if any, keyed
by the name property.
|
| forwards | | protected HashMap forwards(Code) | | The set of global forward configurations for this module, if any,
keyed by the name property.
|
| log | | protected static Log log(Code) | | Commons Logging instance.
|
| messageResources | | protected HashMap messageResources(Code) | | The set of message resources configurations for this module, if any,
keyed by the key property.
|
| plugIns | | protected ArrayList plugIns(Code) | | The set of configured plug-in Actions for this module, if any, in
the order they were declared and configured.
|
| prefix | | protected String prefix(Code) | | The prefix of the context-relative portion of the request URI, used
to select this configuration versus others supported by the controller
servlet. A configuration with a prefix of a zero-length String is the
default configuration for this web module.
|
| ModuleConfigImpl | | public ModuleConfigImpl()(Code) | | Constructor for ModuleConfigImpl. Assumes default
configuration.
since:
Struts 1.2.8 |
| ModuleConfigImpl | | public ModuleConfigImpl(String prefix)(Code) | | Construct an ModuleConfigImpl object according to the specified
parameter values.
Parameters:
prefix - Context-relative URI prefix for this module |
| addActionConfig | | public void addActionConfig(ActionConfig config)(Code) | | Ad d a new ActionConfig instance to the set
associated with this module.
Parameters:
config - The new configuration instance to be added
throws:
IllegalStateException - if this module configuration has beenfrozen |
| addExceptionConfig | | public void addExceptionConfig(ExceptionConfig config)(Code) | | Add a new ExceptionConfig instance to the set
associated with this module.
Parameters:
config - The new configuration instance to be added
throws:
IllegalStateException - if this module configuration has beenfrozen |
| addFormBeanConfig | | public void addFormBeanConfig(FormBeanConfig config)(Code) | | Add a new FormBeanConfig instance to the set
associated with this module.
Parameters:
config - The new configuration instance to be added
throws:
IllegalStateException - if this module configuration has beenfrozen |
| addForwardConfig | | public void addForwardConfig(ForwardConfig config)(Code) | | Add a new ForwardConfig instance to the set of global
forwards associated with this module.
Parameters:
config - The new configuration instance to be added
throws:
IllegalStateException - if this module configuration has beenfrozen |
| addMessageResourcesConfig | | public void addMessageResourcesConfig(MessageResourcesConfig config)(Code) | | Add a new MessageResourcesConfig instance to the set
associated with this module.
Parameters:
config - The new configuration instance to be added
throws:
IllegalStateException - if this module configuration has beenfrozen |
| findActionConfig | | public ActionConfig findActionConfig(String path)(Code) | | Return the action configuration for the specified path, first
looking a direct match, then if none found, a wildcard pattern match;
otherwise return null.
Parameters:
path - Path of the action configuration to return |
| findActionConfigId | | public ActionConfig findActionConfigId(String actionId)(Code) | | Returns the action configuration for the specifed action
action identifier.
Parameters:
actionId - the action identifier the action config if found; otherwise null
See Also: ActionConfig.getActionId
since:
Struts 1.3.6 |
| findActionConfigs | | public ActionConfig[] findActionConfigs()(Code) | | Return the action configurations for this module. If there are
none, a zero-length array is returned.
|
| findException | | public ExceptionConfig findException(Class type)(Code) | | Find and return the ExceptionConfig instance defining
how Exceptions of the specified type should be handled.
In original Struts usage, this was only available in
ActionConfig, but there are cases when an exception could
be thrown before an ActionConfig has been identified,
where global exception handlers may still be pertinent.
TODO: Look for a way to share this logic with
ActionConfig, although there are subtle differences, and
it certainly doesn't seem like it should be done with inheritance.
Parameters:
type - Exception class for which to find a handler
since:
Struts 1.3.0 |
| findExceptionConfig | | public ExceptionConfig findExceptionConfig(String type)(Code) | | Return the exception configuration for the specified type, if any;
otherwise return null.
Parameters:
type - Exception class name to find a configuration for |
| findExceptionConfigs | | public ExceptionConfig[] findExceptionConfigs()(Code) | | Return the exception configurations for this module. If there are
none, a zero-length array is returned.
|
| findFormBeanConfig | | public FormBeanConfig findFormBeanConfig(String name)(Code) | | Return the form bean configuration for the specified key, if any;
otherwise return null.
Parameters:
name - Name of the form bean configuration to return |
| findFormBeanConfigs | | public FormBeanConfig[] findFormBeanConfigs()(Code) | | Return the form bean configurations for this module. If there are
none, a zero-length array is returned.
|
| findForwardConfig | | public ForwardConfig findForwardConfig(String name)(Code) | | Return the forward configuration for the specified key, if any;
otherwise return null.
Parameters:
name - Name of the forward configuration to return |
| findForwardConfigs | | public ForwardConfig[] findForwardConfigs()(Code) | | Return the form bean configurations for this module. If there are
none, a zero-length array is returned.
|
| findMessageResourcesConfig | | public MessageResourcesConfig findMessageResourcesConfig(String key)(Code) | | Return the message resources configuration for the specified key,
if any; otherwise return null.
Parameters:
key - Key of the data source configuration to return |
| findMessageResourcesConfigs | | public MessageResourcesConfig[] findMessageResourcesConfigs()(Code) | | Return the message resources configurations for this module. If
there are none, a zero-length array is returned.
|
| findPlugInConfigs | | public PlugInConfig[] findPlugInConfigs()(Code) | | Return the configured plug-in actions for this module. If there
are none, a zero-length array is returned.
|
| freeze | | public void freeze()(Code) | | Freeze the configuration of this module. After this method
returns, any attempt to modify the configuration will return an
IllegalStateException.
|
| getActionFormBeanClass | | public String getActionFormBeanClass()(Code) | | The default class name to be used when creating action form bean
instances.
|
| getActionForwardClass | | public String getActionForwardClass()(Code) | | The default class name to be used when creating action forward
instances.
|
| getActionMappingClass | | public String getActionMappingClass()(Code) | | The default class name to be used when creating action mapping
instances.
|
| getConfigured | | public boolean getConfigured()(Code) | | Has this module been completely configured yet. Once this flag
has been set, any attempt to modify the configuration will return an
IllegalStateException.
|
| getControllerConfig | | public ControllerConfig getControllerConfig()(Code) | | The controller configuration object for this module.
|
| getPrefix | | public String getPrefix()(Code) | | The prefix of the context-relative portion of the request URI, used
to select this configuration versus others supported by the controller
servlet. A configuration with a prefix of a zero-length String is the
default configuration for this web module.
|
| removeActionConfig | | public void removeActionConfig(ActionConfig config)(Code) | | Remove the specified action configuration instance.
Parameters:
config - ActionConfig instance to be removed
throws:
IllegalStateException - if this module configuration has beenfrozen |
| removeExceptionConfig | | public void removeExceptionConfig(ExceptionConfig config)(Code) | | Remove the specified exception configuration instance.
Parameters:
config - ActionConfig instance to be removed
throws:
IllegalStateException - if this module configuration has beenfrozen |
| removeFormBeanConfig | | public void removeFormBeanConfig(FormBeanConfig config)(Code) | | Remove the specified form bean configuration instance.
Parameters:
config - FormBeanConfig instance to be removed
throws:
IllegalStateException - if this module configuration has beenfrozen |
| removeForwardConfig | | public void removeForwardConfig(ForwardConfig config)(Code) | | Remove the specified forward configuration instance.
Parameters:
config - ForwardConfig instance to be removed
throws:
IllegalStateException - if this module configuration has beenfrozen |
| removeMessageResourcesConfig | | public void removeMessageResourcesConfig(MessageResourcesConfig config)(Code) | | Remove the specified message resources configuration instance.
Parameters:
config - MessageResourcesConfig instance to be removed
throws:
IllegalStateException - if this module configuration has beenfrozen |
| setActionFormBeanClass | | public void setActionFormBeanClass(String actionFormBeanClass)(Code) | | The default class name to be used when creating action form bean
instances.
Parameters:
actionFormBeanClass - default class name to be used when creatingaction form bean instances. |
| setActionForwardClass | | public void setActionForwardClass(String actionForwardClass)(Code) | | The default class name to be used when creating action forward
instances.
Parameters:
actionForwardClass - default class name to be used when creatingaction forward instances. |
| setActionMappingClass | | public void setActionMappingClass(String actionMappingClass)(Code) | | The default class name to be used when creating action mapping
instances.
Parameters:
actionMappingClass - default class name to be used when creatingaction mapping instances. |
| setControllerConfig | | public void setControllerConfig(ControllerConfig cc)(Code) | | The controller configuration object for this module.
Parameters:
cc - The controller configuration object for this module. |
| setPrefix | | public void setPrefix(String prefix)(Code) | | The prefix of the context-relative portion of the request URI, used
to select this configuration versus others supported by the controller
servlet. A configuration with a prefix of a zero-length String is the
default configuration for this web module.
|
| Fields inherited from org.apache.struts.config.BaseConfig | protected boolean configured(Code)(Java Doc)
|
|
|