org.apache.struts.config
Interface ModuleConfig

All Known Implementing Classes:
ModuleConfigImpl

public interface ModuleConfig

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.

Since:
Struts 1.1
Version:
$Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $

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 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.
 

Method Detail

getConfigured

public boolean getConfigured()
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()
The controller configuration object for this module.

setControllerConfig

public void setControllerConfig(ControllerConfig cc)
The controller configuration object for this module.
Parameters:
cc - The controller configuration object for this module.

getPrefix

public 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. A configuration with a prefix of a zero-length String is the default configuration for this web module.

setPrefix

public 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. A configuration with a prefix of a zero-length String is the default configuration for this web module.
Parameters:
prefix - The prefix of the context-relative portion of the request URI.

getActionFormBeanClass

public java.lang.String getActionFormBeanClass()
The default class name to be used when creating action form bean instances.

setActionFormBeanClass

public void setActionFormBeanClass(java.lang.String actionFormBeanClass)
The default class name to be used when creating action form bean instances.
Parameters:
actionFormBeanClass - default class name to be used when creating action form bean instances.

getActionMappingClass

public java.lang.String getActionMappingClass()
The default class name to be used when creating action mapping instances.

setActionMappingClass

public void setActionMappingClass(java.lang.String actionMappingClass)
The default class name to be used when creating action mapping instances.
Parameters:
actionMappingClass - default class name to be used when creating action mapping instances.

addActionConfig

public void addActionConfig(ActionConfig config)
Add a new ActionConfig instance to the set associated with this module.
Parameters:
config - The new configuration instance to be added
Throws:
java.lang.IllegalStateException - if this module configuration has been frozen

addDataSourceConfig

public void addDataSourceConfig(DataSourceConfig config)
Add a new DataSourceConfig instance to the set associated with this module.
Parameters:
config - The new configuration instance to be added
Throws:
java.lang.IllegalStateException - if this module configuration has been frozen

addExceptionConfig

public void addExceptionConfig(ExceptionConfig config)
Add a new ExceptionConfig instance to the set associated with this module.
Parameters:
config - The new configuration instance to be added
Throws:
java.lang.IllegalStateException - if this module configuration has been frozen

addFormBeanConfig

public void addFormBeanConfig(FormBeanConfig config)
Add a new FormBeanConfig instance to the set associated with this module.
Parameters:
config - The new configuration instance to be added
Throws:
java.lang.IllegalStateException - if this module configuration has been frozen

getActionForwardClass

public java.lang.String getActionForwardClass()
The default class name to be used when creating action forward instances.

setActionForwardClass

public void setActionForwardClass(java.lang.String actionForwardClass)
The default class name to be used when creating action forward instances.
Parameters:
actionForwardClass - default class name to be used when creating action forward instances.

addForwardConfig

public void addForwardConfig(ForwardConfig config)
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:
java.lang.IllegalStateException - if this module configuration has been frozen

addMessageResourcesConfig

public void addMessageResourcesConfig(MessageResourcesConfig config)
Add a new MessageResourcesConfig instance to the set associated with this module.
Parameters:
config - The new configuration instance to be added
Throws:
java.lang.IllegalStateException - if this module configuration has been frozen

addPlugInConfig

public void addPlugInConfig(PlugInConfig plugInConfig)
Add a newly configured PlugInConfig instance to the set of plug-in Actions for this module.
Parameters:
plugInConfig - The new configuration instance to be added

findActionConfig

public ActionConfig findActionConfig(java.lang.String path)
Return the action configuration for the specified path, if any; otherwise return null.
Parameters:
path - Path of the action configuration to return

findActionConfigs

public ActionConfig[] findActionConfigs()
Return the action configurations for this module. If there are none, a zero-length array is returned.

findDataSourceConfig

public DataSourceConfig findDataSourceConfig(java.lang.String key)
Return the data source configuration for the specified key, if any; otherwise return null.
Parameters:
key - Key of the data source configuration to return

findDataSourceConfigs

public DataSourceConfig[] findDataSourceConfigs()
Return the data source configurations for this module. If there are none, a zero-length array is returned.

findExceptionConfig

public ExceptionConfig findExceptionConfig(java.lang.String type)
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()
Return the exception configurations for this module. If there are none, a zero-length array is returned.

findFormBeanConfig

public FormBeanConfig findFormBeanConfig(java.lang.String name)
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()
Return the form bean configurations for this module. If there are none, a zero-length array is returned.

findForwardConfig

public ForwardConfig findForwardConfig(java.lang.String name)
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()
Return the form bean configurations for this module. If there are none, a zero-length array is returned.

findMessageResourcesConfig

public MessageResourcesConfig findMessageResourcesConfig(java.lang.String key)
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()
Return the message resources configurations for this module. If there are none, a zero-length array is returned.

findPlugInConfigs

public PlugInConfig[] findPlugInConfigs()
Return the configured plug-in actions for this module. If there are none, a zero-length array is returned.

freeze

public void freeze()
Freeze the configuration of this module. After this method returns, any attempt to modify the configuration will return an IllegalStateException.

removeActionConfig

public void removeActionConfig(ActionConfig config)
Remove the specified action configuration instance.
Parameters:
config - ActionConfig instance to be removed
Throws:
java.lang.IllegalStateException - if this module configuration has been frozen

removeExceptionConfig

public void removeExceptionConfig(ExceptionConfig config)
Remove the specified exception configuration instance.
Parameters:
config - ActionConfig instance to be removed
Throws:
java.lang.IllegalStateException - if this module configuration has been frozen

removeDataSourceConfig

public void removeDataSourceConfig(DataSourceConfig config)
Remove the specified data source configuration instance.
Parameters:
config - DataSourceConfig instance to be removed
Throws:
java.lang.IllegalStateException - if this module configuration has been frozen

removeFormBeanConfig

public void removeFormBeanConfig(FormBeanConfig config)
Remove the specified form bean configuration instance.
Parameters:
config - FormBeanConfig instance to be removed
Throws:
java.lang.IllegalStateException - if this module configuration has been frozen

removeForwardConfig

public void removeForwardConfig(ForwardConfig config)
Remove the specified forward configuration instance.
Parameters:
config - ForwardConfig instance to be removed
Throws:
java.lang.IllegalStateException - if this module configuration has been frozen

removeMessageResourcesConfig

public void removeMessageResourcesConfig(MessageResourcesConfig config)
Remove the specified message resources configuration instance.
Parameters:
config - MessageResourcesConfig instance to be removed
Throws:
java.lang.IllegalStateException - if this module configuration has been frozen


Copyright 2000-2006 - The Apache Software Foundation