Apache Struts 2 Documentation > Home > Tutorials > Bootstrap > TutorialLesson06 |

Apache Struts 2 Documentation
TutorialLesson06
Edit Page Browse Space Add Page Add News
Added by vitorsouza, last edited by Ted Husted on Sep 03, 2006 (view change) show comment hide comment
Comment:
Update parent page
View page history

# Lesson 5: Interceptors

Interceptors allow arbitrary code to be included in the call stack for your action before and/or after processing the action, which can vastly simplify your code itself and provide excellent opportunities for code reuse. Many of the features of XWork and WebWork are implemented as interceptors and can be applied via external configuration along with your own Interceptors in whatever order you specify for any set of actions you define.

In other words, when you access a `*.action` URL, WebWork's `ServletDispatcher` proceeds to the invocation of the an action object. Before it is executed, however, the invocation can be intercepted by another object, that is hence called interceptor. To have an interceptor executed before (or after) a given action, just configure `xwork.xml` properly, like the example below, taken from lesson 4.1.1:

### Interceptor configuration from lesson 4.1.1:

    <action name="formProcessing" class="lesson04_01_01.FormProcessingAction">
    	<result name="input" type="dispatcher">ex01-index.jsp</result>
    	<result name="success" type="dispatcher">ex01-success.jsp</result>
    	<interceptor-ref name="validationWorkflowStack" />
    </action>

As you can see, lesson 4.1.1's `formProcessing` Action uses the `validationWorkflowStack`. That is an interceptor stack, which organizes a bunch of interceptors in the order in which they are to be executed. That stack is configured in `webwork-default.xml`, so all we have to do to use it is declare a `<interceptor-ref />` under the action configuration or a `<default-interceptor-ref />`, under package configuration, as seen in lesson 3's first example:

### Interceptor configuration from lesson 3.1:

    <!DOCTYPE xwork PUBLIC "-//OpenSymphony Group//XWork 1.0//EN"
    "http://www.opensymphony.com/xwork/xwork-1.0.dtd">

    <xwork>
    	<!-- Include webwork defaults (from WebWork JAR). -->
    	<include file="webwork-default.xml" />

    	<!-- Configuration for the default package. -->
    	<package name="default" extends="webwork-default">
    		<!-- Default interceptor stack. -->
    		<default-interceptor-ref name="defaultStack" />

    		<!-- Action: Lesson 03: HelloWebWorldAction. -->
    		<action name="helloWebWorld" class="lesson03.HelloWebWorldAction">
    			<result name="success" type="dispatcher">ex01-success.jsp</result>
    		</action>
    	</package>
    </xwork>

But let's see how it works from scracth:

1. Create an interceptor class, which is a class that implements the `com.opensymphony.xwork.interceptor.Interceptor` interface (bundled in `xwork-1.0.jar`);
2. Declare the class in your XML configuration file (`xwork.xml`) using the element `<interceptor />` nested within `<interceptors />`;
3. Create stacks of interceptors, using the `<interceptor-stack />` element (optional);
4. Determine which interceptors are used by which action, using `<interceptor-ref />` or `<default-interceptor-ref />`. The former defines the interceptors to be used in a specific action, while the latter determines the default interceptor stack to be used by all actions that do not specify their own `<interceptor-ref />`.

Looking inside `webwork-default.xml` we can see how it's done:

### webwork-default.xml:

    <!DOCTYPE xwork PUBLIC "-//OpenSymphony Group//XWork 1.0//EN"
    "http://www.opensymphony.com/xwork/xwork-1.0.dtd">

    <xwork>
    	<package name="webwork-default">
    		<result-types>
    			<result-type name="dispatcher" default="true"
    				class="com.opensymphony.webwork.dispatcher.ServletDispatcherResult"/>
    			<result-type name="redirect"
    				class="com.opensymphony.webwork.dispatcher.ServletRedirectResult"/>
    			<result-type name="velocity"
    				class="com.opensymphony.webwork.dispatcher.VelocityResult"/>
    			<result-type name="chain"
    				class="com.opensymphony.xwork.ActionChainResult"/>
    			<result-type name="xslt"
    				class="com.opensymphony.webwork.views.xslt.XSLTResult"/>
    		</result-types>

    		<interceptors>
    			<interceptor name="timer"
    				class="com.opensymphony.xwork.interceptor.TimerInterceptor"/>
    			<interceptor name="logger"
    				class="com.opensymphony.xwork.interceptor.LoggingInterceptor"/>
    			<interceptor name="chain"
    				class="com.opensymphony.xwork.interceptor.ChainingInterceptor"/>
    			<interceptor name="static-params"
    				class="com.opensymphony.xwork.interceptor.StaticParametersInterceptor"/>
    			<interceptor name="params"
    				class="com.opensymphony.xwork.interceptor.ParametersInterceptor"/>
    			<interceptor name="model-driven"
    				class="com.opensymphony.xwork.interceptor.ModelDrivenInterceptor"/>
    			<interceptor name="component"
    				class="com.opensymphony.xwork.interceptor.component.ComponentInterceptor"/>
    			<interceptor name="token"
    				class="com.opensymphony.webwork.interceptor.TokenInterceptor"/>
    			<interceptor name="token-session"
    				class="com.opensymphony.webwork.interceptor.TokenSessionStoreInterceptor"/>
    			<interceptor name="validation"
    				class="com.opensymphony.xwork.validator.ValidationInterceptor"/>
    			<interceptor name="workflow"
    				class="com.opensymphony.xwork.interceptor.DefaultWorkflowInterceptor"/>
    			<interceptor name="servlet-config"
    				class="com.opensymphony.webwork.interceptor.ServletConfigInterceptor"/>
    			<interceptor name="prepare"
    				class="com.opensymphony.xwork.interceptor.PrepareInterceptor"/>
    			<interceptor name="conversionError"
    				class="com.opensymphony.webwork.interceptor.WebWorkConversionErrorInterceptor"/>
    			<interceptor-stack name="defaultStack">
    				<interceptor-ref name="static-params"/>
    				<interceptor-ref name="params"/>
    				<interceptor-ref name="conversionError"/>
    			</interceptor-stack>
    			<interceptor-stack name="validationWorkflowStack">
    				<interceptor-ref name="defaultStack"/>
    				<interceptor-ref name="validation"/>
    				<interceptor-ref name="workflow"/>
    			</interceptor-stack>
    		</interceptors>
    	</package>
    </xwork>

