org.apache.struts.config.impl
クラス ModuleConfigImpl

java.lang.Object
  org.apache.struts.config.impl.ModuleConfigImpl

すべての実装インタフェース:

ModuleConfig, java.io.Serializable

直系の既知のサブクラス:

ApplicationConfig

public class ModuleConfigImpl

extends java.lang.Object

implements java.io.Serializable, 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.

導入されたバージョン:

Struts 1.1

バージョン:

$Revision: 1.1 $ $Date: 2003/10/21 17:47:29 $

作成者:

Craig R. McClanahan

関連項目:

直列化された形式

フィールドの概要

protected java.util.HashMap	actionConfigs The set of action configurations for this module, if any, keyed by the path property.
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 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.

コンストラクタの概要

ModuleConfigImpl(ModuleConfigImpl moduleConfig)
推奨されていません。 Only used while we are deprecating ApplicationConfig to insure maximum compatability.

ModuleConfigImpl(java.lang.String prefix)
Construct an ModuleConfigImpl object according to the specified parameter values.

メソッドの概要

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.

クラス java.lang.Object から継承したメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

actionConfigs

protected java.util.HashMap actionConfigs

The set of action configurations for this module, if any, keyed by the path property.

dataSources

protected java.util.HashMap dataSources

The set of JDBC data source configurations for this module, if any, keyed by the key property.

exceptions

protected java.util.HashMap exceptions

The set of exception handling configurations for this module, if any, keyed by the type property.

formBeans

protected java.util.HashMap formBeans

The set of form bean configurations for this module, if any, keyed by the name property.

forwards

protected java.util.HashMap forwards

The set of global forward configurations for this module, if any, keyed by the name property.

messageResources

protected java.util.HashMap messageResources

The set of message resources configurations for this module, if any, keyed by the key property.

plugIns

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.

configured

protected boolean configured

Has this module been completely configured yet. Once this flag has been set, any attempt to modify the configuration will return an IllegalStateException.

controllerConfig

protected ControllerConfig controllerConfig

The controller configuration object for this module.

prefix

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

actionMappingClass

protected java.lang.String actionMappingClass

The default class name to be used when creating action mapping instances.

コンストラクタの詳細

ModuleConfigImpl

public ModuleConfigImpl(java.lang.String prefix)

Construct an ModuleConfigImpl object according to the specified parameter values.

パラメータ:

prefix - Context-relative URI prefix for this module

ModuleConfigImpl

public ModuleConfigImpl(ModuleConfigImpl moduleConfig)

推奨されていません。 Only used while we are deprecating ApplicationConfig to insure maximum compatability.

Only used while we are deprecating ApplicationConfig. performs a shallow copy to ensure that any operations performed on an ApplicationConfig object is performed on the same underlying ModuleConfigImpl sub objects

パラメータ:

moduleConfig -

メソッドの詳細

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.

定義:

インタフェース ModuleConfig 内の getConfigured

getControllerConfig

public ControllerConfig getControllerConfig()

The controller configuration object for this module.

定義:

インタフェース ModuleConfig 内の getControllerConfig

setControllerConfig

public void setControllerConfig(ControllerConfig cc)

The controller configuration object for this module.

定義:

インタフェース ModuleConfig 内の setControllerConfig

パラメータ:

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.

定義:

インタフェース ModuleConfig 内の getPrefix

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.

定義:

インタフェース ModuleConfig 内の setPrefix

パラメータ:

prefix - The prefix of the context-relative portion of the request URI.

getActionMappingClass

public java.lang.String getActionMappingClass()

The default class name to be used when creating action mapping instances.

定義:

インタフェース ModuleConfig 内の getActionMappingClass

setActionMappingClass

public void setActionMappingClass(java.lang.String actionMappingClass)

The default class name to be used when creating action mapping instances.

定義:

インタフェース ModuleConfig 内の setActionMappingClass

パラメータ:

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.

定義:

インタフェース ModuleConfig 内の addActionConfig

パラメータ:

config - The new configuration instance to be added

例外:

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.

定義:

インタフェース ModuleConfig 内の addDataSourceConfig

パラメータ:

config - The new configuration instance to be added

例外:

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.

定義:

インタフェース ModuleConfig 内の addExceptionConfig

パラメータ:

config - The new configuration instance to be added

例外:

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.

定義:

インタフェース ModuleConfig 内の addFormBeanConfig

パラメータ:

config - The new configuration instance to be added

例外:

java.lang.IllegalStateException - if this module configuration has been frozen

addForwardConfig

public void addForwardConfig(ForwardConfig config)

Add a new ForwardConfig instance to the set of global forwards associated with this module.

