## Uses of Class
org.keycloak.federation.ldap.idm.model.LDAPObject

- Packages that use LDAPObject
  Package | Description
  --- | ---
  org.keycloak.federation.ldap |
  org.keycloak.federation.ldap.idm.query.internal |
  org.keycloak.federation.ldap.idm.store |
  org.keycloak.federation.ldap.idm.store.ldap |
  org.keycloak.federation.ldap.mappers |
  org.keycloak.federation.ldap.mappers.membership |
  org.keycloak.federation.ldap.mappers.membership.group |
  org.keycloak.federation.ldap.mappers.membership.role |
  org.keycloak.federation.ldap.mappers.msad |

- - ### Uses of LDAPObject in org.keycloak.federation.ldap

    Fields in org.keycloak.federation.ldap declared as LDAPObject
    Modifier and Type | Field and Description
    --- | ---
    `protected LDAPObject` | WritableLDAPUserModelDelegate.`ldapObject`

    Methods in org.keycloak.federation.ldap that return LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `static LDAPObject` | LDAPUtils.`addUserToLDAP(LDAPFederationProvider ldapProvider, RealmModel realm, UserModel user)`
    `static LDAPObject` | LDAPUtils.`createLDAPGroup(LDAPFederationProvider ldapProvider, String groupName, String groupNameAttribute, Collection<String> objectClasses, String parentDn, Map<String,Set<String>> additionalAttributes)`
    `protected LDAPObject` | LDAPFederationProvider.`loadAndValidateUser(RealmModel realm, UserModel local)`
    `LDAPObject` | LDAPFederationProvider.`loadLDAPUserByUsername(RealmModel realm, String username)`
    `protected LDAPObject` | LDAPFederationProvider.`queryByEmail(RealmModel realm, String email)`

    Methods in org.keycloak.federation.ldap that return types with arguments of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `static List<LDAPObject>` | LDAPUtils.`loadAllLDAPObjects(LDAPQuery ldapQuery, LDAPFederationProvider ldapProvider)` Load all LDAP objects corresponding to given query.
    `protected List<LDAPObject>` | LDAPFederationProvider.`searchLDAP(RealmModel realm, Map<String,String> attributes, int maxResults)`

    Methods in org.keycloak.federation.ldap with parameters of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `static void` | LDAPUtils.`addMember(LDAPFederationProvider ldapProvider, MembershipType membershipType, String memberAttrName, LDAPObject ldapParent, LDAPObject ldapChild, boolean sendLDAPUpdateRequest)` Add ldapChild as member of ldapParent and save ldapParent to LDAP.
    `static void` | LDAPUtils.`checkUuid(LDAPObject ldapUser, LDAPConfig config)`
    `static void` | LDAPUtils.`deleteMember(LDAPFederationProvider ldapProvider, MembershipType membershipType, String memberAttrName, LDAPObject ldapParent, LDAPObject ldapChild, boolean sendLDAPUpdateRequest)` Remove ldapChild as member of ldapParent and save ldapParent to LDAP.
    `static Set<String>` | LDAPUtils.`getExistingMemberships(String memberAttrName, LDAPObject ldapRole)` Return all existing memberships (values of attribute 'member' ) from the given ldapRole or ldapGroup
    `static String` | LDAPUtils.`getMemberValueOfChildObject(LDAPObject ldapUser, MembershipType membershipType)` Get value to be used as attribute 'member' in some parent ldapObject
    `static String` | LDAPUtils.`getUsername(LDAPObject ldapUser, LDAPConfig config)`
    `protected UserModel` | LDAPFederationProvider.`importUserFromLDAP(KeycloakSession session, RealmModel realm, LDAPObject ldapUser)`
    `protected UserModel` | LDAPFederationProvider.`proxy(RealmModel realm, UserModel local, LDAPObject ldapObject)`

    Method parameters in org.keycloak.federation.ldap with type arguments of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `protected UserFederationSyncResult` | LDAPFederationProviderFactory.`importLdapUsers(KeycloakSessionFactory sessionFactory, String realmId, UserFederationProviderModel fedModel, List<LDAPObject> ldapUsers)`

    Constructors in org.keycloak.federation.ldap with parameters of type LDAPObject
    Constructor and Description
    `WritableLDAPUserModelDelegate(UserModel delegate, LDAPFederationProvider provider, LDAPObject ldapObject)`

  - ### Uses of LDAPObject in org.keycloak.federation.ldap.idm.query.internal

    Methods in org.keycloak.federation.ldap.idm.query.internal that return LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `LDAPObject` | LDAPQuery.`getFirstResult()`

    Methods in org.keycloak.federation.ldap.idm.query.internal that return types with arguments of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `List<LDAPObject>` | LDAPQuery.`getResultList()`

  - ### Uses of LDAPObject in org.keycloak.federation.ldap.idm.store

    Methods in org.keycloak.federation.ldap.idm.store that return types with arguments of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `List<LDAPObject>` | IdentityStore.`fetchQueryResults(LDAPQuery LDAPQuery)`

    Methods in org.keycloak.federation.ldap.idm.store with parameters of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `void` | IdentityStore.`add(LDAPObject ldapObject)` Persists the specified IdentityType
    `void` | IdentityStore.`remove(LDAPObject ldapObject)` Removes the specified IdentityType
    `void` | IdentityStore.`update(LDAPObject ldapObject)` Updates the specified IdentityType
    `void` | IdentityStore.`updatePassword(LDAPObject user, String password)` Updates the specified credential value.
    `void` | IdentityStore.`validatePassword(LDAPObject user, String password)` Validates the specified credentials.

  - ### Uses of LDAPObject in org.keycloak.federation.ldap.idm.store.ldap

    Methods in org.keycloak.federation.ldap.idm.store.ldap that return types with arguments of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `List<LDAPObject>` | LDAPIdentityStore.`fetchQueryResults(LDAPQuery identityQuery)`

    Methods in org.keycloak.federation.ldap.idm.store.ldap with parameters of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `void` | LDAPIdentityStore.`add(LDAPObject ldapObject)`
    `protected BasicAttributes` | LDAPIdentityStore.`extractAttributes(LDAPObject ldapObject, boolean isCreate)`
    `protected String` | LDAPIdentityStore.`getEntryIdentifier(LDAPObject ldapObject)`
    `void` | LDAPIdentityStore.`remove(LDAPObject ldapObject)`
    `void` | LDAPIdentityStore.`update(LDAPObject ldapObject)`
    `void` | LDAPIdentityStore.`updatePassword(LDAPObject user, String password)`
    `void` | LDAPIdentityStore.`validatePassword(LDAPObject user, String password)`

  - ### Uses of LDAPObject in org.keycloak.federation.ldap.mappers

    Fields in org.keycloak.federation.ldap.mappers declared as LDAPObject
    Modifier and Type | Field and Description
    --- | ---
    `protected LDAPObject` | TxAwareLDAPUserModelDelegate.`ldapUser`

    Methods in org.keycloak.federation.ldap.mappers with parameters of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | AbstractLDAPFederationMapper.`onAuthenticationFailure(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException)`
    `boolean` | LDAPFederationMapperBridge.`onAuthenticationFailure(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm)`
    `boolean` | LDAPFederationMapper.`onAuthenticationFailure(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm)` Called when LDAP authentication of specified user fails.
    `void` | UserAttributeLDAPFederationMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, boolean isCreate)`
    `void` | HardcodedLDAPRoleMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, boolean isCreate)`
    `void` | FullNameLDAPFederationMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, boolean isCreate)`
    `abstract void` | AbstractLDAPFederationMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, boolean isCreate)`
    `void` | LDAPFederationMapperBridge.`onImportUserFromLDAP(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)`
    `void` | LDAPFederationMapper.`onImportUserFromLDAP(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)` Called when importing user from LDAP to local keycloak DB.
    `void` | UserAttributeLDAPFederationMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser)`
    `void` | HardcodedLDAPRoleMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser)`
    `void` | FullNameLDAPFederationMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser)`
    `abstract void` | AbstractLDAPFederationMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser)`
    `void` | LDAPFederationMapperBridge.`onRegisterUserToLDAP(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel localUser, RealmModel realm)`
    `void` | LDAPFederationMapper.`onRegisterUserToLDAP(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel localUser, RealmModel realm)` Called when register new user to LDAP - just after user was created in Keycloak DB
    `UserModel` | UserAttributeLDAPFederationMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`
    `UserModel` | HardcodedLDAPRoleMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`
    `UserModel` | FullNameLDAPFederationMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`
    `abstract UserModel` | AbstractLDAPFederationMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`
    `UserModel` | LDAPFederationMapperBridge.`proxy(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel delegate, RealmModel realm)`
    `UserModel` | LDAPFederationMapper.`proxy(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, LDAPObject ldapUser, UserModel delegate, RealmModel realm)` Called when invoke proxy on LDAP federation provider

    Constructors in org.keycloak.federation.ldap.mappers with parameters of type LDAPObject
    Constructor and Description
    `TxAwareLDAPUserModelDelegate(UserModel delegate, LDAPFederationProvider provider, LDAPObject ldapUser)`

  - ### Uses of LDAPObject in org.keycloak.federation.ldap.mappers.membership

    Methods in org.keycloak.federation.ldap.mappers.membership that return types with arguments of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `List<LDAPObject>` | UserRolesRetrieveStrategy.`getLDAPRoleMappings(CommonLDAPGroupMapper roleOrGroupMapper, LDAPObject ldapUser)`
    `List<LDAPObject>` | UserRolesRetrieveStrategy.LoadRolesByMember.`getLDAPRoleMappings(CommonLDAPGroupMapper roleOrGroupMapper, LDAPObject ldapUser)`
    `List<LDAPObject>` | UserRolesRetrieveStrategy.GetRolesFromUserMemberOfAttribute.`getLDAPRoleMappings(CommonLDAPGroupMapper roleOrGroupMapper, LDAPObject ldapUser)`

    Methods in org.keycloak.federation.ldap.mappers.membership with parameters of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `abstract List<UserModel>` | MembershipType.`getGroupMembers(GroupLDAPFederationMapper groupMapper, LDAPObject ldapGroup, int firstResult, int maxResults)`
    `List<LDAPObject>` | UserRolesRetrieveStrategy.`getLDAPRoleMappings(CommonLDAPGroupMapper roleOrGroupMapper, LDAPObject ldapUser)`
    `List<LDAPObject>` | UserRolesRetrieveStrategy.LoadRolesByMember.`getLDAPRoleMappings(CommonLDAPGroupMapper roleOrGroupMapper, LDAPObject ldapUser)`
    `List<LDAPObject>` | UserRolesRetrieveStrategy.GetRolesFromUserMemberOfAttribute.`getLDAPRoleMappings(CommonLDAPGroupMapper roleOrGroupMapper, LDAPObject ldapUser)`
    `abstract Set<LDAPDn>` | MembershipType.`getLDAPSubgroups(GroupLDAPFederationMapper groupMapper, LDAPObject ldapGroup)`

  - ### Uses of LDAPObject in org.keycloak.federation.ldap.mappers.membership.group

    Methods in org.keycloak.federation.ldap.mappers.membership.group that return LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `LDAPObject` | GroupLDAPFederationMapper.`createLDAPGroup(String groupName, Map<String,Set<String>> additionalAttributes)`
    `LDAPObject` | GroupLDAPFederationMapper.`loadLDAPGroupByName(String groupName)`

    Methods in org.keycloak.federation.ldap.mappers.membership.group that return types with arguments of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `protected List<LDAPObject>` | GroupLDAPFederationMapper.`getAllLDAPGroups()`
    `protected List<LDAPObject>` | GroupLDAPFederationMapper.`getLDAPGroupMappings(LDAPObject ldapUser)`

    Methods in org.keycloak.federation.ldap.mappers.membership.group with parameters of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `void` | GroupLDAPFederationMapper.`addGroupMappingInLDAP(String groupName, LDAPObject ldapUser)`
    `void` | GroupLDAPFederationMapper.`deleteGroupMappingInLDAP(LDAPObject ldapUser, LDAPObject ldapGroup)`
    `protected GroupModel` | GroupLDAPFederationMapper.`findKcGroupByLDAPGroup(LDAPObject ldapGroup)`
    `protected GroupModel` | GroupLDAPFederationMapper.`findKcGroupOrSyncFromLDAP(LDAPObject ldapGroup, UserModel user)`
    `protected List<LDAPObject>` | GroupLDAPFederationMapper.`getLDAPGroupMappings(LDAPObject ldapUser)`
    `protected Set<LDAPDn>` | GroupLDAPFederationMapper.`getLDAPSubgroups(LDAPObject ldapGroup)`
    `void` | GroupLDAPFederationMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, boolean isCreate)`
    `void` | GroupLDAPFederationMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser)`
    `UserModel` | GroupLDAPFederationMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`

    Constructors in org.keycloak.federation.ldap.mappers.membership.group with parameters of type LDAPObject
    Constructor and Description
    `LDAPGroupMappingsUserDelegate(UserModel user, LDAPObject ldapUser)`

  - ### Uses of LDAPObject in org.keycloak.federation.ldap.mappers.membership.role

    Methods in org.keycloak.federation.ldap.mappers.membership.role that return LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `LDAPObject` | RoleLDAPFederationMapper.`createLDAPRole(String roleName)`
    `LDAPObject` | RoleLDAPFederationMapper.`loadLDAPRoleByName(String roleName)`

    Methods in org.keycloak.federation.ldap.mappers.membership.role that return types with arguments of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `protected List<LDAPObject>` | RoleLDAPFederationMapper.`getLDAPRoleMappings(LDAPObject ldapUser)`

    Methods in org.keycloak.federation.ldap.mappers.membership.role with parameters of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `void` | RoleLDAPFederationMapper.`addRoleMappingInLDAP(String roleName, LDAPObject ldapUser)`
    `void` | RoleLDAPFederationMapper.`deleteRoleMappingInLDAP(LDAPObject ldapUser, LDAPObject ldapRole)`
    `protected List<LDAPObject>` | RoleLDAPFederationMapper.`getLDAPRoleMappings(LDAPObject ldapUser)`
    `void` | RoleLDAPFederationMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, boolean isCreate)`
    `void` | RoleLDAPFederationMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser)`
    `UserModel` | RoleLDAPFederationMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`

    Constructors in org.keycloak.federation.ldap.mappers.membership.role with parameters of type LDAPObject
    Constructor and Description
    `LDAPRoleMappingsUserDelegate(UserModel user, LDAPObject ldapUser)`

  - ### Uses of LDAPObject in org.keycloak.federation.ldap.mappers.msad

    Methods in org.keycloak.federation.ldap.mappers.msad with parameters of type LDAPObject
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | MSADUserAccountControlMapper.`onAuthenticationFailure(LDAPObject ldapUser, UserModel user, AuthenticationException ldapException)`
    `void` | MSADUserAccountControlMapper.`onImportUserFromLDAP(LDAPObject ldapUser, UserModel user, boolean isCreate)`
    `void` | MSADUserAccountControlMapper.`onRegisterUserToLDAP(LDAPObject ldapUser, UserModel localUser)`
    `UserModel` | MSADUserAccountControlMapper.`proxy(LDAPObject ldapUser, UserModel delegate)`

    Constructors in org.keycloak.federation.ldap.mappers.msad with parameters of type LDAPObject
    Constructor and Description
    `MSADUserModelDelegate(UserModel delegate, LDAPObject ldapUser)`

Copyright © 2016 JBoss by Red Hat. All rights reserved.