Class StatusCode

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ABNORMAL
      Abnormal Close is a synonym for NO_CLOSE, used to indicate a close condition where no close frame was processed from the remote side.
      static int BAD_DATA
      1003 indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (e.g., an endpoint that understands only text data MAY send this if it receives a binary message).
      static int BAD_PAYLOAD
      1007 indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the message (e.g., non-UTF-8 [RFC3629] data within a text message).
      static int FAILED_TLS_HANDSHAKE
      1015 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
      static int INVALID_UPSTREAM_RESPONSE
      1014 indicates that a gateway or proxy received and invalid upstream response.
      static int MESSAGE_TOO_LARGE
      1009 indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.
      static int NO_CLOSE
      1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
      static int NO_CODE
      1005 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
      static int NORMAL
      1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.
      static int POLICY_VIOLATION
      1008 indicates that an endpoint is terminating the connection because it has received a message that violates its policy.
      static int PROTOCOL
      1002 indicates that an endpoint is terminating the connection due to a protocol error.
      static int REQUIRED_EXTENSION
      1010 indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn't return them in the response message of the WebSocket handshake.
      static int SERVER_ERROR
      1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.
      static int SERVICE_RESTART
      1012 indicates that the service is restarted.
      static int SHUTDOWN
      1001 indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page.
      static int TRY_AGAIN_LATER
      1013 indicates that the service is experiencing overload.
      static int UNDEFINED
      Reserved.
    • Constructor Summary

      Constructors 
      Constructor Description
      StatusCode()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean isTransmittable​(int statusCode)
      Test if provided status code can be sent/received on a WebSocket close.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • StatusCode

        public StatusCode()
    • Method Detail

      • isTransmittable

        public static boolean isTransmittable​(int statusCode)
        Test if provided status code can be sent/received on a WebSocket close.

        This honors the RFC6455 rules and IANA rules.

        Parameters:
        statusCode - the statusCode to test
        Returns:
        true if transmittable