org.apache.wicket.protocol.ws.api

Class WebSocketRequest

java.lang.Object

org.apache.wicket.request.Request

org.apache.wicket.request.http.WebRequest

org.apache.wicket.protocol.http.servlet.ServletWebRequest

org.apache.wicket.protocol.ws.api.WebSocketRequest

public class WebSocketRequest
extends ServletWebRequest

A WebRequest implementation used for the lifecycle of a web socket connection. It keeps a copy of the HttpServletRequest provided by the web container during the creation of the web socket connection (the http upgrade).

Since:

6.0

Field Summary

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

HEADER_AJAX, HEADER_AJAX_BASE_URL, PARAM_AJAX, PARAM_AJAX_BASE_URL, PARAM_AJAX_REQUEST_ANTI_CACHE

Constructor Summary

Constructors

Constructor and Description
WebSocketRequest(javax.servlet.http.HttpServletRequest req, String filterPrefix) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Charset	getCharset()
org.apache.wicket.request.Url	getClientUrl()
List<javax.servlet.http.Cookie>	getCookies()
org.apache.wicket.util.time.Time	getDateHeader(String name)
String	getHeader(String name)
List<String>	getHeaders(String name)
Locale	getLocale()
org.apache.wicket.request.Url	getUrl()
boolean	isAjax()

Methods inherited from class org.apache.wicket.protocol.http.servlet.ServletWebRequest

cloneWithUrl, generatePostParameters, getContainerRequest, getContextPath, getFilterPath, getFilterPrefix, getPostParameters, getPrefixToContextPath, newMultipartWebRequest, newMultipartWebRequest, shouldPreserveClientUrl

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

getCookie, getIfModifiedSinceHeader

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

getOriginalUrl, getQueryParameters, getRequestParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebSocketRequest

public WebSocketRequest(javax.servlet.http.HttpServletRequest req,
                String filterPrefix)

Constructor.

Parameters:

req - the copy of the HttpServletRequest used for the upgrade of the HTTP protocol

Method Detail

getCookies

public List<javax.servlet.http.Cookie> getCookies()

Overrides:

getCookies in class ServletWebRequest

getHeaders

public List<String> getHeaders(String name)

Overrides:

getHeaders in class ServletWebRequest

getHeader

public String getHeader(String name)

Overrides:

getHeader in class ServletWebRequest

getDateHeader

public org.apache.wicket.util.time.Time getDateHeader(String name)

Overrides:

getDateHeader in class ServletWebRequest

getUrl

public org.apache.wicket.request.Url getUrl()

Overrides:

getUrl in class ServletWebRequest

getClientUrl

public org.apache.wicket.request.Url getClientUrl()

Overrides:

getClientUrl in class ServletWebRequest

getLocale

public Locale getLocale()

Overrides:

getLocale in class ServletWebRequest

getCharset

public Charset getCharset()

Overrides:

getCharset in class ServletWebRequest

isAjax

public boolean isAjax()

Overrides:

isAjax in class org.apache.wicket.request.http.WebRequest