com.opensymphony.webwork.interceptor
Class ServletConfigInterceptor

java.lang.Object
  com.opensymphony.xwork.interceptor.AroundInterceptor
      com.opensymphony.webwork.interceptor.ServletConfigInterceptor

All Implemented Interfaces:

WebWorkStatics, com.opensymphony.xwork.interceptor.Interceptor, Serializable

public class ServletConfigInterceptor
extends com.opensymphony.xwork.interceptor.AroundInterceptor
implements WebWorkStatics

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:

• ServletContextAware
• ServletRequestAware
• ServletResponseAware
• ParameterAware
• SessionAware
• ApplicationAware
• PrincipalAware

Interceptor parameters:

• None

Extending the interceptor:

There are no known extension points for this interceptor.

Example code:

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

Author:

Patrick Lightbody, Bill Lynch (docs)

See Also:

ServletContextAware, ServletRequestAware, ServletResponseAware, ParameterAware, SessionAware, ApplicationAware, PrincipalAware, Serialized Form

Field Summary

Fields inherited from class com.opensymphony.xwork.interceptor.AroundInterceptor

log

Fields inherited from interface com.opensymphony.webwork.WebWorkStatics

HTTP_REQUEST, HTTP_RESPONSE, PAGE_CONTEXT, SERVLET_CONTEXT, SERVLET_DISPATCHER

Constructor Summary

ServletConfigInterceptor()

Method Summary

protected void	after(com.opensymphony.xwork.ActionInvocation dispatcher, String result)
protected void	before(com.opensymphony.xwork.ActionInvocation invocation) Sets action properties based on the interfaces an action implements.

Methods inherited from class com.opensymphony.xwork.interceptor.AroundInterceptor

destroy, init, intercept

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

after

protected void after(com.opensymphony.xwork.ActionInvocation dispatcher,
                     String result)
              throws Exception

Specified by:

after in class com.opensymphony.xwork.interceptor.AroundInterceptor

Throws:

Exception

before

protected void before(com.opensymphony.xwork.ActionInvocation invocation)
               throws 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:

before in class com.opensymphony.xwork.interceptor.AroundInterceptor

Parameters:

invocation - an encapsulation of the action execution state.

Throws:

Exception - if an error occurs when setting action properties.