## Uses of Interface
com.opensymphony.xwork2.ActionInvocation

- Packages that use ActionInvocation
  Package | Description
  --- | ---
  com.opensymphony.xwork2 | Main XWork interfaces and classes.
  com.opensymphony.xwork2.interceptor | Interceptor classes.
  com.opensymphony.xwork2.interceptor.annotations | Interceptor annotations.
  com.opensymphony.xwork2.mock | XWork specific mock classes.
  com.opensymphony.xwork2.validator | XWork validation subsystem.
  org.apache.struts2.config | Classes for Struts configuration and property handling.
  org.apache.struts2.factory |
  org.apache.struts2.interceptor |
  org.apache.struts2.interceptor.csp |
  org.apache.struts2.interceptor.debugging |
  org.apache.struts2.interceptor.exec |
  org.apache.struts2.interceptor.httpmethod |
  org.apache.struts2.interceptor.validation |
  org.apache.struts2.result |
  org.apache.struts2.util |
  org.apache.struts2.views.freemarker |

- - ### Uses of ActionInvocation in com.opensymphony.xwork2

    Classes in com.opensymphony.xwork2 that implement ActionInvocation
    Modifier and Type | Class and Description
    --- | ---
    `class` | `DefaultActionInvocation` The Default ActionInvocation implementation

    Fields in com.opensymphony.xwork2 declared as ActionInvocation
    Modifier and Type | Field and Description
    --- | ---
    `protected ActionInvocation` | DefaultActionProxy.`invocation`

    Methods in com.opensymphony.xwork2 that return ActionInvocation
    Modifier and Type | Method and Description
    --- | ---
    `protected ActionInvocation` | DefaultActionProxyFactory.`createActionInvocation(Map<String,Object> extraContext, boolean pushAction)`
    `ActionInvocation` | ActionContext.`getActionInvocation()` Gets the action invocation (the execution state).
    `ActionInvocation` | ActionProxy.`getInvocation()` Gets the ActionInvocation associated with this ActionProxy.
    `ActionInvocation` | DefaultActionProxy.`getInvocation()`

    Methods in com.opensymphony.xwork2 with parameters of type ActionInvocation
    Modifier and Type | Method and Description
    --- | ---
    `ActionProxy` | DefaultActionProxyFactory.`createActionProxy(ActionInvocation inv, String namespace, String actionName, boolean executeResult, boolean cleanupContext)`
    `ActionProxy` | ActionProxyFactory.`createActionProxy(ActionInvocation actionInvocation, String namespace, String actionName, String methodName, boolean executeResult, boolean cleanupContext)` Creates an `ActionProxy` for the given namespace and action name by looking up the configuration.The ActionProxy should be fully initialized when it is returned, including passed `ActionInvocation` instance.
    `ActionProxy` | DefaultActionProxyFactory.`createActionProxy(ActionInvocation inv, String namespace, String actionName, String methodName, boolean executeResult, boolean cleanupContext)`
    `void` | Result.`execute(ActionInvocation invocation)` Represents a generic interface for all action execution results.
    `void` | ActionChainResult.`execute(ActionInvocation invocation)`
    `ActionContext` | ActionContext.`withActionInvocation(ActionInvocation actionInvocation)` Sets the action invocation (the execution state).

    Constructors in com.opensymphony.xwork2 with parameters of type ActionInvocation
    Constructor and Description
    `DefaultActionProxy(ActionInvocation inv, String namespace, String actionName, String methodName, boolean executeResult, boolean cleanupContext)` This constructor is private so the builder methods (create*) should be used to create an DefaultActionProxy.

  - ### Uses of ActionInvocation in com.opensymphony.xwork2.interceptor

    Methods in com.opensymphony.xwork2.interceptor with parameters of type ActionInvocation
    Modifier and Type | Method and Description
    --- | ---
    `protected boolean` | MethodFilterInterceptor.`applyInterceptor(ActionInvocation invocation)`
    `void` | ModelDrivenInterceptor.RefreshModelBeforeResult.`beforeResult(ActionInvocation invocation, String resultCode)`
    `void` | PreResultListener.`beforeResult(ActionInvocation invocation, String resultCode)` This callback method will be called after the `Action` execution and before the `Result` execution.
    `String` | ConversionErrorInterceptor.`doIntercept(ActionInvocation invocation)`
    `String` | PrepareInterceptor.`doIntercept(ActionInvocation invocation)`
    `protected String` | DefaultWorkflowInterceptor.`doIntercept(ActionInvocation invocation)` Intercept `ActionInvocation` and returns a `inputResultName` when action / field errors is found registered.
    `protected abstract String` | MethodFilterInterceptor.`doIntercept(ActionInvocation invocation)` Subclasses must override to implement the interceptor logic.
    `String` | ParametersInterceptor.`doIntercept(ActionInvocation invocation)`
    `protected Object` | ConversionErrorInterceptor.`getOverrideExpr(ActionInvocation invocation, Object value)`
    `String` | StaticParametersInterceptor.`intercept(ActionInvocation invocation)`
    `String` | ModelDrivenInterceptor.`intercept(ActionInvocation invocation)`
    `abstract String` | AbstractInterceptor.`intercept(ActionInvocation invocation)` Override to handle interception
    `String` | ScopedModelDrivenInterceptor.`intercept(ActionInvocation invocation)`
    `String` | MethodFilterInterceptor.`intercept(ActionInvocation invocation)`
    `String` | LoggingInterceptor.`intercept(ActionInvocation invocation)`
    `String` | ChainingInterceptor.`intercept(ActionInvocation invocation)`
    `String` | AliasInterceptor.`intercept(ActionInvocation invocation)`
    `String` | ParameterRemoverInterceptor.`intercept(ActionInvocation invocation)` Decide if the parameter should be removed from the parameter map based on `paramNames` and `paramValues`.
    `String` | Interceptor.`intercept(ActionInvocation invocation)` Allows the Interceptor to do some processing on the request before and/or after the rest of the processing of the request by the `ActionInvocation` or to short-circuit the processing and just return a String return code.
    `String` | ParameterFilterInterceptor.`intercept(ActionInvocation invocation)`
    `String` | ExceptionMappingInterceptor.`intercept(ActionInvocation invocation)`
    `static void` | PrefixMethodInvocationUtil.`invokePrefixMethod(ActionInvocation actionInvocation, String[] prefixes)` This method will prefix `actionInvocation`'s `ActionProxy`'s `method` with `prefixes` before invoking the prefixed method.
    `protected void` | ExceptionMappingInterceptor.`publishException(ActionInvocation invocation, ExceptionHolder exceptionHolder)` Default implementation to handle ExceptionHolder publishing.
    `boolean` | AbstractInterceptor.`shouldIntercept(ActionInvocation invocation)`
    `boolean` | ConditionalInterceptor.`shouldIntercept(ActionInvocation invocation)` Determines if a given interceptor should be executed in the current processing of action invocation.

  - ### Uses of ActionInvocation in com.opensymphony.xwork2.interceptor.annotations

    Methods in com.opensymphony.xwork2.interceptor.annotations with parameters of type ActionInvocation
    Modifier and Type | Method and Description
    --- | ---
    `void` | AnnotationWorkflowInterceptor.`beforeResult(ActionInvocation invocation, String resultCode)` Invokes any @BeforeResult annotated methods
    `String` | AnnotationParameterFilterInterceptor.`intercept(ActionInvocation invocation)`
    `String` | AnnotationWorkflowInterceptor.`intercept(ActionInvocation invocation)` Discovers annotated methods on the action and calls them according to the workflow

  - ### Uses of ActionInvocation in com.opensymphony.xwork2.mock

    Classes in com.opensymphony.xwork2.mock that implement ActionInvocation
    Modifier and Type | Class and Description
    --- | ---
    `class` | `MockActionInvocation` Mock for an `ActionInvocation`.

    Methods in com.opensymphony.xwork2.mock that return ActionInvocation
    Modifier and Type | Method and Description
    --- | ---
    `ActionInvocation` | MockActionProxy.`getInvocation()`
    `ActionInvocation` | MockResult.`getInvocation()`

    Methods in com.opensymphony.xwork2.mock with parameters of type ActionInvocation
    Modifier and Type | Method and Description
    --- | ---
    `void` | MockResult.`execute(ActionInvocation invocation)`
    `String` | MockInterceptor.`intercept(ActionInvocation invocation)` Allows the Interceptor to do some processing on the request before and/or after the rest of the processing of the request by the DefaultActionInvocation or to short-circuit the processing and just return a String return code.
    `void` | MockActionProxy.`setInvocation(ActionInvocation invocation)`

  - ### Uses of ActionInvocation in com.opensymphony.xwork2.validator

    Methods in com.opensymphony.xwork2.validator with parameters of type ActionInvocation
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | ValidationInterceptor.`doBeforeInvocation(ActionInvocation invocation)` Gets the current action and its context and delegates to `ActionValidatorManager` proper validate method.
    `protected String` | ValidationInterceptor.`doIntercept(ActionInvocation invocation)`

  - ### Uses of ActionInvocation in org.apache.struts2.config

    Methods in org.apache.struts2.config with parameters of type ActionInvocation
    Modifier and Type | Method and Description
    --- | ---
    `void` | NullResult.`execute(ActionInvocation invocation)`

  - ### Uses of ActionInvocation in org.apache.struts2.factory

    Methods in org.apache.struts2.factory with parameters of type ActionInvocation
    Modifier and Type | Method and Description
    --- | ---
    `ActionProxy` | StrutsActionProxyFactory.`createActionProxy(ActionInvocation inv, String namespace, String actionName, String methodName, boolean executeResult, boolean cleanupContext)`

    Constructors in org.apache.struts2.factory with parameters of type ActionInvocation
    Constructor and Description
    `StrutsActionProxy(ActionInvocation inv, String namespace, String actionName, String methodName, boolean executeResult, boolean cleanupContext)`

  - ### Uses of ActionInvocation in org.apache.struts2.interceptor

    Fields in org.apache.struts2.interceptor declared as ActionInvocation
    Modifier and Type | Field and Description
    --- | ---
    `protected ActionInvocation` | I18nInterceptor.RequestLocaleHandler.`actionInvocation`

    Methods in org.apache.struts2.interceptor with parameters of type ActionInvocation
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | ScopeInterceptor.`after(ActionInvocation invocation, String result)`
    `protected void` | MessageStoreInterceptor.`before(ActionInvocation invocation)` Handle the retrieving of field errors / action messages / field errors, which is done before action invocation, and the `operationMode` is 'RETRIEVE'.
    `protected void` | ScopeInterceptor.`before(ActionInvocation invocation)`
    `void` | CoepInterceptor.`beforeResult(ActionInvocation invocation, String resultCode)`
    `void` | CookieProviderInterceptor.`beforeResult(ActionInvocation invocation, String resultCode)`
    `void` | CoopInterceptor.`beforeResult(ActionInvocation invocation, String resultCode)`
    `void` | MessageStorePreResultListener.`beforeResult(ActionInvocation invocation, String resultCode)`
    `void` | ScopeInterceptor.`beforeResult(ActionInvocation invocation, String resultCode)`
    `protected MessageStorePreResultListener` | MessageStoreInterceptor.`createPreResultListener(ActionInvocation invocation)`
    `protected String` | TokenInterceptor.`doIntercept(ActionInvocation invocation)`
    `protected String` | ExecuteAndWaitInterceptor.`doIntercept(ActionInvocation actionInvocation)`
    `protected Parameter` | I18nInterceptor.`findLocaleParameter(ActionInvocation invocation, String parameterName)`
    `protected String` | TokenInterceptor.`getErrorMessage(ActionInvocation invocation)`
    `protected I18nInterceptor.LocaleHandler` | I18nInterceptor.`getLocaleHandler(ActionInvocation invocation)` Override this method to use your own implementation of `I18nInterceptor.LocaleHandler`
    `protected BackgroundProcess` | ExecuteAndWaitInterceptor.`getNewBackgroundProcess(String name, ActionInvocation actionInvocation, int threadPriority)` Creates a new background process
    `protected Object` | StrutsConversionErrorInterceptor.`getOverrideExpr(ActionInvocation invocation, Object value)`
    `protected String` | MessageStoreInterceptor.`getRequestOperationMode(ActionInvocation invocation)` Get the operationMode through request parameter, if `allowRequestParameterSwitch` is 'true', else it simply returns 'NONE', meaning its neither in the 'STORE_MODE' nor 'RETRIEVE_MODE'.
    `protected String` | TokenSessionStoreInterceptor.`handleInvalidToken(ActionInvocation invocation)` Handles processing of invalid tokens.
    `protected String` | TokenInterceptor.`handleInvalidToken(ActionInvocation invocation)` Determines what to do if an invalid token is provided.
    `protected String` | RolesInterceptor.`handleRejection(ActionInvocation invocation, javax.servlet.http.HttpServletResponse response)` Handles a rejection by sending a 403 HTTP error
    `protected String` | TokenSessionStoreInterceptor.`handleToken(ActionInvocation invocation)`
    `protected String` | TokenInterceptor.`handleToken(ActionInvocation invocation)`
    `protected String` | TokenSessionStoreInterceptor.`handleValidToken(ActionInvocation invocation)` Handles processing of valid tokens.
    `protected String` | TokenInterceptor.`handleValidToken(ActionInvocation invocation)` Called when a valid token is found.
    `String` | FileUploadInterceptor.`intercept(ActionInvocation invocation)`
    `String` | MultiselectInterceptor.`intercept(ActionInvocation ai)` Just as the CheckboxInterceptor checks that if only the hidden field is present, so too does this interceptor.
    `String` | FetchMetadataInterceptor.`intercept(ActionInvocation invocation)`
    `String` | CoepInterceptor.`intercept(ActionInvocation invocation)`
    `String` | CookieProviderInterceptor.`intercept(ActionInvocation invocation)`
    `String` | CreateSessionInterceptor.`intercept(ActionInvocation invocation)`
    `String` | DateTextFieldInterceptor.`intercept(ActionInvocation ai)`
    `String` | CookieInterceptor.`intercept(ActionInvocation invocation)`
    `String` | CoopInterceptor.`intercept(ActionInvocation invocation)`
    `String` | NoOpInterceptor.`intercept(ActionInvocation invocation)`
    `String` | MessageStoreInterceptor.`intercept(ActionInvocation invocation)`
    `String` | I18nInterceptor.`intercept(ActionInvocation invocation)`
    `String` | ClearSessionInterceptor.`intercept(ActionInvocation invocation)`
    `String` | CheckboxInterceptor.`intercept(ActionInvocation ai)`
    `String` | ScopeInterceptor.`intercept(ActionInvocation invocation)`
    `String` | RolesInterceptor.`intercept(ActionInvocation invocation)`
    `String` | ServletConfigInterceptor.`intercept(ActionInvocation invocation)` Sets action properties based on the interfaces an action implements.
    `protected boolean` | MessageStorePreResultListener.`isRedirect(ActionInvocation invocation, String resultCode)`
    `Locale` | I18nInterceptor.LocaleHandler.`read(ActionInvocation invocation)`
    `Locale` | I18nInterceptor.RequestLocaleHandler.`read(ActionInvocation invocation)`
    `Locale` | I18nInterceptor.SessionLocaleHandler.`read(ActionInvocation invocation)`
    `Locale` | I18nInterceptor.CookieLocaleHandler.`read(ActionInvocation invocation)`
    `Locale` | I18nInterceptor.LocaleHandler.`store(ActionInvocation invocation, Locale locale)`
    `Locale` | I18nInterceptor.RequestLocaleHandler.`store(ActionInvocation invocation, Locale locale)`
    `Locale` | I18nInterceptor.SessionLocaleHandler.`store(ActionInvocation invocation, Locale locale)`
    `Locale` | I18nInterceptor.CookieLocaleHandler.`store(ActionInvocation invocation, Locale locale)`
    `protected void` | I18nInterceptor.`useLocale(ActionInvocation invocation, Locale locale)` Save the given locale to the ActionInvocation.

    Constructors in org.apache.struts2.interceptor with parameters of type ActionInvocation
    Constructor and Description
    `AcceptLanguageLocaleHandler(ActionInvocation invocation)`
    `CookieLocaleHandler(ActionInvocation invocation)`
    `RequestLocaleHandler(ActionInvocation invocation)`
    `SessionLocaleHandler(ActionInvocation invocation)`

  - ### Uses of ActionInvocation in org.apache.struts2.interceptor.csp

    Methods in org.apache.struts2.interceptor.csp with parameters of type ActionInvocation
    Modifier and Type | Method and Description
    --- | ---
    `String` | CspInterceptor.`intercept(ActionInvocation invocation)`

  - ### Uses of ActionInvocation in org.apache.struts2.interceptor.debugging

    Methods in org.apache.struts2.interceptor.debugging with parameters of type ActionInvocation
    Modifier and Type | Method and Description
    --- | ---
    `String` | DebuggingInterceptor.`intercept(ActionInvocation inv)`

  - ### Uses of ActionInvocation in org.apache.struts2.interceptor.exec

    Fields in org.apache.struts2.interceptor.exec declared as ActionInvocation
    Modifier and Type | Field and Description
    --- | ---
    `protected ActionInvocation` | StrutsBackgroundProcess.`invocation`

    Methods in org.apache.struts2.interceptor.exec that return ActionInvocation
    Modifier and Type | Method and Description
    --- | ---
    `ActionInvocation` | StrutsBackgroundProcess.`getInvocation()` Retrieves the action invocation.
    `ActionInvocation` | BackgroundProcess.`getInvocation()`

    Constructors in org.apache.struts2.interceptor.exec with parameters of type ActionInvocation
    Constructor and Description
    `StrutsBackgroundProcess(ActionInvocation invocation, String threadName, int threadPriority)` Constructs a background process

  - ### Uses of ActionInvocation in org.apache.struts2.interceptor.httpmethod

    Methods in org.apache.struts2.interceptor.httpmethod with parameters of type ActionInvocation
    Modifier and Type | Method and Description
    --- | ---
    `protected String` | HttpMethodInterceptor.`doIntercept(ActionInvocation invocation, AnnotatedElement element)`
    `protected String` | HttpMethodInterceptor.`getBadRequestResultName(ActionInvocation invocation)`
    `String` | HttpMethodInterceptor.`intercept(ActionInvocation invocation)`

  - ### Uses of ActionInvocation in org.apache.struts2.interceptor.validation

    Methods in org.apache.struts2.interceptor.validation with parameters of type ActionInvocation
    Modifier and Type | Method and Description
    --- | ---
    `protected String` | AnnotationValidationInterceptor.`doIntercept(ActionInvocation invocation)`

  - ### Uses of ActionInvocation in org.apache.struts2.result

    Methods in org.apache.struts2.result with parameters of type ActionInvocation
    Modifier and Type | Method and Description
    --- | ---
    `protected String` | StrutsResultSupport.`conditionalParse(String param, ActionInvocation invocation)` Parses the parameter for OGNL expressions against the valuestack
    `protected Collection<String>` | StrutsResultSupport.`conditionalParseCollection(String param, ActionInvocation invocation, boolean excludeEmptyElements)` As `StrutsResultSupport.conditionalParse(String, ActionInvocation)` but does not convert found object into String.
    `protected void` | PlainTextResult.`doExecute(String finalLocation, ActionInvocation invocation)`
    `protected void` | PostbackResult.`doExecute(String finalLocation, ActionInvocation invocation)`
    `protected void` | ServletRedirectResult.`doExecute(String finalLocation, ActionInvocation invocation)` Redirects to the location specified by calling `HttpServletResponse.sendRedirect(String)`.
    `protected abstract void` | StrutsResultSupport.`doExecute(String finalLocation, ActionInvocation invocation)` Executes the result given a final location (jsp page, action, etc) and the action invocation (the state in which the action was executed).
    `void` | ServletDispatcherResult.`doExecute(String finalLocation, ActionInvocation invocation)` Dispatches to the given location.
    `protected void` | StreamResult.`doExecute(String finalLocation, ActionInvocation invocation)`
    `void` | HttpHeaderResult.`execute(ActionInvocation invocation)` Sets the optional HTTP response status code and also re-sets HTTP headers after they've been optionally evaluated against the ValueStack.
    `void` | PostbackResult.`execute(ActionInvocation invocation)`
    `void` | ServletRedirectResult.`execute(ActionInvocation invocation)`
    `void` | StrutsResultSupport.`execute(ActionInvocation invocation)` Implementation of the `execute` method from the `Result` interface.
    `void` | ServletActionRedirectResult.`execute(ActionInvocation invocation)`
    `default void` | PlainResult.`execute(ActionInvocation invocation)`
    `protected HttpParameters` | ServletDispatcherResult.`getParameters(ActionInvocation invocation)`
    `protected String` | PostbackResult.`makePostbackUri(ActionInvocation invocation)`
    `protected InputStream` | PlainTextResult.`readStream(ActionInvocation invocation, String location)`

  - ### Uses of ActionInvocation in org.apache.struts2.util

    Methods in org.apache.struts2.util that return ActionInvocation
    Modifier and Type | Method and Description
    --- | ---
    `static ActionInvocation` | InvocationSessionStore.`loadInvocation(String key, String token)` Checks the Map in the Session for the key and the token.

    Methods in org.apache.struts2.util with parameters of type ActionInvocation
    Modifier and Type | Method and Description
    --- | ---
    `static void` | InvocationSessionStore.`storeInvocation(String key, String token, ActionInvocation invocation)` Stores the DefaultActionInvocation and ActionContext into the Session using the provided key for loading later using `InvocationSessionStore.loadInvocation(java.lang.String, java.lang.String)`

  - ### Uses of ActionInvocation in org.apache.struts2.views.freemarker

    Fields in org.apache.struts2.views.freemarker declared as ActionInvocation
    Modifier and Type | Field and Description
    --- | ---
    `protected ActionInvocation` | FreemarkerResult.`invocation`

    Methods in org.apache.struts2.views.freemarker with parameters of type ActionInvocation
    Modifier and Type | Method and Description
    --- | ---
    `void` | FreemarkerResult.`doExecute(String locationArg, ActionInvocation invocation)` Execute this result, using the specified template locationArg.

Copyright © 2000–2023 Apache Software Foundation. All rights reserved.