public static class ActionInvocation.LegacyAdapter extends Object implements ActionInvocation
ActionInvocation.LegacyAdapter| Modifier and Type | Method and Description |
|---|---|
void |
addPreResultListener(PreResultListener listener) |
Object |
getAction()
Get the Action associated with this ActionInvocation.
|
ActionContext |
getInvocationContext()
Gets the ActionContext associated with this ActionInvocation.
|
ActionProxy |
getProxy()
Get the ActionProxy holding this ActionInvocation.
|
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()
Gets the result code returned from this ActionInvocation.
|
ValueStack |
getStack()
Gets the ValueStack associated with this ActionInvocation.
|
void |
init(ActionProxy proxy) |
String |
invoke()
Invokes the next step in processing this ActionInvocation.
|
String |
invokeActionOnly()
Invokes only the Action (not Interceptors or Results).
|
boolean |
isExecuted()
Gets whether this ActionInvocation has executed before.
|
void |
setActionEventListener(ActionEventListener listener) |
void |
setResultCode(String resultCode)
Sets the result code, possibly overriding the one returned by the
action.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitadapt, addPreResultListener, init, setActionEventListenerpublic Object getAction()
ActionInvocationgetAction in interface ActionInvocationpublic boolean isExecuted()
ActionInvocationisExecuted in interface ActionInvocationpublic ActionContext getInvocationContext()
ActionInvocationgetInvocationContext in interface ActionInvocationpublic ActionProxy getProxy()
ActionInvocationgetProxy in interface ActionInvocationpublic Result getResult() throws Exception
ActionInvocationActionChainResult, 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.getResult in interface ActionInvocationException - can be thrown.public String getResultCode()
ActionInvocationgetResultCode in interface ActionInvocationpublic void setResultCode(String resultCode)
ActionInvocationThe "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 opportunity.
If this method is called after the Result has been executed, it will have the effect of raising an IllegalStateException.
setResultCode in interface ActionInvocationresultCode - the result code.ActionInvocation.isExecuted()public ValueStack getStack()
ActionInvocationgetStack in interface ActionInvocationpublic void addPreResultListener(PreResultListener listener)
public String invoke() throws Exception
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.
invoke in interface ActionInvocationException - can be thrown.public String invokeActionOnly() throws Exception
ActionInvocationThis is useful in rare situations where advanced usage with the interceptor/action/result workflow is being manipulated for certain functionality.
invokeActionOnly in interface ActionInvocationException - can be thrown.public void setActionEventListener(ActionEventListener listener)
public void init(ActionProxy proxy)
Copyright © 2000–2025 Apache Software Foundation. All rights reserved.