WebSocketResponse (Wicket Parent 8.15.0-SNAPSHOT API)

java.lang.Object
- org.apache.wicket.request.Response
- - org.apache.wicket.request.http.WebResponse
  - - org.apache.wicket.protocol.ws.api.WebSocketResponse

```
public class WebSocketResponse
extends WebResponse
```
A Response used to cache the written data to the web socket client when Wicket thread locals are available. When the thread locals are not available then you can write directly to the IWebSocketConnection taken from IWebSocketConnectionRegistry. In this case the response wont be cached.

Since:

6.0

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.wicket.request.http.WebResponse
  WebResponse.CacheScope

Field Summary
- Fields inherited from class org.apache.wicket.request.http.WebResponse
  MAX_CACHE_DURATION

Constructor Summary

Constructors
Constructor and Description

WebSocketResponse(IWebSocketConnection conn)

Constructors
Constructor and Description
`WebSocketResponse(IWebSocketConnection conn)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCookie(javax.servlet.http.Cookie cookie)` Add a cookie to the web response
`void`	`addHeader(String name, String value)` Add a value to the servlet response stream.
`void`	`clearCookie(javax.servlet.http.Cookie cookie)` Convenience method for clearing a cookie.
`void`	`close()` Closes the response
`String`	`encodeRedirectURL(CharSequence url)` Encodes urls used to redirect.
`String`	`encodeURL(CharSequence url)` Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.
`void`	`flush()` Flushes the response.
`IWebSocketConnection`	`getContainerResponse()` Provides access to the low-level container response object that implementaion of this `Response` delegate to.
`boolean`	`isRedirect()`
`void`	`reset()` Called when the Response needs to reset itself.
`void`	`sendError(int sc, String msg)` Send error status code with optional message.
`void`	`sendRedirect(String url)` Redirects the response to specified URL.
`void`	`setContentLength(long length)` Set the content length on the response, if appropriate in the subclass.
`void`	`setContentType(String mimeType)` Set the content type on the response, if appropriate in the subclass.
`void`	`setDateHeader(String name, Time date)` Set a header to the date value in the servlet response stream.
`void`	`setHeader(String name, String value)` Set a header to the string value in the servlet response stream.
`void`	`setStatus(int sc)` Sets the status code for this response.
`void`	`write(byte[] array)` Writes the buffer to output.
`void`	`write(byte[] array, int offset, int length)` Writes the buffer to output.
`void`	`write(CharSequence sequence)` Writes the `CharSequence` to output.

Methods inherited from class org.apache.wicket.request.http.WebResponse
disableCaching, enableCaching, setAcceptRange, setAttachmentHeader, setContentRange, setInlineHeader, setLastModifiedTime

Methods inherited from class org.apache.wicket.request.Response
getOutputStream

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WebSocketResponse
```
public WebSocketResponse(IWebSocketConnection conn)
```
- Method Detail
  - write
```
public void write(CharSequence sequence)
```
    Description copied from class: Response
    
    Writes the CharSequence to output.
    
    Specified by:
    
    write in class Response
  - write
```
public void write(byte[] array)
```
    Description copied from class: Response
    
    Writes the buffer to output.
    
    Specified by:
    
    write in class Response
    
    Parameters:
    
    array - the data.
  - write
```
public void write(byte[] array,
                  int offset,
                  int length)
```
    Description copied from class: Response
    
    Writes the buffer to output.
    
    Specified by:
    
    write in class Response
    
    Parameters:
    
    array - the data.
    
    offset - the start offset in the data.
    
    length - the number of bytes to write.
  - close
```
public void close()
```
    Description copied from class: Response
    
    Closes the response
    
    Overrides:
    
    close in class Response
  - reset
```
public void reset()
```
    Description copied from class: Response
    
    Called when the Response needs to reset itself. Subclasses can empty there buffer or build up state.
    
    Overrides:
    
    reset in class Response
  - encodeURL
```
public String encodeURL(CharSequence url)
```
    Description copied from class: Response
    
    Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.
    
    Specified by:
    
    encodeURL in class Response
    
    Returns:
    
    encoded URL
  - getContainerResponse
