TeaServletEngine


1   /* ====================================================================
2    * TeaServlet - Copyright (c) 1999-2001 Walt Disney Internet Group
3    * ====================================================================
4    * The Tea Software License, Version 1.1
5    *
6    * Copyright (c) 2000 Walt Disney Internet Group. All rights reserved.
7    *
8    * Redistribution and use in source and binary forms, with or without
9    * modification, are permitted provided that the following conditions
10   * are met:
11   *
12   * 1. Redistributions of source code must retain the above copyright
13   *    notice, this list of conditions and the following disclaimer.
14   *
15   * 2. Redistributions in binary form must reproduce the above copyright
16   *    notice, this list of conditions and the following disclaimer in
17   *    the documentation and/or other materials provided with the
18   *    distribution.
19   *
20   * 3. The end-user documentation included with the redistribution,
21   *    if any, must include the following acknowledgment:
22   *       "This product includes software developed by the
23   *        Walt Disney Internet Group (http://opensource.go.com/)."
24   *    Alternately, this acknowledgment may appear in the software itself,
25   *    if and wherever such third-party acknowledgments normally appear.
26   *
27   * 4. The names "Tea", "TeaServlet", "Kettle", "Trove" and "BeanDoc" must
28   *    not be used to endorse or promote products derived from this
29   *    software without prior written permission. For written
30   *    permission, please contact opensource@dig.com.
31   *
32   * 5. Products derived from this software may not be called "Tea",
33   *    "TeaServlet", "Kettle" or "Trove", nor may "Tea", "TeaServlet",
34   *    "Kettle", "Trove" or "BeanDoc" appear in their name, without prior
35   *    written permission of the Walt Disney Internet Group.
36   *
37   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40   * DISCLAIMED.  IN NO EVENT SHALL THE WALT DISNEY INTERNET GROUP OR ITS
41   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
42   * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
43   * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
44   * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
45   * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
46   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
47   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48   * ====================================================================
49   *
50   * For more information about Tea, please see http://opensource.go.com/.
51   */
52  
53  package com.go.teaservlet;
54  
55  import java.io.IOException  ;
56  import javax.servlet.http.HttpServletRequest  ;
57  import javax.servlet.http.HttpServletResponse  ;
58  import com.go.trove.io.ByteBuffer;
59  
60  /******************************************************************************
61   * This interface allows other servlets to create
62   * {@link TeaServletTransaction TeaServletTransactions}. When the TeaServlet is
63   * initialized, it adds an attribute to its ServletContext named
64   * "com.go.teaservlet.TeaServletEngine". The attribute's value is a
65   * TeaServletEngine array. The number of array elements matches the number of
66   * times a TeaServlet is configured in. Use TeaServletEngine's name to
67   * distinguish between different instances.
68   * <p>
69   * Servlets that request a TeaServletTransaction should generally let all
70   * output be handled by it. This is because it will try to set headers and use 
71   * a servlet output stream.
72   *
73   * @author Brian S O'Neill
74   * @version
75   * <!--$$Revision:--> 5 <!-- $-->, <!--$$JustDate:--> 01/07/13 <!-- $-->
76   */
77  public interface TeaServletEngine extends ApplicationConfig {
78      /**
79       * Creates a TeaServletTransaction instance for the given request/response 
80       * pair and returns it.
81       *
82       * @param request HttpServletRequest used for building ApplicationRequest.
83       * @param response HttpServletResponse used for building
84       * ApplicationResponse.
85       */
86      public TeaServletTransaction createTransaction
87          (HttpServletRequest   request, HttpServletResponse   response)
88          throws IOException  ;
89  }
90
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags