Top Description Fields Constructors Methods
org.apache.catalina.core

pack-priv Class ApplicationHttpResponse

extends HttpServletResponseWrapper
Class Inheritance
Imports
java.io.IOException, java.util.Locale, jakarta.servlet.http.Cookie, .HttpServletResponse, .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

Field Summary

Modifier and TypeField and Description
protected boolean
included

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

Constructor Summary

AccessConstructor and Description
pack-priv
ApplicationHttpResponse(HttpServletResponse
The servlet response being wrapped
response, boolean
true if this response is being processed by a RequestDispatcher.include() call
included)

Construct a new wrapped response around the specified servlet response.

Method Summary

Modifier and TypeMethod and Description
public void
addCookie(Cookie
The new cookie
cookie)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.addCookie.

Implements jakarta.servlet.http.HttpServletResponse.addCookie.

Disallow addCookie() calls on an included response.

public void
addDateHeader(String
The new header name
name, long
The new header value
value)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.addDateHeader.

Implements jakarta.servlet.http.HttpServletResponse.addDateHeader.

Disallow addDateHeader() calls on an included response.

public void
addHeader(String
The new header name
name, String
The new header value
value)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.addHeader.

Implements jakarta.servlet.http.HttpServletResponse.addHeader.

Disallow addHeader() calls on an included response.

public void
addIntHeader(String
The new header name
name, int
The new header value
value)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.addIntHeader.

Implements jakarta.servlet.http.HttpServletResponse.addIntHeader.

Disallow addIntHeader() calls on an included response.

public void
reset()

Overrides jakarta.servlet.ServletResponseWrapper.reset.

Implements jakarta.servlet.ServletResponse.reset.

Disallow reset() calls on a included response.

public void
sendError(int
The new status code
sc)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.sendError.

Implements jakarta.servlet.http.HttpServletResponse.sendError.

Disallow sendError() calls on an included response.

public void
sendError(int
The new status code
sc, String
The new message
msg)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.sendError.

Implements jakarta.servlet.http.HttpServletResponse.sendError.

Disallow sendError() calls on an included response.

public void
sendRedirect(String
The new location
location)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.sendRedirect.

Implements jakarta.servlet.http.HttpServletResponse.sendRedirect.

Disallow sendRedirect() calls on an included response.

public void
setBufferSize(int
The buffer size
size)

Overrides jakarta.servlet.ServletResponseWrapper.setBufferSize.

Implements jakarta.servlet.ServletResponse.setBufferSize.

Ignore setBufferSize() calls on an included response.

public void
setContentLength(int
The new content length
len)

Overrides jakarta.servlet.ServletResponseWrapper.setContentLength.

Implements jakarta.servlet.ServletResponse.setContentLength.

Disallow setContentLength(int) calls on an included response.

public void
setContentLengthLong(long
The new content length
len)

Overrides jakarta.servlet.ServletResponseWrapper.setContentLengthLong.

Implements jakarta.servlet.ServletResponse.setContentLengthLong.

Disallow setContentLengthLong(long) calls on an included response.

public void
setContentType(String
The new content type
type)

Overrides jakarta.servlet.ServletResponseWrapper.setContentType.

Implements jakarta.servlet.ServletResponse.setContentType.

Disallow setContentType() calls on an included response.

public void
setDateHeader(String
The new header name
name, long
The new header value
value)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.setDateHeader.

Implements jakarta.servlet.http.HttpServletResponse.setDateHeader.

Disallow setDateHeader() calls on an included response.

public void
setHeader(String
The new header name
name, String
The new header value
value)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.setHeader.

Implements jakarta.servlet.http.HttpServletResponse.setHeader.

Disallow setHeader() calls on an included response.

pack-priv void
setIncluded(boolean
The new included flag
included)

Set the included flag for this response.

public void
setIntHeader(String
The new header name
name, int
The new header value
value)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.setIntHeader.

Implements jakarta.servlet.http.HttpServletResponse.setIntHeader.

Disallow setIntHeader() calls on an included response.

public void
setLocale(Locale
The new locale
loc)

Overrides jakarta.servlet.ServletResponseWrapper.setLocale.

Implements jakarta.servlet.ServletResponse.setLocale.

Disallow setLocale() calls on an included response.

pack-priv void
setResponse(HttpServletResponse
The new wrapped response
response)

Set the response that we are wrapping.

public void
setStatus(int
The new status code
sc)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.setStatus.

Implements jakarta.servlet.http.HttpServletResponse.setStatus.

Disallow setStatus() calls on an included response.

Inherited from jakarta.servlet.http.HttpServletResponseWrapper:
containsHeaderencodeRedirectURLencodeURLgetHeadergetHeaderNamesgetHeadersgetStatusgetTrailerFieldssetTrailerFields

Field Detail

includedback to summary
protected boolean included

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

Constructor Detail

ApplicationHttpResponseback to summary
pack-priv ApplicationHttpResponse(HttpServletResponse response, boolean included)

Construct a new wrapped response around the specified servlet response.

Parameters
response:HttpServletResponse

The servlet response being wrapped

included:boolean

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

Method Detail

addCookieback to summary
public void addCookie(Cookie cookie)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.addCookie.

Implements jakarta.servlet.http.HttpServletResponse.addCookie.

Disallow addCookie() calls on an included response.

Parameters
cookie:Cookie

The new cookie

