Repository: struts-site Updated Branches: refs/heads/master 87fffce30 -> 56dec0034
Cleans up page Project: http://git-wip-us.apache.org/repos/asf/struts-site/repo Commit: http://git-wip-us.apache.org/repos/asf/struts-site/commit/56dec003 Tree: http://git-wip-us.apache.org/repos/asf/struts-site/tree/56dec003 Diff: http://git-wip-us.apache.org/repos/asf/struts-site/diff/56dec003 Branch: refs/heads/master Commit: 56dec0034116ed018ec0504f609391e66c4b95c1 Parents: 87fffce Author: Lukasz Lenart <lukaszlen...@apache.org> Authored: Wed Aug 23 14:03:29 2017 +0200 Committer: Lukasz Lenart <lukaszlen...@apache.org> Committed: Wed Aug 23 14:03:29 2017 +0200 ---------------------------------------------------------------------- source/core-developers/interceptors.md | 317 ++++++++++++---------------- 1 file changed, 134 insertions(+), 183 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/struts-site/blob/56dec003/source/core-developers/interceptors.md ---------------------------------------------------------------------- diff --git a/source/core-developers/interceptors.md b/source/core-developers/interceptors.md index 7ad24d3..aaf5c64 100644 --- a/source/core-developers/interceptors.md +++ b/source/core-developers/interceptors.md @@ -4,40 +4,50 @@ title: Interceptors --- # Interceptors +{:.no_toc} +* Will be replaced with the ToC, excluding a header +{:toc} -The default Interceptor stack is designed to serve the needs of most applications\. Most applications will **not** need to add Interceptors or change the Interceptor stack\. +The default Interceptor stack is designed to serve the needs of most applications. Most applications will **not** need +to add Interceptors or change the Interceptor stack. -| +Many Actions share common concerns. Some Actions need input validated. Other Actions may need a file upload +to be pre-processed. Another Action might need protection from a double submit. Many Actions need drop-down lists +and other controls pre-populated before the page displays. -Many Actions share common concerns\. Some Actions need input validated\. Other Actions may need a file upload to be pre\-processed\. Another Action might need protection from a double submit\. Many Actions need drop\-down lists and other controls pre\-populated before the page displays\. +The framework makes it easy to share solutions to these concerns using an "Interceptor" strategy. When you request +a resource that maps to an "action", the framework invokes the Action object. But, before the Action is executed, +the invocation can be intercepted by another object. After the Action executes, the invocation could be intercepted +again. Unsurprisingly, we call these objects "Interceptors." -The framework makes it easy to share solutions to these concerns using an "Interceptor" strategy\. When you request a resource that maps to an "action", the framework invokes the Action object\. But, before the Action is executed, the invocation can be intercepted by another object\. After the Action executes, the invocation could be intercepted again\. Unsurprisingly, we call these objects "Interceptors\." +## Understanding Interceptors +Interceptors can execute code before and after an Action is invoked. Most of the framework's core functionality is +implemented as Interceptors. Features like double-submit guards, type conversion, object population, validation, +file upload, page preparation, and more, are all implemented with the help of Interceptors. Each and every Interceptor +is pluggable, so you can decide exactly which features an Action needs to support. -####Understanding Interceptors#### - -Interceptors can execute code before and after an Action is invoked\. Most of the framework's core functionality is implemented as Interceptors\. Features like double\-submit guards, type conversion, object population, validation, file upload, page preparation, and more, are all implemented with the help of Interceptors\. Each and every Interceptor is pluggable, so you can decide exactly which features an Action needs to support\. - -Interceptors can be configured on a per\-action basis\. Your own custom Interceptors can be mixed\-and\-matched with the Interceptors bundled with the framework\. Interceptors "set the stage" for the Action classes, doing much of the "heavy lifting" before the Action executes\. +Interceptors can be configured on a per-action basis. Your own custom Interceptors can be mixed-and-matched with +the Interceptors bundled with the framework. Interceptors "set the stage" for the Action classes, doing much of +the "heavy lifting" before the Action executes. |Action Lifecyle| |---------------| -|\ -\ - +| | -In some cases, an Interceptor might keep an Action from firing, because of a double\-submit or because validation failed\. Interceptors can also change the state of an Action before it executes\. - -The Interceptors are defined in a stack that specifies the execution order\. In some cases, the order of the Interceptors on the stack can be very important\. +In some cases, an Interceptor might keep an Action from firing, because of a double-submit or because validation failed. +Interceptors can also change the state of an Action before it executes. -####Configuring Interceptors#### +The Interceptors are defined in a stack that specifies the execution order. In some cases, the order of the Interceptors +on the stack can be very important. -**struts\.xml** +## Configuring Interceptors +**struts.xml** -~~~~~~~ +```xml <package name="default" extends="struts-default"> <interceptors> <interceptor name="timer" class=".."/> @@ -51,17 +61,16 @@ The Interceptors are defined in a stack that specifies the execution order\. In <result name="success" type="redirectAction">/secure/home</result> </action> </package> +``` -~~~~~~~ - -####Stacking Interceptors#### - -With most web applications, we find ourselves wanting to apply the same set of Interceptors over and over again\. Rather than reiterate the same list of Interceptors, we can bundle these Interceptors together using an Interceptor Stack\. +## Stacking Interceptors -**struts\.xml** +With most web applications, we find ourselves wanting to apply the same set of Interceptors over and over again. Rather +than reiterate the same list of Interceptors, we can bundle these Interceptors together using an Interceptor Stack. +**struts.xml** -~~~~~~~ +```xml <package name="default" extends="struts-default"> <interceptors> <interceptor name="timer" class=".."/> @@ -78,92 +87,88 @@ With most web applications, we find ourselves wanting to apply the same set of I <result name="success" type="redirectAction">/secure/home</result> </action> </package> +``` -~~~~~~~ - -Looking inside - -~~~~~~~ -struts-default.xml -~~~~~~~ -, we can see how it's done\. - -#####The Default Configuration##### - - +Looking inside `struts-default.xml`, we can see how it's done. -~~~~~~~ -{snippet:id=all|lang=xml|url=struts2/core/src/main/resources/struts-default.xml} -~~~~~~~ -Since the +## The Default Configuration -~~~~~~~ -struts-default.xml -~~~~~~~ - is included in the application's configuration by default, all of the predefined interceptors and stacks are available "out of the box"\. +{% highlight xml %} +{% remote_file_content https://raw.githubusercontent.com/apache/struts/master/core/src/main/resources/struts-default.xml %} +{% endhighlight %} -####Framework Interceptors#### +Since the `struts-default.xml` is included in the application's configuration by default, all of the predefined +interceptors and stacks are available "out of the box". -Interceptor classes are also defined using a key\-value pair specified in the Struts configuration file\. The names specified below come specified in [struts-default.xml](struts-default-xml.html)\. If you extend the +## Framework Interceptors -~~~~~~~ -struts-default -~~~~~~~ - package, then you can use the names below\. Otherwise, they must be defined in your package with a name\-class pair specified in the \<interceptors\> tag\. +Interceptor classes are also defined using a key-value pair specified in the Struts configuration file. The names +specified below come specified in [struts-default.xml](struts-default-xml.html). If you extend the `struts-default` +package, then you can use the names below. Otherwise, they must be defined in your package with a name-class pair +specified in the `<interceptors/>` tag. |Interceptor|Name|Description| |-----------|----|-----------| -|[Alias Interceptor](alias-interceptor.html)|alias|Converts similar parameters that may be named differently between requests\.| -|[Chaining Interceptor](chaining-interceptor.html)|chain|Makes the previous Action's properties available to the current Action\. Commonly used together with \<result type="chain"\> (in the previous Action)\.| -|[Checkbox Interceptor](checkbox-interceptor.html)|checkbox|Adds automatic checkbox handling code that detect an unchecked checkbox and add it as a parameter with a default (usually 'false') value\. Uses a specially named hidden field to detect unsubmitted checkboxes\. The default unchecked value is overridable for non\-boolean value'd checkboxes\.| -|[Cookie Interceptor](cookie-interceptor.html)|cookie|Inject cookie with a certain configurable name / value into action\. (Since 2\.0\.7\.)| -|[CookieProvider Interceptor](cookie-provider-interceptor.html)|cookieProvider|Transfer cookies from action to response (Since 2\.3\.15\.)| +|[Alias Interceptor](alias-interceptor.html)|alias|Converts similar parameters that may be named differently between requests.| +|[Chaining Interceptor](chaining-interceptor.html)|chain|Makes the previous Action's properties available to the current Action. Commonly used together with <result type="chain"> (in the previous Action).| +|[Checkbox Interceptor](checkbox-interceptor.html)|checkbox|Adds automatic checkbox handling code that detect an unchecked checkbox and add it as a parameter with a default (usually 'false') value. Uses a specially named hidden field to detect unsubmitted checkboxes. The default unchecked value is overridable for non-boolean value'd checkboxes.| +|[Cookie Interceptor](cookie-interceptor.html)|cookie|Inject cookie with a certain configurable name / value into action. (Since 2.0.7.)| +|[CookieProvider Interceptor](cookie-provider-interceptor.html)|cookieProvider|Transfer cookies from action to response (Since 2.3.15.)| |[Conversion Error Interceptor](conversion-error-interceptor.html)|conversionError|Adds conversion errors from the ActionContext to the Action's field errors| |[Create Session Interceptor](create-session-interceptor.html)|createSession|Create an HttpSession automatically, useful with certain Interceptors that require a HttpSession to work properly (like the TokenInterceptor)| -|[DebuggingInterceptor](debugging-interceptor.html)|debugging|Provides several different debugging screens to provide insight into the data behind the page\.| -|[Execute and Wait Interceptor](execute-and-wait-interceptor.html)|execAndWait|Executes the Action in the background and then sends the user off to an intermediate waiting page\.| -|[Exception Interceptor](exception-interceptor.html)|exception|Maps exceptions to a result\.| -|[File Upload Interceptor](file-upload-interceptor.html)|fileUpload|An Interceptor that adds easy access to file upload support\.| -|[I18n Interceptor](i18n-interceptor.html)|i18n|Remembers the locale selected for a user's session\.| -|[Logger Interceptor](logger-interceptor.html)|logger|Outputs the name of the Action\.| -|[Message Store Interceptor](message-store-interceptor.html)|store|Store and retrieve action messages / errors / field errors for action that implements ValidationAware interface into session\.| -|[Model Driven Interceptor](model-driven-interceptor.htm)|modelDriven|If the Action implements ModelDriven, pushes the getModel Result onto the Value Stack\.| -|[Scoped Model Driven Interceptor](scoped-model-driven-interceptor.html)|scopedModelDriven|If the Action implements ScopedModelDriven, the interceptor retrieves and stores the model from a scope and sets it on the action calling setModel\.| -|[Parameters Interceptor](parameters-interceptor.html)|params|Sets the request parameters onto the Action\.| -|[Prepare Interceptor](prepare-interceptor.html)|prepare|If the Action implements Preparable, calls its prepare method\.| -|[Scope Interceptor](scope-interceptor.html)|scope|Simple mechanism for storing Action state in the session or application scope\.| -|[Servlet Config Interceptor](servlet-config-interceptor.html)|servletConfig|Provide access to Maps representing HttpServletRequest and HttpServletResponse\.| -|[Static Parameters Interceptor](static-parameters-interceptor.html)|staticParams|Sets the struts\.xml defined parameters onto the action\. These are the \<param\> tags that are direct children of the \<action\> tag\.| -|[Roles Interceptor](roles-interceptor.html)|roles|Action will only be executed if the user has the correct JAAS role\.| +|[DebuggingInterceptor](debugging-interceptor.html)|debugging|Provides several different debugging screens to provide insight into the data behind the page.| +|[Execute and Wait Interceptor](execute-and-wait-interceptor.html)|execAndWait|Executes the Action in the background and then sends the user off to an intermediate waiting page.| +|[Exception Interceptor](exception-interceptor.html)|exception|Maps exceptions to a result.| +|[File Upload Interceptor](file-upload-interceptor.html)|fileUpload|An Interceptor that adds easy access to file upload support.| +|[I18n Interceptor](i18n-interceptor.html)|i18n|Remembers the locale selected for a user's session.| +|[Logger Interceptor](logger-interceptor.html)|logger|Outputs the name of the Action.| +|[Message Store Interceptor](message-store-interceptor.html)|store|Store and retrieve action messages / errors / field errors for action that implements ValidationAware interface into session.| +|[Model Driven Interceptor](model-driven-interceptor.htm)|modelDriven|If the Action implements ModelDriven, pushes the getModel Result onto the Value Stack.| +|[Scoped Model Driven Interceptor](scoped-model-driven-interceptor.html)|scopedModelDriven|If the Action implements ScopedModelDriven, the interceptor retrieves and stores the model from a scope and sets it on the action calling setModel.| +|[Parameters Interceptor](parameters-interceptor.html)|params|Sets the request parameters onto the Action.| +|[Prepare Interceptor](prepare-interceptor.html)|prepare|If the Action implements Preparable, calls its prepare method.| +|[Scope Interceptor](scope-interceptor.html)|scope|Simple mechanism for storing Action state in the session or application scope.| +|[Servlet Config Interceptor](servlet-config-interceptor.html)|servletConfig|Provide access to Maps representing HttpServletRequest and HttpServletResponse.| +|[Static Parameters Interceptor](static-parameters-interceptor.html)|staticParams|Sets the struts.xml defined parameters onto the action. These are the <param> tags that are direct children of the <action> tag.| +|[Roles Interceptor](roles-interceptor.html)|roles|Action will only be executed if the user has the correct JAAS role.| |[Timer Interceptor](timer-interceptor.html)|timer|Outputs how long the Action takes to execute (including nested Interceptors and View)| -|[Token Interceptor](token-interceptor.html)|token|Checks for valid token presence in Action, prevents duplicate form submission\.| +|[Token Interceptor](token-interceptor.html)|token|Checks for valid token presence in Action, prevents duplicate form submission.| |[Token Session Interceptor](token-session-interceptor.html)|tokenSession|Same as Token Interceptor, but stores the submitted data in session when handed an invalid token| -|[Validation Interceptor](validation-interceptor.html)|validation|Performs validation using the validators defined in _action_ \-validation\.xml| -|[Default Workflow Interceptor](default-workflow-interceptor.html)|workflow|Calls the validate method in your Action class\. If Action errors are created then it returns the INPUT view\.| +|[Validation Interceptor](validation-interceptor.html)|validation|Performs validation using the validators defined in _action_ -validation.xml| +|[Default Workflow Interceptor](default-workflow-interceptor.html)|workflow|Calls the validate method in your Action class. If Action errors are created then it returns the INPUT view.| |[Parameter Filter Interceptor](parameter-filter-interceptor.html)|N/A|Removes parameters from the list of those available to Actions| |[Multiselect Interceptor](multiselect-interceptor.html)|multiselect|Like the checkbox interceptor detects that no value was selected for a field with multiple values (like a select) and adds an empty parameter| |[NoOp Interceptor](no-op-interceptor.html)|noop|Does nothing, just passes invocation further, used in empty stack| -Since 2\.0\.7, Interceptors and Results with hyphenated names were converted to camelCase\. (The former model\-driven is now modelDriven\.) The original hyphenated names are retained as "aliases" until Struts 2\.1\.0\. For clarity, the hyphenated versions are not listed here, but might be referenced in prior versions of the documentation\. +Since 2.0.7, Interceptors and Results with hyphenated names were converted to camelCase. (The former model-driven is +now modelDriven.) The original hyphenated names are retained as "aliases" until Struts 2.1.0. For clarity, +the hyphenated versions are not listed here, but might be referenced in prior versions of the documentation. -> +## Method Filtering -#####Method Filtering##### +`MethodFilterInterceptor` is an abstract `Interceptor` used as a base class for interceptors that will filter execution +based on method names according to specified included/excluded method lists. +Settable parameters are as follows: +- excludeMethods - method names to be excluded from interceptor processing +- includeMethods - method names to be included in interceptor processing +> If method name are available in both includeMethods and excludeMethods, it will be considered as an included method: +> includeMethods takes precedence over excludeMethods. -~~~~~~~ -{snippet:id=javadoc|javadoc=true|url=com.opensymphony.xwork2.interceptor.MethodFilterInterceptor} -~~~~~~~ +Interceptors that extends this capability include: +- `TokenInterceptor` +- `TokenSessionStoreInterceptor` +- `DefaultWorkflowInterceptor` +- `ValidationInterceptor` -#####Interceptor Parameter Overriding##### +## Interceptor Parameter Overriding Interceptor's parameter could be overridden through the following ways : **Method 1**: - -~~~~~~~ +```xml <action name="myAction" class="myActionClass"> <interceptor-ref name="exception"/> <interceptor-ref name="alias"/> @@ -178,79 +183,42 @@ Interceptor's parameter could be overridden through the following ways : <interceptor-ref name="params"/> <interceptor-ref name="conversionError"/> <interceptor-ref name="validation"> - <param name="excludeMethods">myValidationExcudeMethod</param> + <param name="excludeMethods">myValidationExcludeMethod</param> </interceptor-ref> <interceptor-ref name="workflow"> <param name="excludeMethods">myWorkflowExcludeMethod</param> </interceptor-ref> </action> - -~~~~~~~ +``` **Method 2**: - -~~~~~~~ +```xml <action name="myAction" class="myActionClass"> <interceptor-ref name="defaultStack"> <param name="validation.excludeMethods">myValidationExcludeMethod</param> <param name="workflow.excludeMethods">myWorkflowExcludeMethod</param> </interceptor-ref> </action> +``` -~~~~~~~ - -In the first method, the whole default stack is copied and the parameter then changed accordingly\. - -In the second method, the - -~~~~~~~ -interceptor-ref -~~~~~~~ - refers to an existing interceptor\-stack, namely - -~~~~~~~ -defaultStack -~~~~~~~ - in this example, and override the - -~~~~~~~ -validator -~~~~~~~ - and - -~~~~~~~ -workflow -~~~~~~~ - interceptor - -~~~~~~~ -excludeMethods -~~~~~~~ - attribute\. Note that in the +In the first method, the whole default stack is copied and the parameter then changed accordingly. -~~~~~~~ -param -~~~~~~~ - tag, the name attribute contains a dot (\.) the word before the dot(\.) specifies the interceptor name whose parameter is to be overridden and the word after the dot (\.) specifies the parameter itself\. The syntax is as follows: +In the second method, the `interceptor-ref` refers to an existing interceptor-stack, namely `defaultStack` in this +example, and override the `validator` and `workflow` interceptor `excludeMethods` attribute. Note that in the `param` +tag, the name attribute contains a dot (.) the word before the dot(.) specifies the interceptor name whose parameter is +to be overridden and the word after the dot (.) specifies the parameter itself. The syntax is as follows: - -~~~~~~~ +``` <interceptor-name>.<parameter-name> +``` -~~~~~~~ - -Note also that in this case the - -~~~~~~~ -interceptor-ref -~~~~~~~ - name attribute is used to indicate an interceptor stack which makes sense as if it is referring to the interceptor itself it would be just using Method 1 describe above\. +Note also that in this case the `interceptor-ref` name attribute is used to indicate an interceptor stack which makes +sense as if it is referring to the interceptor itself it would be just using Method 1 describe above. **Method 3**: - -~~~~~~~ +```xml <interceptors> <interceptor-stack name="parentStack"> <interceptor-ref name="defaultStack"> @@ -260,27 +228,24 @@ interceptor-ref </interceptors> <default-interceptor-ref name="parentStack"/> +``` -~~~~~~~ - -#####Interceptor Parameter Overriding Inheritance##### +## Interceptor Parameter Overriding Inheritance -Parameters override are not inherited in interceptors, meaning that the last set of overridden parameters will be used\. For example, if a stack overrides the parameter "defaultBlock" for the "postPrepareParameterFilter" interceptor as: +Parameters override are not inherited in interceptors, meaning that the last set of overridden parameters will be used. +For example, if a stack overrides the parameter "defaultBlock" for the "postPrepareParameterFilter" interceptor as: - -~~~~~~~ +```xml <interceptor-stack name="parentStack"> <interceptor-ref name="postPrepareParameterFilter"> <param name="defaultBlock">true</param> </interceptor-ref> </interceptor-stack> - -~~~~~~~ +``` and an action overrides the "allowed" for "postPrepareParameterFilter": - -~~~~~~~ +```xml <package name="child2" namespace="/child" extends="parentPackage"> <action name="list" class="SomeAction"> <interceptor-ref name="parentStack"> @@ -288,39 +253,32 @@ and an action overrides the "allowed" for "postPrepareParameterFilter": </interceptor-ref> </action> </package> +``` -~~~~~~~ - -Then, only "allowed" will be overridden for the "postPrepareParameterFilter" interceptor in that action, the other params will be null\. - -#####Lazy parameters##### +Then, only "allowed" will be overridden for the "postPrepareParameterFilter" interceptor in that action, +the other params will be null. +## Lazy parameters -This functionality was added in Struts 2\.5\.9 +This functionality was added in Struts 2.5.9 -| +It is possible to define an interceptor with parameters evaluated during action invocation. In such case +the interceptor must be marked with `WithLazyParams` interface. This must be developer's decision as interceptor +must be aware of having those parameters set during invocation and not when the interceptor is created as it happens +in normal way. -It is possible to define an interceptor with parameters evaluated during action invocation\. In such case the interceptor must be marked with +Params are evaluated as any other expression starting with from action as a top object. -~~~~~~~ -WithLazyParams -~~~~~~~ - interface\. This must be developer's decision as interceptor must be aware of having those parameters set during invocation and not when the interceptor is created as it happens in normal way\. - -Params are evaluated as any other expression starting with from action as a top object\. - - -~~~~~~~ +```xml <action name="LazyFoo" class="com.opensymphony.xwork2.SimpleAction"> <result name="success">result.jsp</result> <interceptor-ref name="lazy"> <param name="foo">${bar}</param> </interceptor-ref> </action> -~~~~~~~ +``` - -~~~~~~~ +```xml public class MockLazyInterceptor extends AbstractInterceptor implements WithLazyParams { private String foo = ""; @@ -334,36 +292,30 @@ public class MockLazyInterceptor extends AbstractInterceptor implements WithLazy return invocation.invoke(); } } -~~~~~~~ - -Please be aware that order of interceptors can matter when want to access parameters passed via request as those parameters are set by [Parameters Interceptor](parameters-interceptor.html). +``` -#####Order of Interceptor Execution##### +Please be aware that order of interceptors can matter when want to access parameters passed via request as those +parameters are set by [Parameters Interceptor](parameters-interceptor.html). -Interceptors provide an excellent means to wrap before/after processing\. The concept reduces code duplication (think AOP)\. +## Order of Interceptor Execution +Interceptors provide an excellent means to wrap before/after processing. The concept reduces code duplication (think AOP). -~~~~~~~ +```xml <interceptor-stack name="xaStack"> <interceptor-ref name="thisWillRunFirstInterceptor"/> <interceptor-ref name="thisWillRunNextInterceptor"/> <interceptor-ref name="followedByThisInterceptor"/> <interceptor-ref name="thisWillRunLastInterceptor"/> </interceptor-stack> +``` -~~~~~~~ +> Note that some Interceptors will interrupt the stack/chain/flow ... so the order is very important. - (\!) Note that some Interceptors will interrupt the stack/chain/flow \.\.\. so the order is very important\. +Interceptors implementing `com.opensymphony.xwork2.interceptor.PreResultListener` will run after the Action executes +but before the Result executes. -Interceptors implementing - -~~~~~~~ -com.opensymphony.xwork2.interceptor.PreResultListener -~~~~~~~ - will run after the Action executes but before the Result executes\. - - -~~~~~~~ +``` thisWillRunFirstInterceptor thisWillRunNextInterceptor followedByThisInterceptor @@ -376,5 +328,4 @@ thisWillRunFirstInterceptor followedByThisInterceptor thisWillRunNextInterceptor thisWillRunFirstInterceptor - -~~~~~~~ +```
