HttpServletResponseWrapper (GNU Servlet API documentation)

JavaScript is disabled on your browser.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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 
```
Provided as a convenience to a developer that wishes to write an adapter to an HttpServletResponse Object. By Default it passes all methods that are part of the HttpServletResponse interface to the underlying implementation

Since:

2.3

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 and Description
`HttpServletResponseWrapper (HttpServletResponse response)` Create a new HttpServletResponseWrapper to act as an adapter for the supplied HttpServletResponse.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCookie (Cookie cookie)` By default passes the call to the underlying HttpServletResponse
`void`	`addDateHeader (java.lang.String name, long date)` By default passes the call to the underlying HttpServletResponse
`void`	`addHeader (java.lang.String name, java.lang.String value)` By default passes the call to the underlying HttpServletResponse
`void`	`addIntHeader (java.lang.String name, int value)` By default passes the call to the underlying HttpServletResponse
`boolean`	`containsHeader (java.lang.String name)` By default passes the call to the underlying HttpServletResponse
`java.lang.String`	`encodeRedirectUrl (java.lang.String url)` Deprecated. use `encodeRedirectURL()`
`java.lang.String`	`encodeRedirectURL (java.lang.String url)` By default passes the call to the underlying HttpServletResponse
`java.lang.String`	`encodeUrl (java.lang.String url)` Deprecated. use `encodeURL()`
`java.lang.String`	`encodeURL (java.lang.String url)` By default passes the call to the underlying HttpServletResponse
`java.lang.String`	`getContentType ()` get the content type
`java.lang.String`	`getHeader (java.lang.String name)` By default passes the call to the underlying HttpServletResponse
`java.util.Collection<java.lang.String>`	`getHeaderNames ()` By default passes the call to the underlying HttpServletResponse
`java.util.Collection<java.lang.String>`	`getHeaders (java.lang.String name)` By default passes the call to the underlying HttpServletResponse
`int`	`getStatus ()` By default passes the call to the underlying HttpServletResponse
`void`	`sendError (int status)` By default passes the call to the underlying HttpServletResponse
`void`	`sendError (int status, java.lang.String message)` By default passes the call to the underlying HttpServletResponse
`void`	`sendRedirect (java.lang.String location)` By default passes the call to the underlying HttpServletResponse
`void`	`setDateHeader (java.lang.String name, long date)` By default passes the call to the underlying HttpServletResponse
`void`	`setHeader (java.lang.String name, java.lang.String value)` By default passes the call to the underlying HttpServletResponse
`void`	`setIntHeader (java.lang.String name, int value)` By default passes the call to the underlying HttpServletResponse
`void`	`setStatus (int status)` By default passes the call to the underlying HttpServletResponse
`void`	`setStatus (int status, java.lang.String msg)` Deprecated. only errors should give an extra error message,

Methods inherited from class javax.servlet.ServletResponseWrapper
flushBuffer, getBufferSize, getCharacterEncoding, getLocale, getOutputStream, getResponse, getWriter, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, 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.ServletResponse
flushBuffer, getBufferSize, getCharacterEncoding, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale

- Constructor Detail
  - HttpServletResponseWrapper
```
public HttpServletResponseWrapper(HttpServletResponse response)
```
    Create a new HttpServletResponseWrapper to act as an adapter for the supplied HttpServletResponse. The Default behavior is to pass all methods that are part of the HttpServletResponse interface through to the underlying object
    
    Parameters:
    response - the response to be wrapped
    
    Throws:
    
    java.lang.IllegalArgumentException - if response is null
- Method Detail
  - getContentType
```
public java.lang.String getContentType()
```
    Description copied from class: ServletResponseWrapper
    
    get the content type
    
    Specified by:
    
    getContentType in interface ServletResponse
    
    Overrides:
    
    getContentType in class ServletResponseWrapper
    
    Returns:
    the content type
  - addCookie
```
public void addCookie(Cookie cookie)
```
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    addCookie in interface HttpServletResponse
    
    Parameters:
    cookie - the cookie to be added
  - containsHeader
```
public boolean containsHeader(java.lang.String name)
```
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    containsHeader in interface HttpServletResponse
    
    Parameters:
    name - the name of the header filed
  - encodeURL
```
public java.lang.String encodeURL(java.lang.String url)
```
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    encodeURL in interface HttpServletResponse
    
    Parameters:
    url - the URL to be encoded
    
    Returns:
    the URL with any necessary session information added
  - encodeRedirectURL
