org.apache.struts.config

Interface ModuleConfig

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.
Version:
$Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $
Since:
Struts 1.1

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(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(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(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(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(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(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.
String
getActionFormBeanClass()
The default class name to be used when creating action form bean instances.
String
getActionForwardClass()
The default class name to be used when creating action forward instances.
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.
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(String actionFormBeanClass)
The default class name to be used when creating action form bean instances.
void
setActionForwardClass(String actionForwardClass)
The default class name to be used when creating action forward instances.
void
setActionMappingClass(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(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 Details

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

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

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

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

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

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

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

getActionFormBeanClass

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

getActionForwardClass

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

getActionMappingClass

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

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.

getPrefix

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

removeActionConfig

public void removeActionConfig(ActionConfig config)
Remove the specified action configuration instance.
Parameters:
config - ActionConfig instance to be removed

removeDataSourceConfig

public void removeDataSourceConfig(DataSourceConfig config)
Remove the specified data source configuration instance.
Parameters:
config - DataSourceConfig instance to be removed

removeExceptionConfig

public void removeExceptionConfig(ExceptionConfig config)
Remove the specified exception configuration instance.
Parameters:
config - ActionConfig instance to be removed

removeFormBeanConfig

public void removeFormBeanConfig(FormBeanConfig config)
Remove the specified form bean configuration instance.
Parameters:
config - FormBeanConfig instance to be removed

removeForwardConfig

public void removeForwardConfig(ForwardConfig config)
Remove the specified forward configuration instance.
Parameters:
config - ForwardConfig instance to be removed

removeMessageResourcesConfig

public void removeMessageResourcesConfig(MessageResourcesConfig config)
Remove the specified message resources configuration instance.
Parameters:
config - MessageResourcesConfig instance to be removed

setActionFormBeanClass

public void setActionFormBeanClass(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.

setActionForwardClass

public void setActionForwardClass(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.

setActionMappingClass

public void setActionMappingClass(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.

setControllerConfig

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

setPrefix

public void setPrefix(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.

Copyright B) 2000-2007 - The Apache Software Foundation