PortalRequestFactory xref

This project has retired. For details please refer to its Attic page.

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.request;
18  
19  import javax.servlet.http.HttpServletRequest;
20  
21  /***
22   * PortalRequestFactory allows specialized instantiation of a PortalRequest to be
23   * used for JetspeedRequestContext.request.
24   * <p>
25   * JetspeedRequestContext also implements this interface and simply returns the
26   * provided request as no wrapping is needed for Tomcat.
27   * </p>
28   * <p>
29   * To actually use a PortalRequest as wrapper (as needed for instance on WebSphere), 
30   * inject the PortalRequestFactoryImpl in JetspeedRequestContext.
31   * </p>
32   * 
33   * @author <a href="mailto:ate@douma.nu">Ate Douma</a>
34   * @version $Id$
35   */
36  public interface PortalRequestFactory
37  {
38      HttpServletRequest createPortalRequest(HttpServletRequest request);
39  }