com.unboundid.ldap.sdk.unboundidds.logs

Enum AccessLogMessageType

java.lang.Object

java.lang.Enum<AccessLogMessageType>

com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessageType

All Implemented Interfaces:

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

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

This enum defines the set of access log message 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
ASSURANCE_COMPLETE The message type that will be used for messages about the result of replication assurance processing.
CLIENT_CERTIFICATE The message type that will be used for messages about connections established to the Directory Server.
CONNECT The message type that will be used for messages about connections established to the Directory Server.
DISCONNECT The message type that will be used for messages about connections disconnected from the Directory Server.
ENTRY The message type that will be used for messages about search result entries returned by the Directory Server.
ENTRY_REBALANCING_REQUEST The message type that will be used for messages that provide information about the beginning of an entry-rebalancing operation.
ENTRY_REBALANCING_RESULT The message type that will be used for messages that provide information about the result of an entry-rebalancing operation.
FORWARD The message type that will be used for messages about operations forwarded to another server.
FORWARD_FAILED The message type that will be used for messages about failed attempts to forward a request to another server.
INTERMEDIATE_RESPONSE The message type that will be used for intermediate response messages.
REFERENCE The message type that will be used for messages about search result references returned by the Directory Server.
REQUEST The message type that will be used for messages about operation requests received from the Directory Server.
RESULT The message type that will be used for messages about operation results, which may include responses sent to clients or results for operations with no response.
SECURITY_NEGOTIATION The message type that will be used for messages about the processing performed to negotiate a secure form of communication between the client and the server.

Method Summary

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

ASSURANCE_COMPLETE

public static final AccessLogMessageType ASSURANCE_COMPLETE

The message type that will be used for messages about the result of replication assurance processing.

CLIENT_CERTIFICATE

public static final AccessLogMessageType CLIENT_CERTIFICATE

The message type that will be used for messages about connections established to the Directory Server.

CONNECT

public static final AccessLogMessageType CONNECT

The message type that will be used for messages about connections established to the Directory Server.

DISCONNECT

public static final AccessLogMessageType DISCONNECT

The message type that will be used for messages about connections disconnected from the Directory Server.

ENTRY

public static final AccessLogMessageType ENTRY

The message type that will be used for messages about search result entries returned by the Directory Server.

ENTRY_REBALANCING_REQUEST

public static final AccessLogMessageType ENTRY_REBALANCING_REQUEST

The message type that will be used for messages that provide information about the beginning of an entry-rebalancing operation.

ENTRY_REBALANCING_RESULT

public static final AccessLogMessageType ENTRY_REBALANCING_RESULT

The message type that will be used for messages that provide information about the result of an entry-rebalancing operation.

FORWARD

public static final AccessLogMessageType FORWARD

The message type that will be used for messages about operations forwarded to another server.

FORWARD_FAILED

public static final AccessLogMessageType FORWARD_FAILED

The message type that will be used for messages about failed attempts to forward a request to another server.

INTERMEDIATE_RESPONSE

public static final AccessLogMessageType INTERMEDIATE_RESPONSE

The message type that will be used for intermediate response messages.

REFERENCE

public static final AccessLogMessageType REFERENCE

The message type that will be used for messages about search result references returned by the Directory Server.

REQUEST

public static final AccessLogMessageType REQUEST

The message type that will be used for messages about operation requests received from the Directory Server.

RESULT

public static final AccessLogMessageType RESULT

The message type that will be used for messages about operation results, which may include responses sent to clients or results for operations with no response.

SECURITY_NEGOTIATION

public static final AccessLogMessageType SECURITY_NEGOTIATION

The message type that will be used for messages about the processing performed to negotiate a secure form of communication between the client and the server.

Method Detail

values

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

Returns:

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

valueOf

public static AccessLogMessageType 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 message type in log files.

Returns:

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

forName

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

Retrieves the access log message type with the provided identifier.

Parameters:

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

Returns:

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