Enum GetConfigurationType
- java.lang.Object
-
- java.lang.Enum<GetConfigurationType>
-
- com.unboundid.ldap.sdk.unboundidds.extensions.GetConfigurationType
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<GetConfigurationType>
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum GetConfigurationType extends java.lang.Enum<GetConfigurationType>
This enum defines the types of configurations that may be obtained using the get configuration extended operation.
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 Description ACTIVE
The type used to specify the current active configuration.ARCHIVED
The type used to specify an archived configuration that was previously in effect.BASELINE
The type used to specify the baseline configuration for the current server version.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GetConfigurationType
forBERType(byte berType)
Retrieves the get configuration type value that has the specified BER type.static GetConfigurationType
forIntValue(int intValue)
Retrieves the get configuration type value that has the specified integer value.static GetConfigurationType
forName(java.lang.String name)
Retrieves the get configuration type value with the specified name.byte
getBERType()
Retrieves the BER type that should be used when this configuration type needs to be encoded in a get configuration request.int
getIntValue()
Retrieves the integer value that should be used when this configuration type needs to be encoded as an enumerated element in a get configuration result.static GetConfigurationType
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static GetConfigurationType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ACTIVE
public static final GetConfigurationType ACTIVE
The type used to specify the current active configuration.
-
BASELINE
public static final GetConfigurationType BASELINE
The type used to specify the baseline configuration for the current server version.
-
ARCHIVED
public static final GetConfigurationType ARCHIVED
The type used to specify an archived configuration that was previously in effect.
-
-
Method Detail
-
values
public static GetConfigurationType[] 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 (GetConfigurationType c : GetConfigurationType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static GetConfigurationType 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 namejava.lang.NullPointerException
- if the argument is null
-
getBERType
public byte getBERType()
Retrieves the BER type that should be used when this configuration type needs to be encoded in a get configuration request.- Returns:
- The BER type that should be used when this configuration type needs to be encoded in a get configuration request.
-
getIntValue
public int getIntValue()
Retrieves the integer value that should be used when this configuration type needs to be encoded as an enumerated element in a get configuration result.- Returns:
- The integer value that should be used when this configuration type needs to be encoded as an enumerated element in a get configuration result.
-
forBERType
@Nullable public static GetConfigurationType forBERType(byte berType)
Retrieves the get configuration type value that has the specified BER type.- Parameters:
berType
- The BER type for the get configuration type value to retrieve.- Returns:
- The get configuration type value for the specified BER type, or
null
if there is no enum value with the specified BER type.
-
forIntValue
@Nullable public static GetConfigurationType forIntValue(int intValue)
Retrieves the get configuration type value that has the specified integer value.- Parameters:
intValue
- The integer value for the get configuration type value to retrieve.- Returns:
- The get configuration type value for the specified integer value,
or
null
if there is no enum value with the specified integer value.
-
forName
@Nullable public static GetConfigurationType forName(@NotNull java.lang.String name)
Retrieves the get configuration type value with the specified name.- Parameters:
name
- The name of the get configuration type value to retrieve. It must not benull
.- Returns:
- The requested get configuration type value, or
null
if no such value is defined.
-
-