Package org.eclipse.jetty.websocket.core.server.internal

Class ServerUpgradeRequestImpl

java.lang.Object

org.eclipse.jetty.server.Request.Wrapper

org.eclipse.jetty.websocket.core.server.internal.ServerUpgradeRequestImpl

All Implemented Interfaces:

Content.Source, Request, Attributes, ServerUpgradeRequest

public class ServerUpgradeRequestImpl
extends Request.Wrapper
implements ServerUpgradeRequest

Upgrade request used for websocket negotiation. Provides getters for things like the requested extensions and subprotocols so that the headers don't have to be parsed manually.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.Attributes

Attributes.Layer, Attributes.Lazy, Attributes.Mapped, Attributes.Synthetic

Nested classes/interfaces inherited from interface org.eclipse.jetty.server.Request

Request.AttributesWrapper, Request.AuthenticationState, Request.Handler, Request.ServeAs, Request.Wrapper

Field Summary

Fields inherited from interface org.eclipse.jetty.util.Attributes

NULL

Fields inherited from interface org.eclipse.jetty.server.Request

COOKIE_ATTRIBUTE, DEFAULT_LOCALES, LOG

Constructor Summary

Constructors

Constructor	Description
ServerUpgradeRequestImpl(WebSocketNegotiation negotiation, Request baseRequest)

Method Summary

Modifier and Type	Method	Description
void	clearAttributes()	Clear all attribute names
Object	getAttribute(String name)	Get an attribute
Set<String>	getAttributeNameSet()	Get the immutable set of attribute names.
List<ExtensionConfig>	getExtensions()
String	getProtocolVersion()
List<String>	getSubProtocols()
WebSocketComponents	getWebSocketComponents()
boolean	hasSubProtocol(String subprotocol)
Object	removeAttribute(String name)	Remove an attribute
Object	setAttribute(String name, Object attribute)	Set an attribute
void	upgrade(Attributes attributes)

Methods inherited from class org.eclipse.jetty.server.Request.Wrapper

addFailureListener, addHttpStreamWrapper, addIdleTimeoutListener, asAttributeMap, consumeAvailable, demand, fail, getBeginNanoTime, getComponents, getConnectionMetaData, getContext, getHeaders, getHeadersNanoTime, getHttpURI, getId, getLength, getMethod, getSession, getTrailers, getTunnelSupport, getWrapped, isSecure, push, read, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.util.Attributes

asAttributeMap, equals, hashCode

Methods inherited from interface org.eclipse.jetty.io.Content.Source

fail, fail, getLength, rewind

Methods inherited from interface org.eclipse.jetty.server.Request

addFailureListener, addHttpStreamWrapper, addIdleTimeoutListener, consumeAvailable, demand, getBeginNanoTime, getComponents, getConnectionMetaData, getContext, getHeaders, getHeadersNanoTime, getHttpURI, getId, getMethod, getSession, getTrailers, getTunnelSupport, isSecure, push, read

Constructor Details

ServerUpgradeRequestImpl

public ServerUpgradeRequestImpl(WebSocketNegotiation negotiation,
 Request baseRequest)
                         throws BadMessageException

Throws:

BadMessageException

Method Details

getWebSocketComponents

public WebSocketComponents getWebSocketComponents()

Specified by:

getWebSocketComponents in interface ServerUpgradeRequest

upgrade

public void upgrade(Attributes attributes)

Specified by:

upgrade in interface ServerUpgradeRequest

removeAttribute

public Object removeAttribute(String name)

Description copied from interface: Attributes

Remove an attribute

Specified by:

removeAttribute in interface Attributes

Overrides:

removeAttribute in class Request.Wrapper

Parameters:

name - the attribute to remove

Returns:

the value of the attribute if removed, else null

setAttribute

public Object setAttribute(String name,
 Object attribute)

Description copied from interface: Attributes

Set an attribute

Specified by:

setAttribute in interface Attributes

Overrides:

setAttribute in class Request.Wrapper

Parameters:

name - the attribute to set

attribute - the value to set. A null value is equivalent to removing the attribute.

Returns:

the previous value of the attribute if set, else null

getAttribute

public Object getAttribute(String name)

Description copied from interface: Attributes

Get an attribute

Specified by:

getAttribute in interface Attributes

Overrides:

getAttribute in class Request.Wrapper

Parameters:

name - the attribute to get

Returns:

the value of the attribute, or null if no such attribute exists

getAttributeNameSet

public Set<String> getAttributeNameSet()

Description copied from interface: Attributes

Get the immutable set of attribute names.

Specified by:

getAttributeNameSet in interface Attributes

Overrides:

getAttributeNameSet in class Request.Wrapper

Returns:

Set of attribute names, or an empty set if there are no attributes.

clearAttributes

public void clearAttributes()

Description copied from interface: Attributes

Clear all attribute names

Specified by:

clearAttributes in interface Attributes

Overrides:

clearAttributes in class Request.Wrapper

getExtensions

public List<ExtensionConfig> getExtensions()

Specified by:

getExtensions in interface ServerUpgradeRequest

Returns:

The extensions offered

getProtocolVersion

public String getProtocolVersion()

Specified by:

getProtocolVersion in interface ServerUpgradeRequest

Returns:

WebSocket protocol version from "Sec-WebSocket-Version" header

getSubProtocols

public List<String> getSubProtocols()

Specified by:

getSubProtocols in interface ServerUpgradeRequest

Returns:

Get WebSocket negotiation offered sub protocols

hasSubProtocol

public boolean hasSubProtocol(String subprotocol)

Specified by:

hasSubProtocol in interface ServerUpgradeRequest

Parameters:

subprotocol - A sub protocol name

Returns:

True if the sub protocol was offered