Module org.eclipse.jetty.websocket.jetty.api
Package org.eclipse.jetty.websocket.api

Interface UpgradeResponse

  • public interface UpgradeResponse
    The HTTP Upgrade to WebSocket Response

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getAcceptedSubProtocol()
      Get the accepted WebSocket protocol.
      java.util.List<ExtensionConfig> getExtensions()
      Get the list of extensions that should be used for the websocket.
      java.lang.String getHeader​(java.lang.String name)
      Get a header value
      java.util.Set<java.lang.String> getHeaderNames()
      Get the header names
      java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getHeaders()
      Get the headers map
      java.util.List<java.lang.String> getHeaders​(java.lang.String name)
      Get the multi-value header value
      int getStatusCode()
      Get the HTTP Response Status Code

    • Method Detail

      • getAcceptedSubProtocol

        java.lang.String getAcceptedSubProtocol()
        Get the accepted WebSocket protocol.
        Returns:
        the accepted WebSocket protocol.

      • getExtensions

        java.util.List<ExtensionConfig> getExtensions()
        Get the list of extensions that should be used for the websocket.
        Returns:
        the list of negotiated extensions to use.

      • getHeader

        java.lang.String getHeader​(java.lang.String name)
        Get a header value
        Parameters:
        name - the header name
        Returns:
        the value (null if header doesn't exist)

      • getHeaderNames

        java.util.Set<java.lang.String> getHeaderNames()
        Get the header names
        Returns:
        the set of header names

      • getHeaders

        java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getHeaders()
        Get the headers map
        Returns:
        the map of headers

      • getHeaders

        java.util.List<java.lang.String> getHeaders​(java.lang.String name)
        Get the multi-value header value
        Parameters:
        name - the header name
        Returns:
        the list of values (null if header doesn't exist)

      • getStatusCode

        int getStatusCode()
        Get the HTTP Response Status Code
        Returns:
        the status code