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

A JavaBean representing the configuration information of an <action> element from a Struts module configuration file.

The internal identification of this action mapping.

The request-scope or session-scope attribute name under which our form bean is accessed, if it is different from the form bean's specified name.

Can this Action be cancelled? [false]

By default, when an Action is cancelled, validation is bypassed and the Action should not execute the business operation.

The name of a commons-chain catalog in which command should be sought.

The name of a commons-chain command which should be executed as part of the processing of this action.

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

Context-relative path of the web application resource that will process this request via RequestDispatcher.forward(), instead of instantiating and calling the Action class specified by "type".

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

Context-relative path of the web application resource that will process this request via RequestDispatcher.include(), instead of instantiating and calling the Action class specified by "type".

Context-relative path of the input form to which control should be returned if a validation error is encountered.

The module configuration with which we are associated.

Fully qualified Java class name of the MultipartRequestHandler implementation class used to process multi-part request data for this Action.

Name of the form bean, if any, associated with this Action.

General purpose configuration parameter that can be used to pass extra information to the Action instance selected by this Action. Struts does not itself use this value in any way.

Context-relative path of the submitted request, starting with a slash ("/") character, and omitting any filename extension if extension mapping is being used.

Prefix used to match request parameter names to form bean property names, if any.

The set of security role names used to authorize access to this Action, as an array for faster access.

Comma-delimited list of security role names allowed to request this Action.

Identifier of the scope ("request" or "session") within which our form bean is accessed, if any.

Suffix used to match request parameter names to form bean property names, if any.

Fully qualified Java class name of the Action class to be used to process requests for this mapping if the forward and include properties are not set.

Indicates Action be configured as the default one for this module, when true.

Add a new ExceptionConfig instance to the set associated with this action.

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

Traces the hierarchy of this object to check if any of the ancestors is extending this instance.

Find and return the ExceptionConfig instance defining how Exceptions of the specified type should be handled. This is performed by checking local and then global configurations for the specified exception's class, and then looking up the superclass chain (again checking local and then global configurations).

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

Return the exception configurations for this action.

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

Return all forward configurations for this module.

Freeze the configuration of this action.

The internal name of this action mapping.

Returns the request-scope or session-scope attribute name under which our form bean is accessed, if it is different from the form bean's specified name.

Get the name of a commons-chain catalog in which a specified command should be sought.

Get the name of a commons-chain command which should be executed as part of the processing of this action.

Returns context-relative path of the web application resource that will process this request.

Context-relative path of the web application resource that will process this request.

Get the context-relative path of the input form to which control should be returned if a validation error is encountered.

The module configuration with which we are associated.

Return the fully qualified Java class name of the MultipartRequestHandler implementation class used to process multi-part request data for this Action.

Return name of the form bean, if any, associated with this Action.

Return general purpose configuration parameter that can be used to pass extra information to the Action instance selected by this Action.

Return context-relative path of the submitted request, starting with a slash ("/") character, and omitting any filename extension if extension mapping is being used.

Retruns prefix used to match request parameter names to form bean property names, if any.

Get array of security role names used to authorize access to this Action.

Get the scope ("request" or "session") within which our form bean is accessed, if any.

Return suffix used to match request parameter names to form bean property names, if any.

Determine whether Action is configured as the default one for this module.

Inherit values that have not been overridden from the provided config object.

Inherit configuration information from the ActionConfig that this instance is extending.

Remove the specified exception configuration instance.

Remove the specified forward configuration instance.

The internal name of this action mapping.

Set the request-scope or session-scope attribute name under which our form bean is accessed, if it is different from the form bean's specified name.

Set the name of a commons-chain catalog in which a specified command should be sought.

Set the name of a commons-chain command which should be executed as part of the processing of this action.

Set the context-relative path of the web application resource that will process this request.

Set context-relative path of the web application resource that will process this request.

Set the context-relative path of the input form to which control should be returned if a validation error is encountered.

The module configuration with which we are associated.

Set the fully qualified Java class name of the MultipartRequestHandler implementation class used to process multi-part request data for this Action.

General purpose configuration parameter that can be used to pass extra information to the Action instance selected by this Action.

Set context-relative path of the submitted request, starting with a slash ("/") character, and omitting any filename extension if extension mapping is being used.

Return a String representation of this object.

The internal identification of this action mapping. Identifications are not inheritable and must be unique within a module.

The request-scope or session-scope attribute name under which our form bean is accessed, if it is different from the form bean's specified name.

Can this Action be cancelled? [false]

By default, when an Action is cancelled, validation is bypassed and the Action should not execute the business operation. If a request tries to cancel an Action when cancellable is not set, a "InvalidCancelException" is thrown.

The name of a commons-chain catalog in which command should be sought. If a command is defined and this property is undefined, the "default" catalog will be used. This is likely to be infrequently used after a future release of commons-chain supports a one-string expression of a catalog/chain combination.
since:
   Struts 1.3.0

The name of a commons-chain command which should be executed as part of the processing of this action.
since:
   Struts 1.3.0

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

Have the inheritance values for this class been applied?

Context-relative path of the web application resource that will process this request via RequestDispatcher.forward(), instead of instantiating and calling the Action class specified by "type". Exactly one of forward, include, or type must be specified.

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

Context-relative path of the web application resource that will process this request via RequestDispatcher.include(), instead of instantiating and calling the Action class specified by "type". Exactly one of forward, include, or type must be specified.

The path of the ActionConfig that this object should inherit properties from.

Context-relative path of the input form to which control should be returned if a validation error is encountered. Required if "name" is specified and the input bean returns validation errors.

The module configuration with which we are associated.

Fully qualified Java class name of the MultipartRequestHandler implementation class used to process multi-part request data for this Action.

