Apache Struts 2 Documentation > Home > Guides > Core Developers Guide > Interceptors > Chaining Interceptor |

Apache Struts 2 Documentation
Chaining Interceptor
Edit Page Browse Space Add Page Add News
Added by benh, last edited by Philip Luppens on Feb 10, 2007 (view change) show comment hide comment
Comment: Fixed macro url
View page history

An interceptor that copies all the properties of every object in the value stack to the currently executing object, except for any object that implements Unchainable. A collection of optional includes and excludes may be provided to control how and which parameters are copied. Only includes or excludes may be specified. Specifying both results in undefined behavior. See the javadocs for {@link OgnlUtil#copy(Object, Object, java.util.Map, java.util.Collection, java.util.Collection)} for more information.

It is important to remember that this interceptor does nothing if there are no objects already on the stack. This means two things: One, you can safely apply it to all your actions without any worry of adverse affects. Two, it is up to you to ensure an object exists in the stack prior to invoking this action. The most typical way this is done is through the use of the chain result type, which combines with this interceptor to make up the action chaining feature.

## Parameters

- excludes (optional) - the list of parameter names to exclude from copying (all others will be included).

- includes (optional) - the list of parameter names to include when copying (all others will be excluded).

## Extending the Interceptor

There are no known extension points to this interceptor.

## Examples

    <action name="someAction" class="com.examples.SomeAction">
        <interceptor-ref name="basicStack"/>
        <result name="success" type="chain">otherAction</result>
    </action>

    <action name="otherAction" class="com.examples.OtherAction">
        <interceptor-ref name="chain"/>
        <interceptor-ref name="basicStack"/>
        <result name="success">good_result.ftl</result>
    </action>