```
public java.lang.String encodeRedirectURL(java.lang.String url)
```
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    encodeRedirectURL in interface HttpServletResponse
    
    Parameters:
    url - the URL to be encoded
    
    Returns:
    the URL with any necessary session information added
    See Also:
    HttpServletResponse.sendRedirect(java.lang.String)
  - encodeUrl
```
public java.lang.String encodeUrl(java.lang.String url)
```
    Deprecated. use encodeURL()
    
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    encodeUrl in interface HttpServletResponse
    
    Parameters:
    url - the URL to be encoded
    
    Returns:
    the URL with any necessary session information added
  - encodeRedirectUrl
```
public java.lang.String encodeRedirectUrl(java.lang.String url)
```
    Deprecated. use encodeRedirectURL()
    
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    encodeRedirectUrl in interface HttpServletResponse
    
    Parameters:
    url - the URL to be encoded
    
    Returns:
    the URL with any necessary session information added
    See Also:
    HttpServletResponse.sendRedirect(java.lang.String)
  - sendError
```
public void sendError(int status,
 java.lang.String message)
 throws java.io.IOException
```
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    sendError in interface HttpServletResponse
    
    Parameters:
    status - The error code
    message - A descriptive error message
    
    Throws:
    
    java.io.IOException
  - sendError
```
public void sendError(int status)
 throws java.io.IOException
```
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    sendError in interface HttpServletResponse
    
    Parameters:
    status - The error code
    
    Throws:
    
    java.io.IOException
  - sendRedirect
```
public void sendRedirect(java.lang.String location)
 throws java.io.IOException
```
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    sendRedirect in interface HttpServletResponse
    
    Throws:
    
    java.io.IOException - if an i/o error occurs
  - setDateHeader
```
public void setDateHeader(java.lang.String name,
 long date)
```
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    setDateHeader in interface HttpServletResponse
    
    Parameters:
    name - The name of the header field
    date - The date in milliseconds since January 1, 1970, 00:00:00 GMT
  - addDateHeader
```
public void addDateHeader(java.lang.String name,
 long date)
```
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    addDateHeader in interface HttpServletResponse
  - setHeader
```
public void setHeader(java.lang.String name,
 java.lang.String value)
```
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    setHeader in interface HttpServletResponse
    
    Parameters:
    name - The name of the header field
    value - The (new) value of the header field
  - addHeader
```
public void addHeader(java.lang.String name,
 java.lang.String value)
```
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    addHeader in interface HttpServletResponse
  - setIntHeader
```
public void setIntHeader(java.lang.String name,
 int value)
```
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    setIntHeader in interface HttpServletResponse
    
    Parameters:
    name - The name of the header field
    value - The (new) value of the header field
  - addIntHeader
```
public void addIntHeader(java.lang.String name,
 int value)
```
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    addIntHeader in interface HttpServletResponse
  - setStatus
```
public void setStatus(int status)
```
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    setStatus in interface HttpServletResponse
    
    Parameters:
    status - The status code
    See Also:
    HttpServletResponse.sendError(int, java.lang.String)
  - setStatus
```
public void setStatus(int status,
 java.lang.String msg)
```
    Deprecated. only errors should give an extra error message,
    
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    setStatus in interface HttpServletResponse
    
    Parameters:
    status - The status code
    See Also:
    HttpServletResponse.sendError(int, java.lang.String), HttpServletResponse.setStatus(int)
  - getStatus
```
public int getStatus()
```
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    getStatus in interface HttpServletResponse
    
    Since:
    
    3.0
  - getHeader
```
public java.lang.String getHeader(java.lang.String name)
```
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    getHeader in interface HttpServletResponse
    
    Since:
    
    3.0
  - getHeaders
```
public java.util.Collection<java.lang.String> getHeaders(java.lang.String name)
```
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    getHeaders in interface HttpServletResponse
    
    Since:
    
    3.0
  - getHeaderNames
```
public java.util.Collection<java.lang.String> getHeaderNames()
```
    By default passes the call to the underlying HttpServletResponse
    
    Specified by:
    
    getHeaderNames in interface HttpServletResponse
    
    Since:
    
    3.0

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class HttpServletResponseWrapper

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletResponse

Constructor Summary

Method Summary

Methods inherited from class javax.servlet.ServletResponseWrapper

Methods inherited from class java.lang.Object

Methods inherited from interface javax.servlet.ServletResponse

Constructor Detail

HttpServletResponseWrapper

Method Detail

getContentType

addCookie

containsHeader

encodeURL

encodeRedirectURL

encodeUrl

encodeRedirectUrl

sendError

sendError

sendRedirect

setDateHeader

addDateHeader

setHeader

addHeader

setIntHeader

addIntHeader

setStatus

setStatus

getStatus

getHeader

getHeaders

getHeaderNames