Package org.opends.server.util

Class ServerConstants

java.lang.Object
org.opends.server.util.ServerConstants
public final class ServerConstants extends Object
This class defines a set of constants that may be referenced throughout the Directory Server source.

  • Field Details

    • EOL

      public static final String EOL
      The end-of-line character for this platform.

    • DATE_FORMAT_COMPACT_LOCAL_TIME

      public static final String DATE_FORMAT_COMPACT_LOCAL_TIME
      The date format string that will be used to construct and parse dates represented in a form like UTC time, but using the local time zone.
      See Also:

    • DATE_FORMATTER_COMPACT_LOCAL_TIME

      public static final DateTimeFormatter DATE_FORMATTER_COMPACT_LOCAL_TIME
      Date time formatter with a precision of milliseconds.

    • DATE_FORMAT_GENERALIZED_TIME

      public static final String DATE_FORMAT_GENERALIZED_TIME
      The date format string that will be used to construct and parse dates represented using generalized time. It is assumed that the provided date formatter will be set to UTC.
      See Also:

    • DATE_FORMATTER_GENERALIZED_TIME

      public static final DateTimeFormatter DATE_FORMATTER_GENERALIZED_TIME
      Date time formatter with a precision of milliseconds.

    • DATE_FORMAT_GMT_TIME

      public static final String DATE_FORMAT_GMT_TIME
      The date format string that will be used to construct and parse dates represented using generalized time with a four-digit year. It is assumed that the provided date formatter will be set to UTC.
      See Also:

    • DATE_FORMATTER_GMT_TIME

      public static final DateTimeFormatter DATE_FORMATTER_GMT_TIME
      Date time formatter with a precision of milliseconds.

    • TIME_ZONE_UTC

      public static final String TIME_ZONE_UTC
      The name of the time zone for universal coordinated time (UTC).
      See Also:

    • ATTR_COMMON_NAME

      public static final String ATTR_COMMON_NAME
      The name of the standard attribute that is used to hold common names, formatted in all lowercase.
      See Also:

    • ATTR_MEMBER_URL_LC

      public static final String ATTR_MEMBER_URL_LC
      The name of the standard "memberURL" attribute type, formatted in all lowercase characters.
      See Also:

    • ATTR_SUBTREE_SPEC_LC

      public static final String ATTR_SUBTREE_SPEC_LC
      The name of the standard "subtreeSpecification" attribute type, formatted in all lowercase characters.
      See Also:

    • ATTR_COLLECTIVE_EXCLUSIONS_LC

      public static final String ATTR_COLLECTIVE_EXCLUSIONS_LC
      The name of the standard "collectiveExclusions" attribute type, formatted in all lowercase characters.
      See Also:

    • VALUE_COLLECTIVE_EXCLUSIONS_EXCLUDE_ALL_LC

      public static final String VALUE_COLLECTIVE_EXCLUSIONS_EXCLUDE_ALL_LC
      The value of the standard "excludeAllCollectiveAttributes" attribute value of the standard "collectiveExclusions" attribute type, formatted in all lowercase characters.
      See Also:

    • OID_COLLECTIVE_EXCLUSIONS_EXCLUDE_ALL

      public static final String OID_COLLECTIVE_EXCLUSIONS_EXCLUDE_ALL
      The OID of the standard "excludeAllCollectiveAttributes" attribute value of the standard "collectiveExclusions" attribute type.
      See Also:

    • ATTR_NAMING_CONTEXTS

      public static final String ATTR_NAMING_CONTEXTS
      The name of the standard attribute that is used to specify the set of public naming contexts (suffixes) for the Directory Server, formatted in camel case.
      See Also:

    • ATTR_PRIVATE_NAMING_CONTEXTS

      public static final String ATTR_PRIVATE_NAMING_CONTEXTS
      The name of the attribute used to hold the DNs that constitute the set of "private" naming contexts registered with the server.
      See Also:

    • ATTR_REFERRAL_URL

      public static final String ATTR_REFERRAL_URL
      The name of the standard attribute that is used to specify the set of referral URLs in a smart referral entry, formatted in all lowercase.
      See Also:

    • ATTR_SN

      public static final String ATTR_SN
      The name of the standard attribute that is used to hold surnames, formatted in all lowercase.
      See Also:

    • ATTR_SUBSCHEMA_SUBENTRY

      public static final String ATTR_SUBSCHEMA_SUBENTRY
      The name of the standard attribute that is used to specify the location for the Directory Server schema, formatted in camel case.
      See Also:

    • ATTR_SUBSCHEMA_SUBENTRY_LC

      public static final String ATTR_SUBSCHEMA_SUBENTRY_LC
      The name of the standard attribute that is used to specify the location for the Directory Server schema, formatted in all lowercase.
      See Also:

    • ATTR_SUPPORTED_AUTH_PW_SCHEMES

      public static final String ATTR_SUPPORTED_AUTH_PW_SCHEMES
      The name of the standard attribute that is used to specify the names of the authentication password schemes supported by the server, formatted in camel case.
      See Also:

    • ATTR_SUPPORTED_CONTROL

      public static final String ATTR_SUPPORTED_CONTROL
      The name of the standard attribute that is used to specify the OIDs of the controls supported by the server, formatted in camel case.
      See Also:

    • ATTR_SUPPORTED_EXTENSION

      public static final String ATTR_SUPPORTED_EXTENSION
      The name of the standard attribute that is used to specify the OIDs of the extended operations supported by the server, formatted in camel case.
      See Also:

    • ATTR_SUPPORTED_FEATURE

      public static final String ATTR_SUPPORTED_FEATURE
      The name of the standard attribute that is used to specify the OIDs of the features supported by the server, formatted in camel case.
      See Also:

    • ATTR_SUPPORTED_LDAP_VERSION

      public static final String ATTR_SUPPORTED_LDAP_VERSION
      The name of the standard attribute that is used to specify the names of the LDAP protocol versions supported by the server, formatted in camel case.
      See Also:

    • ATTR_SUPPORTED_SASL_MECHANISMS

      public static final String ATTR_SUPPORTED_SASL_MECHANISMS
      The name of the standard attribute that is used to specify the names of the SASL mechanisms supported by the server, formatted in camel case.
      See Also:

    • ATTR_SUPPORTED_TLS_PROTOCOLS

      public static final String ATTR_SUPPORTED_TLS_PROTOCOLS
      The name of the standard attribute that is used to specify the versions of the TLS protocol supported by the server, formatted in camel case.
      See Also:

    • ATTR_SUPPORTED_TLS_CIPHERS

      public static final String ATTR_SUPPORTED_TLS_CIPHERS
      The name of the standard attribute that is used to specify the TLS ciphers supported by the server, formatted in camel case.
      See Also:

    • ATTR_TARGET_GROUP_DN

      public static final String ATTR_TARGET_GROUP_DN
      The name of the attribute that is used to specify the DN of the target group for a virtual static group.
      See Also:

    • ATTR_TASK_DISCONNECT_CONN_ID

      public static final String ATTR_TASK_DISCONNECT_CONN_ID
      The name of the attribute that is used to specify the connection ID of the connection to disconnect.
      See Also:

    • ATTR_TASK_DISCONNECT_MESSAGE

      public static final String ATTR_TASK_DISCONNECT_MESSAGE
      The name of the attribute that is used to specify the disconnect message.
      See Also:

    • ATTR_TASK_DISCONNECT_NOTIFY_CLIENT

      public static final String ATTR_TASK_DISCONNECT_NOTIFY_CLIENT
      The name of the attribute that is used to indicate whether to notify the connection it is about to be terminated.
      See Also:

    • ATTR_VENDOR_VERSION

      public static final String ATTR_VENDOR_VERSION
      The name of the standard attribute that is used to specify vendor version for the Directory Server, formatted in camel case.
      See Also:

    • OC_EXTENSIBLE_OBJECT

      public static final String OC_EXTENSIBLE_OBJECT
      The name of the standard objectclass that is used to allow any attribute type to be present in an entry, formatted in camel case.
      See Also:

    • OC_GROUP_OF_ENTRIES

      public static final String OC_GROUP_OF_ENTRIES
      The name of the standard "groupOfEntries" object class, formatted in camelCase.
      See Also:

    • OC_GROUP_OF_ENTRIES_LC

      public static final String OC_GROUP_OF_ENTRIES_LC
      The name of the standard "groupOfEntries" object class, formatted in all lowercase characters.
      See Also:

    • OC_GROUP_OF_NAMES

      public static final String OC_GROUP_OF_NAMES
      The name of the standard "groupOfNames" object class, formatted in camelCase.
      See Also:

    • OC_GROUP_OF_NAMES_LC

      public static final String OC_GROUP_OF_NAMES_LC
      The name of the standard "groupOfNames" object class, formatted in all lowercase characters.
      See Also:

    • OC_GROUP_OF_UNIQUE_NAMES

      public static final String OC_GROUP_OF_UNIQUE_NAMES
      The name of the standard "groupOfUniqueNames" object class, formatted in camelCase.
      See Also:

    • OC_GROUP_OF_UNIQUE_NAMES_LC

      public static final String OC_GROUP_OF_UNIQUE_NAMES_LC
      The name of the standard "groupOfUniqueNames" object class, formatted in all lowercase characters.
      See Also:

    • OC_GROUP_OF_URLS

      public static final String OC_GROUP_OF_URLS
      The name of the standard "groupOfURLs" object class, formatted in camel case.
      See Also:

    • OC_GROUP_OF_URLS_LC

      public static final String OC_GROUP_OF_URLS_LC
      The name of the standard "groupOfURLs" object class, formatted in all lowercase characters.
      See Also:

    • OC_CHANGELOG_ENTRY

      public static final String OC_CHANGELOG_ENTRY
      The name of the objectclass that will be used as the structural class for monitor entries.
      See Also:

    • OID_CANCEL_REQUEST

      public static final String OID_CANCEL_REQUEST
      The request OID for the cancel extended operation.
      See Also:

    • OID_GET_CONNECTION_ID_EXTOP

      public static final String OID_GET_CONNECTION_ID_EXTOP
      The OID for the extended operation that can be used to get the client connection ID. It will be both the request and response OID.
      See Also:

    • OID_PASSWORD_MODIFY_REQUEST

      public static final String OID_PASSWORD_MODIFY_REQUEST
      The request OID for the password modify extended operation.
      See Also:

    • OID_PASSWORD_POLICY_STATE_EXTOP

      public static final String OID_PASSWORD_POLICY_STATE_EXTOP
      The OID for the password policy state extended operation (both the request and response types).
      See Also:

    • OID_START_TLS_REQUEST

      public static final String OID_START_TLS_REQUEST
      The request OID for the StartTLS extended operation.
      See Also:

    • OID_WHO_AM_I_REQUEST

      public static final String OID_WHO_AM_I_REQUEST
      The request OID for the "Who Am I?" extended operation.
      See Also:

    • OID_GET_SYMMETRIC_KEY_EXTENDED_OP

      public static final String OID_GET_SYMMETRIC_KEY_EXTENDED_OP
      The request OID for the get symmetric key extended operation.
      See Also:

    • OC_LDAP_SUBENTRY

      public static final String OC_LDAP_SUBENTRY
      The name of the standard "ldapSubentry" objectclass (which is a special type of objectclass that makes a kind of "operational" entry), formatted in camel case.
      See Also:

    • OC_LDAP_SUBENTRY_LC

      public static final String OC_LDAP_SUBENTRY_LC
      The name of the standard "ldapSubentry" objectclass (which is a special type of objectclass that makes a kind of "operational" entry), formatted in all lowercase.
      See Also:

    • OC_LDAP_SUBENTRY_BS

      public static final ByteString OC_LDAP_SUBENTRY_BS
      ByteString version of OC_LDAP_SUBENTRY_LC.

    • OC_SUBENTRY

      public static final String OC_SUBENTRY
      The name of the RFC 3672 "subentry" objectclass (which is a special type of objectclass that makes a kind of "operational" entry), formatted in all lowercase.
      See Also:

    • OC_SUBENTRY_BS

      public static final ByteString OC_SUBENTRY_BS
      ByteString version of OC_SUBENTRY.

    • OC_COLLECTIVE_ATTR_SUBENTRY_BS

      public static final ByteString OC_COLLECTIVE_ATTR_SUBENTRY_BS
      The name of the RFC 3671 "collectiveAttributeSubentry" objectclass (which is a special type of objectclass that makes a kind of shared attributes subentry), formatted in all lowercase.

    • OC_INHERITED_COLLECTIVE_ATTR_SUBENTRY_BS

      public static final ByteString OC_INHERITED_COLLECTIVE_ATTR_SUBENTRY_BS
      The name of the "inheritedCollectiveAttributeSubentry" objectclass (which is a special type of objectclass that makes a kind of COS template subentry), formatted in all lowercase.

    • OC_INHERITED_FROM_DN_COLLECTIVE_ATTR_SUBENTRY_BS

      public static final ByteString OC_INHERITED_FROM_DN_COLLECTIVE_ATTR_SUBENTRY_BS
      The name of the "inheritedFromDNCollectiveAttributeSubentry" objectclass (which is a special type of objectclass that makes a kind of indirect COS template subentry), formatted in all lowercase.

    • OC_INHERITED_FROM_RDN_COLLECTIVE_ATTR_SUBENTRY_BS

      public static final ByteString OC_INHERITED_FROM_RDN_COLLECTIVE_ATTR_SUBENTRY_BS
      The name of the "inheritedFromRDNCollectiveAttributeSubentry" objectclass (which is a special type of objectclass that makes a kind of classic COS template subentry), formatted in all lowercase.

    • OC_PWD_POLICY_SUBENTRY_BS

      public static final ByteString OC_PWD_POLICY_SUBENTRY_BS
      The name of the LDAP Password Policy Internet-Draft "pwdPolicy" objectclass, formatted in all lowercase.

    • OC_PASSWORD_POLICY_SUBENTRY_BS

      public static final ByteString OC_PASSWORD_POLICY_SUBENTRY_BS
      The name of the OpenDJ extended password policy objectclass, formatted in all lowercase.

    • OC_MONITOR_BACKEND

      public static final String OC_MONITOR_BACKEND
      The name of the custom objectclass that will be included in backend monitor entries.
      See Also:

    • OC_MONITOR_CONNHANDLER

      public static final String OC_MONITOR_CONNHANDLER
      The name of the custom objectclass that will be included in connection handler monitor entries.
      See Also:

    • OC_LDAP_MONITOR_CONNHANDLER

      public static final String OC_LDAP_MONITOR_CONNHANDLER
      The name of the custom objectclass that will be included in ldap connection handler monitor entries.
      See Also:

    • OC_HTTP_MONITOR_CONNHANDLER

      public static final String OC_HTTP_MONITOR_CONNHANDLER
      The name of the custom objectclass that will be included in http connection handler monitor entries.
      See Also:

    • OC_MONITOR_CERTIFICATE_ENTRY

      public static final String OC_MONITOR_CERTIFICATE_ENTRY
      The name of the custom objectclass that will be included in certificate monitor entries.
      See Also:

    • OC_MONITOR_ENTRY

      public static final String OC_MONITOR_ENTRY
      The name of the objectclass that will be used as the structural class for monitor entries.
      See Also:

    • OC_MONITOR_BRANCH

      public static final String OC_MONITOR_BRANCH
      The name of the objectclass that will be used as the structural class for monitor branches.
      See Also:

    • REQUESTS_FAILURE_CLIENT_INVALID_REQUEST

      public static final String REQUESTS_FAILURE_CLIENT_INVALID_REQUEST
      The name of the metric used for monitoring requests failed because they were invalid.
      See Also:

    • REQUESTS_FAILURE_CLIENT_SECURITY

      public static final String REQUESTS_FAILURE_CLIENT_SECURITY
      The name of the metric used for monitoring requests failed for security reasons.
      See Also:

    • REQUESTS_FAILURE_UNKNOWN

      public static final String REQUESTS_FAILURE_UNKNOWN
      The name of the metric used for monitoring requests failed due to uncategorized reasons.
      See Also:

    • REQUESTS_FAILURE_SERVER

      public static final String REQUESTS_FAILURE_SERVER
      The name of the metric used for monitoring requests failed because the server was unable to process them.
      See Also:

    • BYTES_READ

      public static final String BYTES_READ
      The name of the metric used for monitoring number of bytes read by a connection handler.
      See Also:

    • BYTES_WRITTEN

      public static final String BYTES_WRITTEN
      The name of the metric used for monitoring number of bytes written by a connection handler.
      See Also:

    • OC_ROOT_DSE

      public static final String OC_ROOT_DSE
      The name of the structural objectclass that will be used for the Directory Server root DSE entry.
      See Also:

    • OC_SUBSCHEMA

      public static final String OC_SUBSCHEMA
      The name of the standard "subschema" objectclass (which is used in entries that publish schema information), formatted in all lowercase.
      See Also:

    • OC_TOP

      public static final String OC_TOP
      The name of the standard "top" objectclass, which is the superclass for virtually all other objectclasses, formatted in all lowercase.
      See Also:

    • OC_VIRTUAL_STATIC_GROUP

      public static final String OC_VIRTUAL_STATIC_GROUP
      The name of the ds-virtual-static-group objectclass in all lowercase characters.
      See Also:

    • LOG_SEVERITY_ALL

      public static final String LOG_SEVERITY_ALL
      The English name for the basic all log severity used for all log severities.
      See Also:

    • MBEAN_BASE_DOMAIN

      public static final String MBEAN_BASE_DOMAIN
      The domain that will be used for JMX MBeans defined within the Directory Server.
      See Also:

    • ALERT_DESCRIPTION_ACCESS_CONTROL_DISABLED

      public static final String ALERT_DESCRIPTION_ACCESS_CONTROL_DISABLED
      The description for the alert type that will be used for the alert notification generated if the access control handler is disabled.
      See Also:

    • ALERT_TYPE_ACCESS_CONTROL_DISABLED

      public static final String ALERT_TYPE_ACCESS_CONTROL_DISABLED
      The alert type string that will be used for the alert notification generated if the access control handler is disabled.
      See Also:

    • ALERT_DESCRIPTION_ACCESS_CONTROL_ENABLED

      public static final String ALERT_DESCRIPTION_ACCESS_CONTROL_ENABLED
      The description for the alert type that will be used for the alert notification generated if the access control handler is enabled.
      See Also:

    • ALERT_TYPE_ACCESS_CONTROL_ENABLED

      public static final String ALERT_TYPE_ACCESS_CONTROL_ENABLED
      The alert type string that will be used for the alert notification generated if the access control handler is enabled.
      See Also:

    • ALERT_DESCRIPTION_CANNOT_RENAME_CURRENT_TASK_FILE

      public static final String ALERT_DESCRIPTION_CANNOT_RENAME_CURRENT_TASK_FILE
      The description for the alert type that will be used for the alert notification generated if an error occurs while attempting to rename the current tasks backing file.
      See Also:

    • ALERT_TYPE_CANNOT_RENAME_CURRENT_TASK_FILE

      public static final String ALERT_TYPE_CANNOT_RENAME_CURRENT_TASK_FILE
      The alert type string that will be used for the alert notification generated if an error occurs while attempting to rename the current tasks backing file.
      See Also:

    • ALERT_DESCRIPTION_CANNOT_RENAME_NEW_TASK_FILE

      public static final String ALERT_DESCRIPTION_CANNOT_RENAME_NEW_TASK_FILE
      The description for the alert type that will be used for the alert notification generated if an error occurs while attempting to rename the new tasks backing file.
      See Also:

    • ALERT_TYPE_CANNOT_RENAME_NEW_TASK_FILE

      public static final String ALERT_TYPE_CANNOT_RENAME_NEW_TASK_FILE
      The alert type string that will be used for the alert notification generated if an error occurs while attempting to rename the new tasks backing file.
      See Also:

    • ALERT_DESCRIPTION_CANNOT_SCHEDULE_RECURRING_ITERATION

      public static final String ALERT_DESCRIPTION_CANNOT_SCHEDULE_RECURRING_ITERATION
      The description for the alert type that will be used for the alert notification generated if an error occurs while attempting to schedule an iteration of a recurring task.
      See Also:

    • ALERT_TYPE_CANNOT_SCHEDULE_RECURRING_ITERATION

      public static final String ALERT_TYPE_CANNOT_SCHEDULE_RECURRING_ITERATION
      The alert type string that will be used for the alert notification generated if an error occurs while attempting to schedule an iteration of a recurring task.
      See Also:

    • ALERT_DESCRIPTION_CANNOT_WRITE_CONFIGURATION

      public static final String ALERT_DESCRIPTION_CANNOT_WRITE_CONFIGURATION
      The description for the alert type that will be used for the alert notification generated if a problem occurs while attempting to write the Directory Server configuration to disk.
      See Also:

    • ALERT_TYPE_CANNOT_WRITE_CONFIGURATION

      public static final String ALERT_TYPE_CANNOT_WRITE_CONFIGURATION
      The alert type string that will be used for the alert notification generated if a problem occurs while attempting to write the Directory Server configuration to disk.
      See Also:

    • ALERT_DESCRIPTION_ENTERING_LOCKDOWN_MODE

      public static final String ALERT_DESCRIPTION_ENTERING_LOCKDOWN_MODE
      The description for the alert type that will be used for the alert notification generated upon entering lockdown mode.
      See Also:

    • ALERT_TYPE_ENTERING_LOCKDOWN_MODE

      public static final String ALERT_TYPE_ENTERING_LOCKDOWN_MODE
      The alert type that will be used when the Directory Server enters lockdown mode.
      See Also:

    • ALERT_DESCRIPTION_LEAVING_LOCKDOWN_MODE

      public static final String ALERT_DESCRIPTION_LEAVING_LOCKDOWN_MODE
      The description for the alert type that will be used for the alert notification generated upon leaving lockdown mode.
      See Also:

    • ALERT_TYPE_LEAVING_LOCKDOWN_MODE

      public static final String ALERT_TYPE_LEAVING_LOCKDOWN_MODE
      The alert type that will be used when the Directory Server leaves lockdown mode.
      See Also:

    • ALERT_DESCRIPTION_MANUAL_CONFIG_EDIT_HANDLED

      public static final String ALERT_DESCRIPTION_MANUAL_CONFIG_EDIT_HANDLED
      The description for the alert type that will be used for the alert notification generated if the server detects that the configuration has been manually edited with the server online and those edits would have been lost by an online config change.
      See Also:

    • ALERT_TYPE_MANUAL_CONFIG_EDIT_HANDLED

      public static final String ALERT_TYPE_MANUAL_CONFIG_EDIT_HANDLED
      The alert type string that will be used for the alert notification generated if a problem occurs while attempting to write the Directory Server configuration to disk.
      See Also:

    • ALERT_DESCRIPTION_MANUAL_CONFIG_EDIT_LOST

      public static final String ALERT_DESCRIPTION_MANUAL_CONFIG_EDIT_LOST
      The description for the alert type that will be used for the alert notification generated if the server detects that the configuration has been manually edited with the server online, but a problem occurred while trying to preserve the manual changes that may have caused them to be lost.
      See Also:

    • ALERT_TYPE_MANUAL_CONFIG_EDIT_LOST

      public static final String ALERT_TYPE_MANUAL_CONFIG_EDIT_LOST
      The alert type string that will be used for the alert notification generated if a problem occurs while attempting to write the Directory Server configuration to disk.
      See Also:

    • ALERT_DESCRIPTION_CANNOT_WRITE_TASK_FILE

      public static final String ALERT_DESCRIPTION_CANNOT_WRITE_TASK_FILE
      The description for the alert type that will be used for the alert notification generated if an error occurs while attempting to write the tasks backing file.
      See Also:

    • ALERT_TYPE_CANNOT_WRITE_TASK_FILE

      public static final String ALERT_TYPE_CANNOT_WRITE_TASK_FILE
      The alert type string that will be used for the alert notification generated if an error occurs while attempting to write the tasks backing file.
      See Also:

    • ALERT_DESCRIPTION_LDAP_CONNECTION_HANDLER_CONSECUTIVE_FAILURES

      public static final String ALERT_DESCRIPTION_LDAP_CONNECTION_HANDLER_CONSECUTIVE_FAILURES
      The description for the alert type that will be used for the alert notification generated if consecutive failures in the LDAP connection handler have caused it to become disabled.
      See Also:

    • ALERT_TYPE_LDAP_CONNECTION_HANDLER_CONSECUTIVE_FAILURES

      public static final String ALERT_TYPE_LDAP_CONNECTION_HANDLER_CONSECUTIVE_FAILURES
      The alert type string that will be used for the alert notification generated if consecutive failures in the LDAP connection handler have caused it to become disabled.
      See Also:

    • ALERT_DESCRIPTION_HTTP_CONNECTION_HANDLER_CONSECUTIVE_FAILURES

      public static final String ALERT_DESCRIPTION_HTTP_CONNECTION_HANDLER_CONSECUTIVE_FAILURES
      The description for the alert type that will be used for the alert notification generated if consecutive failures in the HTTP connection handler have caused it to become disabled.
      See Also:

    • ALERT_TYPE_HTTP_CONNECTION_HANDLER_CONSECUTIVE_FAILURES

      public static final String ALERT_TYPE_HTTP_CONNECTION_HANDLER_CONSECUTIVE_FAILURES
      The alert type string that will be used for the alert notification generated if consecutive failures in the HTTP connection handler have caused it to become disabled.
      See Also:

    • ALERT_DESCRIPTION_LDAP_CONNECTION_HANDLER_UNCAUGHT_ERROR

      public static final String ALERT_DESCRIPTION_LDAP_CONNECTION_HANDLER_UNCAUGHT_ERROR
      The description for the alert type that will be used for the alert notification generated if the LDAP connection handler encountered an unexpected error that has caused it to become disabled.
      See Also:

    • ALERT_TYPE_LDAP_CONNECTION_HANDLER_UNCAUGHT_ERROR

      public static final String ALERT_TYPE_LDAP_CONNECTION_HANDLER_UNCAUGHT_ERROR
      The alert type string that will be used for the alert notification generated if the LDAP connection handler encountered an unexpected error that has caused it to become disabled.
      See Also:

    • ALERT_DESCRIPTION_SERVER_STARTED

      public static final String ALERT_DESCRIPTION_SERVER_STARTED
      The description for the alert type that will be used for the alert notification generated when the Directory Server has completed its startup process.
      See Also:

    • ALERT_TYPE_SERVER_STARTED

      public static final String ALERT_TYPE_SERVER_STARTED
      The alert type string that will be used for the alert notification generated when the Directory Server has completed its startup process.
      See Also:

    • ALERT_DESCRIPTION_SERVER_SHUTDOWN

      public static final String ALERT_DESCRIPTION_SERVER_SHUTDOWN
      The description for the alert type that will be used for the alert notification generated when the Directory Server has started the shutdown process.
      See Also:

    • ALERT_TYPE_SERVER_SHUTDOWN

      public static final String ALERT_TYPE_SERVER_SHUTDOWN
      The alert type string that will be used for the alert notification generated when the Directory Server has started the shutdown process.
      See Also:

    • ALERT_DESCRIPTION_UNCAUGHT_EXCEPTION

      public static final String ALERT_DESCRIPTION_UNCAUGHT_EXCEPTION
      The description for the alert type that will be used for the alert notification generated by a thread that has died because of an uncaught exception.
      See Also:

    • ALERT_TYPE_UNCAUGHT_EXCEPTION

      public static final String ALERT_TYPE_UNCAUGHT_EXCEPTION
      The alert type string that will be used for the alert notification generated by a thread that has died because of an uncaught exception.
      See Also:

    • ALERT_DESCRIPTION_CANNOT_COPY_SCHEMA_FILES

      public static final String ALERT_DESCRIPTION_CANNOT_COPY_SCHEMA_FILES
      The description for the alert type that will be used for the alert notification generated if a problem occurs while creating copies of the existing schema configuration files and a problem occurs that leaves the schema configuration in a potentially inconsistent state.
      See Also:

    • ALERT_TYPE_CANNOT_COPY_SCHEMA_FILES

      public static final String ALERT_TYPE_CANNOT_COPY_SCHEMA_FILES
      The alert type string that will be used for the alert notification generated if a problem occurs while creating copies of the existing schema files in a manner that may leave the schema configuration inconsistent.
      See Also:

    • ALERT_DESCRIPTION_CANNOT_WRITE_NEW_SCHEMA_FILES

      public static final String ALERT_DESCRIPTION_CANNOT_WRITE_NEW_SCHEMA_FILES
      The description for the alert type that will be used for the alert notification generated if a problem occurs while writing new versions of the server schema configuration files and a problem occurs that leaves the schema configuration in a potentially inconsistent state.
      See Also:

    • ALERT_TYPE_CANNOT_WRITE_NEW_SCHEMA_FILES

      public static final String ALERT_TYPE_CANNOT_WRITE_NEW_SCHEMA_FILES
      The alert type string that will be used for the alert notification generated if a problem occurs while writing new versions of the server schema files in a manner that may leave the schema configuration inconsistent.
      See Also:

    • ALERT_DESCRIPTION_ACCESS_CONTROL_PARSE_FAILED

      public static final String ALERT_DESCRIPTION_ACCESS_CONTROL_PARSE_FAILED
      The description for the alert type that will be used for the alert notification generated if the dseecompat access control subsystem failed to parse one or more ACI rules when the server is first started or a backend is being initialized.
      See Also:

    • ALERT_TYPE_ACCESS_CONTROL_PARSE_FAILED

      public static final String ALERT_TYPE_ACCESS_CONTROL_PARSE_FAILED
      The alert type string that will be used for the alert notification generated if the dseecompat access control subsystem failed to parse one or more ACI rules when the server is first started or a backend is being initialized.
      See Also:

    • ALERT_DESCRIPTION_DISK_SPACE_LOW

      public static final String ALERT_DESCRIPTION_DISK_SPACE_LOW
      The description for the alert type that will be used for the alert notification generated when the free disk space has reached the low threshold.
      See Also:

    • ALERT_TYPE_DISK_SPACE_LOW

      public static final String ALERT_TYPE_DISK_SPACE_LOW
      The alert type string that will be used for the alert notification generated when the JE Environment needs to be reopened by restarting the Directory Server.
      See Also:

    • ALERT_DESCRIPTION_DISK_FULL

      public static final String ALERT_DESCRIPTION_DISK_FULL
      The description for the alert type that will be used for the alert notification generated when the free disk space has reached the full threshold.
      See Also:

    • ALERT_TYPE_DISK_FULL

      public static final String ALERT_TYPE_DISK_FULL
      The alert type string that will be used for the alert notification generated when the JE Environment needs to be reopened by restarting the Directory Server.
      See Also:

    • ALERT_DESCRIPTION_LDIF_BACKEND_CANNOT_WRITE_UPDATE

      public static final String ALERT_DESCRIPTION_LDIF_BACKEND_CANNOT_WRITE_UPDATE
      The description for the alert type that will be used for the alert notification generated when the LDIF backend cannot write an updated LDIF file.
      See Also:

    • ALERT_TYPE_LDIF_BACKEND_CANNOT_WRITE_UPDATE

      public static final String ALERT_TYPE_LDIF_BACKEND_CANNOT_WRITE_UPDATE
      The alert type string that will be used for the alert notification generated when the LDIF backend cannot write an updated LDIF file.
      See Also:

    • ALERT_DESCRIPTION_LDIF_CONNHANDLER_PARSE_ERROR

      public static final String ALERT_DESCRIPTION_LDIF_CONNHANDLER_PARSE_ERROR
      The description for the alert type that will be used for the alert notification generated when the LDIF connection handler is unable to process the contents of a file as valid LDIF.
      See Also:

    • ALERT_TYPE_LDIF_CONNHANDLER_PARSE_ERROR

      public static final String ALERT_TYPE_LDIF_CONNHANDLER_PARSE_ERROR
      The alert type string that will be used for the alert notification generated when the LDIF connection handler is unable to process the contents of a file as valid LDIF.
      See Also:

    • ALERT_DESCRIPTION_LDIF_CONNHANDLER_IO_ERROR

      public static final String ALERT_DESCRIPTION_LDIF_CONNHANDLER_IO_ERROR
      The description for the alert type that will be used for the alert notification generated if an I/O error occurs while attempting to read or write LDIF content.
      See Also:

    • ALERT_TYPE_LDIF_CONNHANDLER_IO_ERROR

      public static final String ALERT_TYPE_LDIF_CONNHANDLER_IO_ERROR
      The alert type string that will be used for the alert notification generated if an I/O error occurs while attempting to read or write LDIF content.
      See Also:

    • ALERT_DESCRIPTION_UNIQUE_ATTR_SYNC_CONFLICT

      public static final String ALERT_DESCRIPTION_UNIQUE_ATTR_SYNC_CONFLICT
      The description for the alert type that will be used for the alert notification generated if a unique attribute conflict is detected during synchronization processing.
      See Also:

    • ALERT_TYPE_UNIQUE_ATTR_SYNC_CONFLICT

      public static final String ALERT_TYPE_UNIQUE_ATTR_SYNC_CONFLICT
      The alert type string that will be used for the alert notification generated if a unique attribute conflict is detected during synchronization processing.
      See Also:

    • ALERT_DESCRIPTION_UNIQUE_ATTR_SYNC_ERROR

      public static final String ALERT_DESCRIPTION_UNIQUE_ATTR_SYNC_ERROR
      The description for the alert type that will be used for the alert notification generated if an error occurs while attempting to perform unique attribute conflict detection during synchronization processing.
      See Also:

    • ALERT_TYPE_UNIQUE_ATTR_SYNC_ERROR

      public static final String ALERT_TYPE_UNIQUE_ATTR_SYNC_ERROR
      The alert type string that will be used for the alert notification generated if an error occurs while attempting to perform unique attribute conflict detection during synchronization processing.
      See Also:

    • ALERT_DESCRIPTION_BACKUP_SUCCESS

      public static final String ALERT_DESCRIPTION_BACKUP_SUCCESS
      The description for the alert type that will be used for the alert notification generated upon success of a backup.
      See Also:

    • ALERT_TYPE_BACKUP_SUCCESS

      public static final String ALERT_TYPE_BACKUP_SUCCESS
      The alert type that will be used when a backup has ended successfully.
      See Also:

    • ALERT_DESCRIPTION_BACKUP_FAILURE

      public static final String ALERT_DESCRIPTION_BACKUP_FAILURE
      The description for the alert type that will be used for the alert notification generated upon failure of a backup.
      See Also:

    • ALERT_TYPE_BACKUP_FAILURE

      public static final String ALERT_TYPE_BACKUP_FAILURE
      The alert type that will be used when a backup has failed.
      See Also:

    • DEFAULT_MAX_INTERNAL_BUFFER_SIZE

      public static final int DEFAULT_MAX_INTERNAL_BUFFER_SIZE
      Default maximum size for cached protocol/entry encoding buffers.
      See Also:

    • OBJECTCLASS_ATTRIBUTE_TYPE_NAME

      public static final String OBJECTCLASS_ATTRIBUTE_TYPE_NAME
      The name of the attribute type that represents the "objectClass" attribute.
      See Also:

    • SERVER_VENDOR_NAME

      public static final String SERVER_VENDOR_NAME
      The value that will be used for the vendorName attribute in the root DSE.
      See Also:

    • SASL_DEFAULT_PROTOCOL

      public static final String SASL_DEFAULT_PROTOCOL
      The name of the default protocol used.
      See Also:

    • OID_ACCOUNT_USABLE_CONTROL

      public static final String OID_ACCOUNT_USABLE_CONTROL
      The OID for the account usable request and response controls.
      See Also:

    • OID_ALL_OPERATIONAL_ATTRS_FEATURE

      public static final String OID_ALL_OPERATIONAL_ATTRS_FEATURE
      The IANA-assigned OID for the feature allowing a user to request that all operational attributes be returned.
      See Also:

    • OID_AUTHZID_REQUEST

      public static final String OID_AUTHZID_REQUEST
      The OID for the authorization identity request control.
      See Also:

    • OID_LDAP_ADLIST_FEATURE

      public static final String OID_LDAP_ADLIST_FEATURE
      The OID to include in the supportedFeatures list of the Directory Server to indicate that it supports requesting attributes by objectclass.
      See Also:

    • OID_LDAP_ASSERTION

      public static final String OID_LDAP_ASSERTION
      The IANA-assigned OID for the LDAP assertion control.
      See Also:

    • OID_LDAP_NOOP_OPENLDAP_ASSIGNED

      public static final String OID_LDAP_NOOP_OPENLDAP_ASSIGNED
      The OID for the LDAP no-op control that was originally assigned in the initial draft (draft-zeilenga-ldap-noop-00) from the OpenLDAP private range. Note that this reference has been removed in later drafts, but given that at this time no official OID is assigned, we will use it for now, and will continue to support it in the future (along with the real OID).
      See Also:

    • OID_LDAP_READENTRY_PREREAD

      public static final String OID_LDAP_READENTRY_PREREAD
      The IANA-assigned OID for the LDAP readentry control used for retrieving an entry in the state it had immediately before an update was applied.
      See Also:

    • OID_LDAP_READENTRY_POSTREAD

      public static final String OID_LDAP_READENTRY_POSTREAD
      The IANA-assigned OID for the LDAP readentry control used for retrieving an entry in the state it had immediately after an update was applied.
      See Also:

    • OID_LDAP_SUBENTRIES

      public static final String OID_LDAP_SUBENTRIES
      The OID for the LDAP subentries control as defined in RFC 3672, which is used to indicate that matching subentries should be returned.
      See Also:

    • OID_LDUP_SUBENTRIES

      public static final String OID_LDUP_SUBENTRIES
      The OID for the LDAP subentries control as defined in the legacy draft-ietf-ldup-subentry internet draft, which is used to indicate that matching subentries should be returned.
      See Also:

    • OID_MATCHED_VALUES

      public static final String OID_MATCHED_VALUES
      The OID for the matched values control used to specify which particular attribute values should be returned in a search result entry.
      See Also:

    • OID_MODIFY_INCREMENT_FEATURE

      public static final String OID_MODIFY_INCREMENT_FEATURE
      The IANA-assigned OID for the feature allowing the use of the increment modification type.
      See Also:

    • OID_NS_PASSWORD_EXPIRED

      public static final String OID_NS_PASSWORD_EXPIRED
      The OID for the Netscape password expired control.
      See Also:

    • OID_NS_PASSWORD_EXPIRING

      public static final String OID_NS_PASSWORD_EXPIRING
      The OID for the Netscape password expiring control.
      See Also:

    • OID_PASSWORD_POLICY_CONTROL

      public static final String OID_PASSWORD_POLICY_CONTROL
      The OID for the password policy control from draft-behera-ldap-password-policy.
      See Also:

    • OID_PROXIED_AUTH_V1

      public static final String OID_PROXIED_AUTH_V1
      The OID for the proxied authorization v1 control.
      See Also:

    • OID_PROXIED_AUTH_V2

      public static final String OID_PROXIED_AUTH_V2
      The OID for the proxied authorization v2 control.
      See Also:

    • OID_GET_EFFECTIVE_RIGHTS

      public static final String OID_GET_EFFECTIVE_RIGHTS
      The OID for the get effective rights control.
      See Also:

    • OID_REAL_ATTRS_ONLY

      public static final String OID_REAL_ATTRS_ONLY
      The OID for the real attributes only control.
      See Also:

    • OID_SUBTREE_DELETE_CONTROL

      public static final String OID_SUBTREE_DELETE_CONTROL
      The OID for the subtree delete control.
      See Also:

    • OID_PAGED_RESULTS_CONTROL

      public static final String OID_PAGED_RESULTS_CONTROL
      The OID for the paged results control defined in RFC 2696.
      See Also:

    • OID_MANAGE_DSAIT_CONTROL

      public static final String OID_MANAGE_DSAIT_CONTROL
      The OID for the ManageDsaIT control defined in RFC 3296.
      See Also:

    • OID_PERMISSIVE_MODIFY_CONTROL

      public static final String OID_PERMISSIVE_MODIFY_CONTROL
      The OID for the Permissive Modify control, defined and used by MSAD.
      See Also:

    • OID_SERVER_SIDE_SORT_REQUEST_CONTROL

      public static final String OID_SERVER_SIDE_SORT_REQUEST_CONTROL
      The OID for the server-side sort request control.
      See Also:

    • OID_TRUE_FALSE_FILTERS_FEATURE

      public static final String OID_TRUE_FALSE_FILTERS_FEATURE
      The IANA-assigned OID for the feature allowing the use of LDAP true and false filters.
      See Also:

    • OID_VIRTUAL_ATTRS_ONLY

      public static final String OID_VIRTUAL_ATTRS_ONLY
      The OID for the virtual attributes only control.
      See Also:

    • OID_VLV_REQUEST_CONTROL

      public static final String OID_VLV_REQUEST_CONTROL
      The OID for the virtual list view request control.
      See Also:

    • OID_CSN_CONTROL

      public static final String OID_CSN_CONTROL
      The OID for the CSN control.
      See Also:

    • OID_RELAX_RULES_CONTROL

      public static final String OID_RELAX_RULES_CONTROL
      The OID for the Relax Rules request control. Note the OID is assigned under OpenLDAP experimental arc
      See Also:

    • JAAS_PROPERTY_CONFIG_FILE

      public static final String JAAS_PROPERTY_CONFIG_FILE
      The name of the JAAS property that specifies the path to the login configuration file.
      See Also:

    • JAAS_PROPERTY_SUBJECT_CREDS_ONLY

      public static final String JAAS_PROPERTY_SUBJECT_CREDS_ONLY
      The name of the JAAS property that indicates whether to allow JAAS credentials to come from somewhere other than a GSS mechanism.
      See Also:

    • KRBV_PROPERTY_KDC

      public static final String KRBV_PROPERTY_KDC
      The name of the Kerberos V property that specifies the address of the KDC.
      See Also:

    • KRBV_PROPERTY_REALM

      public static final String KRBV_PROPERTY_REALM
      The name of the Kerberos V property that specifies the realm to use.
      See Also:

    • LOCKS_DIRECTORY

      public static final String LOCKS_DIRECTORY
      The name of the directory in which lock files will be placed.
      See Also:

    • BACKEND_LOCK_FILE_PREFIX

      public static final String BACKEND_LOCK_FILE_PREFIX
      The prefix that will be used for lock filenames used for Directory Server backends.
      See Also:

    • SERVER_LOCK_FILE_NAME

      public static final String SERVER_LOCK_FILE_NAME
      The name that will be used for the server-wide lock to prevent multiple instances of the server from running concurrently.
      See Also:

    • LOCK_FILE_SUFFIX

      public static final String LOCK_FILE_SUFFIX
      The suffix that will be used for all lock files created by the Directory Server.
      See Also:

    • SCHEMA_PROPERTY_FILENAME

      public static final String SCHEMA_PROPERTY_FILENAME
      The name of the schema property that will be used to specify the path to the schema file from which the schema element was loaded.
      See Also:

    • PROPERTY_CONFIG_FILE

      public static final String PROPERTY_CONFIG_FILE
      The name of the system property that can be used to specify the path to the configuration file that should be used to initialize the config handler.
      See Also:

    • PROPERTY_DISABLE_CONNECTION_HANDLERS

      public static final String PROPERTY_DISABLE_CONNECTION_HANDLERS
      The name of the system property that can be used to disable any connection handler that may be enabled in the server configuration. This may be used to start the server in a mode where it will not accept any external connections, but may still be used for processing internal operations.
      See Also:

    • PROPERTY_DISABLE_SYNCHRONIZATION

      public static final String PROPERTY_DISABLE_SYNCHRONIZATION
      The name of the system property that can be used to disable any synchronization provider that may be enabled in the server configuration. This may be used to start the server in a mode where it will not accept any external connections, but may still be used for processing internal operations.
      See Also:

    • PROPERTY_DISABLE_ADMIN_DATA_SYNCHRONIZATION

      public static final String PROPERTY_DISABLE_ADMIN_DATA_SYNCHRONIZATION
      The name of the system property that can be used to disable the synchronization between between administration data.
      See Also:

    • PROPERTY_FORCE_DAEMON_THREADS

      public static final String PROPERTY_FORCE_DAEMON_THREADS
      The name of the system property that can be used to determine whether all DirectoryThread instances should be created as daemon threads regardless of whether they would otherwise be configured that way.
      See Also:

    • PROPERTY_LOCK_DIRECTORY

      public static final String PROPERTY_LOCK_DIRECTORY
      The name of the system property that can be used to specify the path to the directory in which the server lock files should be written. If this is not set, then the server will use a directory named "locks" below the server root. Note that if the server is ever started with a different lock file directory than was used for the previous startup, then the server administrator must ensure that the instance is not already running.
      See Also:

    • PROPERTY_MAINTAIN_CONFIG_ARCHIVE

      public static final String PROPERTY_MAINTAIN_CONFIG_ARCHIVE
      The name of the system property that can be used to determine whether the server should maintain an archive of previous configurations. If this is not set, or if the value is anything other than "false", then the server will maintain a configuration archive.
      See Also:

    • PROPERTY_MAX_CONFIG_ARCHIVE_SIZE

      public static final String PROPERTY_MAX_CONFIG_ARCHIVE_SIZE
      The name of the system property that can be used to specify the maximum number of archived configurations to maintain. If this is not set, or if it set to a zero or negative value, then there will be no limit on the number of archived configurations.
      See Also:

    • PROPERTY_REGISTER_SHUTDOWN_HOOK

      public static final String PROPERTY_REGISTER_SHUTDOWN_HOOK
      The name of the system property that can be used to determine whether DirectoryServer should register a virtual-machine shutdown hook.
      See Also:

    • PROPERTY_RUNNING_UNIT_TESTS

      public static final String PROPERTY_RUNNING_UNIT_TESTS
      The name of the system property that can be used to determine whether the Directory Server is starting up for the purpose of running the unit tests.
      See Also:

    • PROPERTY_SCHEMA_DIRECTORY

      public static final String PROPERTY_SCHEMA_DIRECTORY
      The name of the system property that can be used to specify the path to the directory in which the schema configuration files may be found. If this is not set, then the server will use a directory named "db/schema" below the instance root.
      See Also:

    • PROPERTY_SERVER_ROOT

      public static final String PROPERTY_SERVER_ROOT
      The name of the system property that can be used to specify the path to the server root.
      See Also:

    • PROPERTY_INSTANCE_ROOT

      public static final String PROPERTY_INSTANCE_ROOT
      The name of the system property that can be used to specify the path to the instance root.
      See Also:

    • PROPERTY_USE_LAST_KNOWN_GOOD_CONFIG

      public static final String PROPERTY_USE_LAST_KNOWN_GOOD_CONFIG
      The name of the system property that can be used to indicate that the Directory Server should attempt to start using the last known good configuration, rather than the current active configuration.
      See Also:

    • SCHEMA_CONCAT_FILE_NAME

      public static final String SCHEMA_CONCAT_FILE_NAME
      The name that should be used for the file to which the latest complete schema data should be concatenated.
      See Also:

    • ALERT_DESCRIPTION_REPLICATION_UNRESOLVED_CONFLICT

      public static final String ALERT_DESCRIPTION_REPLICATION_UNRESOLVED_CONFLICT
      The description for the alert type that will be used for the alert notification generated if multimaster replication detects a conflict that cannot be solved automatically.
      See Also:

    • ALERT_TYPE_REPLICATION_UNRESOLVED_CONFLICT

      public static final String ALERT_TYPE_REPLICATION_UNRESOLVED_CONFLICT
      The alert type string that will be used for the alert notification generated if multimaster replication detects a conflict that cannot be solved automatically.
      See Also:

    • CDDL_HEADER_LINES

      public static final String[] CDDL_HEADER_LINES
      The lines that make up the CDDL header. They will not have any prefix, so an appropriate prefix may need to be added for some cases (e.g., "# " for shell scripts, "rem " for batch files, etc.).

    • TRUE_VALUE

      public static final ByteString TRUE_VALUE
      The normalized true value.

    • FALSE_VALUE

      public static final ByteString FALSE_VALUE
      The normalized false value.

    • DN_EXTERNAL_CHANGELOG_ROOT

      public static final Dn DN_EXTERNAL_CHANGELOG_ROOT
      The base Dn for the external change log.

    • ENABLE_MEMORY_OVERCOMMIT

      public static final String ENABLE_MEMORY_OVERCOMMIT
      Enable overcommit of memory in Old Gen space.
      See Also:

    • REPLICATION_CFG_NAME

      public static final String REPLICATION_CFG_NAME
      Name of the multimaster synchronization element associated to replication.
      See Also:

    • SERVER_ID_PATTERN

      public static final Pattern SERVER_ID_PATTERN
      Pattern to validate a server ID syntax, as defined in the global configuration XML.

      Only ASCII alphanumeric characters are allowed, along with some special chars. Follows kubernetes names, with length to 128 to avoid long filenames hit filesystem limits, also to simplify length constraints if we were to use UTF-8.

    • CONFIG_FILE_HEADER

      public static final LocalizableMessage CONFIG_FILE_HEADER
      The comment at the head of config.ldif, which should not be localized.