Java Doc for ModuleConfig.java in » Web-Framework » struts-1.3.8 » org » apache » struts » config » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Web Framework » struts 1.3.8 » org.apache.struts.config

Source Cross Reference Class Diagram Java Document (Java Doc)

org.apache.struts.config .ModuleConfig

All known Subclasses:   org.apache.struts.config.impl .ModuleConfigImpl,
ModuleConfig
public interface 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-08-06 04:12:10 -0400 (Sat, 06 Aug 2005)
version:
   $
since:
   Struts 1.1

Method Summary
void addActionConfig(ActionConfig config)

Add a new ActionConfig 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 findActionConfigId(String actionId)

ActionConfig[] findActionConfigs()

Return the action configurations for this module.
ExceptionConfig findException(Class type)

Perform a recursive search for an ExceptionConfig registered for this class, or for any superclass.
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 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.
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.

Method Detail
addActionConfig
void addActionConfig(ActionConfig config)(Code)

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

addPlugInConfig
void addPlugInConfig(PlugInConfig plugInConfig)(Code)

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
ActionConfig findActionConfig(String path)(Code)

Return the action configuration for the specified path, if any; otherwise return null.

Parameters:
  path - Path of the action configuration to return

findActionConfigId
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
ActionConfig[] findActionConfigs()(Code)

Return the action configurations for this module. If there are none, a zero-length array is returned.

findException
ExceptionConfig findException(Class type)(Code)

Perform a recursive search for an ExceptionConfig registered for this class, or for any superclass. This should only be used in the case when an ActionConfig is not available; otherwise, use ActionConfig.findException(Class) to preserve the search order.

Parameters:
  type - Exception class name to find a configuration for
See Also:   ActionConfig
See Also:    findException(Class)

findExceptionConfig
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
ExceptionConfig[] findExceptionConfigs()(Code)

Return the exception configurations for this module. If there are none, a zero-length array is returned.

findFormBeanConfig
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
FormBeanConfig[] findFormBeanConfigs()(Code)

Return the form bean configurations for this module. If there are none, a zero-length array is returned.

findForwardConfig
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
ForwardConfig[] findForwardConfigs()(Code)

Return the form bean configurations for this module. If there are none, a zero-length array is returned.

findMessageResourcesConfig
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
MessageResourcesConfig[] findMessageResourcesConfigs()(Code)

Return the message resources configurations for this module. If there are none, a zero-length array is returned.

findPlugInConfigs
PlugInConfig[] findPlugInConfigs()(Code)

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

freeze
void freeze()(Code)

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

getActionFormBeanClass
String getActionFormBeanClass()(Code)

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

getActionForwardClass
String getActionForwardClass()(Code)

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

getActionMappingClass
String getActionMappingClass()(Code)

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

getConfigured
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
ControllerConfig getControllerConfig()(Code)

The controller configuration object for this module.

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

Parameters:
  prefix - The prefix of the context-relative portion of the requestURI.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.