com.hazelcast.config.security

Enum LdapSearchScope

java.lang.Object

java.lang.Enum<LdapSearchScope>

com.hazelcast.config.security.LdapSearchScope

All Implemented Interfaces:

Serializable, Comparable<LdapSearchScope>

public enum LdapSearchScope
extends Enum<LdapSearchScope>

Search scope types for LDAP queries.

Enum Constant Summary

Enum Constants

Enum Constant and Description
OBJECT Only given search context object.
ONE_LEVEL One level under the search context.
SUBTREE Subtree of the search context.

Method Summary

Modifier and Type	Method and Description
static LdapSearchScope	getSearchScope(String label)
int	toSearchControlValue()
String	toString()
static LdapSearchScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static LdapSearchScope[]	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

OBJECT

public static final LdapSearchScope OBJECT

Only given search context object.

ONE_LEVEL

public static final LdapSearchScope ONE_LEVEL

One level under the search context.

SUBTREE

public static final LdapSearchScope SUBTREE

Subtree of the search context.

Method Detail

values

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

Returns:

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

valueOf

public static LdapSearchScope valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<LdapSearchScope>

toSearchControlValue

public int toSearchControlValue()

getSearchScope

public static LdapSearchScope getSearchScope(String label)