com.atlassian.crowd.upgrade.tasks

Class UpgradeTask622ExternalId

java.lang.Object

com.atlassian.crowd.upgrade.tasks.UpgradeTask622ExternalId

All Implemented Interfaces:

UpgradeTask

public class UpgradeTask622ExternalId
extends Object
implements UpgradeTask

Updates LDAP and delegating directories configuration by adding the User Unique Id attribute if absent. Default value is a function of the directory type (example: entryUUID for OpenLDAP). Updating configuration allows to track user renames from LDAP servers (after full sync).

Since:

2.7

Constructor Summary

Constructors

Constructor and Description
UpgradeTask622ExternalId(DirectoryDao directoryDao, LDAPPropertiesHelper ldapPropertiesHelper)

Method Summary

Modifier and Type	Method and Description
void	doUpgrade() Perform the upgrade.
int	getBuildNumber()
Collection<String>	getErrors() Any errors that occur during the upgrade process will be added to this Collection as Strings.
String	getShortDescription() A short (less than 50 chars) description of the upgrade action

Methods inherited from class java.lang.Object

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

Constructor Detail

UpgradeTask622ExternalId

public UpgradeTask622ExternalId(DirectoryDao directoryDao,
                                LDAPPropertiesHelper ldapPropertiesHelper)

Method Detail

getBuildNumber

public int getBuildNumber()

Specified by:

getBuildNumber in interface UpgradeTask

Returns:

The build number that this upgrade is applicable to.

getShortDescription

public String getShortDescription()

Description copied from interface: UpgradeTask

A short (less than 50 chars) description of the upgrade action

Specified by:

getShortDescription in interface UpgradeTask

Returns:

description of upgrade task.

doUpgrade

public void doUpgrade()
               throws Exception

Description copied from interface: UpgradeTask

Perform the upgrade.

Specified by:

doUpgrade in interface UpgradeTask

Throws:

Exception - is thrown if any errors occur during the upgrade process.

getErrors

public Collection<String> getErrors()

Description copied from interface: UpgradeTask

Any errors that occur during the upgrade process will be added to this Collection as Strings.

Specified by:

getErrors in interface UpgradeTask

Returns:

a Collection<String> of errors. This may return an empty Collection.