org.eclipse.jetty.websocket.servlet

Class ServletUpgradeRequest

java.lang.Object

org.eclipse.jetty.websocket.api.UpgradeRequest

org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest

Direct Known Subclasses:

ServletWebSocketRequest

public class ServletUpgradeRequest
extends UpgradeRequest

Servlet specific UpgradeRequest implementation.

Constructor Summary

Constructors

Constructor and Description
ServletUpgradeRequest(HttpServletRequest httpRequest)

Method Summary

Methods

Modifier and Type	Method and Description
void	complete()
X509Certificate[]	getCertificates()
HttpServletRequest	getHttpServletRequest() Return the underlying HttpServletRequest that existed at Upgrade time.
String	getLocalAddress() Equivalent to ServletRequest.getLocalAddr()
Locale	getLocale() Equivalent to ServletRequest.getLocale()
Enumeration<Locale>	getLocales() Equivalent to ServletRequest.getLocales()
String	getLocalHostName() Equivalent to ServletRequest.getLocalName()
int	getLocalPort() Equivalent to ServletRequest.getLocalPort()
InetSocketAddress	getLocalSocketAddress() Return a InetSocketAddress for the local socket.
Principal	getPrincipal() Deprecated. use getUserPrincipal() instead
String	getRemoteAddress() Equivalent to ServletRequest.getRemoteAddr()
String	getRemoteHostName() Equivalent to ServletRequest.getRemoteHost()
int	getRemotePort() Equivalent to ServletRequest.getRemotePort()
InetSocketAddress	getRemoteSocketAddress() Return a InetSocketAddress for the remote socket.
String	getRequestPath()
Object	getServletAttribute(String name)
Map<String,Object>	getServletAttributes()
Map<String,List<String>>	getServletParameters()
HttpSession	getSession() Return the HttpSession if it exists.
Principal	getUserPrincipal() Equivalent to HttpServletRequest.getUserPrincipal()
boolean	isUserInRole(String role)
void	setServletAttribute(String name, Object value)

Methods inherited from class org.eclipse.jetty.websocket.api.UpgradeRequest

addExtensions, addExtensions, clearHeaders, getCookies, getExtensions, getHeader, getHeaderInt, getHeaders, getHeaders, getHost, getHttpVersion, getMethod, getOrigin, getParameterMap, getProtocolVersion, getQueryString, getRequestURI, getSubProtocols, hasSubProtocol, isOrigin, isSecure, setCookies, setExtensions, setHeader, setHeader, setHeaders, setHttpVersion, setMethod, setParameterMap, setRequestURI, setSession, setSubProtocols, setSubProtocols

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletUpgradeRequest

public ServletUpgradeRequest(HttpServletRequest httpRequest)
                      throws URISyntaxException

Throws:

URISyntaxException

Method Detail

getCertificates

public X509Certificate[] getCertificates()

getHttpServletRequest

public HttpServletRequest getHttpServletRequest()

Return the underlying HttpServletRequest that existed at Upgrade time.

Note: many features of the HttpServletRequest are invalid when upgraded, especially ones that deal with body content, streams, readers, and responses.

Returns:

a limited version of the underlying HttpServletRequest

getLocalAddress

public String getLocalAddress()

Equivalent to ServletRequest.getLocalAddr()

Returns:

the local address

getLocalHostName

public String getLocalHostName()

Equivalent to ServletRequest.getLocalName()

Returns:

the local host name

getLocalPort

public int getLocalPort()

Equivalent to ServletRequest.getLocalPort()

Returns:

the local port

getLocalSocketAddress

public InetSocketAddress getLocalSocketAddress()

Return a InetSocketAddress for the local socket.

Warning: this can cause a DNS lookup

Returns:

the local socket address

getLocale

public Locale getLocale()

Equivalent to ServletRequest.getLocale()

Returns:

the preferred Locale for the client

getLocales

public Enumeration<Locale> getLocales()

Equivalent to ServletRequest.getLocales()

Returns:

an Enumeration of preferred Locale objects

getPrincipal

@Deprecated
public Principal getPrincipal()

Deprecated. use getUserPrincipal() instead

getUserPrincipal

public Principal getUserPrincipal()

Equivalent to HttpServletRequest.getUserPrincipal()

Overrides:

getUserPrincipal in class UpgradeRequest

Returns:

the user principal

getRemoteAddress

public String getRemoteAddress()

Equivalent to ServletRequest.getRemoteAddr()

Returns:

the remote address

getRemoteHostName

public String getRemoteHostName()

Equivalent to ServletRequest.getRemoteHost()

Returns:

the remote host name

getRemotePort

public int getRemotePort()

Equivalent to ServletRequest.getRemotePort()

Returns:

the remote port

getRemoteSocketAddress

public InetSocketAddress getRemoteSocketAddress()

Return a InetSocketAddress for the remote socket.

Warning: this can cause a DNS lookup

Returns:

the remote socket address

getServletAttributes

public Map<String,Object> getServletAttributes()

getServletParameters

public Map<String,List<String>> getServletParameters()

getSession

public HttpSession getSession()

Return the HttpSession if it exists.

Note: this is equivalent to HttpServletRequest.getSession(boolean) and will not create a new HttpSession.

Overrides:

getSession in class UpgradeRequest

Returns:

the Servlet HTTPSession on server side UpgradeRequests

setServletAttribute

public void setServletAttribute(String name,
                       Object value)

getServletAttribute

public Object getServletAttribute(String name)

isUserInRole

public boolean isUserInRole(String role)

getRequestPath

public String getRequestPath()

complete

public void complete()