com.atlassian.crowd.importer.importers
Class DirectoryImporter

java.lang.Object
  extended by com.atlassian.crowd.importer.importers.BaseImporter
      extended by 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)
           
 
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<RemoteGroup> findGroups(Configuration configuration)
          Will locate and build a collection of RemoteGroup objects based on the passed in Configuration
 java.util.Collection<RoleMembership> findRoleMemberships(Configuration configuration)
          Will locate and build a collection of RoleMembership objects based on the passed in Configuration
 java.util.Collection<RemoteRole> findRoles(Configuration configuration)
          Will locate and build a collection of RemoteRole objects based on the passed in Configuration
 java.util.Collection<RemotePrincipal> findUsers(Configuration configuration)
          Will locate and build a collection of RemotePrincipal 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
importPrincipalGroupMemberships, importPrincipalRoleMemberships, importRemoteGroups, importRemotePrincipals, importRemoteRoles, importUsersGroupsAndRoles
 
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)
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

findRoleMemberships

public java.util.Collection<RoleMembership> findRoleMemberships(Configuration configuration)
                                                         throws ImporterException
Description copied from interface: Importer
Will locate and build a collection of RoleMembership objects based on the passed in Configuration

Parameters:
configuration - the Importer Configuration
Returns:
a collection of RoleMembership's to be imported or Collections.EMPTY_LIST
Throws:
ImporterException - if there is an error finding role memberships

findGroups

public java.util.Collection<RemoteGroup> findGroups(Configuration configuration)
                                             throws ImporterException
Description copied from interface: Importer
Will locate and build a collection of RemoteGroup objects based on the passed in Configuration

Parameters:
configuration - the Importer Configuration
Returns:
a collection of RemoteGroups to be imported or Collections.EMPTY_LIST
Throws:
ImporterException - if there is an error finding the RemoteGroups

findRoles

public java.util.Collection<RemoteRole> findRoles(Configuration configuration)
                                           throws ImporterException
Description copied from interface: Importer
Will locate and build a collection of RemoteRole objects based on the passed in Configuration

Parameters:
configuration - the Importer Configuration
Returns:
a collection of RemoteRoles to be imported or Collections.EMPTY_LIST
Throws:
ImporterException - if there is an error finding the RemoteRoles

findUsers

public java.util.Collection<RemotePrincipal> findUsers(Configuration configuration)
                                                throws ImporterException
Description copied from interface: Importer
Will locate and build a collection of RemotePrincipal objects based on the passed in Configuration

Parameters:
configuration - the Importer Configuration
Returns:
a collection of RemotePrincipals to be imported or Collections.EMPTY_LIST
Throws:
ImporterException - if there is an error finding the RemotePrincipal

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


Copyright © 2009 Atlassian Pty Ltd. All Rights Reserved.