Package org.apereo.cas.configuration.model.support.ldap

Enum Class LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes

java.lang.Object

java.lang.Enum<LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes>

org.apereo.cas.configuration.model.support.ldap.LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes

All Implemented Interfaces:

Serializable, Comparable<LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes>, Constable

Enclosing class:

LdapSearchEntryHandlersProperties

public static enum LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes
extends Enum<LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes>

The enum Search entry handler types.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE_DIRECTORY	Process the entry results fetched from active directory and check for account status controls for disabled/expired accounts, etc.
CASE_CHANGE	Case change search entry handler.
DN_ATTRIBUTE_ENTRY	DN attribute entry handler.
FOLLOW_SEARCH_REFERRAL	Provides handling of an ldap referral for search operations.
FOLLOW_SEARCH_RESULT_REFERENCE	Provides handling of an ldap continuation reference for search operations.
MERGE	Merge search entry handler.
MERGE_ENTRIES	Merge entries handler.
OBJECT_GUID	Object guid search entry handler.
OBJECT_SID	Object sid search entry handler.
PRIMARY_GROUP	Primary group search handler.
RANGE_ENTRY	Range entry search handler.
RECURSIVE_ENTRY	Recursive entry search handler.

Method Summary

Modifier and Type	Method	Description
static LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FOLLOW_SEARCH_REFERRAL

public static final LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes FOLLOW_SEARCH_REFERRAL

Provides handling of an ldap referral for search operations.

FOLLOW_SEARCH_RESULT_REFERENCE

public static final LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes FOLLOW_SEARCH_RESULT_REFERENCE

Provides handling of an ldap continuation reference for search operations.

ACTIVE_DIRECTORY

public static final LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes ACTIVE_DIRECTORY

Process the entry results fetched from active directory and check for account status controls for disabled/expired accounts, etc.

OBJECT_GUID

public static final LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes OBJECT_GUID

Object guid search entry handler. Handles the objectGUID attribute fetching and conversion.

OBJECT_SID

public static final LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes OBJECT_SID

Object sid search entry handler. Handles the objectSid attribute fetching and conversion.

CASE_CHANGE

public static final LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes CASE_CHANGE

Case change search entry handler. Provides the ability to modify the case of search entry DNs, attribute names, and attribute values.

DN_ATTRIBUTE_ENTRY

public static final LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes DN_ATTRIBUTE_ENTRY

DN attribute entry handler. Adds the entry DN as an attribute to the result set. Provides a client side implementation of RFC 5020.

MERGE

public static final LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes MERGE

Merge search entry handler. Merges the values of one or more attributes into a single attribute.

PRIMARY_GROUP

public static final LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes PRIMARY_GROUP

Primary group search handler. Constructs the primary group SID and then searches for that group and puts it's DN in the memberOf attribute of the original search entry.

RANGE_ENTRY

public static final LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes RANGE_ENTRY

Range entry search handler. Rewrites attributes returned from Active Directory to include all values by performing additional searches.

RECURSIVE_ENTRY

public static final LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes RECURSIVE_ENTRY

Recursive entry search handler. This recursively searches based on a supplied attribute and merges those results into the original entry.

MERGE_ENTRIES

public static final LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes MERGE_ENTRIES

Merge entries handler. Merges the values of one or more attributes in all entries into a single attribute. The merged attribute may or may not already exist on the entry. If it does exist it's existing values will remain intact.

Method Details

values

public static LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null