org.apache.catalina.core.ApplicationHttpResponse Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.catalina.core;
import java.io.IOException;
import java.util.Locale;
import jakarta.servlet.http.Cookie;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.servlet.http.HttpServletResponseWrapper;
/**
* Wrapper around a jakarta.servlet.http.HttpServletResponse
* that transforms an application response object (which might be the original
* one passed to a servlet, or might be based on the 2.3
* jakarta.servlet.http.HttpServletResponseWrapper class)
* back into an internal org.apache.catalina.HttpResponse.
*
* WARNING: Due to Java's lack of support for multiple
* inheritance, all of the logic in ApplicationResponse is
* duplicated in ApplicationHttpResponse. Make sure that you
* keep these two classes in synchronization when making changes!
*
* @author Craig R. McClanahan
*/
class ApplicationHttpResponse extends HttpServletResponseWrapper {
// ----------------------------------------------------------- Constructors
/**
* Construct a new wrapped response around the specified servlet response.
*
* @param response The servlet response being wrapped
* @param included true if this response is being processed
* by a RequestDispatcher.include() call
*/
public ApplicationHttpResponse(HttpServletResponse response,
boolean included) {
super(response);
setIncluded(included);
}
// ----------------------------------------------------- Instance Variables
/**
* Is this wrapped response the subject of an include()
* call?
*/
protected boolean included = false;
// ------------------------------------------------ ServletResponse Methods
/**
* Disallow reset() calls on a included response.
*
* @exception IllegalStateException if the response has already
* been committed
*/
@Override
public void reset() {
// If already committed, the wrapped response will throw ISE
if (!included || getResponse().isCommitted()) {
getResponse().reset();
}
}
/**
* Disallow setContentLength(int) calls on an included
* response.
*
* @param len The new content length
*/
@Override
public void setContentLength(int len) {
if (!included) {
getResponse().setContentLength(len);
}
}
/**
* Disallow setContentLengthLong(long) calls on an included
* response.
*
* @param len The new content length
*/
@Override
public void setContentLengthLong(long len) {
if (!included) {
getResponse().setContentLengthLong(len);
}
}
/**
* Disallow setContentType() calls on an included response.
*
* @param type The new content type
*/
@Override
public void setContentType(String type) {
if (!included) {
getResponse().setContentType(type);
}
}
/**
* Disallow setLocale() calls on an included response.
*
* @param loc The new locale
*/
@Override
public void setLocale(Locale loc) {
if (!included) {
getResponse().setLocale(loc);
}
}
/**
* Ignore setBufferSize() calls on an included response.
*
* @param size The buffer size
*/
@Override
public void setBufferSize(int size) {
if (!included) {
getResponse().setBufferSize(size);
}
}
// -------------------------------------------- HttpServletResponse Methods
/**
* Disallow addCookie() calls on an included response.
*
* @param cookie The new cookie
*/
@Override
public void addCookie(Cookie cookie) {
if (!included) {
((HttpServletResponse) getResponse()).addCookie(cookie);
}
}
/**
* Disallow addDateHeader() calls on an included response.
*
* @param name The new header name
* @param value The new header value
*/
@Override
public void addDateHeader(String name, long value) {
if (!included) {
((HttpServletResponse) getResponse()).addDateHeader(name, value);
}
}
/**
* Disallow addHeader() calls on an included response.
*
* @param name The new header name
* @param value The new header value
*/
@Override
public void addHeader(String name, String value) {
if (!included) {
((HttpServletResponse) getResponse()).addHeader(name, value);
}
}
/**
* Disallow addIntHeader() calls on an included response.
*
* @param name The new header name
* @param value The new header value
*/
@Override
public void addIntHeader(String name, int value) {
if (!included) {
((HttpServletResponse) getResponse()).addIntHeader(name, value);
}
}
/**
* Disallow sendError() calls on an included response.
*
* @param sc The new status code
*
* @exception IOException if an input/output error occurs
*/
@Override
public void sendError(int sc) throws IOException {
if (!included) {
((HttpServletResponse) getResponse()).sendError(sc);
}
}
/**
* Disallow sendError() calls on an included response.
*
* @param sc The new status code
* @param msg The new message
*
* @exception IOException if an input/output error occurs
*/
@Override
public void sendError(int sc, String msg) throws IOException {
if (!included) {
((HttpServletResponse) getResponse()).sendError(sc, msg);
}
}
/**
* Disallow sendRedirect() calls on an included response.
*
* @param location The new location
*
* @exception IOException if an input/output error occurs
*/
@Override
public void sendRedirect(String location) throws IOException {
if (!included) {
((HttpServletResponse) getResponse()).sendRedirect(location);
}
}
/**
* Disallow setDateHeader() calls on an included response.
*
* @param name The new header name
* @param value The new header value
*/
@Override
public void setDateHeader(String name, long value) {
if (!included) {
((HttpServletResponse) getResponse()).setDateHeader(name, value);
}
}
/**
* Disallow setHeader() calls on an included response.
*
* @param name The new header name
* @param value The new header value
*/
@Override
public void setHeader(String name, String value) {
if (!included) {
((HttpServletResponse) getResponse()).setHeader(name, value);
}
}
/**
* Disallow setIntHeader() calls on an included response.
*
* @param name The new header name
* @param value The new header value
*/
@Override
public void setIntHeader(String name, int value) {
if (!included) {
((HttpServletResponse) getResponse()).setIntHeader(name, value);
}
}
/**
* Disallow setStatus() calls on an included response.
*
* @param sc The new status code
*/
@Override
public void setStatus(int sc) {
if (!included) {
((HttpServletResponse) getResponse()).setStatus(sc);
}
}
// -------------------------------------------------------- Package Methods
/**
* 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);
}
}