|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.struts.config.ActionConfig
A JavaBean representing the configuration information of an
<action>
element from a Struts
module configuration file.
Field Summary | |
protected java.lang.String |
attribute
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 . |
protected boolean |
configured
Indicates if configuration of this component been completed. |
protected java.util.HashMap |
exceptions
The set of exception handling configurations for this action, if any, keyed by the type property. |
protected java.lang.String |
forward
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". |
protected java.util.HashMap |
forwards
The set of local forward configurations for this action, if any, keyed by the name property. |
protected java.lang.String |
include
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". |
protected java.lang.String |
input
Context-relative path of the input form to which control should be returned if a validation error is encountered. |
protected ModuleConfig |
moduleConfig
The module configuration with which we are associated. |
protected java.lang.String |
multipartClass
Fully qualified Java class name of the MultipartRequestHandler implementation class used to
process multi-part request data for this Action. |
protected java.lang.String |
name
Name of the form bean, if any, associated with this Action. |
protected java.lang.String |
parameter
General purpose configuration parameter that can be used to pass extra information to the Action instance selected by this Action. |
protected java.lang.String |
path
Context-relative path of the submitted request, starting with a slash ("/") character, and omitting any filename extension if extension mapping is being used. |
protected java.lang.String |
prefix
Prefix used to match request parameter names to form bean property names, if any. |
protected java.lang.String[] |
roleNames
The set of security role names used to authorize access to this Action, as an array for faster access. |
protected java.lang.String |
roles
Comma-delimited list of security role names allowed to request this Action. |
protected java.lang.String |
scope
Identifier of the scope ("request" or "session") within which our form bean is accessed, if any. |
protected java.lang.String |
suffix
Suffix used to match request parameter names to form bean property names, if any. |
protected java.lang.String |
type
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. |
protected boolean |
unknown
Indicates Action be configured as the default one for this application, when true. |
protected boolean |
validate
Should the validate() method of the form bean associated
with this action be called? |
Constructor Summary | |
ActionConfig()
|
Method Summary | |
void |
addExceptionConfig(ExceptionConfig config)
Add a new ExceptionConfig instance to the set associated
with this action. |
void |
addForwardConfig(ForwardConfig config)
Add a new ForwardConfig instance to the set of global
forwards associated with this action. |
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 action. |
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 application. |
void |
freeze()
Freeze the configuration of this action. |
ModuleConfig |
getApplicationConfig()
Deprecated. getModuleConfig() |
java.lang.String |
getAttribute()
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 . |
java.lang.String |
getForward()
Returns context-relative path of the web application resource that will process this request. |
java.lang.String |
getInclude()
Context-relative path of the web application resource that will process this request. |
java.lang.String |
getInput()
Get the context-relative path of the input form to which control should be returned if a validation error is encountered. |
ModuleConfig |
getModuleConfig()
The module configuration with which we are associated. |
java.lang.String |
getMultipartClass()
Return the fully qualified Java class name of the MultipartRequestHandler implementation class used to
process multi-part request data for this Action. |
java.lang.String |
getName()
Return name of the form bean, if any, associated with this Action. |
java.lang.String |
getParameter()
Return general purpose configuration parameter that can be used to pass extra information to the Action instance selected by this Action. |
java.lang.String |
getPath()
Return context-relative path of the submitted request, starting with a slash ("/") character, and omitting any filename extension if extension mapping is being used. |
java.lang.String |
getPrefix()
Retruns prefix used to match request parameter names to form bean property names, if any. |
java.lang.String[] |
getRoleNames()
Get array of security role names used to authorize access to this Action. |
java.lang.String |
getRoles()
|
java.lang.String |
getScope()
Get the scope ("request" or "session") within which our form bean is accessed, if any. |
java.lang.String |
getSuffix()
Return suffix used to match request parameter names to form bean property names, if any. |
java.lang.String |
getType()
|
boolean |
getUnknown()
Determine whether Action is configured as the default one for this application. |
boolean |
getValidate()
|
void |
removeExceptionConfig(ExceptionConfig config)
Remove the specified exception configuration instance. |
void |
removeForwardConfig(ForwardConfig config)
Remove the specified forward configuration instance. |
void |
setApplicationConfig(ModuleConfig moduleConfig)
Deprecated. setModuleConfig(ModuleConfig) |
void |
setAttribute(java.lang.String attribute)
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 . |
void |
setForward(java.lang.String forward)
Set the context-relative path of the web application resource that will process this request. |
void |
setInclude(java.lang.String include)
Set context-relative path of the web application resource that will process this request. |
void |
setInput(java.lang.String input)
Set the context-relative path of the input form to which control should be returned if a validation error is encountered. |
void |
setModuleConfig(ModuleConfig moduleConfig)
The module configuration with which we are associated. |
void |
setMultipartClass(java.lang.String multipartClass)
Set the fully qualified Java class name of the MultipartRequestHandler implementation class used to
process multi-part request data for this Action. |
void |
setName(java.lang.String name)
|
void |
setParameter(java.lang.String parameter)
General purpose configuration parameter that can be used to pass extra information to the Action instance selected by this Action. |
void |
setPath(java.lang.String path)
Set context-relative path of the submitted request, starting with a slash ("/") character, and omitting any filename extension if extension mapping is being used. |
void |
setPrefix(java.lang.String prefix)
|
void |
setRoles(java.lang.String roles)
|
void |
setScope(java.lang.String scope)
|
void |
setSuffix(java.lang.String suffix)
|
void |
setType(java.lang.String type)
|
void |
setUnknown(boolean unknown)
|
void |
setValidate(boolean validate)
|
java.lang.String |
toString()
Return a String representation of this object. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected boolean configured
protected java.util.HashMap exceptions
type
property.
protected java.util.HashMap forwards
name
property.
protected ModuleConfig moduleConfig
protected java.lang.String attribute
name
.
protected java.lang.String forward
Action
class specified by "type".
Exactly one of forward
, include
, or
type
must be specified.
protected java.lang.String include
Action
class specified by "type".
Exactly one of forward
, include
, or
type
must be specified.
protected java.lang.String input
protected java.lang.String multipartClass
MultipartRequestHandler
implementation class used to
process multi-part request data for this Action.
protected java.lang.String name
protected java.lang.String parameter
protected java.lang.String path
protected java.lang.String prefix
protected java.lang.String roles
protected java.lang.String[] roleNames
protected java.lang.String scope
protected java.lang.String suffix
protected java.lang.String type
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.
protected boolean unknown
protected boolean validate
validate()
method of the form bean associated
with this action be called?
Constructor Detail |
public ActionConfig()
Method Detail |
public ModuleConfig getApplicationConfig()
getModuleConfig()
public ModuleConfig getModuleConfig()
public void setApplicationConfig(ModuleConfig moduleConfig)
setModuleConfig(ModuleConfig)
public void setModuleConfig(ModuleConfig moduleConfig)
public java.lang.String getAttribute()
name
.
public void setAttribute(java.lang.String attribute)
name
.
attribute
- the request-scope or session-scope attribute name under which our
form bean is access.public java.lang.String getForward()
public void setForward(java.lang.String forward)
forward
, include
, or
type
must be specified.
forward
- context-relative path of the web application resource that will process
this request.public java.lang.String getInclude()
public void setInclude(java.lang.String include)
forward
, include
, or
type
must be specified.
include
- context-relative path of the web application resource that will process
this request.public java.lang.String getInput()
public void setInput(java.lang.String input)
input
- context-relative path of the input form to which control should be
returned if a validation error is encountered.public java.lang.String getMultipartClass()
MultipartRequestHandler
implementation class used to
process multi-part request data for this Action.
public void setMultipartClass(java.lang.String multipartClass)
MultipartRequestHandler
implementation class used to
process multi-part request data for this Action.
multipartClass
- fully qualified class name of the
MultipartRequestHandler
implementation class.public java.lang.String getName()
public void setName(java.lang.String name)
name
- name of the form bean associated with this Action.public java.lang.String getParameter()
public void setParameter(java.lang.String parameter)
parameter
- General purpose configuration parameter.public java.lang.String getPath()
public void setPath(java.lang.String path)
path
- context-relative path of the submitted request.public java.lang.String getPrefix()
public void setPrefix(java.lang.String prefix)
prefix
- Prefix used to match request parameter names to
form bean property names, if any.public java.lang.String getRoles()
public void setRoles(java.lang.String roles)
public java.lang.String[] getRoleNames()
public java.lang.String getScope()
public void setScope(java.lang.String scope)
scope
- scope ("request" or "session") within which
our form bean is accessed, if any.public java.lang.String getSuffix()
public void setSuffix(java.lang.String suffix)
suffix
- Suffix used to match request parameter names to form bean property
names, if any.public java.lang.String getType()
public void setType(java.lang.String type)
public boolean getUnknown()
public void setUnknown(boolean unknown)
unknown
- Indicates Action is configured as the default one for this
application, when true.public boolean getValidate()
public void setValidate(boolean validate)
public void addExceptionConfig(ExceptionConfig config)
ExceptionConfig
instance to the set associated
with this action.
config
- The new configuration instance to be added
java.lang.IllegalStateException
- if this module configuration
has been frozenpublic void addForwardConfig(ForwardConfig config)
ForwardConfig
instance to the set of global
forwards associated with this action.
config
- The new configuration instance to be added
java.lang.IllegalStateException
- if this module configuration
has been frozenpublic ExceptionConfig findExceptionConfig(java.lang.String type)
null
.
type
- Exception class name to find a configuration forpublic ExceptionConfig[] findExceptionConfigs()
public ForwardConfig findForwardConfig(java.lang.String name)
null
.
name
- Name of the forward configuration to returnpublic ForwardConfig[] findForwardConfigs()
public void freeze()
public void removeExceptionConfig(ExceptionConfig config)
config
- ExceptionConfig instance to be removed
java.lang.IllegalStateException
- if this module configuration
has been frozenpublic void removeForwardConfig(ForwardConfig config)
config
- ForwardConfig instance to be removed
java.lang.IllegalStateException
- if this module configuration
has been frozenpublic java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |