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

Class LdapSearchEntryHandlersProperties

java.lang.Object

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

All Implemented Interfaces:

Serializable

@RequiresModule(name="cas-server-support-ldap")
public class LdapSearchEntryHandlersProperties
extends Object
implements Serializable

This is LdapSearchEntryHandlersProperties.

Since:

5.2.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes	The enum Search entry handler types.

Constructor Summary

Constructors

Constructor	Description
LdapSearchEntryHandlersProperties()

Method Summary

Modifier and Type	Method	Description
CaseChangeSearchEntryHandlersProperties	getCaseChange()	Provides the ability to modify the case of search entry DNs, attribute names, and attribute values.
DnAttributeSearchEntryHandlersProperties	getDnAttribute()	Adds the entry DN as an attribute to the result set.
MergeAttributesSearchEntryHandlersProperties	getMergeAttribute()	Merges the values of one or more attributes into a single attribute.
PrimaryGroupIdSearchEntryHandlersProperties	getPrimaryGroupId()	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.
RecursiveSearchEntryHandlersProperties	getRecursive()	This recursively searches based on a supplied attribute and merges those results into the original entry.
FollowReferralSearchEntryHandlersProperties	getSearchReferral()	Provides handling of an ldap referral for search operations.
FollowResultSearchEntryHandlersProperties	getSearchResult()	Provides handling of an ldap continuation reference for search operations.
LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes	getType()	The type of search entry handler to choose.
LdapSearchEntryHandlersProperties	setCaseChange(CaseChangeSearchEntryHandlersProperties caseChange)	Provides the ability to modify the case of search entry DNs, attribute names, and attribute values.
LdapSearchEntryHandlersProperties	setDnAttribute(DnAttributeSearchEntryHandlersProperties dnAttribute)	Adds the entry DN as an attribute to the result set.
LdapSearchEntryHandlersProperties	setMergeAttribute(MergeAttributesSearchEntryHandlersProperties mergeAttribute)	Merges the values of one or more attributes into a single attribute.
LdapSearchEntryHandlersProperties	setPrimaryGroupId(PrimaryGroupIdSearchEntryHandlersProperties primaryGroupId)	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.
LdapSearchEntryHandlersProperties	setRecursive(RecursiveSearchEntryHandlersProperties recursive)	This recursively searches based on a supplied attribute and merges those results into the original entry.
LdapSearchEntryHandlersProperties	setSearchReferral(FollowReferralSearchEntryHandlersProperties searchReferral)	Provides handling of an ldap referral for search operations.
LdapSearchEntryHandlersProperties	setSearchResult(FollowResultSearchEntryHandlersProperties searchResult)	Provides handling of an ldap continuation reference for search operations.
LdapSearchEntryHandlersProperties	setType(LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes type)	The type of search entry handler to choose.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LdapSearchEntryHandlersProperties

public LdapSearchEntryHandlersProperties()

Method Details

getType

public LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes getType()

The type of search entry handler to choose.

getCaseChange

public CaseChangeSearchEntryHandlersProperties getCaseChange()

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

getDnAttribute

public DnAttributeSearchEntryHandlersProperties getDnAttribute()

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

getMergeAttribute

public MergeAttributesSearchEntryHandlersProperties getMergeAttribute()

Merges the values of one or more attributes 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.

getPrimaryGroupId

public PrimaryGroupIdSearchEntryHandlersProperties getPrimaryGroupId()

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. This handler requires that entries contain both the objectSid/primaryGroupID attributes. If those attributes are not found this handler is a no-op. This handler should be used in conjunction with the ObjectSidHandler to ensure the objectSid attribute is in the proper form. See this.

getRecursive

public RecursiveSearchEntryHandlersProperties getRecursive()

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

getSearchReferral

public FollowReferralSearchEntryHandlersProperties getSearchReferral()

Provides handling of an ldap referral for search operations.

getSearchResult

public FollowResultSearchEntryHandlersProperties getSearchResult()

Provides handling of an ldap continuation reference for search operations.

setType

public LdapSearchEntryHandlersProperties setType(LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes type)

The type of search entry handler to choose.

Returns:

this.

setCaseChange

public LdapSearchEntryHandlersProperties setCaseChange(CaseChangeSearchEntryHandlersProperties caseChange)

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

Returns:

this.

setDnAttribute

public LdapSearchEntryHandlersProperties setDnAttribute(DnAttributeSearchEntryHandlersProperties dnAttribute)

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

Returns:

this.

setMergeAttribute

public LdapSearchEntryHandlersProperties setMergeAttribute(MergeAttributesSearchEntryHandlersProperties mergeAttribute)

Merges the values of one or more attributes 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.

Returns:

this.

setPrimaryGroupId

public LdapSearchEntryHandlersProperties setPrimaryGroupId(PrimaryGroupIdSearchEntryHandlersProperties primaryGroupId)

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. This handler requires that entries contain both the objectSid/primaryGroupID attributes. If those attributes are not found this handler is a no-op. This handler should be used in conjunction with the ObjectSidHandler to ensure the objectSid attribute is in the proper form. See this.

Returns:

this.

setRecursive

public LdapSearchEntryHandlersProperties setRecursive(RecursiveSearchEntryHandlersProperties recursive)

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

Returns:

this.

setSearchReferral

public LdapSearchEntryHandlersProperties setSearchReferral(FollowReferralSearchEntryHandlersProperties searchReferral)

Provides handling of an ldap referral for search operations.

Returns:

this.

setSearchResult

public LdapSearchEntryHandlersProperties setSearchResult(FollowResultSearchEntryHandlersProperties searchResult)

Provides handling of an ldap continuation reference for search operations.

Returns:

this.