| java.lang.Object
 org.springframework.webflow.action.AbstractAction
All known Subclasses: org.springframework.webflow.action.AttributeMapperAction, org.springframework.webflow.action.AbstractBeanInvokingAction, org.springframework.webflow.action.CompositeAction, org.springframework.webflow.action.SetAction, org.springframework.webflow.action.EvaluateAction, org.springframework.webflow.action.MultiAction, org.springframework.webflow.action.portlet.SetPortletModeAction,
| AbstractAction | | abstract public class AbstractAction implements Action,InitializingBean(Code) | | Base action that provides assistance commonly needed by action
implementations. This includes:
- Implementing
InitializingBean to receive an init callback
when deployed within a Spring bean factory.
- Exposing convenient event factory methods to create common result
Event objects such as "success" and "error".
- A hook for inserting action pre and post execution logic.
author:
Keith Donald
author:
Erwin Vervaet |
| Field Summary | |
| final protected Log | logger
Logger, usable in subclasses. |
| logger | | final protected Log logger(Code) | | Logger, usable in subclasses.
|
| doExecute | | abstract protected Event doExecute(RequestContext context) throws Exception(Code) | | Template hook method subclasses should override to encapsulate their
specific action execution logic.
Parameters:
context - the action execution context, for accessing and settingdata in "flow scope" or "request scope" the action result event
throws:
Exception - an unrecoverable exception occured, eitherchecked or unchecked |
| doPostExecute | | protected void doPostExecute(RequestContext context) throws Exception(Code) | | Post-action execution hook, subclasses may override. Will only be called
if doExecute() was called, e.g. when doPreExecute()
returned null.
This implementation does nothing.
Parameters:
context - the action execution context, for accessing and settingdata in "flow scope" or "request scope"
throws:
Exception - an unrecoverable exception occured, eitherchecked or unchecked |
| doPreExecute | | protected Event doPreExecute(RequestContext context) throws Exception(Code) | | Pre-action-execution hook, subclasses may override. If this method
returns a non-null event, the doExecute()
method will not be called and the returned event will be used to
select a transition to trigger in the calling action state. If this
method returns null, doExecute() will be
called to obtain an action result event.
This implementation just returns null.
Parameters:
context - the action execution context, for accessing and settingdata in "flow scope" or "request scope" the non-null action result, in which case thedoExecute() will not be called, or null ifthe doExecute() method should be called to obtain theaction result
throws:
Exception - an unrecoverable exception occured, eitherchecked or unchecked |
| error | | protected Event error()(Code) | | Returns an "error" result event.
|
| error | | protected Event error(Exception e)(Code) | | Returns an "error" result event caused by the provided exception.
Parameters:
e - the exception that caused the error event, to be configured asan event attribute |
| getActionNameForLogging | | protected String getActionNameForLogging()(Code) | | Internal helper to return the name of this action for logging
purposes. Defaults to the short class name.
See Also: ClassUtils.getShortName(java.lang.Class) |
| getEventFactorySupport | | public EventFactorySupport getEventFactorySupport()(Code) | | Returns the helper delegate for creating action execution result events.
the event factory support |
| initAction | | protected void initAction() throws Exception(Code) | | Action initializing callback, may be overriden by subclasses to perform
custom initialization logic.
Keep in mind that this hook will only be invoked when this action is
deployed in a Spring application context since it uses the Spring
InitializingBean mechanism to trigger action initialisation.
|
| no | | protected Event no()(Code) | | Returns a "no" result event.
|
| result | | protected Event result(boolean booleanResult)(Code) | | Returns yes() if the boolean result is true, no() if false.
Parameters:
booleanResult - the boolean yes or no |
| result | | protected Event result(String eventId)(Code) | | Returns a result event for this action with the specified identifier.
Typically called as part of return, for example:
protected Event doExecute(RequestContext context) {
// do some work
if (some condition) {
return result("success");
} else {
return result("error");
}
}
Consider calling the error() or success() factory methods for returning
common results.
Parameters:
eventId - the result event identifier the action result event |
| result | | protected Event result(String eventId, AttributeMap resultAttributes)(Code) | | Returns a result event for this action with the specified identifier and
the specified set of attributes. Typically called as part of return, for
example:
protected Event doExecute(RequestContext context) {
// do some work
AttributeMap resultAttributes = new AttributeMap();
resultAttributes.put("name", "value");
if (some condition) {
return result("success", resultAttributes);
} else {
return result("error", resultAttributes);
}
}
Consider calling the error() or success() factory methods for returning
common results.
Parameters:
eventId - the result event identifier
Parameters:
resultAttributes - the event attributes the action result event |
| result | | protected Event result(String eventId, String resultAttributeName, Object resultAttributeValue)(Code) | | Returns a result event for this action with the specified identifier and
a single attribute.
Parameters:
eventId - the result id
Parameters:
resultAttributeName - the attribute name
Parameters:
resultAttributeValue - the attribute value the action result event |
| success | | protected Event success()(Code) | | Returns a "success" result event.
|
| success | | protected Event success(Object result)(Code) | | Returns a "success" result event with the provided result object as a
parameter.
Parameters:
result - the action success result |
| yes | | protected Event yes()(Code) | | Returns a "yes" result event.
|
|
|