| com.opensymphony.xwork.ActionInvocation
All known Subclasses: com.opensymphony.xwork.DefaultActionInvocation, com.opensymphony.xwork.mock.MockActionInvocation,
| ActionInvocation | | public interface ActionInvocation extends Serializable(Code) | | An ActionInvocation represents the execution state of an Action. It holds the Interceptors and the Action instance.
By repeated re-entrant execution of the invoke() method, initially by the ActionProxy, then by the Interceptors, the
Interceptors are all executed, and then the Action and the Result.
author:
Jason Carreira
See Also: com.opensymphony.xwork.ActionProxy |
| Method Summary | |
| void | addPreResultListener(PreResultListener listener)
Register a com.opensymphony.xwork.interceptor.PreResultListener to be notified after the Action is executed and
before the Result is executed. | | Object | getAction()
| | ActionContext | getInvocationContext()
Gets the ActionContext associated with this ActionInvocation. | | ActionProxy | getProxy()
| | Result | getResult()
If the ActionInvocation has been executed before and the Result is an instance of ActionChainResult, this method
will walk down the chain of ActionChainResults until it finds a non-chain result, which will be returned. | | String | getResultCode()
| | OgnlValueStack | getStack()
| | String | invoke()
Invokes the next step in processing this ActionInvocation. | | String | invokeActionOnly()
Invokes only the action (not interceptors or results). | | boolean | isExecuted()
whether this ActionInvocation has executed before. | | void | setResultCode(String resultCode)
Sets the result code, possibly overriding the one returned by the
action.
The "intended" purpose of this method is to allow PreResultListeners to
override the result code returned by the Action.
If this method is used before the Action executes, the Action's returned
result code will override what was set. |
| addPreResultListener | | void addPreResultListener(PreResultListener listener)(Code) | | Register a com.opensymphony.xwork.interceptor.PreResultListener to be notified after the Action is executed and
before the Result is executed. The ActionInvocation implementation must guarantee that listeners will be called in
the order in which they are registered. Listener registration and execution does not need to be thread-safe.
|
| getAction | | Object getAction()(Code) | | Get the Action associated with this ActionInvocation
|
| getInvocationContext | | ActionContext getInvocationContext()(Code) | | Gets the ActionContext associated with this ActionInvocation. The ActionProxy is
responsible for setting this ActionContext onto the ThreadLocal before invoking
the ActionInvocation and resetting the old ActionContext afterwards.
|
| getProxy | | ActionProxy getProxy()(Code) | | Get the ActionProxy holding this ActionInvocation
|
| getResult | | Result getResult() throws Exception(Code) | | If the ActionInvocation has been executed before and the Result is an instance of ActionChainResult, this method
will walk down the chain of ActionChainResults until it finds a non-chain result, which will be returned. If the
ActionInvocation's result has not been executed before, the Result instance will be created and populated with
the result params.
a Result instance |
| getResultCode | | String getResultCode()(Code) | | Gets the result code returned from this ActionInvocation
|
| invoke | | String invoke() throws Exception(Code) | | Invokes the next step in processing this ActionInvocation. If there are more Interceptors, this will call the next
one. If Interceptors choose not to short-circuit ActionInvocation processing and return their own return code,
they will call invoke() to allow the next Interceptor to execute. If there are no more Interceptors to be applied,
the Action is executed. If the ActionProxy getExecuteResult() method returns true, the Result is also executed.
|
| invokeActionOnly | | String invokeActionOnly() throws Exception(Code) | | Invokes only the action (not interceptors or results). This is useful in rare situations where advanced usage
with the interceptor/action/result workflow is being manipulated for certain functionality. Specifically,
WebWork's execAndWait interceptor takes advantage of this method.
|
| isExecuted | | boolean isExecuted()(Code) | | whether this ActionInvocation has executed before. This will be set after the Action and the Result haveexecuted. |
| setResultCode | | void setResultCode(String resultCode)(Code) | | Sets the result code, possibly overriding the one returned by the
action.
The "intended" purpose of this method is to allow PreResultListeners to
override the result code returned by the Action.
If this method is used before the Action executes, the Action's returned
result code will override what was set. However the Action could (if
specifically coded to do so) inspect the ActionInvocation to see that
someone "upstream" (e.g. an Interceptor) had suggested a value as the
result, and it could therefore return the same value itself.
If this method is called between the Action execution and the Result
execution, then the value set here will override the result code the
action had returned. Creating an Interceptor that implements
PreResultListener will give you this oportunity.
If this method is called after the Result has been executed, it will
have the effect of raising an exception.
throws:
IllegalStateException - if called after the Result has beenexecuted.
See Also: ActionInvocation.isExecuted() |
|
|