/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* Portions Copyright Apache Software Foundation.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.apache.catalina.core;
import java.io.IOException;
import java.util.Locale;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;
import org.apache.catalina.HttpResponse;
import org.apache.catalina.util.StringManager;
/**
* Wrapper around a <code>javax.servlet.http.HttpServletResponse</code>
* that transforms an application response object (which might be the original
* one passed to a servlet, or might be based on the 2.3
* <code>javax.servlet.http.HttpServletResponseWrapper</code> class)
* back into an internal <code>org.apache.catalina.HttpResponse</code>.
* <p>
* <strong>WARNING</strong>: Due to Java's lack of support for multiple
* inheritance, all of the logic in <code>ApplicationResponse</code> is
* duplicated in <code>ApplicationHttpResponse</code>. Make sure that you
* keep these two classes in synchronization when making changes!
*
* @author Craig R. McClanahan
* @version $Revision: 1.4 $ $Date: 2007/05/05 05:31:54 $
*/
/** PWC 4858179
class ApplicationHttpResponse extends HttpServletResponseWrapper {
**/
// START OF PWC 4858179
public class ApplicationHttpResponse extends HttpServletResponseWrapper {
// END OF PWC 4858179
// ----------------------------------------------------------- Constructors
/**
* Construct a new wrapped response around the specified servlet response.
*
* @param response The servlet response being wrapped
*/
public ApplicationHttpResponse(HttpServletResponse response) {
this(response, false);
}
/**
* Construct a new wrapped response around the specified servlet response.
*
* @param response The servlet response being wrapped
* @param included <code>true</code> if this response is being processed
* by a <code>RequestDispatcher.include()</code> call
*/
public ApplicationHttpResponse(HttpServletResponse response,
boolean included) {
super(response);
setIncluded(included);
}
// ----------------------------------------------------- Instance Variables
/**
* Is this wrapped response the subject of an <code>include()</code>
* call?
*/
protected boolean included = false;
/**
* Descriptive information about this implementation.
*/
protected static final String info =
"org.apache.catalina.core.ApplicationHttpResponse/1.0";
/**
* The string manager for this package.
*/
protected static final StringManager sm =
StringManager.getManager(Constants.Package);
// ------------------------------------------------ ServletResponse Methods
/**
* Disallow <code>reset()</code> calls on a included response.
*
* @exception IllegalStateException if the response has already
* been committed
*/
public void reset() {
// If already committed, the wrapped response will throw ISE
if (!included || getResponse().isCommitted())
getResponse().reset();
}
/**
* Disallow <code>setContentLength()</code> calls on an included response.
*
* @param len The new content length
*/
public void setContentLength(int len) {
if (!included)
getResponse().setContentLength(len);
}
/**
* Disallow <code>setContentType()</code> calls on an included response.
*
* @param type The new content type
*/
public void setContentType(String type) {
if (!included)
getResponse().setContentType(type);
}
/**
* Disallow <code>setLocale()</code> calls on an included response.
*
* @param loc The new locale
*/
public void setLocale(Locale loc) {
if (!included)
getResponse().setLocale(loc);
}
/**
* Ignore <code>setBufferSize()</code> calls on an included response.
*
* @param size The buffer size
*/
public void setBufferSize(int size) {
if (!included)
getResponse().setBufferSize(size);
}
// -------------------------------------------- HttpServletResponse Methods
/**
* Disallow <code>addCookie()</code> calls on an included response.
*
* @param cookie The new cookie
*/
public void addCookie(Cookie cookie) {
if (!included)
((HttpServletResponse) getResponse()).addCookie(cookie);
}
/**
* Disallow <code>addDateHeader()</code> calls on an included response.
*
* @param name The new header name
* @param value The new header value
*/
public void addDateHeader(String name, long value) {
if (!included)
((HttpServletResponse) getResponse()).addDateHeader(name, value);
}
/**
* Disallow <code>addHeader()</code> calls on an included response.
*
* @param name The new header name
* @param value The new header value
*/
public void addHeader(String name, String value) {
if (!included)
((HttpServletResponse) getResponse()).addHeader(name, value);
}
/**
* Disallow <code>addIntHeader()</code> calls on an included response.
*
* @param name The new header name
* @param value The new header value
*/
public void addIntHeader(String name, int value) {
if (!included)
((HttpServletResponse) getResponse()).addIntHeader(name, value);
}
/**
* Disallow <code>sendError()</code> calls on an included response.
*
* @param sc The new status code
*
* @exception IOException if an input/output error occurs
*/
public void sendError(int sc) throws IOException {
if (!included)
((HttpServletResponse) getResponse()).sendError(sc);
}
/**
* Disallow <code>sendError()</code> calls on an included response.
*
* @param sc The new status code
* @param msg The new message
*
* @exception IOException if an input/output error occurs
*/
public void sendError(int sc, String msg) throws IOException {
if (!included)
((HttpServletResponse) getResponse()).sendError(sc, msg);
}
/**
* Disallow <code>sendRedirect()</code> calls on an included response.
*
* @param location The new location
*
* @exception IOException if an input/output error occurs
*/
public void sendRedirect(String location) throws IOException {
if (!included)
((HttpServletResponse) getResponse()).sendRedirect(location);
}
/**
* Disallow <code>setDateHeader()</code> calls on an included response.
*
* @param name The new header name
* @param value The new header value
*/
public void setDateHeader(String name, long value) {
if (!included)
((HttpServletResponse) getResponse()).setDateHeader(name, value);
}
/**
* Disallow <code>setHeader()</code> calls on an included response.
*
* @param name The new header name
* @param value The new header value
*/
public void setHeader(String name, String value) {
if (!included)
((HttpServletResponse) getResponse()).setHeader(name, value);
}
/**
* Disallow <code>setIntHeader()</code> calls on an included response.
*
* @param name The new header name
* @param value The new header value
*/
public void setIntHeader(String name, int value) {
if (!included)
((HttpServletResponse) getResponse()).setIntHeader(name, value);
}
/**
* Disallow <code>setStatus()</code> calls on an included response.
*
* @param sc The new status code
*/
public void setStatus(int sc) {
if (!included)
((HttpServletResponse) getResponse()).setStatus(sc);
}
/**
* Disallow <code>setStatus()</code> calls on an included response.
*
* @param sc The new status code
* @param msg The new message
*/
public void setStatus(int sc, String msg) {
if (!included)
((HttpServletResponse) getResponse()).setStatus(sc, msg);
}
// -------------------------------------------------------- Package Methods
/**
* Return descriptive information about this implementation.
*/
public String getInfo() {
return (this.info);
}
// START OF RIMOD 4858179
/**
* Return the included flag for this response.
*/
public boolean isIncluded() {
return (this.included);
}
/*
boolean isIncluded() {
return (this.included);
}*/
// END OF RIMOD 4858179
/**
* Set the included flag for this response.
*
* @param included The new included flag
*/
void setIncluded(boolean included) {
this.included = included;
}
/**
* Set the response that we are wrapping.
*
* @param response The new wrapped response
*/
void setResponse(HttpServletResponse response) {
super.setResponse(response);
}
}
|
