Interface ServerUpgradeRequest

All Superinterfaces:
org.eclipse.jetty.util.Attributes, org.eclipse.jetty.io.Content.Source, org.eclipse.jetty.server.Request
public interface ServerUpgradeRequest extends org.eclipse.jetty.server.Request

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:

  • Nested Class Summary

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

    org.eclipse.jetty.util.Attributes.Layer, org.eclipse.jetty.util.Attributes.Lazy, org.eclipse.jetty.util.Attributes.Mapped, org.eclipse.jetty.util.Attributes.Synthetic

    Nested classes/interfaces inherited from interface org.eclipse.jetty.io.Content.Source

    org.eclipse.jetty.io.Content.Source.Factory

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

    org.eclipse.jetty.server.Request.AttributesWrapper, org.eclipse.jetty.server.Request.AuthenticationState, org.eclipse.jetty.server.Request.Handler, org.eclipse.jetty.server.Request.ServeAs, org.eclipse.jetty.server.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

  • Method Summary

    Modifier and Type
    Method
    Description
    List<org.eclipse.jetty.websocket.api.ExtensionConfig>
    getExtensions()
     
    List<String>
    getSubProtocols()
     
    boolean
    hasSubProtocol(String subProtocol)
     

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

    asAttributeMap, clearAttributes, equals, getAttribute, getAttributeNameSet, hashCode, removeAttribute, setAttribute

    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

  • Method Details

    • getExtensions

      List<org.eclipse.jetty.websocket.api.ExtensionConfig> getExtensions()
      Returns:
      the list of extensions provided by the client

    • getSubProtocols

      List<String> getSubProtocols()
      Returns:
      the list of sub-protocols provided by the client

    • hasSubProtocol

      boolean hasSubProtocol(String subProtocol)
      Parameters:
      subProtocol - the sub-protocol to search
      Returns:
      whether this request contains the given sub-protocol