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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
The enum Search entry handler types. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionProvides the ability to modify the case of search entry DNs, attribute names, and attribute values.Adds the entry DN as an attribute to the result set.Merges the values of one or more attributes into a single attribute.Constructs the primary group SID and then searches for that group and puts it's DN in thememberOf
attribute of the original search entry.This recursively searches based on a supplied attribute and merges those results into the original entry.Provides handling of an ldap referral for search operations.Provides handling of an ldap continuation reference for search operations.getType()
The type of search entry handler to choose.setCaseChange
(CaseChangeSearchEntryHandlersProperties caseChange) Provides the ability to modify the case of search entry DNs, attribute names, and attribute values.setDnAttribute
(DnAttributeSearchEntryHandlersProperties dnAttribute) Adds the entry DN as an attribute to the result set.setMergeAttribute
(MergeAttributesSearchEntryHandlersProperties mergeAttribute) Merges the values of one or more attributes into a single attribute.setPrimaryGroupId
(PrimaryGroupIdSearchEntryHandlersProperties primaryGroupId) Constructs the primary group SID and then searches for that group and puts it's DN in thememberOf
attribute of the original search entry.This recursively searches based on a supplied attribute and merges those results into the original entry.setSearchReferral
(FollowReferralSearchEntryHandlersProperties searchReferral) Provides handling of an ldap referral for search operations.setSearchResult
(FollowResultSearchEntryHandlersProperties searchResult) Provides handling of an ldap continuation reference for search operations.The type of search entry handler to choose.
-
Constructor Details
-
LdapSearchEntryHandlersProperties
public LdapSearchEntryHandlersProperties()
-
-
Method Details
-
getType
The type of search entry handler to choose. -
getCaseChange
Provides the ability to modify the case of search entry DNs, attribute names, and attribute values. -
getDnAttribute
Adds the entry DN as an attribute to the result set. Provides a client side implementation of RFC 5020. -
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
Constructs the primary group SID and then searches for that group and puts it's DN in thememberOf
attribute of the original search entry. This handler requires that entries contain both theobjectSid/primaryGroupID
attributes. If those attributes are not found this handler is a no-op. This handler should be used in conjunction with theObjectSidHandler
to ensure theobjectSid
attribute is in the proper form. See this. -
getRecursive
This recursively searches based on a supplied attribute and merges those results into the original entry. -
getSearchReferral
Provides handling of an ldap referral for search operations. -
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 thememberOf
attribute of the original search entry. This handler requires that entries contain both theobjectSid/primaryGroupID
attributes. If those attributes are not found this handler is a no-op. This handler should be used in conjunction with theObjectSidHandler
to ensure theobjectSid
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
.
-