PortletServletResponseWrapper (Apache Wicket

java.lang.Object
- javax.servlet.ServletResponseWrapper
- - javax.servlet.http.HttpServletResponseWrapper
  - - org.apache.wicket.portlet.PortletServletResponseWrapper

All Implemented Interfaces:

HttpServletResponse, ServletResponse
```
public class PortletServletResponseWrapper
extends HttpServletResponseWrapper
```
General class for all Portal responses, wrapping Servlet responses with Portal specific functionality. Records various settings in the ResponseState, like the redirect location, which as when running as a portlet wicket uses the RequestCycleSettings.RenderStrategy.REDIRECT_TO_RENDER strategy, is used in the render phase to know what Wicket url to request Wicket Core to render.

Author:

Ate Douma, Sebastian Thomschke

See Also:

WicketPortlet.processActionResponseState(java.lang.String, javax.portlet.PortletRequest, javax.portlet.ActionResponse, org.apache.wicket.portlet.ResponseState), WicketPortlet.processMimeResponseRequest(java.lang.String, javax.portlet.PortletRequest, javax.portlet.MimeResponse, org.apache.wicket.portlet.ResponseState), RequestCycleSettings.RenderStrategy.REDIRECT_TO_RENDER

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

PortletServletResponseWrapper(HttpServletResponse response, ResponseState responseState)

Constructors
Constructor and Description
`PortletServletResponseWrapper(HttpServletResponse response, ResponseState responseState)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCookie(Cookie cookie)`
`void`	`addDateHeader(String name, long date)`
`void`	`addHeader(String name, String value)`
`void`	`addIntHeader(String name, int value)`
`boolean`	`containsHeader(String name)`
`String`	`encodeRedirectUrl(String url)`
`String`	`encodeRedirectURL(String url)`
`String`	`encodeUrl(String url)`
`String`	`encodeURL(String url)`
`void`	`flushBuffer()`
`int`	`getBufferSize()`
`String`	`getCharacterEncoding()`
`String`	`getContentType()`
`Locale`	`getLocale()`
`ServletOutputStream`	`getOutputStream()`
`PrintWriter`	`getWriter()`
`boolean`	`isCommitted()`
`void`	`reset()`
`void`	`resetBuffer()`
`void`	`sendError(int errorCode)`
`void`	`sendError(int errorCode, String errorMessage)`
`void`	`sendRedirect(String redirectLocation)`
`void`	`setBufferSize(int size)`
`void`	`setCharacterEncoding(String charset)`
`void`	`setContentLength(int len)`
`void`	`setContentType(String type)`
`void`	`setDateHeader(String name, long date)`
`void`	`setHeader(String name, String value)`
`void`	`setIntHeader(String name, int value)`
`void`	`setLocale(Locale locale)`
`void`	`setStatus(int statusCode)`
`void`	`setStatus(int statusCode, String message)`

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper
getHeader, getHeaderNames, getHeaders, getStatus

Methods inherited from class javax.servlet.ServletResponseWrapper
getResponse, isWrapperFor, isWrapperFor, setContentLengthLong, 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
setContentLengthLong

- Constructor Detail
  - PortletServletResponseWrapper
```
public PortletServletResponseWrapper(HttpServletResponse response,
                                     ResponseState responseState)
```
- Method Detail
  - addCookie
```
public void addCookie(Cookie cookie)
```
    Specified by:
    
    addCookie in interface HttpServletResponse
    
    Overrides:
    
    addCookie in class HttpServletResponseWrapper
  - addDateHeader
```
public void addDateHeader(String name,
                          long date)
```
    Specified by:
    
    addDateHeader in interface HttpServletResponse
    
    Overrides:
    
    addDateHeader in class HttpServletResponseWrapper
  - addHeader
```
public void addHeader(String name,
                      String value)
```
    Specified by:
    
    addHeader in interface HttpServletResponse
    
    Overrides:
    
    addHeader in class HttpServletResponseWrapper
  - addIntHeader
```
public void addIntHeader(String name,
                         int value)
```
    Specified by:
    
    addIntHeader in interface HttpServletResponse
    
    Overrides:
    
    addIntHeader in class HttpServletResponseWrapper
  - containsHeader
```
public boolean containsHeader(String name)
```
    Specified by:
    
    containsHeader in interface HttpServletResponse
    
    Overrides:
    
    containsHeader in class HttpServletResponseWrapper
  - encodeRedirectUrl
```
public String encodeRedirectUrl(String url)
```
    Specified by:
    
    encodeRedirectUrl in interface HttpServletResponse
    
    Overrides:
    
    encodeRedirectUrl in class HttpServletResponseWrapper
  - encodeRedirectURL
```
public String encodeRedirectURL(String url)
```
    Specified by:
    
    encodeRedirectURL in interface HttpServletResponse
    
    Overrides:
    
    encodeRedirectURL in class HttpServletResponseWrapper
  - encodeUrl
```
public String encodeUrl(String url)
```
    Specified by:
    
    encodeUrl in interface HttpServletResponse
    
    Overrides:
    
    encodeUrl in class HttpServletResponseWrapper
  - encodeURL
```
public String encodeURL(String url)
```
    Specified by:
    
    encodeURL in interface HttpServletResponse
    
    Overrides:
    
    encodeURL in class HttpServletResponseWrapper
  - flushBuffer
```
public void flushBuffer()
                 throws IOException
```
    Specified by:
    
    flushBuffer in interface ServletResponse
    
    Overrides:
    
    flushBuffer in class ServletResponseWrapper
    
    Throws:
    
    IOException
  - getBufferSize
```
public int getBufferSize()
```
    Specified by:
    
    getBufferSize in interface ServletResponse
    
    Overrides:
    
    getBufferSize in class ServletResponseWrapper
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface ServletResponse
    
    Overrides:
    
    getCharacterEncoding in class ServletResponseWrapper
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface ServletResponse
    
    Overrides:
    
    getContentType in class ServletResponseWrapper
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface ServletResponse
    
    Overrides:
    
    getLocale in class ServletResponseWrapper
  - getOutputStream
```
public ServletOutputStream getOutputStream()
                                    throws IOException
```
    Specified by:
    
    getOutputStream in interface ServletResponse
    
    Overrides:
    
    getOutputStream in class ServletResponseWrapper
    
    Throws:
    
    IOException
  - getWriter
```
public PrintWriter getWriter()
                      throws IOException
```
    Specified by:
    
    getWriter in interface ServletResponse
    
    Overrides:
    
    getWriter in class ServletResponseWrapper
    
    Throws:
    
    IOException
  - isCommitted
```
public boolean isCommitted()
```
    Specified by:
    
    isCommitted in interface ServletResponse
    
    Overrides:
    
    isCommitted in class ServletResponseWrapper
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface ServletResponse
    
    Overrides:
    
    reset in class ServletResponseWrapper
  - resetBuffer
```
public void resetBuffer()
```
    Specified by:
    
    resetBuffer in interface ServletResponse
    
    Overrides:
    
    resetBuffer in class ServletResponseWrapper
  - sendError
```
public void sendError(int errorCode)
               throws IOException
```
    Specified by:
    
    sendError in interface HttpServletResponse
    
    Overrides:
    
    sendError in class HttpServletResponseWrapper
    
    Throws:
    
    IOException
  - sendError
```
public void sendError(int errorCode,
                      String errorMessage)
               throws IOException
```
    Specified by:
    
    sendError in interface HttpServletResponse
    
    Overrides:
    
    sendError in class HttpServletResponseWrapper
    
    Throws:
    
    IOException
  - sendRedirect
```
public void sendRedirect(String redirectLocation)
                  throws IOException
```
    Specified by:
    
    sendRedirect in interface HttpServletResponse
    
    Overrides:
    
    sendRedirect in class HttpServletResponseWrapper
    
    Throws:
    
    IOException
  - setBufferSize
```
public void setBufferSize(int size)
```
    Specified by:
    
    setBufferSize in interface ServletResponse
    
    Overrides:
    
    setBufferSize in class ServletResponseWrapper
  - setCharacterEncoding
```
public void setCharacterEncoding(String charset)
```
    Specified by:
    
    setCharacterEncoding in interface ServletResponse
    
    Overrides:
    
    setCharacterEncoding in class ServletResponseWrapper
  - setContentLength
```
public void setContentLength(int len)
```
    Specified by:
    
    setContentLength in interface ServletResponse
    
    Overrides:
    
    setContentLength in class ServletResponseWrapper
  - setContentType
```
public void setContentType(String type)
```
    Specified by:
    
    setContentType in interface ServletResponse
    
    Overrides:
    
    setContentType in class ServletResponseWrapper
  - setDateHeader
```
public void setDateHeader(String name,
                          long date)
```
    Specified by:
    
    setDateHeader in interface HttpServletResponse
    
    Overrides:
    
    setDateHeader in class HttpServletResponseWrapper
  - setHeader
```
public void setHeader(String name,
                      String value)
```
    Specified by:
    
    setHeader in interface HttpServletResponse
    
    Overrides:
    
    setHeader in class HttpServletResponseWrapper
  - setIntHeader
```
public void setIntHeader(String name,
                         int value)
```
    Specified by:
    
    setIntHeader in interface HttpServletResponse
    
    Overrides:
    
    setIntHeader in class HttpServletResponseWrapper
  - setLocale
```
public void setLocale(Locale locale)
```
    Specified by:
    
    setLocale in interface ServletResponse
    
    Overrides:
    
    setLocale in class ServletResponseWrapper
  - setStatus
```
public void setStatus(int statusCode)
```
    Specified by:
    
    setStatus in interface HttpServletResponse
    
    Overrides:
    
    setStatus in class HttpServletResponseWrapper
  - setStatus
```
public void setStatus(int statusCode,
                      String message)
```
    Specified by:
    
    setStatus in interface HttpServletResponse
    
    Overrides:
    
    setStatus in class HttpServletResponseWrapper

Class PortletServletResponseWrapper

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletResponse

Constructor Summary

Method Summary

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

Methods inherited from class javax.servlet.ServletResponseWrapper

Methods inherited from class java.lang.Object

Methods inherited from interface javax.servlet.ServletResponse

Constructor Detail

PortletServletResponseWrapper

Method Detail

addCookie

addDateHeader

addHeader

addIntHeader

containsHeader

encodeRedirectUrl

encodeRedirectURL

encodeUrl

encodeURL

flushBuffer

getBufferSize

getCharacterEncoding

getContentType

getLocale

getOutputStream

getWriter

isCommitted

reset

resetBuffer

sendError

sendError

sendRedirect

setBufferSize

setCharacterEncoding

setContentLength

setContentType

setDateHeader

setHeader

setIntHeader

setLocale

setStatus

setStatus