org.opends.server.types
Enum AuthenticationType

java.lang.Object
  extended by java.lang.Enum<AuthenticationType>
      extended by org.opends.server.types.AuthenticationType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<AuthenticationType>

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public enum AuthenticationType
extends java.lang.Enum<AuthenticationType>

This enumeration defines the set of possible authentication types that may be used for a bind request. This is based on the LDAP specification defined in RFC 2251.


Enum Constant Summary
INTERNAL
          The authentication type that indicates that the associated connection is an internal connection.
SASL
          The authentication type that indicates that the user will be performing SASL authentication using some extensible mechanism.
SIMPLE
          The authentication type that indicates that the user will be performing simple authentication (i.e., just a password).
 
Method Summary
 int getBERType()
          Retrieves the BER type tag associated with this authentication type.
 java.lang.String toString()
          Retrieves a string representation of this authentication type.
static AuthenticationType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static AuthenticationType[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

SIMPLE

public static final AuthenticationType SIMPLE
The authentication type that indicates that the user will be performing simple authentication (i.e., just a password).


SASL

public static final AuthenticationType SASL
The authentication type that indicates that the user will be performing SASL authentication using some extensible mechanism.


INTERNAL

public static final AuthenticationType INTERNAL
The authentication type that indicates that the associated connection is an internal connection.

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

getBERType

public int getBERType()
Retrieves the BER type tag associated with this authentication type.

Returns:
The BER type tag associated with this authentication type.

toString

public java.lang.String toString()
Retrieves a string representation of this authentication type.

Overrides:
toString in class java.lang.Enum<AuthenticationType>
Returns:
A string representation of this authentication type.