Package com.microsoft.azure.proton.transport.ws.impl

Class WebSocketUpgrade

  • public class WebSocketUpgrade
extends java.lang.Object
    Represents a web socket upgrade request.

    • Constructor Summary

      Constructors 
      Constructor Description
      WebSocketUpgrade​(java.lang.String hostName, java.lang.String webSocketPath, java.lang.String webSocketQuery, int webSocketPort, java.lang.String webSocketProtocol, java.util.Map<java.lang.String,​java.lang.String> additionalHeaders)
      Create WebSocketUpgrade instance, which can be used for websocket upgrade hand-shake with http server as per RFC https://tools.ietf.org/html/rfc6455.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String createUpgradeRequest()
      Create the Upgrade to websocket request as per the RFC https://tools.ietf.org/html/rfc6455.
      java.lang.String toString()  
      java.lang.Boolean validateUpgradeReply​(byte[] responseBytes)
      Validate the response received for 'upgrade to websockets' request from http server.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • WebSocketUpgrade

        public WebSocketUpgrade​(java.lang.String hostName,
                        java.lang.String webSocketPath,
                        java.lang.String webSocketQuery,
                        int webSocketPort,
                        java.lang.String webSocketProtocol,
                        java.util.Map<java.lang.String,​java.lang.String> additionalHeaders)
        Create WebSocketUpgrade instance, which can be used for websocket upgrade hand-shake with http server as per RFC https://tools.ietf.org/html/rfc6455.
        Parameters:
        hostName - host name to send the request to
        webSocketPath - path on the request url where WebSocketUpgrade will be sent to
        webSocketQuery - query on the request url where WebSocketUpgrade will be sent to
        webSocketPort - port on the request url where WebSocketUpgrade will be sent to
        webSocketProtocol - value for Sec-WebSocket-Protocol header on the WebSocketUpgrade request
        additionalHeaders - any additional headers to be part of the WebSocketUpgrade request

    • Method Detail

      • createUpgradeRequest

        public java.lang.String createUpgradeRequest()
        Create the Upgrade to websocket request as per the RFC https://tools.ietf.org/html/rfc6455.
        Returns:
        http request to upgrade to websockets.

      • validateUpgradeReply

        public java.lang.Boolean validateUpgradeReply​(byte[] responseBytes)
        Validate the response received for 'upgrade to websockets' request from http server.
        Parameters:
        responseBytes - bytes received from http server
        Returns:
        value indicating if the websockets upgrade succeeded

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object