Package org.cometd.websocket.server.common

Class AbstractBayeuxContext

java.lang.Object

org.cometd.websocket.server.common.AbstractBayeuxContext

All Implemented Interfaces:

BayeuxContext

public abstract class AbstractBayeuxContext
extends Object
implements BayeuxContext

Constructor Summary

Constructors

Constructor	Description
AbstractBayeuxContext(javax.servlet.ServletContext context, String uri, String query, Map<String,List<String>> headers, Map<String,List<String>> parameters, Principal principal, javax.servlet.http.HttpSession session, InetSocketAddress local, InetSocketAddress remote, List<Locale> locales, String protocol, boolean secure)

Method Summary

Modifier and Type	Method	Description
Object	getContextAttribute(String name)	Access the ServletContext (if any) attributes.
String	getContextInitParameter(String name)	Access the ServletContext (if any) init parameter.
String	getContextPath()
String	getCookie(String name)	Get a transport cookie.
String	getHeader(String name)	Get a transport header.
List<String>	getHeaderValues(String name)	Get a multi valued transport header.
Object	getHttpSessionAttribute(String name)	Access the HTTP Session (if any) attributes.
String	getHttpSessionId()	Access the HTTP Session (if any) ID.
InetSocketAddress	getLocalAddress()
List<Locale>	getLocales()
String	getParameter(String name)	Get a transport parameter.
List<String>	getParameterValues(String name)	Get a multi valued transport parameter.
String	getProtocol()
InetSocketAddress	getRemoteAddress()
Object	getRequestAttribute(String name)	Access the Request (if any) attributes.
String	getURL()
Principal	getUserPrincipal()
void	invalidateHttpSession()	Invalidate the HTTP Session.
boolean	isSecure()
boolean	isUserInRole(String role)
void	setHttpSessionAttribute(String name, Object value)	Access the HTTP Session (if any) attributes.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBayeuxContext

public AbstractBayeuxContext(javax.servlet.ServletContext context,
                             String uri,
                             String query,
                             Map<String,List<String>> headers,
                             Map<String,List<String>> parameters,
                             Principal principal,
                             javax.servlet.http.HttpSession session,
                             InetSocketAddress local,
                             InetSocketAddress remote,
                             List<Locale> locales,
                             String protocol,
                             boolean secure)

Method Detail

getURL

public String getURL()

Specified by:

getURL in interface BayeuxContext

Returns:

the full request URI complete with query string if present.

getHeader

public String getHeader(String name)

Description copied from interface: BayeuxContext

Get a transport header.

Get a header for any current transport mechanism (eg HTTP request). For transports like websocket, the header may be from the initial handshake.

Specified by:

getHeader in interface BayeuxContext

Parameters:

name - The name of the header

Returns:

The header value or null if no current transport mechanism or no such header.

getHeaderValues

public List<String> getHeaderValues(String name)

Description copied from interface: BayeuxContext

Get a multi valued transport header.

Get a header for any current transport mechanism (eg HTTP request). For transports like websocket, the header may be from the initial handshake.

Specified by:

getHeaderValues in interface BayeuxContext

Parameters:

name - The name of the header

Returns:

The header value or null if no current transport mechanism or no such header.

getParameter

public String getParameter(String name)

Description copied from interface: BayeuxContext

Get a transport parameter.

Get a parameter for any current transport mechanism (eg HTTP request). For transports like websocket, the parameter may be from the initial handshake.

Specified by:

getParameter in interface BayeuxContext

Parameters:

name - The name of the parameter

Returns:

The parameter value or null if no current transport mechanism or no such parameter.

getParameterValues

public List<String> getParameterValues(String name)

Description copied from interface: BayeuxContext

Get a multi valued transport parameter.

Get a parameter for any current transport mechanism (eg HTTP request). For transports like websocket, the parameter may be from the initial handshake.

Specified by:

getParameterValues in interface BayeuxContext

Parameters:

name - The name of the parameter

Returns:

The parameter value or null if no current transport mechanism or no such parameter.

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface BayeuxContext

Returns:

The user Principal (if any)

isUserInRole

public boolean isUserInRole(String role)

Specified by:

isUserInRole in interface BayeuxContext

Parameters:

role - the role to check whether the user belongs to

Returns:

true if there is a known user and they are in the given role.

getHttpSessionId

public String getHttpSessionId()

Description copied from interface: BayeuxContext

Access the HTTP Session (if any) ID. The Session.getId() should be used in preference to the HTTP Session.

Specified by:

getHttpSessionId in interface BayeuxContext

Returns:

HTTP session ID or null

getHttpSessionAttribute

public Object getHttpSessionAttribute(String name)

Description copied from interface: BayeuxContext

Access the HTTP Session (if any) attributes. The Session.getAttribute(String) should be used in preference to the HTTP Session.

Specified by:

getHttpSessionAttribute in interface BayeuxContext

Parameters:

name - the attribute name

Returns:

The attribute value

setHttpSessionAttribute

public void setHttpSessionAttribute(String name,
                                    Object value)

Description copied from interface: BayeuxContext

Access the HTTP Session (if any) attributes. The Session.setAttribute(String, Object) should be used in preference to the HTTP Session.

Specified by:

setHttpSessionAttribute in interface BayeuxContext

Parameters:

name - the attribute name

value - the attribute value

invalidateHttpSession

public void invalidateHttpSession()

Description copied from interface: BayeuxContext

Invalidate the HTTP Session. The Session.getId() should be used in preference to the HTTP Session.

Specified by:

invalidateHttpSession in interface BayeuxContext

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface BayeuxContext

Returns:

the remote socket address

getLocalAddress

public InetSocketAddress getLocalAddress()

Specified by:

getLocalAddress in interface BayeuxContext

Returns:

the local socket address

getLocales

public List<Locale> getLocales()

Specified by:

getLocales in interface BayeuxContext

Returns:

the request Locales, in order of preference, or the default server Locale if the request Locales are missing.

getCookie

public String getCookie(String name)

Description copied from interface: BayeuxContext

Get a transport cookie.

Get a cookie for any current transport mechanism (eg HTTP request). For transports like websocket, the cookie may be from the initial handshake.

Specified by:

getCookie in interface BayeuxContext

Parameters:

name - The name of the cookie

Returns:

The cookie value or null if no current transport mechanism or no such cookie.

getRequestAttribute

public Object getRequestAttribute(String name)

Description copied from interface: BayeuxContext

Access the Request (if any) attributes.

Specified by:

getRequestAttribute in interface BayeuxContext

Parameters:

name - the attribute name

Returns:

The attribute value

getContextAttribute

public Object getContextAttribute(String name)

Description copied from interface: BayeuxContext

Access the ServletContext (if any) attributes.

Specified by:

getContextAttribute in interface BayeuxContext

Parameters:

name - the attribute name

Returns:

The attribute value

getContextInitParameter

public String getContextInitParameter(String name)

Description copied from interface: BayeuxContext

Access the ServletContext (if any) init parameter.

Specified by:

getContextInitParameter in interface BayeuxContext

Parameters:

name - the init parameter name

Returns:

The attribute value

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface BayeuxContext

Returns:

the application context path

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface BayeuxContext

Returns:

a string containing the protocol name and version number

isSecure

public boolean isSecure()

Specified by:

isSecure in interface BayeuxContext

Returns:

whether the request was made over a secure channel