io.undertow.servlet.spec

Class HttpServletResponseImpl

java.lang.Object

io.undertow.servlet.spec.HttpServletResponseImpl

All Implemented Interfaces:

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

public final class HttpServletResponseImpl
extends Object
implements javax.servlet.http.HttpServletResponse

Author:

Stuart Douglas

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpServletResponseImpl.ResponseState

Field Summary

Fields

Modifier and Type	Field and Description
static String	ISO_8859_1

Fields inherited from interface javax.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 and Description
HttpServletResponseImpl(HttpServerExchange exchange, ServletContextImpl servletContext)

Method Summary

Methods

Modifier and Type	Method and Description
void	addCookie(javax.servlet.http.Cookie cookie)
void	addDateHeader(String name, long date)
void	addHeader(HttpString name, String value)
void	addHeader(String name, String value)
void	addIntHeader(String name, int value)
void	closeStreamAndWriter()
boolean	containsHeader(String name)
String	encodeRedirectUrl(String url)
String	encodeRedirectURL(String url) Encode the session identifier associated with this response into the specified redirect URL, if necessary.
String	encodeUrl(String url)
String	encodeURL(String url)
void	flushBuffer()
int	getBufferSize()
String	getCharacterEncoding()
String	getContentType()
HttpServerExchange	getExchange()
String	getHeader(String name)
Collection<String>	getHeaderNames()
Collection<String>	getHeaders(String name)
Locale	getLocale()
javax.servlet.ServletOutputStream	getOutputStream()
ServletContextImpl	getServletContext()
int	getStatus()
PrintWriter	getWriter()
boolean	isCommitted()
protected boolean	isEncodeable(String location) Return true if the specified URL should be encoded with a session identifier.
boolean	isInsideInclude()
void	reset()
void	resetBuffer()
void	responseDone()
void	sendError(int sc)
void	sendError(int sc, String msg)
void	sendRedirect(String location)
void	setBufferSize(int size)
void	setCharacterEncoding(String charset)
void	setContentLength(int len)
void	setContentLengthLong(long len)
void	setContentType(String type)
void	setDateHeader(String name, long date)
void	setHeader(HttpString name, String value)
void	setHeader(String name, String value)
void	setInsideInclude(boolean insideInclude)
void	setIntHeader(String name, int value)
void	setLocale(Locale loc)
void	setServletContext(ServletContextImpl servletContext)
void	setStatus(int sc)
void	setStatus(int sc, String sm)
protected String	toEncoded(String url, String sessionId) Return the specified URL with the specified session identifier suitably encoded.

Methods inherited from class java.lang.Object

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

Field Detail

ISO_8859_1

public static final String ISO_8859_1

See Also:

Constant Field Values

Constructor Detail

HttpServletResponseImpl

public HttpServletResponseImpl(HttpServerExchange exchange,
                       ServletContextImpl servletContext)

Method Detail

getExchange

public HttpServerExchange getExchange()

addCookie

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

Specified by:

addCookie in interface javax.servlet.http.HttpServletResponse

containsHeader

public boolean containsHeader(String name)

Specified by:

containsHeader in interface javax.servlet.http.HttpServletResponse

encodeUrl

public String encodeUrl(String url)

Specified by:

encodeUrl in interface javax.servlet.http.HttpServletResponse

encodeRedirectUrl

public String encodeRedirectUrl(String url)

Specified by:

encodeRedirectUrl in interface javax.servlet.http.HttpServletResponse

sendError

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

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Throws:

IOException

sendError

public void sendError(int sc)
               throws IOException

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Throws:

IOException

sendRedirect

public void sendRedirect(String location)
                  throws IOException

Specified by:

sendRedirect in interface javax.servlet.http.HttpServletResponse

Throws:

IOException

setDateHeader

public void setDateHeader(String name,
                 long date)

Specified by:

setDateHeader in interface javax.servlet.http.HttpServletResponse

addDateHeader

public void addDateHeader(String name,
                 long date)

Specified by:

addDateHeader in interface javax.servlet.http.HttpServletResponse

setHeader

