Package org.glassfish.tyrus.spi

Enum WebSocketEngine.UpgradeStatus

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      HANDSHAKE_FAILED
      Upgrade failed due to version, extensions, origin check etc.
      NOT_APPLICABLE
      Not a WebSocketRequest or no mapping in the application.
      SUCCESS
      Upgrade is successful.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static WebSocketEngine.UpgradeStatus valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static WebSocketEngine.UpgradeStatus[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • NOT_APPLICABLE

        public static final WebSocketEngine.UpgradeStatus NOT_APPLICABLE
        Not a WebSocketRequest or no mapping in the application. This may mean that HTTP request processing should continue (in servlet container, the next filter may be called).

      • HANDSHAKE_FAILED

        public static final WebSocketEngine.UpgradeStatus HANDSHAKE_FAILED
        Upgrade failed due to version, extensions, origin check etc. Tyrus would set an appropriate HTTP error status code in UpgradeResponse.

    • Method Detail

      • values

        public static WebSocketEngine.UpgradeStatus[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (WebSocketEngine.UpgradeStatus c : WebSocketEngine.UpgradeStatus.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static WebSocketEngine.UpgradeStatus valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null