com.unboundid.ldap.sdk.unboundidds.logs

Enum AccessLogOperationType

java.lang.Object

java.lang.Enum<AccessLogOperationType>

com.unboundid.ldap.sdk.unboundidds.logs.AccessLogOperationType

All Implemented Interfaces:

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

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

This enum defines the set of access log operation types.

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
ABANDON The operation type that will be used for messages about abandon operations.
ADD The operation type that will be used for messages about add operations.
BIND The operation type that will be used for messages about bind operations.
COMPARE The operation type that will be used for messages about compare operations.
DELETE The operation type that will be used for messages about delete operations.
EXTENDED The operation type that will be used for messages about extended operations.
MODDN The operation type that will be used for messages about modify DN operations.
MODIFY The operation type that will be used for messages about modify operations.
SEARCH The operation type that will be used for messages about search operations.
UNBIND The operation type that will be used for messages about unbind operations.

Method Summary

Modifier and Type	Method and Description
static AccessLogOperationType	forName(java.lang.String logIdentifier) Retrieves the access log operation type with the provided identifier.
java.lang.String	getLogIdentifier() Retrieves the string that will be used to identify this operation type in log files.
static AccessLogOperationType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AccessLogOperationType[]	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

ABANDON

public static final AccessLogOperationType ABANDON

The operation type that will be used for messages about abandon operations.

ADD

public static final AccessLogOperationType ADD

The operation type that will be used for messages about add operations.

BIND

public static final AccessLogOperationType BIND

The operation type that will be used for messages about bind operations.

COMPARE

public static final AccessLogOperationType COMPARE

The operation type that will be used for messages about compare operations.

DELETE

public static final AccessLogOperationType DELETE

The operation type that will be used for messages about delete operations.

EXTENDED

public static final AccessLogOperationType EXTENDED

The operation type that will be used for messages about extended operations.

MODIFY

public static final AccessLogOperationType MODIFY

The operation type that will be used for messages about modify operations.

MODDN

public static final AccessLogOperationType MODDN

The operation type that will be used for messages about modify DN operations.

SEARCH

public static final AccessLogOperationType SEARCH

The operation type that will be used for messages about search operations.

UNBIND

public static final AccessLogOperationType UNBIND

The operation type that will be used for messages about unbind operations.

Method Detail

values

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

Returns:

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

valueOf

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

getLogIdentifier

@NotNull
public java.lang.String getLogIdentifier()

Retrieves the string that will be used to identify this operation type in log files.

Returns:

The string that will be used to identify this operation type in log files.

forName

@Nullable
public static AccessLogOperationType forName(@NotNull
                                                       java.lang.String logIdentifier)

Retrieves the access log operation type with the provided identifier.

Parameters:

logIdentifier - The identifier string for which to retrieve the corresponding access log operation type.

Returns:

The appropriate operation type, or null if there is no operation type associated with the provided identifier.