ActionSupport (Atlassian Vendor Patch of Webwork 1 1.4-atlassian-30 API)

java.lang.Object
- webwork.action.ActionSupport

All Implemented Interfaces:

Serializable, Action, IllegalArgumentAware

Direct Known Subclasses:

CardPane, ClientInfo, JSP, Redirect, Script, XML
```
public class ActionSupport
extends Object
implements Action, Serializable, IllegalArgumentAware
```
This is a useful base class for WebWork Action implementations. It gives you access to a set of useful functionality, including result view mapping, error handling, and i18n.
It is also possible to use this class by way of delegation instead of subclassing. This is useful in the case that your action cannot use subclassing to add functionality

Version:

$Revision: 1.54 $

Author:

Rickard Öberg (rickard@middleware-company.com), Victor Salaman (salaman@qoretech.com)

See Also:
Action, Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected String command

protected Map errorMap

protected Collection errorMessages

protected org.apache.commons.logging.Log log
- Fields inherited from interface webwork.action.Action
  ERROR, INPUT, LOGIN, NONE, SUCCESS

Fields
Modifier and Type	Field and Description
`protected String`	`command`
`protected Map`	`errorMap`
`protected Collection`	`errorMessages`
`protected org.apache.commons.logging.Log`	`log`

Constructor Summary

Constructors
Constructor and Description

ActionSupport()

Constructors
Constructor and Description
`ActionSupport()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addError(String fieldName, String errorMessage)` This method is used to attach an error message to a particular form field.
`void`	`addErrorMessage(String anErrorMessage)` Add an error message to this action
`void`	`addIllegalArgumentException(String fieldName, IllegalArgumentException e)`
`String`	`doDefault()` "default" command
`protected String`	`doExecute()`
`protected void`	`doValidation()` Subclasses may override this method to provide validation of input data.
`String`	`execute()` Execute will first check the request for a result exception.
`protected String`	`getActionName()` This is used to get the current action's class name
`String`	`getCommandName()`
`Collection`	`getErrorMessages()` Get the list of error messages for this action
`Map`	`getErrors()` Get the field specific errors associated with this action.
`boolean`	`getHasErrorMessages()` Check whether there are any error messages
`boolean`	`getHasErrors()` Check whether there are any errors associated with this action.
`Locale`	`getLocale()` Get the locale for this action.
`protected String`	`getPropertyEditorMessage(String fieldName, PropertyEditorException pe)` This method is called from addIllegalArgumentException and it should return an error message (that may be localized).
`String`	`getText(String aTextName)` Get a text from the resource bundles associated with this action.
`ResourceBundle`	`getTexts()` Get the resource bundle associated with this action.
`ResourceBundle`	`getTexts(String aBundleName)` Get the named bundle.
`TimeZone`	`getTimezone()` Get the user's timezone for date/time formatting in text tag.
`boolean`	`invalidInput()` Check whether there are any error messages.
`protected String`	`invokeCommand()` Invokes an alternate execution path for the action.
`boolean`	`isCommand(String aName)` Detect whether a particular command has been issued
`void`	`setCommand(String command)` Support implementation of CommandDriven interface.
`void`	`setErrorMessages(Collection errorMessages)`
`void`	`setErrors(Map errorMap)`
`protected void`	`validate()` Do validation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - log
```
protected transient org.apache.commons.logging.Log log
```
  - errorMap
```
protected Map errorMap
```
  - errorMessages
```
protected Collection errorMessages
```
  - command
```
protected String command
```
- Constructor Detail
  - ActionSupport
```
public ActionSupport()
```
- Method Detail
  - addIllegalArgumentException
```
public void addIllegalArgumentException(String fieldName,
                               IllegalArgumentException e)
```
    Specified by:
    
    addIllegalArgumentException in interface IllegalArgumentAware
  - getPropertyEditorMessage
```
protected String getPropertyEditorMessage(String fieldName,
                              PropertyEditorException pe)
```
    This method is called from addIllegalArgumentException and it should return an error message (that may be localized). The implementation here does this by calling the getText method but you may override it with your own implementation. The default messages are stored in the ActionSupport.properties file
  - setCommand
```
public void setCommand(String command)
```
    Support implementation of CommandDriven interface. Let your action subclasses implement CommandDriven if they support this notion.
    
    See Also:
    CommandDriven
  - isCommand
```
public boolean isCommand(String aName)
```
    Detect whether a particular command has been issued
  - getCommandName
```
public String getCommandName()
```
  - execute