```
public final IWebSocketConnection getContainerResponse()
```
    Description copied from class: Response
    
    Provides access to the low-level container response object that implementaion of this Response delegate to. This allows users to access features provided by the container response but not by generalized Wicket Response objects.
    
    Specified by:
    
    getContainerResponse in class Response
    
    Returns:
    
    low-level container response object, or null if none
  - addCookie
```
public void addCookie(javax.servlet.http.Cookie cookie)
```
    Description copied from class: WebResponse
    
    Add a cookie to the web response
    
    Specified by:
    
    addCookie in class WebResponse
  - clearCookie
```
public void clearCookie(javax.servlet.http.Cookie cookie)
```
    Description copied from class: WebResponse
    
    Convenience method for clearing a cookie.
    
    Specified by:
    
    clearCookie in class WebResponse
    
    Parameters:
    
    cookie - The cookie to set
    
    See Also:
    
    WebResponse.addCookie(Cookie)
  - setHeader
```
public void setHeader(String name,
                      String value)
```
    Description copied from class: WebResponse
    
    Set a header to the string value in the servlet response stream.
    
    Specified by:
    
    setHeader in class WebResponse
  - addHeader
```
public void addHeader(String name,
                      String value)
```
    Description copied from class: WebResponse
    
    Add a value to the servlet response stream.
    
    Specified by:
    
    addHeader in class WebResponse
  - setDateHeader
```
public void setDateHeader(String name,
                          Time date)
```
    Description copied from class: WebResponse
    
    Set a header to the date value in the servlet response stream.
    
    Specified by:
    
    setDateHeader in class WebResponse
  - setContentLength
```
public void setContentLength(long length)
```
    Description copied from class: WebResponse
    
    Set the content length on the response, if appropriate in the subclass. This default implementation does nothing.
    
    Specified by:
    
    setContentLength in class WebResponse
    
    Parameters:
    
    length - The length of the content
  - setContentType
```
public void setContentType(String mimeType)
```
    Description copied from class: WebResponse
    
    Set the content type on the response, if appropriate in the subclass. This default implementation does nothing.
    
    Specified by:
    
    setContentType in class WebResponse
    
    Parameters:
    
    mimeType - The mime type
  - setStatus
```
public void setStatus(int sc)
```
    Description copied from class: WebResponse
    
    Sets the status code for this response.
    
    Specified by:
    
    setStatus in class WebResponse
    
    Parameters:
    
    sc - status code
  - sendError
```
public void sendError(int sc,
                      String msg)
```
    Description copied from class: WebResponse
    
    Send error status code with optional message.
    
    Specified by:
    
    sendError in class WebResponse
  - encodeRedirectURL
```
public String encodeRedirectURL(CharSequence url)
```
    Description copied from class: WebResponse
    
    Encodes urls used to redirect. Sometimes rules for encoding URLs for redirecting differ from encoding URLs for links, so this method is broken out away form Response.encodeURL(CharSequence).
    
    Specified by:
    
    encodeRedirectURL in class WebResponse
    
    Returns:
    
    encoded URL
  - sendRedirect
```
public void sendRedirect(String url)
```
    Description copied from class: WebResponse
    
    Redirects the response to specified URL. The implementation is responsible for properly encoding the URL. Implementations of this method should run passed in url parameters through the WebResponse.encodeRedirectURL(CharSequence) method.
    
    Specified by:
    
    sendRedirect in class WebResponse
  - isRedirect
```
public boolean isRedirect()
```
    Specified by:
    
    isRedirect in class WebResponse
    
    Returns:
    
    true is WebResponse.sendRedirect(String) was called, false otherwise.
  - flush
```
public void flush()
```
    Description copied from class: WebResponse
    
    Flushes the response.
    
    Specified by:
    
    flush in class WebResponse

Class WebSocketResponse

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.request.http.WebResponse

Field Summary

Fields inherited from class org.apache.wicket.request.http.WebResponse

Constructor Summary

Method Summary

Methods inherited from class org.apache.wicket.request.http.WebResponse

Methods inherited from class org.apache.wicket.request.Response

Methods inherited from class java.lang.Object

Constructor Detail

WebSocketResponse

Method Detail

write

write

write

close

reset

encodeURL

getContainerResponse

addCookie

clearCookie

setHeader

addHeader

setDateHeader

setContentLength

setContentType

setStatus

sendError

encodeRedirectURL

sendRedirect

isRedirect

flush