Top Description Fields Methods
org.eclipse.jetty.websocket.server

public Interface ServerUpgradeRequest

extends Request
Known Direct Implementers
org.eclipse.jetty.websocket.server.internal.ServerUpgradeRequestDelegate
Imports
java.util.List, org.eclipse.jetty.server.Request, org.eclipse.jetty.websocket.api.ExtensionConfig

The HTTP request to upgrade to WebSocket.

An instance of this class is given as a parameter to a WebSocketCreator, so that applications can interact with the request.

See Also
ServerUpgradeResponse

Field Summary

Inherited from org.eclipse.jetty.server.Request:
CACHE_ATTRIBUTECOOKIE_ATTRIBUTEDEFAULT_LOCALESLOG

Method Summary

Modifier and TypeMethod and Description
public List<ExtensionConfig>
getExtensions()

Returns: the list of extensions provided by the client

public List<String>
getSubProtocols()

Returns: the list of sub-protocols provided by the client

public boolean
hasSubProtocol(String
the sub-protocol to search
subProtocol)

Returns: whether this request contains the given sub-protocol

Inherited from org.eclipse.jetty.server.Request:
addCompletionListeneraddFailureListeneraddHttpStreamWrapperaddIdleTimeoutListenerasasInputStreamasReadOnlyconsumeAvailabledemandextractQueryParametersextractQueryParametersgetgetAuthenticationStategetBeginNanoTimegetCharsetgetComponentsgetConnectionMetaDatagetContentBytesReadgetContextgetContextPathgetCookiesgetHeadersgetHeadersNanoTimegetHostNamegetHttpURIgetIdgetLocalAddrgetLocalesgetLocalPortgetMethodgetParametersgetParametersAsyncgetPathInContextgetRemoteAddrgetRemotePortgetServerNamegetServerPortgetSessiongetTimeStampgetTrailersgetTunnelSupportisSecurenewHttpURIFrompushreadserveAssetAuthenticationStatetoRedirectURIunWrap

Method Detail

getExtensionsback to summary
public List<ExtensionConfig> getExtensions()
Returns:List<ExtensionConfig>

the list of extensions provided by the client

getSubProtocolsback to summary
public List<String> getSubProtocols()
Returns:List<String>

the list of sub-protocols provided by the client

hasSubProtocolback to summary
public boolean hasSubProtocol(String subProtocol)
Parameters
subProtocol:String

the sub-protocol to search

Returns:boolean

whether this request contains the given sub-protocol