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.request;
18  
19  import javax.servlet.ServletConfig;
20  import javax.servlet.http.HttpServletRequest;
21  import javax.servlet.http.HttpServletResponse;
22  
23  
24  /***
25   * RequestContextComponent
26   *
27   * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
28   * @version $Id: RequestContextComponent.java 516448 2007-03-09 16:25:47Z ate $
29   */
30  public interface RequestContextComponent 
31  {
32      /***
33       * Creates a request context for the given servlet request.
34       * 
35       * @param req
36       * @param resp
37       * @param config
38       * @return
39       */
40      RequestContext create(HttpServletRequest req, HttpServletResponse resp, ServletConfig config);
41  
42      /***
43       * Release a request context back to the context pool.
44       * 
45       * @param context
46       */
47      void release(RequestContext context);
48      
49      /***
50       * The servlet request can always get you back to the Request Context if you need it
51       * This static accessor provides this capability
52       *
53       * @param request
54       * @return RequestContext
55       */
56      RequestContext getRequestContext(HttpServletRequest request);    
57      RequestContext getRequestContext();    
58      
59  }