Package org.apache.struts2.interceptor
Class ServletConfigInterceptor
java.lang.Object
org.apache.struts2.interceptor.AbstractInterceptor
org.apache.struts2.interceptor.ServletConfigInterceptor
- All Implemented Interfaces:
- Serializable,- ConditionalInterceptor,- Interceptor,- StrutsStatics
 An interceptor which sets action properties based on the interfaces an action implements. For example, if the action
 implements ParametersAware 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
- ParametersAware
- ServletRequestAware
- 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="servletConfig"/>
     <interceptor-ref name="basicStack"/>
     <result name="success">good_result.ftl</result>
 </action>
 
 - 
Field SummaryFields inherited from interface org.apache.struts2.StrutsStaticsACTION_MAPPING, HTTP_REQUEST, HTTP_RESPONSE, PAGE_CONTEXT, SERVLET_CONTEXT, SERVLET_DISPATCHER, STRUTS_ACTION_TAG_INVOCATION
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionintercept(ActionInvocation invocation) Sets action properties based on the interfaces an action implements.Methods inherited from class org.apache.struts2.interceptor.AbstractInterceptordestroy, init, setDisabled, shouldIntercept
- 
Constructor Details- 
ServletConfigInterceptorpublic ServletConfigInterceptor()
 
- 
- 
Method Details- 
interceptSets 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:
- interceptin interface- Interceptor
- Specified by:
- interceptin class- AbstractInterceptor
- Parameters:
- invocation- an encapsulation of the action execution state.
- Returns:
- the return code, either returned from ActionInvocation.invoke(), or from the interceptor itself.
- Throws:
- Exception- if an error occurs when setting action properties.
 
 
-