net.bluemind.system.importation.commons.scanner

Class Scanner

java.lang.Object

net.bluemind.system.importation.commons.scanner.Scanner

Direct Known Subclasses:

LdapScanner

public abstract class Scanner
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected ICoreServices	coreService
protected ItemValue<Domain>	domain
protected ImportLogger	importLogger
protected LdapConProxy	ldapCon

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Scanner(ImportLogger importLogger, ICoreServices coreService, ItemValue<Domain> domain)
protected	Scanner(ImportLogger importLogger, ItemValue<Domain> domain)

Method Summary

Modifier and Type	Method and Description
protected abstract PagedSearchResult	allGroupsFromDirectory()
protected abstract PagedSearchResult	allUsersFromDirectory()
protected abstract boolean	doNotImportGroup(org.apache.directory.api.ldap.model.entry.Entry entry)
protected abstract boolean	doNotImportUser(org.apache.directory.api.ldap.model.entry.Entry entry)
protected abstract LdapConProxy	getConnection()
protected abstract java.util.Optional<org.apache.directory.api.ldap.model.entry.Entry>	getGroupFromDn(org.apache.directory.api.ldap.model.name.Dn dn)
protected abstract java.util.Optional<GroupManager>	getGroupManager(org.apache.directory.api.ldap.model.entry.Entry entry)
protected abstract GroupMemberAttribute	getGroupMembersAttributeName()
protected abstract java.lang.String	getKind()
protected java.util.Optional<org.apache.directory.api.ldap.model.name.Dn>	getMemberDn(java.lang.String groupMember) Convert groupMember to DN.
protected abstract java.util.Optional<org.apache.directory.api.ldap.model.name.Dn>	getMemberDnFromLogin(java.lang.String userLogin)
protected abstract Parameters	getParameter()
protected abstract java.util.List<IScannerEnhancer>	getScannerEnhancerHooks()
protected abstract java.util.Optional<org.apache.directory.api.ldap.model.entry.Entry>	getUserFromDn(org.apache.directory.api.ldap.model.name.Dn dn)
protected abstract java.util.Optional<UserManager>	getUserManager(org.apache.directory.api.ldap.model.entry.Entry entry)
protected abstract java.util.Optional<UuidMapper>	getUuidMapperFromEntry(org.apache.directory.api.ldap.model.entry.Entry entry)
protected abstract java.util.Optional<UuidMapper>	getUuidMapperFromExtId(java.lang.String externalId)
protected abstract PagedSearchResult	groupsDnByLastModification(java.util.Optional<java.lang.String> lastUpdate)
protected abstract boolean	isSuspended(org.apache.directory.api.ldap.model.entry.Entry entry)
static void	manageUserGroups(org.apache.directory.ldap.client.api.LdapConnection ldapCon, ICoreServices coreService, UserManager userManager, java.util.function.Function<java.lang.String,java.util.Optional<? extends UuidMapper>> getUuidMapperFromExtId)
protected abstract void	manageUserGroups(UserManager userManager)
protected abstract void	reset()
void	scan() Scan directory for updated entries since lastUpdate (Incremental mode)
protected abstract void	setupSplitGroup()
protected abstract PagedSearchResult	usersDnByLastModification(java.util.Optional<java.lang.String> lastUpdate)
protected abstract java.util.Set<UuidMapper>	uuidMapperFromExtIds(java.util.Set<java.lang.String> importedUsersExtId)

Methods inherited from class java.lang.Object

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

Field Detail

importLogger

protected final ImportLogger importLogger

domain

protected final ItemValue<Domain> domain

coreService

protected final ICoreServices coreService

ldapCon

protected LdapConProxy ldapCon

Constructor Detail

Scanner

protected Scanner(ImportLogger importLogger,
                  ItemValue<Domain> domain)

Scanner

protected Scanner(ImportLogger importLogger,
                  ICoreServices coreService,
                  ItemValue<Domain> domain)

Method Detail

scan

public void scan()

Scan directory for updated entries since lastUpdate (Incremental mode)

Parameters:

lastUpdate -

setupSplitGroup

protected abstract void setupSplitGroup()

reset

protected abstract void reset()

getKind

protected abstract java.lang.String getKind()

getParameter

protected abstract Parameters getParameter()

getConnection

protected abstract LdapConProxy getConnection()

getUuidMapperFromExtId

protected abstract java.util.Optional<UuidMapper> getUuidMapperFromExtId(java.lang.String externalId)

uuidMapperFromExtIds

protected abstract java.util.Set<UuidMapper> uuidMapperFromExtIds(java.util.Set<java.lang.String> importedUsersExtId)

getUuidMapperFromEntry

protected abstract java.util.Optional<UuidMapper> getUuidMapperFromEntry(org.apache.directory.api.ldap.model.entry.Entry entry)

getUserManager

protected abstract java.util.Optional<UserManager> getUserManager(org.apache.directory.api.ldap.model.entry.Entry entry)

getGroupManager

protected abstract java.util.Optional<GroupManager> getGroupManager(org.apache.directory.api.ldap.model.entry.Entry entry)

getGroupMembersAttributeName

protected abstract GroupMemberAttribute getGroupMembersAttributeName()

doNotImportUser

protected abstract boolean doNotImportUser(org.apache.directory.api.ldap.model.entry.Entry entry)

doNotImportGroup

protected abstract boolean doNotImportGroup(org.apache.directory.api.ldap.model.entry.Entry entry)

allUsersFromDirectory

protected abstract PagedSearchResult allUsersFromDirectory()
                                                    throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

allGroupsFromDirectory

protected abstract PagedSearchResult allGroupsFromDirectory()
                                                     throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

usersDnByLastModification

protected abstract PagedSearchResult usersDnByLastModification(java.util.Optional<java.lang.String> lastUpdate)
                                                        throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

groupsDnByLastModification

protected abstract PagedSearchResult groupsDnByLastModification(java.util.Optional<java.lang.String> lastUpdate)
                                                         throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

getUserFromDn

protected abstract java.util.Optional<org.apache.directory.api.ldap.model.entry.Entry> getUserFromDn(org.apache.directory.api.ldap.model.name.Dn dn)
                                                                                              throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

getGroupFromDn

protected abstract java.util.Optional<org.apache.directory.api.ldap.model.entry.Entry> getGroupFromDn(org.apache.directory.api.ldap.model.name.Dn dn)
                                                                                               throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

manageUserGroups

protected abstract void manageUserGroups(UserManager userManager)

getMemberDnFromLogin

protected abstract java.util.Optional<org.apache.directory.api.ldap.model.name.Dn> getMemberDnFromLogin(java.lang.String userLogin)

getScannerEnhancerHooks

protected abstract java.util.List<IScannerEnhancer> getScannerEnhancerHooks()

isSuspended

protected abstract boolean isSuspended(org.apache.directory.api.ldap.model.entry.Entry entry)

getMemberDn

protected java.util.Optional<org.apache.directory.api.ldap.model.name.Dn> getMemberDn(java.lang.String groupMember)

Convert groupMember to DN. Search for user DN using groupMember as login if groupMember is not a valid DN.

Parameters:

groupMember - valid DN or user login

Returns:

manageUserGroups

public static void manageUserGroups(org.apache.directory.ldap.client.api.LdapConnection ldapCon,
                                    ICoreServices coreService,
                                    UserManager userManager,
                                    java.util.function.Function<java.lang.String,java.util.Optional<? extends UuidMapper>> getUuidMapperFromExtId)
                             throws ServerFault

Throws:

ServerFault