001: /*
002: * ResponseIncludeWrapper.java
003: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/ssi/ResponseIncludeWrapper.java,v 1.1 2002/05/24 04:38:58 billbarker Exp $
004: * $Revision: 1.1 $
005: * $Date: 2002/05/24 04:38:58 $
006: *
007: * ====================================================================
008: *
009: * The Apache Software License, Version 1.1
010: *
011: * Copyright (c) 1999 The Apache Software Foundation. All rights
012: * reserved.
013: *
014: * Redistribution and use in source and binary forms, with or without
015: * modification, are permitted provided that the following conditions
016: * are met:
017: *
018: * 1. Redistributions of source code must retain the above copyright
019: * notice, this list of conditions and the following disclaimer.
020: *
021: * 2. Redistributions in binary form must reproduce the above copyright
022: * notice, this list of conditions and the following disclaimer in
023: * the documentation and/or other materials provided with the
024: * distribution.
025: *
026: * 3. The end-user documentation included with the redistribution, if
027: * any, must include the following acknowlegement:
028: * "This product includes software developed by the
029: * Apache Software Foundation (http://www.apache.org/)."
030: * Alternately, this acknowlegement may appear in the software itself,
031: * if and wherever such third-party acknowlegements normally appear.
032: *
033: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
034: * Foundation" must not be used to endorse or promote products derived
035: * from this software without prior written permission. For written
036: * permission, please contact apache@apache.org.
037: *
038: * 5. Products derived from this software may not be called "Apache"
039: * nor may "Apache" appear in their names without prior written
040: * permission of the Apache Group.
041: *
042: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
043: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
044: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
045: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
046: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
047: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
048: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
049: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
050: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
051: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
052: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
053: * SUCH DAMAGE.
054: * ====================================================================
055: *
056: * This software consists of voluntary contributions made by many
057: * individuals on behalf of the Apache Software Foundation. For more
058: * information on the Apache Software Foundation, please see
059: * <http://www.apache.org/>.
060: *
061: * [Additional notices, if required by prior licensing conditions]
062: *
063: */
064:
065: package org.apache.catalina.ssi;
066:
067: import java.io.IOException;
068: import java.io.OutputStream;
069: import java.io.PrintWriter;
070: import javax.servlet.ServletOutputStream;
071: import javax.servlet.http.HttpServletResponse;
072: import javax.servlet.http.HttpServletResponseWrapper;
073:
074: /**
075: * A HttpServletResponseWrapper, used from <code>SSIServletExternalResolver</code>
076: *
077: * @author Bip Thelin
078: * @version $Revision: 1.1 $, $Date: 2002/05/24 04:38:58 $
079: */
080: public class ResponseIncludeWrapper extends HttpServletResponseWrapper {
081:
082: /**
083: * Our ServletOutputStream
084: */
085: protected ServletOutputStream originalServletOutputStream;
086: protected ServletOutputStream servletOutputStream;
087: protected PrintWriter printWriter;
088:
089: /**
090: * Initialize our wrapper with the current HttpServletResponse
091: * and ServletOutputStream.
092: *
093: * @param res The HttpServletResponse to use
094: * @param out The ServletOutputStream' to use
095: */
096: public ResponseIncludeWrapper(HttpServletResponse res,
097: ServletOutputStream originalServletOutputStream) {
098: super (res);
099: this .originalServletOutputStream = originalServletOutputStream;
100: }
101:
102: /**
103: * Flush the servletOutputStream or printWriter ( only one will be non-null )
104: *
105: * This must be called after a requestDispatcher.include, since we can't assume that
106: * the included servlet flushed its stream.
107: */
108: public void flushOutputStreamOrWriter() throws IOException {
109: if (servletOutputStream != null) {
110: servletOutputStream.flush();
111: }
112: if (printWriter != null) {
113: printWriter.flush();
114: }
115: }
116:
117: /**
118: * Return a printwriter, throws and exception if a
119: * OutputStream already been returned.
120: *
121: * @return a PrintWriter object
122: * @exception java.io.IOException if the outputstream already been called
123: */
124: public PrintWriter getWriter() throws java.io.IOException {
125: if (servletOutputStream == null) {
126: if (printWriter == null) {
127: printWriter = new PrintWriter(
128: originalServletOutputStream);
129: }
130: return printWriter;
131: }
132: throw new IllegalStateException();
133: }
134:
135: /**
136: * Return a OutputStream, throws and exception if a
137: * printwriter already been returned.
138: *
139: * @return a OutputStream object
140: * @exception java.io.IOException if the printwriter already been called
141: */
142: public ServletOutputStream getOutputStream()
143: throws java.io.IOException {
144: if (printWriter == null) {
145: if (servletOutputStream == null) {
146: servletOutputStream = originalServletOutputStream;
147: }
148: return servletOutputStream;
149: }
150: throw new IllegalStateException();
151: }
152: }
|