Home » xwork-2.1.5 » com.opensymphony » xwork2 » interceptor » [javadoc | source]
com.opensymphony.xwork2.interceptor
public class: AliasInterceptor [javadoc | source]
java.lang.Object
   com.opensymphony.xwork2.interceptor.AbstractInterceptor
      com.opensymphony.xwork2.interceptor.AliasInterceptor

All Implemented Interfaces:
    Interceptor

The aim of this Interceptor is to alias a named parameter to a different named parameter. By acting as the glue between actions sharing similiar parameters (but with different names), it can help greatly with action chaining.

Action's alias expressions should be in the form of #{ "name1" : "alias1", "name2" : "alias2" }. This means that assuming an action (or something else in the stack) has a value for the expression named name1 and the action this interceptor is applied to has a setter named alias1, alias1 will be set with the value from name1.

Interceptor parameters:

Extending the interceptor:

This interceptor does not have any known extension points.

Example code:


<action name="someAction" class="com.examples.SomeAction">
    <!-- The value for the foo parameter will be applied as if it were named bar -->
    <param name="aliases">#{ 'foo' : 'bar' }</param>

    <interceptor-ref name="alias"/>
    <interceptor-ref name="basicStack"/>
    <result name="success">good_result.ftl</result>
</action>

Field Summary
protected  String aliasesKey     
protected  ValueStackFactory valueStackFactory     
static  boolean devMode     
Method from com.opensymphony.xwork2.interceptor.AliasInterceptor Summary:
intercept,   setAliasesKey,   setDevMode,   setValueStackFactory
Methods from com.opensymphony.xwork2.interceptor.AbstractInterceptor:
destroy,   init,   intercept
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from com.opensymphony.xwork2.interceptor.AliasInterceptor Detail:
 public String intercept(ActionInvocation invocation) throws Exception 
 public  void setAliasesKey(String aliasesKey) 
    Sets the name of the action parameter to look for the alias map.

    Default is aliases.

 public static  void setDevMode(String mode) 
 public  void setValueStackFactory(ValueStackFactory valueStackFactory)