KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > caucho > portal > generic > context > ResponseHandler


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  * Copyright (c) 2001-2004 Caucho Technology, Inc. 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, if
19  * any, must include the following acknowlegement:
20  * "This product includes software developed by the
21  * Caucho Technology (http://www.caucho.com/)."
22  * Alternately, this acknowlegement may appear in the software itself,
23  * if and wherever such third-party acknowlegements normally appear.
24  *
25  * 4. The names "Hessian", "Resin", and "Caucho" must not be used to
26  * endorse or promote products derived from this software without prior
27  * written permission. For written permission, please contact
28  * info@caucho.com.
29  *
30  * 5. Products derived from this software may not be called "Resin"
31  * nor may "Resin" appear in their names without prior written
32  * permission of Caucho Technology.
33  *
34  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
35  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
36  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
37  * DISCLAIMED. IN NO EVENT SHALL CAUCHO TECHNOLOGY OR ITS CONTRIBUTORS
38  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
39  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
40  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
41  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
42  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
43  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
44  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45  *
46  * @author Sam
47  */
48
49
50 package com.caucho.portal.generic.context;
51
52 import java.io.IOException JavaDoc;
53 import java.io.OutputStream JavaDoc;
54 import java.io.PrintWriter JavaDoc;
55 import java.io.UnsupportedEncodingException JavaDoc;
56 import java.util.Locale JavaDoc;
57
58 public interface ResponseHandler
59 {
60   /**
61    * Get the handler that this handler wraps, if any
62    */
63   public ResponseHandler getSuccessor();
64
65   /**
66    * Set a property to be returned to the client.
67    *
68    * "properties" correspond to HTTP headers in the response for HTTP
69    * connections.
70    *
71    * @see javax.portlet.PortletResponse#setProperty
72    */
73   public void setProperty(String JavaDoc name, String JavaDoc value);
74
75   /**
76    * Add a value to a property to be returned to the client.
77    *
78    * "properties" correspond to HTTP headers in the response for HTTP
79    * connections.
80    *
81    * @see javax.portlet.PortletResponse#addProperty
82    */
83   public void addProperty(String JavaDoc name, String JavaDoc value);
84
85
86   public void setContentType(String JavaDoc contentType);
87
88   /**
89    * Get the type previously set with setContentType
90    * or null if the type has not been set.
91    */
92   public String JavaDoc getContentType();
93
94   public void setLocale(Locale JavaDoc locale);
95
96   public Locale JavaDoc getLocale();
97
98   public void setBufferSize(int size);
99
100   public int getBufferSize();
101
102   /**
103    * Implementations should NOT call flushBuffer() on any wrapped
104    * streams, flushing through the chain of ResponseHandlers is done by
105    * ConnectionContext.
106    */
107   public void flushBuffer()
108     throws IOException JavaDoc;
109
110   /**
111    * Implementations should NOT call resetBuffer() on any wrapped
112    * streams, resetBuffer() through the chain of ResponseHandlers is done by
113    * ConnectionContext.
114    */
115   public void resetBuffer();
116
117   /**
118    * Implementations should call NOT call reset() on any wrapped streams.
119    * streams, reset() through the chain of ResponseHandlers is done by
120    * ConnectionContext.
121    */
122   public void reset();
123
124   public boolean isCommitted();
125   
126   /**
127    * Set the character encoding of the writer.
128    */
129   public void setCharacterEncoding(String JavaDoc enc)
130     throws UnsupportedEncodingException JavaDoc;
131
132   /**
133    * Get the character encoding of the writer.
134    */
135   public String JavaDoc getCharacterEncoding();
136
137   /**
138    * Get a writer that sends output to the client of the connection.
139    */
140   public PrintWriter JavaDoc getWriter()
141     throws IOException JavaDoc;
142
143   public OutputStream JavaDoc getOutputStream()
144     throws IOException JavaDoc;
145
146   public void finish()
147     throws IOException JavaDoc;
148
149 }
150
Popular Tags