com.atlassian.confluence.user.migration

Class OSUserRepositoryConfigurationMigrator

java.lang.Object

com.atlassian.confluence.user.migration.OSUserRepositoryConfigurationMigrator

All Implemented Interfaces:

RepositoryConfigurationMigrator

public class OSUserRepositoryConfigurationMigrator
extends Object
implements RepositoryConfigurationMigrator

Constructor Summary

Constructors

Constructor and Description
OSUserRepositoryConfigurationMigrator()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	matches(com.atlassian.user.configuration.RepositoryConfiguration repositoryConfiguration) Return true if this migrator is able to migrate the configuration supplied by the passed in configuration.
void	migrate(com.atlassian.user.configuration.RepositoryConfiguration repositoryConfiguration) Migrate the passed in configuration.
List<String>	validate(com.atlassian.user.configuration.RepositoryConfiguration repositoryConfiguration) Validates that the passed in configuration can be migrated.

Methods inherited from class java.lang.Object

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

Constructor Detail

OSUserRepositoryConfigurationMigrator

public OSUserRepositoryConfigurationMigrator()

Method Detail

validate

public List<String> validate(com.atlassian.user.configuration.RepositoryConfiguration repositoryConfiguration)
                      throws AtlassianUserMigrationException

Description copied from interface: RepositoryConfigurationMigrator

Validates that the passed in configuration can be migrated.

Specified by:

validate in interface RepositoryConfigurationMigrator

Parameters:

repositoryConfiguration - the configuration to validate

Returns:

A list of all the validation errors detected in the given repository configuration

Throws:

AtlassianUserMigrationException - if the repository configuration is unable to be upgraded due to being incomplete or malformed

migrate

public void migrate(com.atlassian.user.configuration.RepositoryConfiguration repositoryConfiguration)
             throws AtlassianUserMigrationException

Description copied from interface: RepositoryConfigurationMigrator

Migrate the passed in configuration. In most cases this will result in a new directory being created by calling CrowdDirectoryService.addDirectory(com.atlassian.crowd.embedded.api.Directory).

Specified by:

migrate in interface RepositoryConfigurationMigrator

Parameters:

repositoryConfiguration - the configuration to migrate

Throws:

AtlassianUserMigrationException - if the repository configuration is unable to be upgraded due to being incomplete or malformed

matches

public boolean matches(com.atlassian.user.configuration.RepositoryConfiguration repositoryConfiguration)

Description copied from interface: RepositoryConfigurationMigrator

Return true if this migrator is able to migrate the configuration supplied by the passed in configuration.

Specified by:

matches in interface RepositoryConfigurationMigrator

Parameters:

repositoryConfiguration - the configuration to migrate

Returns:

true if this migrator can migrate the configuration