Name of the form bean, if any, associated with this Action.

General purpose configuration parameter that can be used to pass extra information to the Action instance selected by this Action. Struts does not itself use this value in any way.

Context-relative path of the submitted request, starting with a slash ("/") character, and omitting any filename extension if extension mapping is being used.

Prefix used to match request parameter names to form bean property names, if any.

The set of security role names used to authorize access to this Action, as an array for faster access.

Comma-delimited list of security role names allowed to request this Action.

Identifier of the scope ("request" or "session") within which our form bean is accessed, if any.

Suffix used to match request parameter names to form bean property names, if any.

Fully qualified Java class name of the Action class to be used to process requests for this mapping if the forward and include properties are not set. Exactly one of forward, include, or type must be specified.

Indicates Action be configured as the default one for this module, when true.

Should the validate() method of the form bean associated with this action be called?

Add a new ExceptionConfig instance to the set associated with this action.

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

Traces the hierarchy of this object to check if any of the ancestors is extending this instance.

Find and return the ExceptionConfig instance defining how Exceptions of the specified type should be handled. This is performed by checking local and then global configurations for the specified exception's class, and then looking up the superclass chain (again checking local and then global configurations). If no handler configuration can be found, return null.

Introduced in ActionMapping in Struts 1.1, but pushed up to ActionConfig in Struts 1.2.0.

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

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

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

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

Freeze the configuration of this action.

The internal name of this action mapping. If an action has a name, it may be used as a shortcut in a URI. For example, an action with an identification of "editPerson" may be internally forwarded as "editPerson?id=1" which will then resolve to the real URI path at execution time.

Returns the request-scope or session-scope attribute name under which our form bean is accessed, if it is different from the form bean's specified name. attribute name under which our form bean is accessed.

Accessor for cancellable property

Get the name of a commons-chain catalog in which a specified command should be sought. This is likely to be infrequently used after a future release of commons-chain supports a one-string expression of a catalog/chain combination.

Get the name of a commons-chain command which should be executed as part of the processing of this action.

Returns the path of the ActionConfig that this object should inherit properties from.

Returns context-relative path of the web application resource that will process this request. context-relative path of the web application resource that willprocess this request.

Context-relative path of the web application resource that will process this request. Context-relative path of the web application resource that willprocess this request.

Get the context-relative path of the input form to which control should be returned if a validation error is encountered. context-relative path of the input form to which control shouldbe returned if a validation error is encountered.

The module configuration with which we are associated.

Return the fully qualified Java class name of the MultipartRequestHandler implementation class used to process multi-part request data for this Action.

Return name of the form bean, if any, associated with this Action.

Return general purpose configuration parameter that can be used to pass extra information to the Action instance selected by this Action. Struts does not itself use this value in any way.

Return context-relative path of the submitted request, starting with a slash ("/") character, and omitting any filename extension if extension mapping is being used.

Retruns prefix used to match request parameter names to form bean property names, if any.

Get array of security role names used to authorize access to this Action.

Get the scope ("request" or "session") within which our form bean is accessed, if any.

Return suffix used to match request parameter names to form bean property names, if any.

Determine whether Action is configured as the default one for this module.

Compare the exception handlers of this action with that of the given and copy those that are not present.

Compare the forwards of this action with that of the given and copy those that are not present.

Inherit values that have not been overridden from the provided config object. Subclasses overriding this method should verify that the given parameter is of a class that contains a property it is trying to inherit:

 if (config instanceof MyCustomConfig) {
 MyCustomConfig myConfig =
 (MyCustomConfig) config;
 if (getMyCustomProp() == null) {
 setMyCustomProp(myConfig.getMyCustomProp());
 }
 }
 

If the given config is extending another object, those extensions should be resolved before it's used as a parameter to this method.

Inherit configuration information from the ActionConfig that this instance is extending. This method verifies that any action config object that it inherits from has also had its processExtends() method called.

Remove the specified exception configuration instance.

Remove the specified forward configuration instance.

The internal name of this action mapping. The name is not inheritable, may not contain a forward slash, and must be unique within a module.

Set the request-scope or session-scope attribute name under which our form bean is accessed, if it is different from the form bean's specified name.
Parameters:
  attribute - the request-scope or session-scope attribute nameunder which our form bean is access.

Mutator for for cancellable property

Set the name of a commons-chain catalog in which a specified command should be sought. This is likely to be infrequently used after a future release of commons-chain supports a one-string expression of a catalog/chain combination.

Set the name of a commons-chain command which should be executed as part of the processing of this action.

Set the path of the ActionConfig that this object should inherit properties from.

Set the context-relative path of the web application resource that will process this request. Exactly one of forward, include, or type must be specified.
Parameters:
  forward - context-relative path of the web application resourcethat will process this request.

Set context-relative path of the web application resource that will process this request. Exactly one of forward, include, or type must be specified.
Parameters:
  include - context-relative path of the web application resourcethat will process this request.

Set the context-relative path of the input form to which control should be returned if a validation error is encountered. Required if "name" is specified and the input bean returns validation errors.
Parameters:
  input - context-relative path of the input form to which controlshould be returned if a validation error is encountered.

The module configuration with which we are associated.

Set the fully qualified Java class name of the MultipartRequestHandler implementation class used to process multi-part request data for this Action.
Parameters:
  multipartClass - fully qualified class name of theMultipartRequestHandlerimplementation class.

General purpose configuration parameter that can be used to pass extra information to the Action instance selected by this Action. Struts does not itself use this value in any way.
Parameters:
  parameter - General purpose configuration parameter.

Set context-relative path of the submitted request, starting with a slash ("/") character, and omitting any filename extension if extension mapping is being used.
Parameters:
  path - context-relative path of the submitted request.

Return a String representation of this object.