001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/core/ApplicationResponse.java,v 1.6 2001/07/22 20:25:08 pier Exp $
003: * $Revision: 1.6 $
004: * $Date: 2001/07/22 20:25:08 $
005: *
006: * ====================================================================
007: *
008: * The Apache Software License, Version 1.1
009: *
010: * Copyright (c) 1999 The Apache Software Foundation. All rights
011: * reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions
015: * are met:
016: *
017: * 1. Redistributions of source code must retain the above copyright
018: * notice, this list of conditions and the following disclaimer.
019: *
020: * 2. Redistributions in binary form must reproduce the above copyright
021: * notice, this list of conditions and the following disclaimer in
022: * the documentation and/or other materials provided with the
023: * distribution.
024: *
025: * 3. The end-user documentation included with the redistribution, if
026: * any, must include the following acknowlegement:
027: * "This product includes software developed by the
028: * Apache Software Foundation (http://www.apache.org/)."
029: * Alternately, this acknowlegement may appear in the software itself,
030: * if and wherever such third-party acknowlegements normally appear.
031: *
032: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
033: * Foundation" must not be used to endorse or promote products derived
034: * from this software without prior written permission. For written
035: * permission, please contact apache@apache.org.
036: *
037: * 5. Products derived from this software may not be called "Apache"
038: * nor may "Apache" appear in their names without prior written
039: * permission of the Apache Group.
040: *
041: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
042: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
043: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
044: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
045: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
046: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
047: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
048: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
049: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
050: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
051: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
052: * SUCH DAMAGE.
053: * ====================================================================
054: *
055: * This software consists of voluntary contributions made by many
056: * individuals on behalf of the Apache Software Foundation. For more
057: * information on the Apache Software Foundation, please see
058: * <http://www.apache.org/>.
059: *
060: * [Additional notices, if required by prior licensing conditions]
061: *
062: */
063:
064: package org.apache.catalina.core;
065:
066: import java.io.IOException;
067: import java.io.PrintWriter;
068: import java.util.Locale;
069: import javax.servlet.ServletOutputStream;
070: import javax.servlet.ServletResponse;
071: import javax.servlet.ServletResponseWrapper;
072: import org.apache.catalina.Response;
073: import org.apache.catalina.connector.ResponseFacade;
074: import org.apache.catalina.util.StringManager;
075:
076: /**
077: * Wrapper around a <code>javax.servlet.ServletResponse</code>
078: * that transforms an application response object (which might be the original
079: * one passed to a servlet, or might be based on the 2.3
080: * <code>javax.servlet.ServletResponseWrapper</code> class)
081: * back into an internal <code>org.apache.catalina.Response</code>.
082: * <p>
083: * <strong>WARNING</strong>: Due to Java's lack of support for multiple
084: * inheritance, all of the logic in <code>ApplicationResponse</code> is
085: * duplicated in <code>ApplicationHttpResponse</code>. Make sure that you
086: * keep these two classes in synchronization when making changes!
087: *
088: * @author Craig R. McClanahan
089: * @version $Revision: 1.6 $ $Date: 2001/07/22 20:25:08 $
090: */
091:
092: class ApplicationResponse extends ServletResponseWrapper {
093:
094: // ----------------------------------------------------------- Constructors
095:
096: /**
097: * Construct a new wrapped response around the specified servlet response.
098: *
099: * @param response The servlet response being wrapped
100: */
101: public ApplicationResponse(ServletResponse response) {
102:
103: this (response, false);
104:
105: }
106:
107: /**
108: * Construct a new wrapped response around the specified servlet response.
109: *
110: * @param response The servlet response being wrapped
111: * @param included <code>true</code> if this response is being processed
112: * by a <code>RequestDispatcher.include()</code> call
113: */
114: public ApplicationResponse(ServletResponse response,
115: boolean included) {
116:
117: super (response);
118: setIncluded(included);
119:
120: }
121:
122: // ----------------------------------------------------- Instance Variables
123:
124: /**
125: * Is this wrapped response the subject of an <code>include()</code>
126: * call?
127: */
128: protected boolean included = false;
129:
130: /**
131: * The string manager for this package.
132: */
133: protected static StringManager sm = StringManager
134: .getManager(Constants.Package);
135:
136: // ------------------------------------------------ ServletResponse Methods
137:
138: /**
139: * Disallow <code>reset()</code> calls on a included response.
140: *
141: * @exception IllegalStateException if the response has already
142: * been committed
143: */
144: public void reset() {
145:
146: // If already committed, the wrapped response will throw ISE
147: if (!included || getResponse().isCommitted())
148: getResponse().reset();
149:
150: }
151:
152: /**
153: * Disallow <code>setContentLength()</code> calls on an included response.
154: *
155: * @param len The new content length
156: */
157: public void setContentLength(int len) {
158:
159: if (!included)
160: getResponse().setContentLength(len);
161:
162: }
163:
164: /**
165: * Disallow <code>setContentType()</code> calls on an included response.
166: *
167: * @param type The new content type
168: */
169: public void setContentType(String type) {
170:
171: if (!included)
172: getResponse().setContentType(type);
173:
174: }
175:
176: // ----------------------------------------- ServletResponseWrapper Methods
177:
178: /**
179: * Set the response that we are wrapping.
180: *
181: * @param response The new wrapped response
182: */
183: public void setResponse(ServletResponse response) {
184:
185: super .setResponse(response);
186:
187: }
188:
189: // -------------------------------------------------------- Package Methods
190:
191: /**
192: * Return the included flag for this response.
193: */
194: boolean isIncluded() {
195:
196: return (this .included);
197:
198: }
199:
200: /**
201: * Set the included flag for this response.
202: *
203: * @param included The new included flag
204: */
205: void setIncluded(boolean included) {
206:
207: this.included = included;
208:
209: }
210:
211: }
|