```
public String execute()
               throws Exception
```
    Execute will first check the request for a result exception. If one is found, then it will add its message as an error message and throw the ResultException. If there no exception is found, then it will invoke the "command" - invokeCommand(). If we are not invoking a command, it will call validate() and then doExecute().
    
    Specified by:
    
    execute in interface Action
    
    Returns:
    view
    
    Throws:
    
    Exception - thrown if a system level exception occurs. Application level exceptions should be handled by returning an error value, such as Action.ERROR.
  - doDefault
```
public String doDefault()
                 throws Exception
```
    "default" command
    
    Throws:
    
    Exception
  - getErrorMessages
```
public Collection getErrorMessages()
```
    Get the list of error messages for this action
    
    Returns:
    list of error messages
  - setErrorMessages
```
public void setErrorMessages(Collection errorMessages)
```
  - getHasErrorMessages
```
public boolean getHasErrorMessages()
```
    Check whether there are any error messages
    
    Returns:
    true if any error messages have been registered
  - addErrorMessage
```
public void addErrorMessage(String anErrorMessage)
```
    Add an error message to this action
    
    Parameters:
    anErrorMessage -
  - addError
```
public void addError(String fieldName,
            String errorMessage)
```
    This method is used to attach an error message to a particular form field.
    
    Parameters:
    fieldName - name of field
    errorMessage - the error message
  - getErrors
```
public Map getErrors()
```
    Get the field specific errors associated with this action.
    
    Returns:
    map with errors
  - setErrors
```
public void setErrors(Map errorMap)
```
  - getHasErrors
```
public boolean getHasErrors()
```
    Check whether there are any errors associated with this action.
    
    Returns:
    whether there are any errors
  - getLocale
```
public Locale getLocale()
```
    Get the locale for this action.
    Applications may customize how locale is chosen by subclassing ActionSupport and override this method.
    
    Returns:
    the locale to use
  - getTexts
```
public ResourceBundle getTexts(String aBundleName)
```
    Get the named bundle.
    You can override the getLocale() method to change the behaviour of how to choose locale for the bundles that are returned. Typically you would use the LocaleAware interface to get the users configured locale, or use your own method to allow the user to select the locale and store it in the session (by using the SessionAware interface).
    
    Parameters:
    aBundleName - bundle name
    
    Returns:
    a resource bundle
  - getTexts
```
public ResourceBundle getTexts()
```
    Get the resource bundle associated with this action. This will be based on the actual subclass that is used.
    
    Returns:
    resouce bundle
  - getText
```
public String getText(String aTextName)
```
    Get a text from the resource bundles associated with this action. The resource bundles are searched, starting with the one associated with this particular action, and testing all its superclasses' bundles. It will stop once a bundle is found that contains the given text. This gives a cascading style that allow global texts to be defined for an application base class.
    
    Parameters:
    aTextName - name of text to be found
    
    Returns:
    value of named text
  - doExecute
```
protected String doExecute()
                    throws Exception
```
    Throws:
    
    Exception
  - doValidation
```
protected void doValidation()
```
    Subclasses may override this method to provide validation of input data. The execute() method should call validate() in the beginning of its code (which will delegate to this method), so as to check input data before doing the actual processing.
    If any application errors arise these should be registered by calling addErrorMessage or addError .
    If the validation is dependent on whether a command has been issued, and what that command is, then the isCommand() method should be used.
  - validate
```
protected void validate()
                 throws ResultException
```
    Do validation. This method is called implicitly before executing doExecute(), but must be called explicitly from within command implementation methods. The actual validation should be done by overriding the doValidation() method. If any errors have been registered by doValidation() this method will throw ResultException() which should simply be passed through.
    
    Throws:
    
    ResultException
  - invalidInput
```
public boolean invalidInput()
```
    Check whether there are any error messages. Just a nicer way of doing "getHasErrorMessages() || getHasErrors()".
    
    Returns:
    true if any error messages have been registered
  - invokeCommand
```
protected String invokeCommand()
                        throws Exception
```
    Invokes an alternate execution path for the action. The name of the action is derived by prepending a "do" and capitalizing the first letter of the action.
    
    Throws:
    
    Exception
  - getActionName
```
protected String getActionName()
```
    This is used to get the current action's class name
  - getTimezone
```
public TimeZone getTimezone()
```
    Get the user's timezone for date/time formatting in text tag.
    
    Returns:
    null if the default timezone should be used

Class ActionSupport

Field Summary

Fields inherited from interface webwork.action.Action

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

errorMap

errorMessages

command

Constructor Detail

ActionSupport

Method Detail

addIllegalArgumentException

getPropertyEditorMessage

setCommand

isCommand

getCommandName

execute

doDefault

getErrorMessages

setErrorMessages

getHasErrorMessages

addErrorMessage

addError

getErrors

setErrors

getHasErrors

getLocale

getTexts

getTexts

getText

doExecute

doValidation

validate

invalidInput

invokeCommand

getActionName

getTimezone