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

Enum ReplicationServerCfgDefn.ChangelogEnabled

java.lang.Object

java.lang.Enum<ReplicationServerCfgDefn.ChangelogEnabled>

org.forgerock.opendj.server.config.meta.ReplicationServerCfgDefn.ChangelogEnabled

All Implemented Interfaces:

Serializable, Comparable<ReplicationServerCfgDefn.ChangelogEnabled>

Enclosing class:

ReplicationServerCfgDefn

public static enum ReplicationServerCfgDefn.ChangelogEnabled
extends Enum<ReplicationServerCfgDefn.ChangelogEnabled>

Defines the set of permissible values for the "changelog-enabled" property.

Specifies whether the "cn=changelog" backend will be available to client applications.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISABLED	The "cn=changelog" backend will not be available to client applications.
ENABLED	The "cn=changelog" backend will be available to client applications.
ENABLED_COOKIE_MODE_ONLY	The "cn=changelog" backend will be available to client applications.

Method Summary

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

DISABLED

public static final ReplicationServerCfgDefn.ChangelogEnabled DISABLED

The "cn=changelog" backend will not be available to client applications.

ENABLED

public static final ReplicationServerCfgDefn.ChangelogEnabled ENABLED

The "cn=changelog" backend will be available to client applications. It will support searches using changelog cookies and "change numbers" as per the internet draft, https://datatracker.ietf.org/doc/html/draft-good-ldap-changelog-04. Change numbers are globally consistent across all servers. This mode requires additional CPU, disk accesses and storage, so it should not be used unless change number based browsing is required.

ENABLED_COOKIE_MODE_ONLY

public static final ReplicationServerCfgDefn.ChangelogEnabled ENABLED_COOKIE_MODE_ONLY

The "cn=changelog" backend will be available to client applications. However, it will only support searches using changelog cookies. Changes are published immediately, and in an order which may vary from one server to another. This mode does not require additional server resources.

Method Detail

values

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

Returns:

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

valueOf

public static ReplicationServerCfgDefn.ChangelogEnabled 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<ReplicationServerCfgDefn.ChangelogEnabled>