Since we included `webwork-default.xml` in our `xwork.xml`, all the interceptors and stacks above are available for us to use in our actions. Here's what these interceptors do:

- timer: clocks how long the action (including nested interceptors and view) takes to execute;
- logger: logs the action being executed;
- chain: makes the previous action's properties available to the current action. Used to make action chaining (reference: Result Types);
- static-params: sets the parameters defined in `xwork.xml` onto the action. These are the `<param />` tags that are direct children of the `<action />` tag;
- params: sets the request (POST and GET) parameters onto the action class. We have seen an example of this in lesson 3;
- model-driven: if the action implements `ModelDriven`, pushes the `getModel()` result onto the Value Stack;
- component: enables and makes registered components available to the actions. (reference: IoC & Components);
- token: checks for valid token presence in action, prevents duplicate form submission;
- token-session: same as above, but storing the submitted data in session when handed an invalid token;
- validation: performs validation using the validators defined in {`Action}-validation.xml` (reference: Validation). We've seen an example of this in lesson 4.1.1;
- workflow: calls the validate method in your action class. If action errors created then it returns the `INPUT` view. Good to use together with the validation interceptor (reference: Validation);
- servlet-config: give access to `HttpServletRequest` and `HttpServletResponse` (think twice before using this since this ties you to the Servlet API);
- prepare: allows you to programmatic access to your Action class before the parameters are set on it.;
- conversionError: help needed here.

## Building your own Interceptor

If none of the above interceptors suit your particular need, you will have to implement your own interceptor. Fortunately, this is an easy task to accomplish. Suppose we need an interceptor that places a greeting in the Session according to the time of the day (morning, afternoon or evening). Here's how we could implement it:

### GreetingInterceptor.java:

    package lesson05;

    import java.util.Calendar;
    import com.opensymphony.xwork.interceptor.Interceptor;
    import com.opensymphony.xwork.ActionInvocation;

    public class GreetingInterceptor implements Interceptor {
    	public void init() { }
    	public void destroy() { }
    	public String intercept(ActionInvocation invocation) throws Exception {
    		Calendar calendar = Calendar.getInstance();
    		int hour = calendar.get(Calendar.HOUR_OF_DAY);
    		String greeting = (hour < 6) ? "Good evening" :
    			((hour < 12) ? "Good morning":
    			((hour < 18) ? "Good afternoon": "Good evening"));

    		invocation.getInvocationContext().getSession().put("greeting", greeting);

    		String result = invocation.invoke();

    		return result;
    	}
    }

### xwork.xml:

    <!DOCTYPE xwork PUBLIC "-//OpenSymphony Group//XWork 1.0//EN"
    "http://www.opensymphony.com/xwork/xwork-1.0.dtd">

    <xwork>
    	<!-- Include webwork defaults (from WebWork JAR). -->
    	<include file="webwork-default.xml" />

    	<!-- Configuration for the default package. -->
    	<package name="default" extends="webwork-default">
    		<interceptors>
    			<interceptor name="greeting" class="section02.lesson05.GreetingInterceptor" />
    		</interceptors>

    		<!-- Action: Lesson 5: GreetingInterceptor. -->
    		<action name="greetingAction" class="lesson05.GreetingAction">
    			<result name="success" type="velocity">ex01-result.vm</result>
    			<interceptor-ref name="greeting" />
    		</action>
    	</package>
    </xwork>

### GreetingAction.java:

    package lesson05;

    import com.opensymphony.xwork.ActionSupport;

    public class GreetingAction extends ActionSupport {
    	public String execute() throws Exception {
    		return SUCCESS;
    	}
    }

### ex01-result.vm:

    <html>
    <head>
    <title>WebWork Tutorial - Lesson 5 - Example 1</title>
    </head>
    <body>

    #set ($ses = $req.getSession())
    <p><b>${ses.getAttribute('greeting')}!</b></p>

    </body>
    </html>

Let's take a look at our interceptor class first. As explained before, the interceptor must implement `com.opensymphony.xwork.interceptor.Interceptor`'s methods: `init()`, called during interceptor initialization, `destroy()`, called during destruction, and most importantly, `intercept(ActionInvocation invocation)`, which is where we place the code that does the work.

Notice that our interceptor returns the result from `invocation.invoke()` which is the method responsible for executing the next interceptor in the stack or, if this is the last one, the action. This means that the interceptor has the power of short-circuiting the action invocation and return a result string without executing the action at all! Use this with caution, though.

One other thing that interceptors can do is execute code after the action has executed. To do that, just place code after the invocation.invoke() call. WebWork provides an abstract class that already implements this kind of behaviour: `com.opensymphony.xwork.interceptor.AroundInterceptor`. Just extend it and implement the methods `before(ActionInvocation invocation)` and `after(ActionInvocation dispatcher, String result)`.

The `xwork.xml` configuration, the action class and the result page are pretty straightforward and require no further explanation.

> Try the example!

Previous Lesson | End of Tutorial

Children Show Children Hide Children
TutorialEnd (Apache Struts 2 Documentation)