2011/08/05 - Jakarta Cactus has been retired.

For more information, please explore the Attic.

View Javadoc

1   /* 
2    * ========================================================================
3    * 
4    * Licensed to the Apache Software Foundation (ASF) under one or more
5    * contributor license agreements.  See the NOTICE file distributed with
6    * this work for additional information regarding copyright ownership.
7    * The ASF licenses this file to You under the Apache License, Version 2.0
8    * (the "License"); you may not use this file except in compliance with
9    * the License.  You may obtain a copy of the License at
10   * 
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   * 
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   * 
19   * ========================================================================
20   */
21  package org.apache.cactus.internal.server;
22  
23  import javax.servlet.ServletContext;
24  import javax.servlet.http.HttpServletRequest;
25  import javax.servlet.http.HttpServletResponse;
26  
27  import org.apache.cactus.spi.server.ImplicitObjects;
28  
29  /**
30   * Interface for implicit objects that exist
31   * for all web requests (<code>HttpServletRequest</code>,
32   * <code>HttpServletResponse</code> and <code>ServletContext</code>).
33   *
34   * @version $Id: WebImplicitObjects.java 238991 2004-05-22 11:34:50Z vmassol $
35   */
36  public interface WebImplicitObjects extends ImplicitObjects
37  {
38      /**
39       * @return the <code>ServletContext</code> implicit object
40       */
41      ServletContext getServletContext();
42  
43      /**
44       * @param theContext the <code>ServletContext</code> implicit object
45       */
46      void setServletContext(ServletContext theContext);
47  
48      /**
49       * @return the <code>HttpServletResponse</code> implicit object
50       */
51      HttpServletResponse getHttpServletResponse();
52  
53      /**
54       * @param theResponse the <code>HttpServletResponse</code> implicit object
55       */
56      void setHttpServletResponse(HttpServletResponse theResponse);
57  
58      /**
59       * @return the <code>HttpServletRequest</code> implicit object
60       */
61      HttpServletRequest getHttpServletRequest();
62  
63      /**
64       * @param theRequest the <code>HttpServletRequest</code> implicit object
65       */
66      void setHttpServletRequest(HttpServletRequest theRequest);
67  }