Package org.apache.tomcat.websocket

Enum AuthenticationType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AuthenticationType>
    public enum AuthenticationType
extends java.lang.Enum<AuthenticationType>
    Defines the authentication types supported by the WebSocket client.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      PROXY
      HTTP Proxy authentication over WebSocket.
      WWW
      HTTP Basic authentication over WebSocket.

    • Enum Constant Detail

      • WWW

        public static final AuthenticationType WWW
        HTTP Basic authentication over WebSocket.

      • PROXY

        public static final AuthenticationType PROXY
        HTTP Proxy authentication over WebSocket.

    • Method Detail

      • values

        public static AuthenticationType[] 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 (AuthenticationType c : AuthenticationType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static AuthenticationType 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

      • getAuthorizationHeaderName

        public java.lang.String getAuthorizationHeaderName()
        Returns the name of the authorization header.
        Returns:
        the authorization header name

      • getAuthenticateHeaderName

        public java.lang.String getAuthenticateHeaderName()
        Returns the name of the authenticate header.
        Returns:
        the authenticate header name

      • getUserNameProperty

        public java.lang.String getUserNameProperty()
        Returns the property name for the user name.
        Returns:
        the user name property name

      • getUserPasswordProperty

        public java.lang.String getUserPasswordProperty()
        Returns the property name for the user password.
        Returns:
        the user password property name

      • getUserRealmProperty

        public java.lang.String getUserRealmProperty()
        Returns the property name for the user realm.
        Returns:
        the user realm property name