Package org.glassfish.grizzly.servlet

Class DispatchedHttpServletResponse

java.lang.Object

jakarta.servlet.ServletResponseWrapper

jakarta.servlet.http.HttpServletResponseWrapper

org.glassfish.grizzly.servlet.DispatchedHttpServletResponse

All Implemented Interfaces:

HttpServletResponse, ServletResponse

public class DispatchedHttpServletResponse
extends HttpServletResponseWrapper

Wrapper around a jakarta.servlet.http.HttpServletResponse that transforms an application response object (which might be the original one passed to a servlet.

Author:

Bongjae Chang

Field Summary

Fields inherited from interface jakarta.servlet.http.HttpServletResponse

SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, 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_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

Constructor Summary

Constructors

Constructor	Description
DispatchedHttpServletResponse(HttpServletResponse response, boolean included)

Method Summary

Modifier and Type	Method	Description
void	addCookie(Cookie cookie)	The default behavior of this method is to call addCookie(Cookie cookie) on the wrapped response object.
void	addDateHeader(String name, long date)	The default behavior of this method is to call addDateHeader(String name, long date) on the wrapped response object.
void	addHeader(String name, String value)	The default behavior of this method is to return addHeader(String name, String value) on the wrapped response object.
void	addIntHeader(String name, int value)	The default behavior of this method is to call addIntHeader(String name, int value) on the wrapped response object.
void	reset()	The default behavior of this method is to call reset() on the wrapped response object.
void	sendError(int sc)	The default behavior of this method is to call sendError(int sc) on the wrapped response object.
void	sendError(int sc, String msg)	The default behavior of this method is to call sendError(int sc, String msg) on the wrapped response object.
void	sendRedirect(String location)	The default behavior of this method is to return sendRedirect(String location) on the wrapped response object.
void	setBufferSize(int size)	The default behavior of this method is to call setBufferSize(int size) on the wrapped response object.
void	setCharacterEncoding(String charEnc)	The default behavior of this method is to call setCharacterEncoding(String charset) on the wrapped response object.
void	setContentLength(int len)	The default behavior of this method is to call setContentLength(int len) on the wrapped response object.
void	setContentType(String type)	The default behavior of this method is to call setContentType(String type) on the wrapped response object.
void	setDateHeader(String name, long date)	The default behavior of this method is to call setDateHeader(String name, long date) on the wrapped response object.
void	setHeader(String name, String value)	The default behavior of this method is to return setHeader(String name, String value) on the wrapped response object.
void	setIntHeader(String name, int value)	The default behavior of this method is to call setIntHeader(String name, int value) on the wrapped response object.
void	setLocale(Locale loc)	The default behavior of this method is to call setLocale(Locale loc) on the wrapped response object.
void	setStatus(int sc)	The default behavior of this method is to call setStatus(int sc) on the wrapped response object.

Methods inherited from class jakarta.servlet.http.HttpServletResponseWrapper

containsHeader, encodeRedirectURL, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, getTrailerFields, setTrailerFields

Methods inherited from class jakarta.servlet.ServletResponseWrapper

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.servlet.ServletResponse

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, resetBuffer, setContentLengthLong

Constructor Details

DispatchedHttpServletResponse

public DispatchedHttpServletResponse(HttpServletResponse response,
 boolean included)

Method Details

setContentLength

public void setContentLength(int len)

Description copied from class: ServletResponseWrapper

The default behavior of this method is to call setContentLength(int len) on the wrapped response object.

Specified by:

setContentLength in interface ServletResponse

Overrides:

setContentLength in class ServletResponseWrapper

Parameters:

len - an integer specifying the length of the content being returned to the client; sets the Content-Length header

setContentType

public void setContentType(String type)

Description copied from class: ServletResponseWrapper

The default behavior of this method is to call setContentType(String type) on the wrapped response object.

Specified by:

setContentType in interface ServletResponse

Overrides:

setContentType in class ServletResponseWrapper

Parameters:

type - a String specifying the MIME type of the content or null

See Also:

• ServletResponse.setLocale(java.util.Locale)
• ServletResponse.setCharacterEncoding(java.lang.String)
• ServletResponse.getOutputStream()
• ServletResponse.getWriter()

setBufferSize

public void setBufferSize(int size)

Description copied from class: ServletResponseWrapper

The default behavior of this method is to call setBufferSize(int size) on the wrapped response object.

Specified by:

setBufferSize in interface ServletResponse

Overrides:

setBufferSize in class ServletResponseWrapper

Parameters:

size - the preferred buffer size

See Also:

• ServletResponse.getBufferSize()
• ServletResponse.flushBuffer()
• ServletResponse.isCommitted()
• ServletResponse.reset()

reset

public void reset()

Description copied from class: ServletResponseWrapper

The default behavior of this method is to call reset() on the wrapped response object.

Specified by:

reset in interface ServletResponse

Overrides:

reset in class ServletResponseWrapper

See Also:

• ServletResponse.setBufferSize(int)
• ServletResponse.getBufferSize()
• ServletResponse.flushBuffer()
• ServletResponse.isCommitted()

setLocale

public void setLocale(Locale loc)

Description copied from class: ServletResponseWrapper

The default behavior of this method is to call setLocale(Locale loc) on the wrapped response object.

Specified by:

setLocale in interface ServletResponse

Overrides:

setLocale in class ServletResponseWrapper

Parameters:

loc - the locale of the response or {code @null}

See Also:

• ServletResponse.getLocale()
• ServletResponse.setContentType(java.lang.String)
• ServletResponse.setCharacterEncoding(java.lang.String)

addCookie

public void addCookie(Cookie cookie)

Description copied from class: HttpServletResponseWrapper

The default behavior of this method is to call addCookie(Cookie cookie) on the wrapped response object.

Specified by:

addCookie in interface HttpServletResponse

Overrides:

addCookie in class HttpServletResponseWrapper

Parameters:

cookie - the Cookie to return to the client

sendError

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

Description copied from class: HttpServletResponseWrapper

The default behavior of this method is to call sendError(int sc, String msg) on the wrapped response object.

Specified by:

sendError in interface HttpServletResponse

Overrides:

sendError in class HttpServletResponseWrapper

Parameters:

sc - the error status code

msg - the descriptive message

Throws:

IOException - If an input or output exception occurs

sendError

public void sendError(int sc)
               throws IOException

Description copied from class: HttpServletResponseWrapper

The default behavior of this method is to call sendError(int sc) on the wrapped response object.

Specified by:

sendError in interface HttpServletResponse

Overrides:

sendError in class HttpServletResponseWrapper

Parameters:

sc - the error status code

Throws:

IOException - If an input or output exception occurs

sendRedirect

public void sendRedirect(String location)
                  throws IOException

Description copied from class: HttpServletResponseWrapper

The default behavior of this method is to return sendRedirect(String location) on the wrapped response object.

Specified by:

sendRedirect in interface HttpServletResponse

Overrides:

sendRedirect in class HttpServletResponseWrapper

Parameters:

location - the redirect location URL

Throws:

IOException - If an input or output exception occurs

setDateHeader

public void setDateHeader(String name,
 long date)

Description copied from class: HttpServletResponseWrapper

The default behavior of this method is to call setDateHeader(String name, long date) on the wrapped response object.

Specified by:

setDateHeader in interface HttpServletResponse

Overrides:

setDateHeader in class HttpServletResponseWrapper

Parameters:

name - the name of the header to set

date - the assigned date value

See Also:

• HttpServletResponse.containsHeader(java.lang.String)
• HttpServletResponse.addDateHeader(java.lang.String, long)

addDateHeader

public void addDateHeader(String name,
 long date)

Description copied from class: HttpServletResponseWrapper

The default behavior of this method is to call addDateHeader(String name, long date) on the wrapped response object.

Specified by:

addDateHeader in interface HttpServletResponse

Overrides:

addDateHeader in class HttpServletResponseWrapper

Parameters:

name - the name of the header to set

date - the additional date value

See Also:

• HttpServletResponse.setDateHeader(java.lang.String, long)

setHeader

public void setHeader(String name,
 String value)

Description copied from class: HttpServletResponseWrapper

The default behavior of this method is to return setHeader(String name, String value) on the wrapped response object.

Specified by:

setHeader in interface HttpServletResponse

Overrides:

setHeader in class HttpServletResponseWrapper

Parameters:

name - the name of the header

value - the header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)

