com.atlassian.crowd.importer.manager
Interface ImporterManager

All Known Implementing Classes:

ImporterManagerImpl

public interface ImporterManager

Handles the importing of users, groups and memberships into Crowd.

Method Summary

java.util.Set<java.lang.String>	getAtlassianSupportedApplications() A list of Atlassian supported applications
java.util.Set<java.lang.String>	getSupportedApplications() A list of supported applications
Result	performImport(Configuration configuration) Will perform the import based on the given configuration into Crowd.
java.util.Set<Directory>	retrieveRemoteSourceDirectories(Configuration configuration) The retrieve the set of remote source directories.
boolean	supportsMultipleDirectories(Configuration configuration) Returns true if the source application supports multiple directories such as if it is crowdified.
void	testConfiguration(Configuration configuration) Tests that the connection succeeded or failed based on the provided configuration

Method Detail

getSupportedApplications

java.util.Set<java.lang.String> getSupportedApplications()

A list of supported applications

Returns:

Set's representing each application

getAtlassianSupportedApplications

java.util.Set<java.lang.String> getAtlassianSupportedApplications()

A list of Atlassian supported applications

Returns:

Set's representing each application

performImport

Result performImport(Configuration configuration)
                     throws ImporterException

Will perform the import based on the given configuration into Crowd.

Parameters:

configuration - The Configuration for the import

Returns:

result This will contain details about the import process

Throws:

ImporterException - will be thrown if an error occurs connecting or importing the users into Crowd, or if the provided configuration is invalid.

supportsMultipleDirectories

boolean supportsMultipleDirectories(Configuration configuration)
                                    throws ImporterException

Returns true if the source application supports multiple directories such as if it is crowdified.

Parameters:

configuration - the import configuration.

Returns:

true

Throws:

ImporterException - will be thrown if an error occurs connecting, or if the provided configuration is invalid.

retrieveRemoteSourceDirectories

java.util.Set<Directory> retrieveRemoteSourceDirectories(Configuration configuration)
                                                         throws ImporterException

The retrieve the set of remote source directories.

Parameters:

configuration - the import configuration.

Returns:

the set of source directories.

Throws:

ImporterException - will be thrown if an error occurs connecting, or if the provided configuration is invalid.

testConfiguration

void testConfiguration(Configuration configuration)
                       throws ImporterConfigurationException

Tests that the connection succeeded or failed based on the provided configuration

Parameters:

configuration - the configuration to use with the importer

Throws:

ImporterConfigurationException - thrown if there is an error connecting to the external datasource