com.unboundid.ldap.sdk.unboundidds.controls

Enum RouteToBackendSetRoutingType

java.lang.Object

java.lang.Enum<RouteToBackendSetRoutingType>

com.unboundid.ldap.sdk.unboundidds.controls.RouteToBackendSetRoutingType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RouteToBackendSetRoutingType>

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum RouteToBackendSetRoutingType
extends java.lang.Enum<RouteToBackendSetRoutingType>

This enum defines the set of routing types that may be used in a route to backend set request control.

NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABSOLUTE_ROUTING The routing type that is used for a control which specifies the absolute collection of backend sets to which the request should be forwarded.
ROUTING_HINT The routing type that is used for a control which specifies a routing hint to use as a first guess for processing the request and an optional collection of fallback sets.

Method Summary

Modifier and Type	Method and Description
static RouteToBackendSetRoutingType	forName(java.lang.String name) Retrieves the route to backend set routing type with the specified name.
byte	getBERType() Retrieves the BER type for this routing type value.
static RouteToBackendSetRoutingType	valueOf(byte berType) Retrieves the routing type value for the provided BER type.
static RouteToBackendSetRoutingType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RouteToBackendSetRoutingType[]	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

ABSOLUTE_ROUTING

public static final RouteToBackendSetRoutingType ABSOLUTE_ROUTING

The routing type that is used for a control which specifies the absolute collection of backend sets to which the request should be forwarded.

ROUTING_HINT

public static final RouteToBackendSetRoutingType ROUTING_HINT

The routing type that is used for a control which specifies a routing hint to use as a first guess for processing the request and an optional collection of fallback sets.

Method Detail

values

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

Returns:

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

valueOf

public static RouteToBackendSetRoutingType valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getBERType

public byte getBERType()

Retrieves the BER type for this routing type value.

Returns:

The BER type for this routing type value.

valueOf

@Nullable
public static RouteToBackendSetRoutingType valueOf(byte berType)

Retrieves the routing type value for the provided BER type.

Parameters:

berType - The BER type for the routing type value to retrieve.

Returns:

The routing type value that corresponds to the provided BER type, or null if there is no corresponding routing type value.

forName

@Nullable
public static RouteToBackendSetRoutingType forName(@NotNull
                                                             java.lang.String name)

Retrieves the route to backend set routing type with the specified name.

Parameters:

name - The name of the route to backend set routing type to retrieve. It must not be null.

Returns:

The requested route to backend set routing type, or null if no such type is defined.