001: /*
002: * Copyright (c) 1998-2008 Caucho Technology -- all rights reserved
003: *
004: * This file is part of Resin(R) Open Source
005: *
006: * Each copy or derived work must preserve the copyright notice and this
007: * notice unmodified.
008: *
009: * Resin Open Source is free software; you can redistribute it and/or modify
010: * it under the terms of the GNU General Public License as published by
011: * the Free Software Foundation; either version 2 of the License, or
012: * (at your option) any later version.
013: *
014: * Resin Open Source is distributed in the hope that it will be useful,
015: * but WITHOUT ANY WARRANTY; without even the implied warranty of
016: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
017: * of NON-INFRINGEMENT. See the GNU General Public License for more
018: * details.
019: *
020: * You should have received a copy of the GNU General Public License
021: * along with Resin Open Source; if not, write to the
022: * Free SoftwareFoundation, Inc.
023: * 59 Temple Place, Suite 330
024: * Boston, MA 02111-1307 USA
025: *
026: * @author Scott Ferguson
027: */
028:
029: package com.caucho.server.connection;
030:
031: import com.caucho.log.Log;
032: import com.caucho.util.L10N;
033: import com.caucho.vfs.OutputStreamWithBuffer;
034: import com.caucho.vfs.Path;
035:
036: import java.io.IOException;
037: import java.io.OutputStream;
038: import java.io.UnsupportedEncodingException;
039: import java.io.Writer;
040: import java.util.Locale;
041: import java.util.logging.Logger;
042:
043: /**
044: * API for handling the PrintWriter/ServletOutputStream
045: */
046: public abstract class AbstractResponseStream extends
047: OutputStreamWithBuffer {
048: private static final Logger log = Log
049: .open(AbstractResponseStream.class);
050: private static final L10N L = new L10N(AbstractResponseStream.class);
051:
052: /**
053: * Starts the response stream.
054: */
055: public void start() {
056: }
057:
058: /**
059: * Returns true for a Caucho response stream.
060: */
061: abstract public boolean isCauchoResponseStream();
062:
063: /**
064: * Sets the encoding.
065: */
066: public void setEncoding(String encoding)
067: throws UnsupportedEncodingException {
068: }
069:
070: /**
071: * Set true for output stream only request.
072: */
073: public void setOutputStreamOnly(boolean isOutputStreamOnly) {
074: }
075:
076: /**
077: * Sets the locale.
078: */
079: public void setLocale(Locale locale)
080: throws UnsupportedEncodingException {
081: }
082:
083: /**
084: * Sets the buffer size.
085: */
086: abstract public void setBufferSize(int size);
087:
088: /**
089: * Gets the buffer size.
090: */
091: abstract public int getBufferSize();
092:
093: /**
094: * Sets the auto-flush
095: */
096: public void setAutoFlush(boolean isAutoFlush) {
097: }
098:
099: /**
100: * Return the auto-flush.
101: */
102: public boolean isAutoFlush() {
103: return true;
104: }
105:
106: /**
107: * Returns the remaining buffer entries.
108: */
109: abstract public int getRemaining();
110:
111: /**
112: * Returns the char buffer.
113: */
114: abstract public char[] getCharBuffer() throws IOException;
115:
116: /**
117: * Returns the char buffer offset.
118: */
119: abstract public int getCharOffset() throws IOException;
120:
121: /**
122: * Sets the char buffer offset.
123: */
124: abstract public void setCharOffset(int offset) throws IOException;
125:
126: /**
127: * Returns the next char buffer.
128: */
129: abstract public char[] nextCharBuffer(int offset)
130: throws IOException;
131:
132: /**
133: * Returns true if the response is committed.
134: */
135: public boolean isCommitted() {
136: return false;
137: }
138:
139: /**
140: * Set true for HEAD requests.
141: */
142: public void setHead() {
143: }
144:
145: /**
146: * Set true for HEAD requests.
147: */
148: public boolean isHead() {
149: return false;
150: }
151:
152: /**
153: * Sets a byte cache stream.
154: */
155: public void setByteCacheStream(OutputStream cacheStream) {
156: throw new UnsupportedOperationException(getClass().getName());
157: }
158:
159: /**
160: * Sets a char cache stream.
161: */
162: public void setCharCacheStream(Writer cacheStream) {
163: throw new UnsupportedOperationException(getClass().getName());
164: }
165:
166: /**
167: * Returns the written content length
168: */
169: public int getContentLength() {
170: return 0;
171: }
172:
173: /**
174: * Writes a byte to the output.
175: */
176: abstract public void write(int v) throws IOException;
177:
178: /**
179: * Writes a byte array to the output.
180: */
181: abstract public void write(byte[] buffer, int offset, int length)
182: throws IOException;
183:
184: /**
185: * Writes a character to the output.
186: */
187: abstract public void print(int ch) throws IOException;
188:
189: /**
190: * Writes a char array to the output.
191: */
192: abstract public void print(char[] buffer, int offset, int length)
193: throws IOException;
194:
195: /**
196: * Clears the output buffer, including headers if possible.
197: */
198: public void clear() throws IOException {
199: clearBuffer();
200: }
201:
202: /**
203: * Clears the output buffer.
204: */
205: abstract public void clearBuffer();
206:
207: /**
208: * Flushes the output buffer.
209: */
210: abstract public void flushBuffer() throws IOException;
211:
212: /**
213: * Flushes the output.
214: */
215: public void flushByte() throws IOException {
216: flushBuffer();
217: }
218:
219: /**
220: * Flushes the output.
221: */
222: public void flushChar() throws IOException {
223: flushBuffer();
224: }
225:
226: /**
227: * Sends a file.
228: *
229: * @param path the path to the file
230: * @param length the length of the file (-1 if unknown)
231: */
232: public void sendFile(Path path, long length) throws IOException {
233: path.writeToStream(this );
234: }
235:
236: /**
237: * Flushes the output.
238: */
239: public void flush() throws IOException {
240: flushByte();
241: }
242:
243: /**
244: * Finishes the response stream
245: */
246: public void finish() throws IOException {
247: flushBuffer();
248: }
249:
250: /**
251: * Closes the response stream
252: */
253: public void close() throws IOException {
254: finish();
255: }
256:
257: /**
258: * Clears the close
259: */
260: public void clearClosed() throws IOException {
261: }
262: }
|