com.atlassian.crowd.importer.importers

Class ConfluenceImporter

java.lang.Object

com.atlassian.crowd.importer.importers.ConditionalImporter

com.atlassian.crowd.importer.importers.ConfluenceImporter

All Implemented Interfaces:

Importer

public class ConfluenceImporter
extends ConditionalImporter

This class handles the delegation of the import of Confluence Groups, Users and their memberships into Crowd.

Field Summary

Fields

Modifier and Type	Field and Description
protected DirectoryManager	directoryManager
protected org.springframework.jdbc.core.JdbcOperations	jdbcTemplate

Constructor Summary

Constructors

Constructor and Description
ConfluenceImporter(DirectoryManager directoryManager)

Method Summary

Modifier and Type	Method and Description
Class	getConfigurationType() The type of configuration being used for this Import.
protected Importer	getCrowdifiedImporter()
protected Importer	getFallbackImporter()
Result	importUsersGroupsAndMemberships(Configuration configuration) This method will handle the importing of Users, Groups and Memberships from Confluence.
void	init(Configuration configuration) Initialise anything required for the import process.
Set<Directory>	retrieveRemoteSourceDirectory(Configuration configuration) The retrieve the set of remote source directories.
void	setJdbcTemplate(JdbcConfiguration configuration)
boolean	supportsMultipleDirectories(Configuration configuration) Some sources might be capable of handling more than one directory.

Methods inherited from class java.lang.Object

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

Field Detail

jdbcTemplate

protected org.springframework.jdbc.core.JdbcOperations jdbcTemplate

directoryManager

protected DirectoryManager directoryManager

Constructor Detail

ConfluenceImporter

public ConfluenceImporter(DirectoryManager directoryManager)

Method Detail

getCrowdifiedImporter

protected Importer getCrowdifiedImporter()

Specified by:

getCrowdifiedImporter in class ConditionalImporter

getFallbackImporter

protected Importer getFallbackImporter()

Specified by:

getFallbackImporter in class ConditionalImporter

init

public void init(Configuration configuration)

Description copied from interface: Importer

Initialise anything required for the import process.

Specified by:

init in interface Importer

Parameters:

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

getConfigurationType

public Class getConfigurationType()

Description copied from interface: Importer

The type of configuration being used for this Import.

Specified by:

getConfigurationType in interface Importer

Returns:

Class that should be a subclass of Configuration

setJdbcTemplate

public void setJdbcTemplate(JdbcConfiguration configuration)

importUsersGroupsAndMemberships

public Result importUsersGroupsAndMemberships(Configuration configuration)
                                       throws ImporterException

This method will handle the importing of Users, Groups and Memberships from Confluence.

Specified by:

importUsersGroupsAndMemberships in interface Importer

Parameters:

configuration - the configuration required for the import

Returns:

success or failure for the import.

Throws:

ImporterException - general exception if anything happened during the import

supportsMultipleDirectories

public boolean supportsMultipleDirectories(Configuration configuration)
                                    throws ImporterException

Description copied from interface: Importer

Some sources might be capable of handling more than one directory.

Specified by:

supportsMultipleDirectories in interface Importer

Parameters:

configuration - the Importer Configuration

Returns:

true if the source can have multiple directories.

Throws:

ImporterException - if there is an error figuring out source directories.

retrieveRemoteSourceDirectory

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

Description copied from interface: Importer

The retrieve the set of remote source directories.

Specified by:

retrieveRemoteSourceDirectory in interface Importer

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.