Package org.forgerock.http.routing

Enum DefaultVersionBehaviour

java.lang.Object

java.lang.Enum<DefaultVersionBehaviour>

org.forgerock.http.routing.DefaultVersionBehaviour

All Implemented Interfaces:

Serializable, Comparable<DefaultVersionBehaviour>

public enum DefaultVersionBehaviour
extends Enum<DefaultVersionBehaviour>

The default routing behaviour to use when no Accept-API-Version is set on the request.

Enum Constant Summary

Enum Constants

Enum Constant	Description
LATEST	Will route to the latest version of the resource.
NONE	Will not attempt to route to any version of the resource, instead will return an error to the client.
OLDEST	Will route to the oldest version of the resource.

Method Summary

Modifier and Type	Method	Description
static DefaultVersionBehaviour	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DefaultVersionBehaviour[]	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

LATEST

public static final DefaultVersionBehaviour LATEST

Will route to the latest version of the resource.

OLDEST

public static final DefaultVersionBehaviour OLDEST

Will route to the oldest version of the resource.

NONE

public static final DefaultVersionBehaviour NONE

Will not attempt to route to any version of the resource, instead will return an error to the client.

Method Detail

values

public static DefaultVersionBehaviour[] 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 (DefaultVersionBehaviour c : DefaultVersionBehaviour.values())
    System.out.println(c);

Returns:

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

valueOf

public static DefaultVersionBehaviour 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