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

java.lang.Object
  extended by java.lang.Enum<RouteToBackendSetRoutingType>
      extended by 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>

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This enum defines the set of routing types that may be used in a route to backend set request control.


Enum Constant Summary
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
 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

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.