See Also:

• HttpServletResponse.containsHeader(java.lang.String)
• HttpServletResponse.addHeader(java.lang.String, java.lang.String)

addHeader

public void addHeader(String name,
 String value)

Description copied from class: HttpServletResponseWrapper

The default behavior of this method is to return addHeader(String name, String value) on the wrapped response object.

Specified by:

addHeader in interface HttpServletResponse

Overrides:

addHeader in class HttpServletResponseWrapper

Parameters:

name - the name of the header

value - the additional header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)

See Also:

• HttpServletResponse.setHeader(java.lang.String, java.lang.String)

setIntHeader

public void setIntHeader(String name,
 int value)

Description copied from class: HttpServletResponseWrapper

The default behavior of this method is to call setIntHeader(String name, int value) on the wrapped response object.

Specified by:

setIntHeader in interface HttpServletResponse

Overrides:

setIntHeader in class HttpServletResponseWrapper

Parameters:

name - the name of the header

value - the assigned integer value

See Also:

• HttpServletResponse.containsHeader(java.lang.String)
• HttpServletResponse.addIntHeader(java.lang.String, int)

addIntHeader

public void addIntHeader(String name,
 int value)

Description copied from class: HttpServletResponseWrapper

The default behavior of this method is to call addIntHeader(String name, int value) on the wrapped response object.

Specified by:

addIntHeader in interface HttpServletResponse

Overrides:

addIntHeader in class HttpServletResponseWrapper

Parameters:

name - the name of the header

value - the assigned integer value

See Also:

• HttpServletResponse.setIntHeader(java.lang.String, int)

setStatus

public void setStatus(int sc)

Description copied from class: HttpServletResponseWrapper

The default behavior of this method is to call setStatus(int sc) on the wrapped response object.

Specified by:

setStatus in interface HttpServletResponse

Overrides:

setStatus in class HttpServletResponseWrapper

Parameters:

sc - the status code

See Also:

• HttpServletResponse.sendError(int, java.lang.String)

setCharacterEncoding

public void setCharacterEncoding(String charEnc)

Description copied from class: ServletResponseWrapper

The default behavior of this method is to call setCharacterEncoding(String charset) on the wrapped response object.

Specified by:

setCharacterEncoding in interface ServletResponse

Overrides:

setCharacterEncoding in class ServletResponseWrapper

Parameters:

charEnc - a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets) or null

See Also:

• ServletResponse.setContentType(java.lang.String)
• ServletResponse.setLocale(java.util.Locale)