View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed.container.invoker;
18  
19  import javax.portlet.PortletRequest;
20  import javax.portlet.PortletResponse;
21  import javax.servlet.ServletRequest;
22  import javax.servlet.ServletResponse;
23  
24  /***
25   * PortletRequestResponseUnwrapper finds servlet request or servlet response 
26   * from portlet request or portlet response by unwrapping.
27   * Third-party module can provide an implementation to decorate the real request
28   * or response object of a servlet container.
29   * For example, the real request object of a servlet container can be decorated
30   * because it is not thread-safe under Jetspeed parallel rendering mode.
31   *
32   * @author <a href="mailto:woonsan@apache.org">Woonsan Ko</a>
33   * @version $Id: $
34   */
35  public interface PortletRequestResponseUnwrapper
36  {
37      /***
38       * Unwraps portlet request to find the real servlet request.
39       * 
40       * @param portletRequest The portlet request to be unwrapped.
41       * @return servletRequest The servlet request found by unwrapping.
42       */
43      ServletRequest unwrapPortletRequest(PortletRequest portletRequest);
44      
45      /***
46       * Unwraps portlet response to find the real servlet response.
47       * 
48       * @param portletResponse The portlet response to be unwrapped.
49       * @return servletResponse The servlet response found by unwrapping.
50       */
51      ServletResponse unwrapPortletResponse(PortletResponse portletResponse);
52  }