org.apache.wicket.protocol.ws.api

Class WebSocketResponse

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 org.apache.wicket.request.http.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

org.apache.wicket.request.http.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)

Method Summary

Methods

Modifier and Type	Method and Description
void	addCookie(javax.servlet.http.Cookie cookie)
void	addHeader(String name, String value)
void	clearCookie(javax.servlet.http.Cookie cookie)
void	close()
String	encodeRedirectURL(CharSequence url)
String	encodeURL(CharSequence url)
void	flush()
IWebSocketConnection	getContainerResponse()
boolean	isRedirect()
void	reset()
void	sendError(int sc, String msg)
void	sendRedirect(String url)
void	setContentLength(long length)
void	setContentType(String mimeType)
void	setDateHeader(String name, org.apache.wicket.util.time.Time date)
void	setHeader(String name, String value)
void	setStatus(int sc)
void	write(byte[] array)
void	write(byte[] array, int offset, int length)
void	write(CharSequence sequence)

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)

Specified by:

write in class org.apache.wicket.request.Response

write

public void write(byte[] array)

Specified by:

write in class org.apache.wicket.request.Response

write

public void write(byte[] array,
         int offset,
         int length)

Specified by:

write in class org.apache.wicket.request.Response

close

public void close()

Overrides:

close in class org.apache.wicket.request.Response

reset

public void reset()

Overrides:

reset in class org.apache.wicket.request.Response

encodeURL

public String encodeURL(CharSequence url)

Specified by:

encodeURL in class org.apache.wicket.request.Response

getContainerResponse

public final IWebSocketConnection getContainerResponse()

Specified by:

getContainerResponse in class org.apache.wicket.request.Response

addCookie

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

Specified by:

addCookie in class org.apache.wicket.request.http.WebResponse

clearCookie

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

Specified by:

clearCookie in class org.apache.wicket.request.http.WebResponse

setHeader

public void setHeader(String name,
             String value)

Specified by:

setHeader in class org.apache.wicket.request.http.WebResponse

addHeader

public void addHeader(String name,
             String value)

Specified by:

addHeader in class org.apache.wicket.request.http.WebResponse

setDateHeader

public void setDateHeader(String name,
                 org.apache.wicket.util.time.Time date)

Specified by:

setDateHeader in class org.apache.wicket.request.http.WebResponse

setContentLength

public void setContentLength(long length)

Specified by:

setContentLength in class org.apache.wicket.request.http.WebResponse

setContentType

public void setContentType(String mimeType)

Specified by:

setContentType in class org.apache.wicket.request.http.WebResponse

setStatus

public void setStatus(int sc)

Specified by:

setStatus in class org.apache.wicket.request.http.WebResponse

sendError

public void sendError(int sc,
             String msg)

Specified by:

sendError in class org.apache.wicket.request.http.WebResponse

encodeRedirectURL

public String encodeRedirectURL(CharSequence url)

Specified by:

encodeRedirectURL in class org.apache.wicket.request.http.WebResponse

sendRedirect

public void sendRedirect(String url)

Specified by:

sendRedirect in class org.apache.wicket.request.http.WebResponse

isRedirect

public boolean isRedirect()

Specified by:

isRedirect in class org.apache.wicket.request.http.WebResponse

flush

public void flush()

Specified by:

flush in class org.apache.wicket.request.http.WebResponse