com.atlassian.crowd.importer.manager

Class ImporterManagerImpl

java.lang.Object

com.atlassian.crowd.importer.manager.ImporterManagerImpl

All Implemented Interfaces:

ImporterManager

public class ImporterManagerImpl
extends Object
implements ImporterManager

The main implementation of the ImporterManager.

See Also:

ImporterManager

Constructor Summary

Constructors

Constructor and Description
ImporterManagerImpl()

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getAtlassianSupportedApplications() A list of Atlassian supported applications
Set<String>	getSupportedApplications() A list of supported applications
Result	performImport(Configuration configuration) Will perform the import based on the given configuration into Crowd.
Set<Directory>	retrieveRemoteSourceDirectories(Configuration configuration) The retrieve the set of remote source directories.
void	setImporterFactory(ImporterFactory importerFactory)
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

Methods inherited from class java.lang.Object

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

Constructor Detail

ImporterManagerImpl

public ImporterManagerImpl()

Method Detail

performImport

public Result performImport(Configuration configuration)
                     throws ImporterException

Description copied from interface: ImporterManager

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

Specified by:

performImport in interface ImporterManager

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

public boolean supportsMultipleDirectories(Configuration configuration)
                                    throws ImporterException

Description copied from interface: ImporterManager

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

Specified by:

supportsMultipleDirectories in interface ImporterManager

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

public Set<Directory> retrieveRemoteSourceDirectories(Configuration configuration)
                                               throws ImporterException

Description copied from interface: ImporterManager

The retrieve the set of remote source directories.

Specified by:

retrieveRemoteSourceDirectories in interface ImporterManager

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

public void testConfiguration(Configuration configuration)
                       throws ImporterConfigurationException

Description copied from interface: ImporterManager

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

Specified by:

testConfiguration in interface ImporterManager

Parameters:

configuration - the configuration to use with the importer

Throws:

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

getSupportedApplications

public Set<String> getSupportedApplications()

Description copied from interface: ImporterManager

A list of supported applications

Specified by:

getSupportedApplications in interface ImporterManager

Returns:

Set's representing each application

getAtlassianSupportedApplications

public Set<String> getAtlassianSupportedApplications()

Description copied from interface: ImporterManager

A list of Atlassian supported applications

Specified by:

getAtlassianSupportedApplications in interface ImporterManager

Returns:

Set's representing each application

setImporterFactory

public void setImporterFactory(ImporterFactory importerFactory)