Package org.forgerock.opendj.server.config.meta

Enum FileBasedAccessLogPublisherCfgDefn.LogFormat

java.lang.Object

java.lang.Enum<FileBasedAccessLogPublisherCfgDefn.LogFormat>

org.forgerock.opendj.server.config.meta.FileBasedAccessLogPublisherCfgDefn.LogFormat

All Implemented Interfaces:

Serializable, Comparable<FileBasedAccessLogPublisherCfgDefn.LogFormat>

Enclosing class:

FileBasedAccessLogPublisherCfgDefn

public static enum FileBasedAccessLogPublisherCfgDefn.LogFormat
extends Enum<FileBasedAccessLogPublisherCfgDefn.LogFormat>

Defines the set of permissable values for the "log-format" property.

Specifies how log records should be formatted and written to the access log.

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMBINED	Combine log records for operation requests and responses into a single record.
MULTI_LINE	Outputs separate log records for operation requests and responses.

Method Summary

Modifier and Type	Method	Description
String	toString()
static FileBasedAccessLogPublisherCfgDefn.LogFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FileBasedAccessLogPublisherCfgDefn.LogFormat[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COMBINED

public static final FileBasedAccessLogPublisherCfgDefn.LogFormat COMBINED

Combine log records for operation requests and responses into a single record. This format should be used when log records are to be filtered based on response criteria (e.g. result code).

MULTI_LINE

public static final FileBasedAccessLogPublisherCfgDefn.LogFormat MULTI_LINE

Outputs separate log records for operation requests and responses.

Method Detail

values

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

Returns:

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

valueOf

public static FileBasedAccessLogPublisherCfgDefn.LogFormat valueOf(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:

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

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<FileBasedAccessLogPublisherCfgDefn.LogFormat>