com.atlassian.crowd.importer.importers
Class DirectoryImporter

java.lang.Object
  com.atlassian.crowd.importer.importers.BaseImporter
      com.atlassian.crowd.importer.importers.DirectoryImporter

All Implemented Interfaces:

Importer

public class DirectoryImporter
extends BaseImporter

An Importer that manages moving users, groups and roles from one directory to another.

Field Summary

Fields inherited from class com.atlassian.crowd.importer.importers.BaseImporter

directoryManager, logger

Constructor Summary

DirectoryImporter(DirectoryManager directoryManager, PasswordHelper passwordHelper)

Method Summary

java.util.Collection<GroupMembership>	findGroupMemberships(Configuration configuration) Will locate and build a collection of GroupMembership objects based on the passed in Configuration
java.util.Collection<GroupTemplate>	findGroups(Configuration configuration) Will locate and build a collection of GroupTemplate objects based on the passed in Configuration
java.util.Collection<UserTemplateWithCredentialAndAttributes>	findUsers(Configuration configuration) Will locate and build a collection of UserTemplate objects based on the passed in Configuration
java.lang.Class	getConfigurationType() The type of configuration being used for this Import.
void	init(Configuration configuration) Initialise anything required for the import process.

Methods inherited from class com.atlassian.crowd.importer.importers.BaseImporter

importGroupMemberships, importGroups, importUsers, importUsersGroupsAndMemberships

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryImporter

public DirectoryImporter(DirectoryManager directoryManager,
                         PasswordHelper passwordHelper)

Method Detail

findGroupMemberships

public java.util.Collection<GroupMembership> findGroupMemberships(Configuration configuration)
                                                           throws ImporterException

Description copied from interface: Importer

Will locate and build a collection of GroupMembership objects based on the passed in Configuration

Parameters:

configuration - the Importer Configuration

Returns:

a collection of GroupMemberships to be imported or Collections.EMPTY_LIST

Throws:

ImporterException - if there is an error finding group memberships

findGroups

public java.util.Collection<GroupTemplate> findGroups(Configuration configuration)
                                               throws ImporterException

Description copied from interface: Importer

Will locate and build a collection of GroupTemplate objects based on the passed in Configuration

Parameters:

configuration - the Importer Configuration

Returns:

a collection of GroupTemplates to be imported or Collections.EMPTY_LIST

Throws:

ImporterException - if there is an error finding the groups

findUsers

public java.util.Collection<UserTemplateWithCredentialAndAttributes> findUsers(Configuration configuration)
                                                                        throws ImporterException

Description copied from interface: Importer

Will locate and build a collection of UserTemplate objects based on the passed in Configuration

Parameters:

configuration - the Importer Configuration

Returns:

a collection of UserTemplates to be imported or Collections.EMPTY_LIST

Throws:

ImporterException - if there is an error finding the users

init

public void init(Configuration configuration)

Description copied from interface: Importer

Initialise anything required for the import process.

Parameters:

configuration - can contain any setup params such as database settings that need init'ing

getConfigurationType

public java.lang.Class getConfigurationType()

Description copied from interface: Importer

The type of configuration being used for this Import.

Returns:

Class that should be a subclass of Configuration