定義:

インタフェース ModuleConfig 内の addForwardConfig

パラメータ:

config - The new configuration instance to be added

例外:

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.

定義:

インタフェース ModuleConfig 内の addMessageResourcesConfig

パラメータ:

config - The new configuration instance to be added

例外:

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.

定義:

インタフェース ModuleConfig 内の addPlugInConfig

パラメータ:

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.

定義:

インタフェース ModuleConfig 内の findActionConfig

パラメータ:

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.

定義:

インタフェース ModuleConfig 内の findActionConfigs

findDataSourceConfig

public DataSourceConfig findDataSourceConfig(java.lang.String key)

Return the data source configuration for the specified key, if any; otherwise return null.

定義:

インタフェース ModuleConfig 内の findDataSourceConfig

パラメータ:

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.

定義:

インタフェース ModuleConfig 内の findDataSourceConfigs

findExceptionConfig

public ExceptionConfig findExceptionConfig(java.lang.String type)

Return the exception configuration for the specified type, if any; otherwise return null.

定義:

インタフェース ModuleConfig 内の findExceptionConfig

パラメータ:

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.

定義:

インタフェース ModuleConfig 内の findExceptionConfigs

findFormBeanConfig

public FormBeanConfig findFormBeanConfig(java.lang.String name)

Return the form bean configuration for the specified key, if any; otherwise return null.

定義:

インタフェース ModuleConfig 内の findFormBeanConfig

パラメータ:

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.

定義:

インタフェース ModuleConfig 内の findFormBeanConfigs

findForwardConfig

public ForwardConfig findForwardConfig(java.lang.String name)

Return the forward configuration for the specified key, if any; otherwise return null.

定義:

インタフェース ModuleConfig 内の findForwardConfig

パラメータ:

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.

定義:

インタフェース ModuleConfig 内の findForwardConfigs

findMessageResourcesConfig

public MessageResourcesConfig findMessageResourcesConfig(java.lang.String key)

Return the message resources configuration for the specified key, if any; otherwise return null.

定義:

インタフェース ModuleConfig 内の findMessageResourcesConfig

パラメータ:

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.

定義:

インタフェース ModuleConfig 内の findMessageResourcesConfigs

findPlugInConfigs

public PlugInConfig[] findPlugInConfigs()

Return the configured plug-in actions for this module. If there are none, a zero-length array is returned.

定義:

インタフェース ModuleConfig 内の findPlugInConfigs

freeze

public void freeze()

Freeze the configuration of this module. After this method returns, any attempt to modify the configuration will return an IllegalStateException.

定義:

インタフェース ModuleConfig 内の freeze

removeActionConfig

public void removeActionConfig(ActionConfig config)

Remove the specified action configuration instance.

定義:

インタフェース ModuleConfig 内の removeActionConfig

パラメータ:

config - ActionConfig instance to be removed

例外:

java.lang.IllegalStateException - if this module configuration has been frozen

removeExceptionConfig

public void removeExceptionConfig(ExceptionConfig config)

Remove the specified exception configuration instance.

定義:

インタフェース ModuleConfig 内の removeExceptionConfig

パラメータ:

config - ActionConfig instance to be removed

例外:

java.lang.IllegalStateException - if this module configuration has been frozen

removeDataSourceConfig

public void removeDataSourceConfig(DataSourceConfig config)

Remove the specified data source configuration instance.

定義:

インタフェース ModuleConfig 内の removeDataSourceConfig

パラメータ:

config - DataSourceConfig instance to be removed

例外:

java.lang.IllegalStateException - if this module configuration has been frozen

removeFormBeanConfig

public void removeFormBeanConfig(FormBeanConfig config)

Remove the specified form bean configuration instance.

定義:

インタフェース ModuleConfig 内の removeFormBeanConfig

パラメータ:

config - FormBeanConfig instance to be removed

例外:

java.lang.IllegalStateException - if this module configuration has been frozen

removeForwardConfig

public void removeForwardConfig(ForwardConfig config)

Remove the specified forward configuration instance.

定義:

インタフェース ModuleConfig 内の removeForwardConfig

パラメータ:

config - ForwardConfig instance to be removed

例外:

java.lang.IllegalStateException - if this module configuration has been frozen

removeMessageResourcesConfig

public void removeMessageResourcesConfig(MessageResourcesConfig config)

Remove the specified message resources configuration instance.

定義:

インタフェース ModuleConfig 内の removeMessageResourcesConfig

パラメータ:

config - MessageResourcesConfig instance to be removed

例外:

java.lang.IllegalStateException - if this module configuration has been frozen