public class LDAPUtils extends Object
Constructor and Description |
---|
LDAPUtils() |
Modifier and Type | Method and Description |
---|---|
static void |
addMember(LDAPStorageProvider ldapProvider,
MembershipType membershipType,
String memberAttrName,
String memberChildAttrName,
LDAPObject ldapParent,
LDAPObject ldapChild)
Add ldapChild as member of ldapParent and save ldapParent to LDAP.
|
static LDAPObject |
addUserToLDAP(LDAPStorageProvider ldapProvider,
RealmModel realm,
UserModel user) |
static void |
checkUuid(LDAPObject ldapUser,
LDAPConfig config) |
static void |
computeAndSetDn(LDAPConfig config,
LDAPObject ldapUser) |
static LDAPObject |
createLDAPGroup(LDAPStorageProvider ldapProvider,
String groupName,
String groupNameAttribute,
Collection<String> objectClasses,
String parentDn,
Map<String,Set<String>> additionalAttributes,
String membershipLdapAttribute) |
static LDAPQuery |
createQueryForUserSearch(LDAPStorageProvider ldapProvider,
RealmModel realm) |
static void |
deleteMember(LDAPStorageProvider ldapProvider,
MembershipType membershipType,
String memberAttrName,
String memberChildAttrName,
LDAPObject ldapParent,
LDAPObject ldapChild)
Remove ldapChild as member of ldapParent and save ldapParent to LDAP.
|
static void |
fillRangedAttribute(LDAPStorageProvider ldapProvider,
LDAPObject ldapObject,
String name)
Performs iterative searches over an LDAPObject to return an attribute that is ranged.
|
static Set<String> |
getExistingMemberships(LDAPStorageProvider ldapProvider,
String memberAttrName,
LDAPObject ldapRole)
Return all existing memberships (values of attribute 'member' ) from the given ldapRole or ldapGroup
|
static String |
getMemberValueOfChildObject(LDAPObject ldapUser,
MembershipType membershipType,
String memberChildAttrName)
Get value to be used as attribute 'member' or 'memberUid' in some parent ldapObject
|
static Map<String,Property<Object>> |
getUserModelProperties()
Return a map of the user model properties from the getter methods
Map key are the attributes names in lower case
|
static String |
getUsername(LDAPObject ldapUser,
LDAPConfig config) |
static List<LDAPObject> |
loadAllLDAPObjects(LDAPQuery ldapQuery,
LDAPStorageProvider ldapProvider)
Load all LDAP objects corresponding to given query.
|
static LDAPObject |
updateLDAPGroup(LDAPStorageProvider ldapProvider,
LDAPObject ldapObject) |
static void |
validateCustomLdapFilter(String customFilter)
Validate configured customFilter matches the requested format
|
public static LDAPObject addUserToLDAP(LDAPStorageProvider ldapProvider, RealmModel realm, UserModel user)
ldapProvider
- realm
- user
- public static LDAPQuery createQueryForUserSearch(LDAPStorageProvider ldapProvider, RealmModel realm)
public static void computeAndSetDn(LDAPConfig config, LDAPObject ldapUser)
public static String getUsername(LDAPObject ldapUser, LDAPConfig config)
public static void checkUuid(LDAPObject ldapUser, LDAPConfig config)
public static LDAPObject createLDAPGroup(LDAPStorageProvider ldapProvider, String groupName, String groupNameAttribute, Collection<String> objectClasses, String parentDn, Map<String,Set<String>> additionalAttributes, String membershipLdapAttribute)
public static LDAPObject updateLDAPGroup(LDAPStorageProvider ldapProvider, LDAPObject ldapObject)
public static void addMember(LDAPStorageProvider ldapProvider, MembershipType membershipType, String memberAttrName, String memberChildAttrName, LDAPObject ldapParent, LDAPObject ldapChild)
ldapProvider
- membershipType
- how is 'member' attribute saved (full DN or just uid)memberAttrName
- usually 'member'memberChildAttrName
- used just if membershipType is UID. Usually 'uid'ldapParent
- role or groupldapChild
- usually user (or child group or child role)public static void deleteMember(LDAPStorageProvider ldapProvider, MembershipType membershipType, String memberAttrName, String memberChildAttrName, LDAPObject ldapParent, LDAPObject ldapChild)
ldapProvider
- membershipType
- how is 'member' attribute saved (full DN or just uid)memberAttrName
- usually 'member'memberChildAttrName
- used just if membershipType is UID. Usually 'uid'ldapParent
- role or groupldapChild
- usually user (or child group or child role)public static Set<String> getExistingMemberships(LDAPStorageProvider ldapProvider, String memberAttrName, LDAPObject ldapRole)
ldapProvider
- The ldap providermemberAttrName
- usually 'member'ldapRole
- public static String getMemberValueOfChildObject(LDAPObject ldapUser, MembershipType membershipType, String memberChildAttrName)
public static List<LDAPObject> loadAllLDAPObjects(LDAPQuery ldapQuery, LDAPStorageProvider ldapProvider)
ldapQuery
- LDAP query to be used. The caller should close it after calling this methodldapProvider
- public static void validateCustomLdapFilter(String customFilter) throws ComponentValidationException
customFilter
- ComponentValidationException
public static void fillRangedAttribute(LDAPStorageProvider ldapProvider, LDAPObject ldapObject, String name)
ldapProvider
- The provider to useldapObject
- The current object with the ranged attribute not completename
- The attribute nameCopyright © 2021 JBoss by Red Hat. All rights reserved.