APIAwareDispatcher


1   /* ====================================================================
2    * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3    *
4    * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
5    *
6    * Redistribution and use in source and binary forms, with or without
7    * modification, are permitted provided that the following conditions
8    * are met:
9    *
10   * 1. Redistributions of source code must retain the above copyright
11   *    notice, this list of conditions and the following disclaimer.
12   *
13   * 2. Redistributions in binary form must reproduce the above copyright
14   *    notice, this list of conditions and the following disclaimer in
15   *    the documentation and/or other materials provided with the
16   *    distribution.
17   *
18   * 3. The end-user documentation included with the redistribution,
19   *    if any, must include the following acknowledgment:
20   *       "This product includes software developed by Jcorporate Ltd.
21   *        (http://www.jcorporate.com/)."
22   *    Alternately, this acknowledgment may appear in the software itself,
23   *    if and wherever such third-party acknowledgments normally appear.
24   *
25   * 4. "Jcorporate" and product names such as "Expresso" must
26   *    not be used to endorse or promote products derived from this
27   *    software without prior written permission. For written permission,
28   *    please contact info@jcorporate.com.
29   *
30   * 5. Products derived from this software may not be called "Expresso",
31   *    or other Jcorporate product names; nor may "Expresso" or other
32   *    Jcorporate product names appear in their name, without prior
33   *    written permission of Jcorporate Ltd.
34   *
35   * 6. No product derived from this software may compete in the same
36   *    market space, i.e. framework, without prior written permission
37   *    of Jcorporate Ltd. For written permission, please contact
38   *    partners@jcorporate.com.
39   *
40   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43   * DISCLAIMED.  IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44   * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45   * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46   * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51   * SUCH DAMAGE.
52   * ====================================================================
53   *
54   * This software consists of voluntary contributions made by many
55   * individuals on behalf of the Jcorporate Ltd. Contributions back
56   * to the project(s) are encouraged when you make modifications.
57   * Please send them to support@jcorporate.com. For more information
58   * on Jcorporate Ltd. and its products, please see
59   * <http://www.jcorporate.com/>.
60   *
61   * Portions of this software are based upon other open source
62   * products and are subject to their respective licenses.
63   */
64  
65  package com.jcorporate.expresso.core.jsdkapi;
66  
67  /**
68   * APIAwareDispatcher.java
69   *
70   * Copyright 2000, 2001 Jcorporate Ltd.
71   */
72  
73  import javax.servlet.Servlet  ;
74  import javax.servlet.ServletContext  ;
75  import javax.servlet.http.HttpServletRequest  ;
76  import javax.servlet.http.HttpServletResponse  ;
77  
78  
79  /**
80   * Servlet API 2.0 does not have the RequestDispatcher interface.
81   * Apache-JServ is based on Servlet API 2.0.  For those users
82   * that are using JServ, this interface allows the use of the
83   * RequestDispatcher forward() and include() methods by
84   * hiding the API differences between the Servlet API 2.0 and 2.1
85   * This class is used in conjunction with the
86   * com.jcorporate.expresso.core.jsdkapi.GenericDispatcher class.
87   *
88   * @author Shash Chatterjee
89   */
90  public interface APIAwareDispatcher {
91      /**
92       * This method is used to forward to a new URL
93       *
94       * @param srv javax.servlet.Servlet - The servlet which is using this method,
95       *            usually the "this" attribute. Used to extract the PrintWriter.
96       * @param ctx javax.servlet.ServletContext - The servlet context of the calling
97       *            servlet.
98       * @param req javax.servlet.http.HttpServletRequest - The request object
99       *            associated with this service call
100      * @param res javax.servlet.http.HttpServletResponse - The response object
101      *            associated with this service call.
102      * @param URL java.lang.String - The URL to forward to
103      * @throws javax.servlet.ServletException The exception description.
104      * @throws java.io.IOException            The exception description.
105      */
106     public void forward(Servlet   srv, ServletContext   ctx,
107                         HttpServletRequest   req, HttpServletResponse   res,
108                         String   URL)
109             throws javax.servlet.ServletException  , java.io.IOException  ;
110 
111     /* forward(Servlet, ServletContext, HttpServletRequest, HttpServletResponse, */
112     /*          String) */
113     /**
114      * Insert the method's description here.
115      * Creation date: (04/16/00 %r)
116      *
117      * @param srv   javax.servlet.Servlet - The servlet which is using this method,
118      *              usually the "this" attribute. Used to extract the PrintWriter.
119      * @param param javax.servlet.ServletContext - The servlet context of the calling
120      *              servlet.
121      * @param req   javax.servlet.http.ServletRequest - The request object associated
122      *              with this service call
123      * @param res   javax.servlet.http.ServletResponse - The response object associated
124      *              with this service call.
125      * @param URL   java.lang.String - The URL to include
126      * @throws javax.servlet.ServletException The exception description.
127      * @throws java.io.IOException            The exception description.
128      */
129     public void include(Servlet   srv, ServletContext   param,
130                         HttpServletRequest   req, HttpServletResponse   res,
131                         String   URL)
132             throws javax.servlet.ServletException  , java.io.IOException  ;
133 
134     /* include(Servlet, ServletContext, HttpServletRequest, HttpServletResponse, */
135     /*          String) */
136     /**
137      * Retrieve the context path.
138      *
139      * @param req the HttpServletRequest object
140      * @return String for the context path
141      */
142     public String   getContextPath(HttpServletRequest   req);
143 
144 
145     /* getContextPath(HttpServletRequest) */
146 } /* APIAwareDispatcher */
147 
148 /* APIAwareDispatcher */
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags