com.atlassian.confluence.user.migration
Interface RepositoryConfigurationMigrator

All Known Implementing Classes:

CrowdRepositoryConfigurationMigrator, HibernateRepositoryConfigurationMigrator, LdapRepositoryConfigurationMigrator, OSUserRepositoryConfigurationMigrator

public interface RepositoryConfigurationMigrator

Interface to logic that can create an embedded crowd directory from an Atlassian User repository configuration.

Method Summary

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.

Method Detail

validate

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

Validates that the passed in configuration can be migrated.

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

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

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).

Parameters:

repositoryConfiguration - the configuration to migrate

Throws:

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

matches

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.

Parameters:

repositoryConfiguration - the configuration to migrate

Returns:

true if this migrator can migrate the configuration