View Javadoc

1   /*
2    * $Id: PreparatorServlet.java 471756 2006-11-06 15:01:43Z husted $
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  package org.apache.struts2.portlet.context;
22  
23  import java.io.IOException;
24  
25  import javax.servlet.ServletContext;
26  import javax.servlet.ServletException;
27  import javax.servlet.http.HttpServlet;
28  import javax.servlet.http.HttpServletRequest;
29  import javax.servlet.http.HttpServletResponse;
30  
31  import org.apache.commons.logging.Log;
32  import org.apache.commons.logging.LogFactory;
33  import org.apache.struts2.StrutsStatics;
34  
35  import com.opensymphony.xwork2.ActionContext;
36  
37  /***
38   * Since a portlet is not dispatched the same way as a servlet, the
39   * {@link org.apache.struts2.ServletActionContext} is not immediately available, as it
40   * depends on objects from the servlet API. However, the WW2 view implementations require access
41   * to the objects in the {@link org.apache.struts2.ServletActionContext}, and this servlet
42   * makes sure that these are available when the portlet actions are executing the render results.
43   *
44   */
45  public class PreparatorServlet extends HttpServlet implements StrutsStatics {
46  
47      private static final long serialVersionUID = 1853399729352984089L;
48  
49      private final static Log LOG = LogFactory.getLog(PreparatorServlet.class);
50  
51      /***
52       * Prepares the {@link org.apache.struts2.ServletActionContext} with the
53       * {@link ServletContext}, {@link HttpServletRequest} and {@link HttpServletResponse}.
54       */
55      public void service(HttpServletRequest servletRequest,
56              HttpServletResponse servletResponse) throws ServletException,
57              IOException {
58          LOG.debug("Preparing servlet objects for dispatch");
59          ServletContext ctx = getServletContext();
60          ActionContext.getContext().put(SERVLET_CONTEXT, ctx);
61          ActionContext.getContext().put(HTTP_REQUEST, servletRequest);
62          ActionContext.getContext().put(HTTP_RESPONSE, servletResponse);
63          LOG.debug("Preparation complete");
64      }
65  
66  }