Package org.forgerock.openam.upgrade.steps

Class UpgradeOAuth2ProviderStep

java.lang.Object

org.forgerock.openam.upgrade.steps.AbstractUpgradeStep

org.forgerock.openam.upgrade.steps.UpgradeOAuth2ProviderStep

All Implemented Interfaces:

UpgradeStep

public class UpgradeOAuth2ProviderStep
extends AbstractUpgradeStep

This upgrade step will find all the OAuth2 Providers that was created with a subset of the available attributes. It will then add the missing attributes with their default values and persist the provider's attributes. This needs to be done before changes can be made to the OAuth2 Provider Schema to ensure that the existing providers does not automatically inherit the changes made to the schema.

Since:

12.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static Map<String,String>	ALGORITHM_NAMES
static Set<String>	DEFAULT_CLAIMS

Fields inherited from class org.forgerock.openam.upgrade.steps.AbstractUpgradeStep

BULLET, BUNDLE, DEBUG, INDENT

Constructor Summary

Constructors

Constructor	Description
UpgradeOAuth2ProviderStep(PrivilegedAction<SSOToken> adminTokenAction, ConnectionFactory factory)

Method Summary

Modifier and Type	Method	Description
String	getDetailedReport(String delimiter)	Generates a detailed upgrade report suitable for reviewing changes.
String	getShortReport(String delimiter)	Returns a short report for this upgrade step that should be suitable for the upgrade screen.
void	initialize()	Initializes the upgrade step during which it determines what sort of changes needs to be applied to the configurationif any.
boolean	isApplicable()	Tells whether this given upgrade step is applicable for this version/configuration of OpenAM.
void	perform()	Performs the required changes for this upgrade step.

Methods inherited from class org.forgerock.openam.upgrade.steps.AbstractUpgradeStep

getAdminSubject, getAdminToken, getConnection, getRealmNames

Methods inherited from class java.lang.Object

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

Field Detail

ALGORITHM_NAMES

public static final Map<String,String> ALGORITHM_NAMES

DEFAULT_CLAIMS

public static final Set<String> DEFAULT_CLAIMS

Constructor Detail

UpgradeOAuth2ProviderStep

@Inject
public UpgradeOAuth2ProviderStep(PrivilegedAction<SSOToken> adminTokenAction,
                                 ConnectionFactory factory)

Method Detail

isApplicable

public boolean isApplicable()

Description copied from interface: UpgradeStep

Tells whether this given upgrade step is applicable for this version/configuration of OpenAM.

Returns:

true if this upgrade step needs to be performed.

initialize

public void initialize()
                throws UpgradeException

Description copied from interface: UpgradeStep

Initializes the upgrade step during which it determines what sort of changes needs to be applied to the configurationif any.

Throws:

UpgradeException - If there was an error while determining the required changes.

perform

public void perform()
             throws UpgradeException

Description copied from interface: UpgradeStep

Performs the required changes for this upgrade step.

Throws:

UpgradeException - If there was an error while upgrading the configuration.

getShortReport

public String getShortReport(String delimiter)

Description copied from interface: UpgradeStep

Returns a short report for this upgrade step that should be suitable for the upgrade screen.

Parameters:

delimiter - The delimiter to use between lines.

Returns:

The short upgrade report.

getDetailedReport

public String getDetailedReport(String delimiter)

Description copied from interface: UpgradeStep

Generates a detailed upgrade report suitable for reviewing changes.

Parameters:

delimiter - The delimiter to use between lines.

Returns:

The detailed upgrade report.