Package javax.servlet.http
Class HttpServletResponseWrapper
- java.lang.Object
-
- javax.servlet.ServletResponseWrapper
-
- javax.servlet.http.HttpServletResponseWrapper
-
- All Implemented Interfaces:
HttpServletResponse
,ServletResponse
public class HttpServletResponseWrapper extends ServletResponseWrapper implements HttpServletResponse
The HttpServletResponseWrapper API.- Author:
- Manfred Riem ([email protected])
-
-
Field Summary
-
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 Description HttpServletResponseWrapper(HttpServletResponse response)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addCookie(Cookie cookie)
Add the cookie.void
addDateHeader(String name, long date)
Add the date header.void
addHeader(String name, String value)
Add the header.void
addIntHeader(String name, int value)
Add the int header.boolean
containsHeader(String name)
Contains the header.String
encodeRedirectUrl(String url)
Deprecated.String
encodeRedirectURL(String url)
Encode the redirect URL.String
encodeUrl(String url)
Deprecated.String
encodeURL(String url)
Encode the URL.String
getHeader(String name)
Get the header.Collection<String>
getHeaderNames()
Get the header names.Collection<String>
getHeaders(String name)
Get the headers.int
getStatus()
Get the status.void
sendError(int status)
Send an error.void
sendError(int status, String message)
Send an error.void
sendRedirect(String location)
Send a redirect.void
setDateHeader(String name, long date)
Set the date header.void
setHeader(String name, String value)
Set the header.void
setIntHeader(String name, int value)
Set the int header.void
setStatus(int status)
Set the status.void
setStatus(int status, String message)
Deprecated.-
Methods inherited from class javax.servlet.ServletResponseWrapper
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale, 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.http.HttpServletResponse
getTrailerFields, setTrailerFields
-
Methods inherited from interface javax.servlet.ServletResponse
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale
-
-
-
-
Constructor Detail
-
HttpServletResponseWrapper
public HttpServletResponseWrapper(HttpServletResponse response)
Constructor.- Parameters:
response
- the HTTP servlet response.
-
-
Method Detail
-
addCookie
public void addCookie(Cookie cookie)
Add the cookie.- Specified by:
addCookie
in interfaceHttpServletResponse
- Parameters:
cookie
- the cookie.
-
addDateHeader
public void addDateHeader(String name, long date)
Add the date header.- Specified by:
addDateHeader
in interfaceHttpServletResponse
- Parameters:
name
- the name.date
- the date.
-
addHeader
public void addHeader(String name, String value)
Add the header.- Specified by:
addHeader
in interfaceHttpServletResponse
- Parameters:
name
- the name.value
- the value.
-
addIntHeader
public void addIntHeader(String name, int value)
Add the int header.- Specified by:
addIntHeader
in interfaceHttpServletResponse
- Parameters:
name
- the name.value
- the value.
-
containsHeader
public boolean containsHeader(String name)
Contains the header.- Specified by:
containsHeader
in interfaceHttpServletResponse
- Parameters:
name
- the name.- Returns:
- true if it contains the given header, false otherwise.
-
encodeRedirectURL
public String encodeRedirectURL(String url)
Encode the redirect URL.- Specified by:
encodeRedirectURL
in interfaceHttpServletResponse
- Parameters:
url
- the redirect URL.- Returns:
- the encoded redirect URL.
-
encodeRedirectUrl
@Deprecated public String encodeRedirectUrl(String url)
Deprecated.Encode the redirect URL.- Specified by:
encodeRedirectUrl
in interfaceHttpServletResponse
- Parameters:
url
- the redirect URL.- Returns:
- the encoded redirect URL.
-
encodeURL
public String encodeURL(String url)
Encode the URL.- Specified by:
encodeURL
in interfaceHttpServletResponse
- Parameters:
url
- the URL.- Returns:
- the encoded URL.
-
encodeUrl
@Deprecated public String encodeUrl(String url)
Deprecated.Encode the URL.- Specified by:
encodeUrl
in interfaceHttpServletResponse
- Parameters:
url
- the URL.- Returns:
- the encoded URL.
-
getHeader
public String getHeader(String name)
Get the header.- Specified by:
getHeader
in interfaceHttpServletResponse
- Parameters:
name
- the name.- Returns:
- the header, or null if not found.
-
getHeaders
public Collection<String> getHeaders(String name)
Get the headers.- Specified by:
getHeaders
in interfaceHttpServletResponse
- Parameters:
name
- the name.- Returns:
- the headers.
-
getHeaderNames
public Collection<String> getHeaderNames()
Get the header names.- Specified by:
getHeaderNames
in interfaceHttpServletResponse
- Returns:
- the header names.
-
getStatus
public int getStatus()
Get the status.- Specified by:
getStatus
in interfaceHttpServletResponse
- Returns:
- the status.
-
sendError
public void sendError(int status) throws IOException
Send an error.- Specified by:
sendError
in interfaceHttpServletResponse
- Parameters:
status
- the status code.- Throws:
IOException
- when an I/O error occurs.
-
sendError
public void sendError(int status, String message) throws IOException
Send an error.- Specified by:
sendError
in interfaceHttpServletResponse
- Parameters:
status
- the status code.message
- the message.- Throws:
IOException
- when an I/O error occurs.
-
sendRedirect
public void sendRedirect(String location) throws IOException
Send a redirect.- Specified by:
sendRedirect
in interfaceHttpServletResponse
- Parameters:
location
- the location.- Throws:
IOException
- when an I/O error occurs.
-
setDateHeader
public void setDateHeader(String name, long date)
Set the date header.- Specified by:
setDateHeader
in interfaceHttpServletResponse
- Parameters:
name
- the name.date
- the date.
-
setHeader
public void setHeader(String name, String value)
Set the header.- Specified by:
setHeader
in interfaceHttpServletResponse
- Parameters:
name
- the name.value
- the value.
-
setIntHeader
public void setIntHeader(String name, int value)
Set the int header.- Specified by:
setIntHeader
in interfaceHttpServletResponse
- Parameters:
name
- the name.value
- the value.
-
setStatus
public void setStatus(int status)
Set the status.- Specified by:
setStatus
in interfaceHttpServletResponse
- Parameters:
status
- the status.
-
setStatus
@Deprecated public void setStatus(int status, String message)
Deprecated.Set the status.- Specified by:
setStatus
in interfaceHttpServletResponse
- Parameters:
status
- the status code.message
- the status message.
-
-