public void setHeader(String name,
             String value)

Specified by:

setHeader in interface javax.servlet.http.HttpServletResponse

setHeader

public void setHeader(HttpString name,
             String value)

addHeader

public void addHeader(String name,
             String value)

Specified by:

addHeader in interface javax.servlet.http.HttpServletResponse

addHeader

public void addHeader(HttpString name,
             String value)

setIntHeader

public void setIntHeader(String name,
                int value)

Specified by:

setIntHeader in interface javax.servlet.http.HttpServletResponse

addIntHeader

public void addIntHeader(String name,
                int value)

Specified by:

addIntHeader in interface javax.servlet.http.HttpServletResponse

setStatus

public void setStatus(int sc)

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

setStatus

public void setStatus(int sc,
             String sm)

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

getStatus

public int getStatus()

Specified by:

getStatus in interface javax.servlet.http.HttpServletResponse

getHeader

public String getHeader(String name)

Specified by:

getHeader in interface javax.servlet.http.HttpServletResponse

getHeaders

public Collection<String> getHeaders(String name)

Specified by:

getHeaders in interface javax.servlet.http.HttpServletResponse

getHeaderNames

public Collection<String> getHeaderNames()

Specified by:

getHeaderNames in interface javax.servlet.http.HttpServletResponse

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface javax.servlet.ServletResponse

getContentType

public String getContentType()

Specified by:

getContentType in interface javax.servlet.ServletResponse

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface javax.servlet.ServletResponse

Throws:

IOException

setCharacterEncoding

public void setCharacterEncoding(String charset)

Specified by:

setCharacterEncoding in interface javax.servlet.ServletResponse

setContentLength

public void setContentLength(int len)

Specified by:

setContentLength in interface javax.servlet.ServletResponse

setContentLengthLong

public void setContentLengthLong(long len)

Specified by:

setContentLengthLong in interface javax.servlet.ServletResponse

setContentType

public void setContentType(String type)

Specified by:

setContentType in interface javax.servlet.ServletResponse

setBufferSize

public void setBufferSize(int size)

Specified by:

setBufferSize in interface javax.servlet.ServletResponse

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface javax.servlet.ServletResponse

flushBuffer

public void flushBuffer()
                 throws IOException

Specified by:

flushBuffer in interface javax.servlet.ServletResponse

Throws:

IOException

closeStreamAndWriter

public void closeStreamAndWriter()
                          throws IOException

Throws:

IOException

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface javax.servlet.ServletResponse

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface javax.servlet.ServletResponse

reset

public void reset()

Specified by:

reset in interface javax.servlet.ServletResponse

setLocale

public void setLocale(Locale loc)

Specified by:

setLocale in interface javax.servlet.ServletResponse

getLocale

public Locale getLocale()

Specified by:

getLocale in interface javax.servlet.ServletResponse

responseDone

public void responseDone()

isInsideInclude

public boolean isInsideInclude()

setInsideInclude

public void setInsideInclude(boolean insideInclude)

setServletContext

public void setServletContext(ServletContextImpl servletContext)

getServletContext

public ServletContextImpl getServletContext()

encodeURL

public String encodeURL(String url)

Specified by:

encodeURL in interface javax.servlet.http.HttpServletResponse

encodeRedirectURL

public String encodeRedirectURL(String url)

Encode the session identifier associated with this response into the specified redirect URL, if necessary.

Specified by:

encodeRedirectURL in interface javax.servlet.http.HttpServletResponse

Parameters:

url - URL to be encoded

isEncodeable

protected boolean isEncodeable(String location)

Return true if the specified URL should be encoded with a session identifier. This will be true if all of the following conditions are met:

• The request we are responding to asked for a valid session
• The requested session ID was not received via a cookie
• The specified URL points back to somewhere within the web application that is responding to this request

Parameters:

location - Absolute URL to be validated

toEncoded

protected String toEncoded(String url,
               String sessionId)

Return the specified URL with the specified session identifier suitably encoded.

Parameters:

url - URL to be encoded with the session id

sessionId - Session id to be included in the encoded URL