## Uses of Class
org.keycloak.federation.ldap.LDAPFederationProvider

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

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

    Fields in org.keycloak.federation.ldap declared as LDAPFederationProvider
    Modifier and Type | Field and Description
    --- | ---
    `protected LDAPFederationProvider` | WritableLDAPUserModelDelegate.`provider`
    `protected LDAPFederationProvider` | UnsyncedLDAPUserModelDelegate.`provider`
    `protected LDAPFederationProvider` | ReadonlyLDAPUserModelDelegate.`provider`

    Methods in org.keycloak.federation.ldap that return LDAPFederationProvider
    Modifier and Type | Method and Description
    --- | ---
    `LDAPFederationProvider` | LDAPFederationProviderFactory.`getInstance(KeycloakSession session, UserFederationProviderModel model)`

    Methods in org.keycloak.federation.ldap with parameters of type LDAPFederationProvider
    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 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)`
    `static LDAPQuery` | LDAPUtils.`createQueryForUserSearch(LDAPFederationProvider ldapProvider, RealmModel realm)`
    `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 List<LDAPObject>` | LDAPUtils.`loadAllLDAPObjects(LDAPQuery ldapQuery, LDAPFederationProvider ldapProvider)` Load all LDAP objects corresponding to given query.

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

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

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

    Constructors in org.keycloak.federation.ldap.idm.query.internal with parameters of type LDAPFederationProvider
    Constructor and Description
    `LDAPQuery(LDAPFederationProvider ldapProvider)`

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

    Fields in org.keycloak.federation.ldap.mappers declared as LDAPFederationProvider
    Modifier and Type | Field and Description
    --- | ---
    `protected LDAPFederationProvider` | AbstractLDAPFederationMapper.`ldapProvider`
    `protected LDAPFederationProvider` | TxAwareLDAPUserModelDelegate.`provider`

    Methods in org.keycloak.federation.ldap.mappers that return LDAPFederationProvider
    Modifier and Type | Method and Description
    --- | ---
    `LDAPFederationProvider` | AbstractLDAPFederationMapper.`getLdapProvider()`

    Methods in org.keycloak.federation.ldap.mappers with parameters of type LDAPFederationProvider
    Modifier and Type | Method and Description
    --- | ---
    `protected AbstractLDAPFederationMapper` | UserAttributeLDAPFederationMapperFactory.`createMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider federationProvider, RealmModel realm)`
    `protected AbstractLDAPFederationMapper` | HardcodedLDAPRoleMapperFactory.`createMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider federationProvider, RealmModel realm)`
    `protected AbstractLDAPFederationMapper` | FullNameLDAPFederationMapperFactory.`createMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider federationProvider, RealmModel realm)`
    `protected abstract AbstractLDAPFederationMapper` | AbstractLDAPFederationMapperFactory.`createMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider federationProvider, RealmModel realm)`
    `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` | 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` | 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` | 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 LDAPFederationProvider
    Constructor and Description
    `AbstractLDAPFederationMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, RealmModel realm)`
    `FullNameLDAPFederationMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, RealmModel realm)`
    `HardcodedLDAPRoleMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, RealmModel realm)`
    `TxAwareLDAPUserModelDelegate(UserModel delegate, LDAPFederationProvider provider, LDAPObject ldapUser)`
    `UserAttributeLDAPFederationMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, RealmModel realm)`

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

    Methods in org.keycloak.federation.ldap.mappers.membership.group with parameters of type LDAPFederationProvider
    Modifier and Type | Method and Description
    --- | ---
    `protected AbstractLDAPFederationMapper` | GroupLDAPFederationMapperFactory.`createMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider federationProvider, RealmModel realm)`
    `Collection<String>` | GroupMapperConfig.`getGroupObjectClasses(LDAPFederationProvider ldapProvider)`

    Constructors in org.keycloak.federation.ldap.mappers.membership.group with parameters of type LDAPFederationProvider
    Constructor and Description
    `GroupLDAPFederationMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, RealmModel realm, GroupLDAPFederationMapperFactory factory)`

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

    Methods in org.keycloak.federation.ldap.mappers.membership.role with parameters of type LDAPFederationProvider
    Modifier and Type | Method and Description
    --- | ---
    `protected AbstractLDAPFederationMapper` | RoleLDAPFederationMapperFactory.`createMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider federationProvider, RealmModel realm)`
    `Collection<String>` | RoleMapperConfig.`getRoleObjectClasses(LDAPFederationProvider ldapProvider)`

    Constructors in org.keycloak.federation.ldap.mappers.membership.role with parameters of type LDAPFederationProvider
    Constructor and Description
    `RoleLDAPFederationMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, RealmModel realm, RoleLDAPFederationMapperFactory factory)`

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

    Methods in org.keycloak.federation.ldap.mappers.msad with parameters of type LDAPFederationProvider
    Modifier and Type | Method and Description
    --- | ---
    `protected AbstractLDAPFederationMapper` | MSADUserAccountControlMapperFactory.`createMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider federationProvider, RealmModel realm)`

    Constructors in org.keycloak.federation.ldap.mappers.msad with parameters of type LDAPFederationProvider
    Constructor and Description
    `MSADUserAccountControlMapper(UserFederationMapperModel mapperModel, LDAPFederationProvider ldapProvider, RealmModel realm)`

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