/*
* $Id$
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.struts2.interceptor;
import com.opensymphony.xwork2.ActionInvocation;
import com.opensymphony.xwork2.interceptor.AbstractInterceptor;
import com.opensymphony.xwork2.util.logging.Logger;
import com.opensymphony.xwork2.util.logging.LoggerFactory;
import org.apache.struts2.ServletActionContext;
import org.apache.struts2.dispatcher.SessionMap;
import javax.servlet.http.HttpSession;
/**
* <!-- START SNIPPET: description -->
*
* This interceptor creates the HttpSession if it doesn't exist, also SessionMap is recreated and put in ServletActionContext.
* <p/>
* This is particular useful when using the <@s.token> tag in freemarker templates.
* The tag <b>do</b> require that a HttpSession is already created since freemarker commits
* the response to the client immediately.
*
* <!-- END SNIPPET: description -->
*
* <p/> <u>Interceptor parameters:</u>
*
*
* <!-- START SNIPPET: extending -->
*
* <ul>
* <li>none</li>
* </ul>
*
* <!-- END SNIPPET: extending -->
*
*
* <!-- START SNIPPET: parameters -->
*
* <ul>
*
* <li>None</li>
*
* </ul>
*
* <!-- END SNIPPET: parameters -->
*
* <b>Example:</b>
*
* <pre>
* <!-- START SNIPPET: example -->
*
* <action name="someAction" class="com.examples.SomeAction">
* <interceptor-ref name="createSession"/>
* <interceptor-ref name="defaultStack"/>
* <result name="input">input_with_token_tag.ftl</result>
* </action>
*
* <!-- END SNIPPET: example -->
* </pre>
*
* @version $Date$ $Id$
*/
public class CreateSessionInterceptor extends AbstractInterceptor {
private static final long serialVersionUID = -4590322556118858869L;
private static final Logger LOG = LoggerFactory.getLogger(CreateSessionInterceptor.class);
/* (non-Javadoc)
* @see com.opensymphony.xwork2.interceptor.Interceptor#intercept(com.opensymphony.xwork2.ActionInvocation)
*/
public String intercept(ActionInvocation invocation) throws Exception {
HttpSession httpSession = ServletActionContext.getRequest().getSession(false);
if (httpSession == null) {
if (LOG.isDebugEnabled()) {
LOG.debug("Creating new HttpSession and new SessionMap in ServletActionContext");
}
ServletActionContext.getRequest().getSession(true);
ServletActionContext.getContext().setSession(new SessionMap<String, Object>(ServletActionContext.getRequest()));
}
return invocation.invoke();
}
}