001: /*
002: * The Apache Software License, Version 1.1
003: *
004: * Copyright (c) 2001-2004 Caucho Technology, Inc. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution, if
019: * any, must include the following acknowlegement:
020: * "This product includes software developed by the
021: * Caucho Technology (http://www.caucho.com/)."
022: * Alternately, this acknowlegement may appear in the software itself,
023: * if and wherever such third-party acknowlegements normally appear.
024: *
025: * 4. The names "Hessian", "Resin", and "Caucho" must not be used to
026: * endorse or promote products derived from this software without prior
027: * written permission. For written permission, please contact
028: * info@caucho.com.
029: *
030: * 5. Products derived from this software may not be called "Resin"
031: * nor may "Resin" appear in their names without prior written
032: * permission of Caucho Technology.
033: *
034: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
035: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
036: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
037: * DISCLAIMED. IN NO EVENT SHALL CAUCHO TECHNOLOGY OR ITS CONTRIBUTORS
038: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
039: * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
040: * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
041: * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
042: * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
043: * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
044: * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
045: *
046: * @author Sam
047: */
048:
049: package com.caucho.portal.generic.context;
050:
051: import java.io.IOException;
052: import java.io.OutputStream;
053: import java.io.PrintWriter;
054: import java.io.UnsupportedEncodingException;
055: import java.util.Locale;
056:
057: public interface ResponseHandler {
058: /**
059: * Get the handler that this handler wraps, if any
060: */
061: public ResponseHandler getSuccessor();
062:
063: /**
064: * Set a property to be returned to the client.
065: *
066: * "properties" correspond to HTTP headers in the response for HTTP
067: * connections.
068: *
069: * @see javax.portlet.PortletResponse#setProperty
070: */
071: public void setProperty(String name, String value);
072:
073: /**
074: * Add a value to a property to be returned to the client.
075: *
076: * "properties" correspond to HTTP headers in the response for HTTP
077: * connections.
078: *
079: * @see javax.portlet.PortletResponse#addProperty
080: */
081: public void addProperty(String name, String value);
082:
083: public void setContentType(String contentType);
084:
085: /**
086: * Get the type previously set with setContentType
087: * or null if the type has not been set.
088: */
089: public String getContentType();
090:
091: public void setLocale(Locale locale);
092:
093: public Locale getLocale();
094:
095: public void setBufferSize(int size);
096:
097: public int getBufferSize();
098:
099: /**
100: * Implementations should NOT call flushBuffer() on any wrapped
101: * streams, flushing through the chain of ResponseHandlers is done by
102: * ConnectionContext.
103: */
104: public void flushBuffer() throws IOException;
105:
106: /**
107: * Implementations should NOT call resetBuffer() on any wrapped
108: * streams, resetBuffer() through the chain of ResponseHandlers is done by
109: * ConnectionContext.
110: */
111: public void resetBuffer();
112:
113: /**
114: * Implementations should call NOT call reset() on any wrapped streams.
115: * streams, reset() through the chain of ResponseHandlers is done by
116: * ConnectionContext.
117: */
118: public void reset();
119:
120: public boolean isCommitted();
121:
122: /**
123: * Set the character encoding of the writer.
124: */
125: public void setCharacterEncoding(String enc)
126: throws UnsupportedEncodingException;
127:
128: /**
129: * Get the character encoding of the writer.
130: */
131: public String getCharacterEncoding();
132:
133: /**
134: * Get a writer that sends output to the client of the connection.
135: */
136: public PrintWriter getWriter() throws IOException;
137:
138: public OutputStream getOutputStream() throws IOException;
139:
140: public void finish() throws IOException;
141:
142: }
|