Annotations
@Override
addDateHeaderback to summary
public void addDateHeader(String name, long value)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.addDateHeader.

Implements jakarta.servlet.http.HttpServletResponse.addDateHeader.

Disallow addDateHeader() calls on an included response.

Parameters
name:String

The new header name

value:long

The new header value

Annotations
@Override
addHeaderback to summary
public void addHeader(String name, String value)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.addHeader.

Implements jakarta.servlet.http.HttpServletResponse.addHeader.

Disallow addHeader() calls on an included response.

Parameters
name:String

The new header name

value:String

The new header value

Annotations
@Override
addIntHeaderback to summary
public void addIntHeader(String name, int value)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.addIntHeader.

Implements jakarta.servlet.http.HttpServletResponse.addIntHeader.

Disallow addIntHeader() calls on an included response.

Parameters
name:String

The new header name

value:int

The new header value

Annotations
@Override
resetback to summary
public void reset()

Overrides jakarta.servlet.ServletResponseWrapper.reset.

Implements jakarta.servlet.ServletResponse.reset.

Disallow reset() calls on a included response.

Annotations
@Override
Exceptions
IllegalStateException:
if the response has already been committed
sendErrorback to summary
public void sendError(int sc) throws IOException

Overrides jakarta.servlet.http.HttpServletResponseWrapper.sendError.

Implements jakarta.servlet.http.HttpServletResponse.sendError.

Disallow sendError() calls on an included response.

Parameters
sc:int

The new status code

Annotations
@Override
Exceptions
IOException:
if an input/output error occurs
sendErrorback to summary
public void sendError(int sc, String msg) throws IOException

Overrides jakarta.servlet.http.HttpServletResponseWrapper.sendError.

Implements jakarta.servlet.http.HttpServletResponse.sendError.

Disallow sendError() calls on an included response.

Parameters
sc:int

The new status code

msg:String

The new message

Annotations
@Override
Exceptions
IOException:
if an input/output error occurs
sendRedirectback to summary
public void sendRedirect(String location) throws IOException

Overrides jakarta.servlet.http.HttpServletResponseWrapper.sendRedirect.

Implements jakarta.servlet.http.HttpServletResponse.sendRedirect.

Disallow sendRedirect() calls on an included response.

Parameters
location:String

The new location

Annotations
@Override
Exceptions
IOException:
if an input/output error occurs
setBufferSizeback to summary
public void setBufferSize(int size)

Overrides jakarta.servlet.ServletResponseWrapper.setBufferSize.

Implements jakarta.servlet.ServletResponse.setBufferSize.

Ignore setBufferSize() calls on an included response.

Parameters
size:int

The buffer size

Annotations
@Override
setContentLengthback to summary
public void setContentLength(int len)

Overrides jakarta.servlet.ServletResponseWrapper.setContentLength.

Implements jakarta.servlet.ServletResponse.setContentLength.

Disallow setContentLength(int) calls on an included response.

Parameters
len:int

The new content length

Annotations
@Override
setContentLengthLongback to summary
public void setContentLengthLong(long len)

Overrides jakarta.servlet.ServletResponseWrapper.setContentLengthLong.

Implements jakarta.servlet.ServletResponse.setContentLengthLong.

Disallow setContentLengthLong(long) calls on an included response.

Parameters
len:long

The new content length

Annotations
@Override
setContentTypeback to summary
public void setContentType(String type)

Overrides jakarta.servlet.ServletResponseWrapper.setContentType.

Implements jakarta.servlet.ServletResponse.setContentType.

Disallow setContentType() calls on an included response.

Parameters
type:String

The new content type

Annotations
@Override
setDateHeaderback to summary
public void setDateHeader(String name, long value)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.setDateHeader.

Implements jakarta.servlet.http.HttpServletResponse.setDateHeader.

Disallow setDateHeader() calls on an included response.

Parameters
name:String

The new header name

value:long

The new header value

Annotations
@Override
setHeaderback to summary
public void setHeader(String name, String value)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.setHeader.

Implements jakarta.servlet.http.HttpServletResponse.setHeader.

Disallow setHeader() calls on an included response.

Parameters
name:String

The new header name

value:String

The new header value

Annotations
@Override
setIncludedback to summary
pack-priv void setIncluded(boolean included)

Set the included flag for this response.

Parameters
included:boolean

The new included flag

setIntHeaderback to summary
public void setIntHeader(String name, int value)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.setIntHeader.

Implements jakarta.servlet.http.HttpServletResponse.setIntHeader.

Disallow setIntHeader() calls on an included response.

Parameters
name:String

The new header name

value:int

The new header value

Annotations
@Override
setLocaleback to summary
public void setLocale(Locale loc)

Overrides jakarta.servlet.ServletResponseWrapper.setLocale.

Implements jakarta.servlet.ServletResponse.setLocale.

Disallow setLocale() calls on an included response.

Parameters
loc:Locale

The new locale

Annotations
@Override
setResponseback to summary
pack-priv void setResponse(HttpServletResponse response)

Set the response that we are wrapping.

Parameters
response:HttpServletResponse

The new wrapped response

setStatusback to summary
public void setStatus(int sc)

Overrides jakarta.servlet.http.HttpServletResponseWrapper.setStatus.

Implements jakarta.servlet.http.HttpServletResponse.setStatus.

Disallow setStatus() calls on an included response.

Parameters
sc:int

The new status code

Annotations
@Override