Package org.forgerock.openam.federation.plugin.rooturl

Enum RootUrlManager

java.lang.Object

java.lang.Enum<RootUrlManager>

org.forgerock.openam.federation.plugin.rooturl.RootUrlManager

All Implemented Interfaces:

Serializable, Comparable<RootUrlManager>

@SupportedAll
public enum RootUrlManager
extends Enum<RootUrlManager>

Singleton class used to manage Root URL providers.

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE	The root url manager instance.

Method Summary

Modifier and Type	Method	Description
RootUrlProvider	getDefaultProvider()	Gets the default root url provider.
static RootUrlManager	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RootUrlManager[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final RootUrlManager INSTANCE

The root url manager instance.

Method Detail

values

public static RootUrlManager[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RootUrlManager c : RootUrlManager.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RootUrlManager valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getDefaultProvider

public RootUrlProvider getDefaultProvider()
                                   throws RootUrlProviderException

Gets the default root url provider.

Returns:

the default provider.

Throws:

RootUrlProviderException - when the default provider is null.