org.apache.directory.api.ldap.model.constants

Enum AuthenticationLevel

java.lang.Object

java.lang.Enum<AuthenticationLevel>

org.apache.directory.api.ldap.model.constants.AuthenticationLevel

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AuthenticationLevel>

public enum AuthenticationLevel
extends java.lang.Enum<AuthenticationLevel>

An enumeration that represents the level of authentication. We have 4 different levels :

• NONE : anonymous
• SIMPLE : Simple authentication
• STRONG : SASL or external authentication
• UNAUTHENT>A special case when just doing some auditing

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE No authentication (anonymous access)
SIMPLE Simple authentication (bound with plain-text credentials)
STRONG Strong authentication (bound with encrypted credentials)
UNAUTHENT Unauthentication, if the BIND contains a Dn but no credentials

Field Summary

Fields

Modifier and Type	Field and Description
private int	level The internal numeric value
private java.lang.String	name The level name

Method Summary

Modifier and Type	Method and Description
int	getLevel()
static AuthenticationLevel	getLevel(int val) Return the AuthenticationLevel associated with the given numeric level.
java.lang.String	getName()
java.lang.String	toString()
static AuthenticationLevel	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AuthenticationLevel[]	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

NONE

public static final AuthenticationLevel NONE

No authentication (anonymous access)

SIMPLE

public static final AuthenticationLevel SIMPLE

Simple authentication (bound with plain-text credentials)

STRONG

public static final AuthenticationLevel STRONG

Strong authentication (bound with encrypted credentials)

UNAUTHENT

public static final AuthenticationLevel UNAUTHENT

Unauthentication, if the BIND contains a Dn but no credentials

Field Detail

level

private int level

The internal numeric value

name

private final java.lang.String name

The level name

Method Detail

values

public static AuthenticationLevel[] 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 (AuthenticationLevel c : AuthenticationLevel.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

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

getLevel

public int getLevel()

Returns:

the integer value of this level (greater value, stronger level).

getName

public java.lang.String getName()

Returns:

the name of this level.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<AuthenticationLevel>

getLevel

public static AuthenticationLevel getLevel(int val)

Return the AuthenticationLevel associated with the given numeric level. This is used by the serialization process.

Parameters:

val - The numeric level we are looking at

Returns:

The associated AuthenticationLevel