|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.webflow.action.AbstractAction
public abstract class AbstractAction
Base action that provides assistance commonly needed by action implementations. This includes:
InitializingBean
to receive an init callback when deployed within a Spring bean factory.
Event
objects such as "success" and
"error".
Constructor Summary | |
---|---|
AbstractAction()
|
Method Summary | |
---|---|
void |
afterPropertiesSet()
|
Event |
execute(RequestContext context)
Execute this action. |
EventFactorySupport |
getEventFactorySupport()
Returns the helper delegate for creating action execution result events. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractAction()
Method Detail |
---|
public EventFactorySupport getEventFactorySupport()
public void afterPropertiesSet() throws Exception
afterPropertiesSet
in interface org.springframework.beans.factory.InitializingBean
Exception
public final Event execute(RequestContext context) throws Exception
Action
Action invocation is typically triggered in a production environment by a state within a flow carrying out the execution of a flow definition. The result of action execution, a logical outcome event, can be used as grounds for a transition out of the calling state.
Note: The RequestContext
argument to this method provides access to data about the active flow execution
in the context of the currently executing thread. Among other things, this allows this action to access
data
set by other actions, as well as set its own attributes it wishes
to expose in a given scope.
Some notes about actions and their usage of the attribute scope types:
request scope
exist for the life of the currently
executing request only.
flash scope
exist until the next external user
event is signaled. That time includes the current request plus any redirect or additional refreshes to the next
view.
flow scope
exist for the life of the flow session
and will be cleaned up automatically when the flow session ends.
conversation scope
exist for the life of the
entire flow execution representing a single logical "conversation" with a user.
All attributes present in any scope are typically exposed in a model for access by a view when an "interactive" state type such as a view state is entered.
Note: flow scope should generally not be used as a general purpose cache, but rather as a context for data needed locally by other states of the flow this action participates in. For example, it would be inappropriate to stuff large collections of objects (like those returned to support a search results view) into flow scope. Instead, put such result collections in request scope, and ensure you execute this action again each time you wish to view those results. 2nd level caches managed outside of SWF are more general cache solutions.
Note: as flow scoped attributes are eligible for serialization they should be Serializable
.
execute
in interface Action
context
- the action execution context, for accessing and setting data in a scope type
,
as well as obtaining other flow contextual information (e.g. request context attributes and flow execution
context information)
Exception
- a exception occurred during action execution, either checked or unchecked; note, any
recoverable exceptions should be caught within this method and an appropriate result outcome returned
or be handled by the current state of the calling flow execution.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |