org.apache.struts2.interceptor
Class ServletConfigInterceptor

java.lang.Object
  extended by com.opensymphony.xwork2.interceptor.AbstractInterceptor
      extended by org.apache.struts2.interceptor.ServletConfigInterceptor
All Implemented Interfaces:
Interceptor, java.io.Serializable, StrutsStatics

public class ServletConfigInterceptor
extends AbstractInterceptor
implements StrutsStatics

An interceptor which sets action properties based on the interfaces an action implements. For example, if the action implements ParameterAware then the action context's parameter map will be set on it.

This interceptor is designed to set all properties an action needs if it's aware of servlet parameters, the servlet context, the session, etc. Interfaces that it supports are:

Interceptor parameters:

Extending the interceptor:

There are no known extension points for this interceptor.

Example code:

 
 <action name="someAction" class="com.examples.SomeAction">
     <interceptor-ref name="servletConfig"/>
     <interceptor-ref name="basicStack"/>
     <result name="success">good_result.ftl</result>
 </action>
 
 

See Also:
ServletContextAware, ServletRequestAware, ServletResponseAware, ParameterAware, SessionAware, ApplicationAware, PrincipalAware, Serialized Form

Field Summary
 
Fields inherited from interface org.apache.struts2.StrutsStatics
HTTP_REQUEST, HTTP_RESPONSE, PAGE_CONTEXT, SERVLET_CONTEXT, SERVLET_DISPATCHER, STRUTS_ACTION_TAG_INVOCATION, STRUTS_PORTLET_CONTEXT
 
Constructor Summary
ServletConfigInterceptor()
           
 
Method Summary
 java.lang.String intercept(ActionInvocation invocation)
          Sets action properties based on the interfaces an action implements.
 
Methods inherited from class com.opensymphony.xwork2.interceptor.AbstractInterceptor
destroy, init
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServletConfigInterceptor

public ServletConfigInterceptor()
Method Detail

intercept

public java.lang.String intercept(ActionInvocation invocation)
                           throws java.lang.Exception
Sets action properties based on the interfaces an action implements. Things like application properties, parameters, session attributes, etc are set based on the implementing interface.

Specified by:
intercept in interface Interceptor
Specified by:
intercept in class AbstractInterceptor
Parameters:
invocation - an encapsulation of the action execution state.
Throws:
java.lang.Exception - if an error occurs when setting action properties.


Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.