org.apache.catalina.core

Class ApplicationHttpResponse

java.lang.Object

javax.servlet.ServletResponseWrapper

javax.servlet.http.HttpServletResponseWrapper

org.apache.catalina.core.ApplicationHttpResponse

All Implemented Interfaces:

javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

public class ApplicationHttpResponse
extends javax.servlet.http.HttpServletResponseWrapper

PWC 4858179 class ApplicationHttpResponse extends HttpServletResponseWrapper {

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	included Is this wrapped response the subject of an include() call?
protected static String	info Descriptive information about this implementation.

Fields inherited from interface javax.servlet.http.HttpServletResponse

SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_FORBIDDEN, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

Constructor Summary

Constructors

Constructor and Description
ApplicationHttpResponse(javax.servlet.http.HttpServletResponse response) Construct a new wrapped response around the specified servlet response.
ApplicationHttpResponse(javax.servlet.http.HttpServletResponse response, boolean included) Construct a new wrapped response around the specified servlet response.

Method Summary

Modifier and Type	Method and Description
void	addCookie(javax.servlet.http.Cookie cookie) Disallow addCookie() calls on an included response.
void	addDateHeader(String name, long value) Disallow addDateHeader() calls on an included response.
void	addHeader(String name, String value) Disallow addHeader() calls on an included response.
void	addIntHeader(String name, int value) Disallow addIntHeader() calls on an included response.
String	getInfo() Return descriptive information about this implementation.
boolean	isIncluded() Return the included flag for this response.
void	reset() Disallow reset() calls on a included response.
void	sendError(int sc) Disallow sendError() calls on an included response.
void	sendError(int sc, String msg) Disallow sendError() calls on an included response.
void	sendRedirect(String location) Disallow sendRedirect() calls on an included response.
void	setBufferSize(int size) Ignore setBufferSize() calls on an included response.
void	setContentLength(int len) Disallow setContentLength() calls on an included response.
void	setContentType(String type) Disallow setContentType() calls on an included response.
void	setDateHeader(String name, long value) Disallow setDateHeader() calls on an included response.
void	setHeader(String name, String value) Disallow setHeader() calls on an included response.
void	setIntHeader(String name, int value) Disallow setIntHeader() calls on an included response.
void	setLocale(Locale loc) Disallow setLocale() calls on an included response.
void	setStatus(int sc) Disallow setStatus() calls on an included response.
void	setStatus(int sc, String msg) Disallow setStatus() calls on an included response.

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus

Methods inherited from class javax.servlet.ServletResponseWrapper

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, isWrapperFor, isWrapperFor, resetBuffer, setCharacterEncoding, setContentLengthLong, setResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.ServletResponse

getCharacterEncoding, getOutputStream, getWriter

Field Detail

included

protected boolean included

Is this wrapped response the subject of an include() call?

info

protected static final String info

Descriptive information about this implementation.

See Also:

Constant Field Values

Constructor Detail

ApplicationHttpResponse

public ApplicationHttpResponse(javax.servlet.http.HttpServletResponse response)

Construct a new wrapped response around the specified servlet response.

Parameters:

response - The servlet response being wrapped

ApplicationHttpResponse

public ApplicationHttpResponse(javax.servlet.http.HttpServletResponse response,
                               boolean included)

Construct a new wrapped response around the specified servlet response.

Parameters:

response - The servlet response being wrapped

included - true if this response is being processed by a RequestDispatcher.include() call

Method Detail

reset

public void reset()

Disallow reset() calls on a included response.

Overrides:

reset in class javax.servlet.ServletResponseWrapper

Throws:

IllegalStateException - if the response has already been committed

setContentLength

public void setContentLength(int len)

Disallow setContentLength() calls on an included response.

Specified by:

setContentLength in interface javax.servlet.ServletResponse

Overrides:

setContentLength in class javax.servlet.ServletResponseWrapper

Parameters:

len - The new content length

setContentType

public void setContentType(String type)

Disallow setContentType() calls on an included response.

Specified by:

setContentType in interface javax.servlet.ServletResponse

Overrides:

setContentType in class javax.servlet.ServletResponseWrapper

Parameters:

type - The new content type

setLocale

public void setLocale(Locale loc)

Disallow setLocale() calls on an included response.

Overrides:

setLocale in class javax.servlet.ServletResponseWrapper

Parameters:

loc - The new locale

setBufferSize

public void setBufferSize(int size)

Ignore setBufferSize() calls on an included response.

Overrides:

setBufferSize in class javax.servlet.ServletResponseWrapper

Parameters:

size - The buffer size

addCookie

public void addCookie(javax.servlet.http.Cookie cookie)

Disallow addCookie() calls on an included response.

Specified by:

addCookie in interface javax.servlet.http.HttpServletResponse

Overrides:

addCookie in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

cookie - The new cookie

addDateHeader

public void addDateHeader(String name,
                          long value)

Disallow addDateHeader() calls on an included response.

Overrides:

addDateHeader in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

name - The new header name

value - The new header value

addHeader

public void addHeader(String name,
                      String value)

Disallow addHeader() calls on an included response.

Overrides:

addHeader in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

name - The new header name

value - The new header value

addIntHeader

public void addIntHeader(String name,
                         int value)

Disallow addIntHeader() calls on an included response.

Overrides:

addIntHeader in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

name - The new header name

value - The new header value

sendError

public void sendError(int sc)
               throws IOException

Disallow sendError() calls on an included response.

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Overrides:

sendError in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

sc - The new status code

Throws:

IOException - if an input/output error occurs

sendError

public void sendError(int sc,
                      String msg)
               throws IOException

Disallow sendError() calls on an included response.

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Overrides:

sendError in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

sc - The new status code

msg - The new message

Throws:

IOException - if an input/output error occurs

sendRedirect

public void sendRedirect(String location)
                  throws IOException

Disallow sendRedirect() calls on an included response.

Specified by:

sendRedirect in interface javax.servlet.http.HttpServletResponse

Overrides:

sendRedirect in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

location - The new location

Throws:

IOException - if an input/output error occurs

setDateHeader

public void setDateHeader(String name,
                          long value)

Disallow setDateHeader() calls on an included response.

Specified by:

setDateHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setDateHeader in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

name - The new header name

value - The new header value

setHeader

public void setHeader(String name,
                      String value)

Disallow setHeader() calls on an included response.

Specified by:

setHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setHeader in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

name - The new header name

value - The new header value

setIntHeader

public void setIntHeader(String name,
                         int value)

Disallow setIntHeader() calls on an included response.

Specified by:

setIntHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setIntHeader in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

name - The new header name

value - The new header value

setStatus

public void setStatus(int sc)

Disallow setStatus() calls on an included response.

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

setStatus in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

sc - The new status code

setStatus

public void setStatus(int sc,
                      String msg)

Disallow setStatus() calls on an included response.

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

setStatus in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

sc - The new status code

msg - The new message

getInfo

public String getInfo()

Return descriptive information about this implementation.

isIncluded

public boolean isIncluded()

Return the included flag for this response.