Class ConfigConstants

java.lang.Object
org.opends.server.config.ConfigConstants

public final class ConfigConstants extends Object
This class defines a number of constants used by the Directory Server configuration, including configuration attribute and objectclass names, and attribute options.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    The name of the configuration attribute that holds the set of attribute type definitions in the server schema, formatted in camelCase.
    static final String
    The name of the configuration attribute that holds the set of attribute type definitions in the server schema, formatted in all lowercase.
    static final String
    The name of the configuration attribute that specifies a global attribute access control instruction.
    static final String
    The name of the configuration attribute that specifies the base DN(s) for a backend.
    static final String
    The name of the configuration attribute that holds the fully-qualified name of the Java class for a backend implementation.
    static final String
    The name of the configuration attribute that indicates whether a particular backend is enabled.
    static final String
    The name of the configuration attribute that specifies the unique ID for a backend.
    static final String
    The name of the configuration attribute that specifies the writability mode for a backend.
    static final String
    The name of the configuration attribute that holds the backup ID.
    static final String
    The name of the configuration attribute that holds the location of the backup directory.
    static final String
    The name of the configuration attribute that specifies the set of privileges that root users should automatically be granted in the server.
    static final String
    The name of the attribute that is used to hold the description of an objectclass.
    static final String
    The name of the attribute that is used to hold the DIT content rule definitions in the server schema, formatted in camelCase.
    static final String
    The name of the attribute that is used to hold the DIT content rule definitions in the server schema, formatted in all lowercase.
    static final String
    The name of the attribute that is used to hold the DIT structure rule definitions in the server schema, formatted in camelCase.
    static final String
    The name of the attribute that is used to hold the DIT structure rule definitions in the server schema, formatted in all lowercase.
    static final String
    The name of the attribute in an import task definition that specifies the backend ID for the backend into which the date should be imported.
    static final String
    The name of the attribute in an import task definition that specifies whether the backend should be cleared before the import.
    static final String
    The name of the attribute in an import task definition that specifies an attribute that should be excluded from the LDIF import.
    static final String
    The name of the attribute in an import task definition that specifies the base DN of a branch that should be excluded from the LDIF import.
    static final String
    The name of the attribute in an import task definition that specifies a search filter that may be used to control which entries are excluded from the import.
    static final String
    The name of the attribute in an import task definition that specifies an attribute that should be included in the LDIF import.
    static final String
    The name of the attribute in an import task definition that specifies the base DN of a branch that should be included in the LDIF import.
    static final String
    The name of the attribute in an import task definition that specifies a search filter that may be used to control which entries are included in the import.
    static final String
    The name of the attribute in an import task definition that specifies whether the LDIF file containing the data to import is compressed.
    static final String
    The name of the attribute in an import task definition that specifies whether the LDIF file containing the data to import is encrypted.
    static final String
    The name of the attribute in an import task definition that specifies the path to the file containing the LDIF data to import.
    static final String
    The name of the attribute in an import task definition that specifies whether to overwrite an existing rejects and/or skip file when performing an LDIF import rather than appending to it.
    static final String
    The name of the attribute in an import task definition that specifies the random seed to be used when we pass a template file to the import.
    static final String
    The name of the attribute in an import task definition that specifies the path to a file into which rejected entries may be written if they are not accepted during the import process.
    static final String
    The name of the attribute in an import task definition that specifies the path to a file into which skipped entries may be written if they do not match criteria during the import process.
    static final String
    The name of the attribute in an import task definition that specifies whether to skip schema validation during the import.
    static final String
    The name of the attribute in an import task definition that specifies the path to the file containing the template data to import.
    static final String
    The name of the attribute in an import task definition that specifies the thread count to be used during the import.
    static final String
    The name of the attribute in an import task definition that specifies the temp directory path.
    static final String
    The name of the configuration attribute that holds the set of attribute syntax definitions in the server schema, formatted in camelCase.
    static final String
    The name of the configuration attribute that holds the set of attribute syntax definitions in the server schema, formatted in all lowercase.
    static final String
    The name of the configuration attribute that holds the set of matching rule use definitions in the server schema, formatted in camelCase.
    static final String
    The name of the configuration attribute that holds the set of matching rule use definitions in the server schema, formatted in all lowercase.
    static final String
    The name of the attribute that is used to hold the name form definitions in the server schema, formatted in camelCase.
    static final String
    The name of the attribute that is used to hold the name form definitions in the server schema, formatted in all lowercase.
    static final String
    The name of the standard attribute that holds the objectclass values for the entry, formatted in camelCase.
    static final String
    The name of the configuration attribute that holds the set of objectclass definitions in the server schema, formatted in camelCase.
    static final String
    The name of the configuration attribute that holds the set of objectclass definitions in the server schema, formatted in all lowercase.
    static final String
    The name of the attribute in an rebuild task definition that specifies the base DN of the indexes to do the rebuild in.
    static final String
    The name of the attribute in an rebuild task definition that specifies the indexes to rebuild.
    static final String
    The name of the attribute in an rebuild task definition that specifies the degraded index which needs to be clear.
    static final String
    The name of the attribute in an rebuild task definition that specifies the temporary scratch file.
    static final String
    The name of the configuration attribute that holds the recurring task ID for a recurring task that may be associated with a task.
    static final String
    The name of the configuration attribute that holds the schedule for a recurring task.
    static final String
    The name of the configuration attribute that indicates whether the Directory Server should be restarted instead of shut down.
    static final String
    The name of the configuration attribute that specifies the set of subordinate base DNs that should be used for non-base-level searches against the root DSE.
    static final String
    The name of the configuration attribute that indicates whether the root DSE should treat all attributes as user attributes or if it should treat them as per their definition in the schema.
    static final String
    The name of the configuration attribute that specifies the location(s) of the entries used to publish the Directory Server schema information.
    static final String
    The name of the configuration attribute that indicates whether the subschema entry should treat all attributes as user attributes or if it should treat them as per their definition in the schema.
    static final String
    The name of the configuration attribute that holds a message that may be provided for the reason the Directory Server has been requested to shutdown.
    static final String
    The name of the configuration attribute that holds the actual start time for a task.
    static final String
    The name of the attribute in the add schema file task definition that specifies the name of the schema file to be added.
    static final String
    The name of the attribute in a backup or restore task definition that specifies the backend ID for a backend that should be backed up or restored.
    static final String
    The name of the attribute in a backup task definition that specifies a property of the storage.
    static final String
    The name of the configuration attribute that holds the name of the class providing the task logic.
    static final String
    The name of the configuration attribute that holds the completion time for a task.
    static final String
    The name of the attribute in a purge conflicts historical task definition that specifies whether this task run has been able to complete in the allocated time.
    static final String
    The name of the attribute in a purge conflicts historical task definition that specifies the number of values that have been purged.
    static final String
    The name of the attribute in a purge conflicts historical task definition that specifies the base dn related to the synchonization domain to purge.
    static final String
    The name of the attribute in a purge conflicts historical task definition that specifies the oldest CSN that has been purged.
    static final String
    The name of the attribute in a purge conflicts historical task definition that specifies the newest CSN that has been purged.
    static final String
    The name of the attribute in a purge conflicts historical task definition that specifies the maximum duration of the task.
    static final String
    The name of the configuration attribute that holds task IDs of any tasks on which a given task is dependent.
    static final String
    The name of the attribute in an export task definition that specifies whether the export process should append to an existing LDIF file rather than overwrite it.
    static final String
    The name of the attribute in an export task definition that specifies the backend ID for the backend from which the data should be exported.
    static final String
    The name of the attribute in an export task definition that specifies whether the LDIF data should be compressed as it is exported.
    static final String
    The name of the attribute in an export task definition that specifies whether the LDIF data should be encrypted as it is exported.
    static final String
    The name of the attribute in an export task definition that specifies an attribute that should be excluded from the LDIF export.
    static final String
    The name of the attribute in an export task definition that specifies the base DN of a branch that should be excluded from the LDIF export.
    static final String
    The name of the attribute in an export task definition that specifies a search filter that may be used to control which entries are excluded from the export.
    static final String
    The name of the attribute in an export task definition that specifies an attribute that should be included in the LDIF export.
    static final String
    The name of the attribute in an export task definition that specifies the base DN of a branch that should be included in the LDIF export.
    static final String
    The name of the attribute in an export task definition that specifies a search filter that may be used to control which entries are included in the export.
    static final String
    The name of the attribute in an export task definition that specifies that operational attributes have to be included.
    static final String
    The name of the attribute in an export task definition that specifies the path to the file to which the LDIF data should be written.
    static final String
    The name of the attribute in an export task definition that specifies whether a signed hash of the export data should be appended to the LDIF file.
    static final String
    The name of the attribute in an export task definition that specifies the column at which long lines should be wrapped.
    static final String
    The name of the configuration attribute that holds the indication of what to do in the event that one of the dependencies for a task has failed.
    static final String
    The name of the configuration attribute that holds the task ID for a task.
    static final String
    The name of the attribute in an initialize task definition that specifies the base dn related to the synchonization domain to initialize.
    static final String
    The name of the attribute in an initialize target task definition that specifies the scope in terms of servers to initialize.
    static final String
    The name of the attribute in an initialize target task definition that specifies the scope in terms of servers to initialize.
    static final String
    The name of the attribute in an initialize target task definition that specifies the source in terms of source server from which to initialize.
    static final String
    The name of the attribute in an initialize target task definition that specifies the base dn related to the synchonization domain to initialize.
    static final String
    The name of the attribute in an initialize target task definition that specifies the scope in terms of servers to initialize.
    static final String
    The name of the configuration attribute that holds the set of log messages for a task.
    static final String
    The name of the configuration attribute that holds the set of e-mail addresses of the users to notify when a task has completed.
    static final String
    The name of the configuration attribute that holds the set of e-mail addresses of the users to notify if a task fails.
    static final String
    The name of the attribute in a purge task definition that specifies to which backend purge should apply.
    static final String
    The name of the attribute in a purge task definition that specifies the backup ID for a backup that should be purged.
    static final String
    The name of the attribute in a purge task definition that specifies whether ATTR_TASK_PURGE_OLDER_THAN may purge all the backups of the backends or keep the latest ones for each backend in all the cases.
    static final String
    The name of the attribute in a purge task definition that specifies the number of backups to keep safe.
    static final String
    The name of the attribute in a purge task definition that specifies the duration threshold above which backups are purged.
    static final String
    The name of the attribute in a reset change number task that specifies the basedn where the csn applies.
    static final String
    The name of the attribute in a reset change number task that specifies the csn of the new first change.
    static final String
    The name of the attribute in a reset change number task that specifies the change number for the first change.
    static final String
    The name of the configuration attribute that holds the scheduled start time for a task.
    static final String
    The name of the attribute containing the baseDn related to the replication domain to which applies the task.
    static final String
    The name of the configuration attribute that holds the current state for a task.
    static final String
    The base name (with no path information) of the directory that will hold the archived versions of previous configurations.
    static final int
    The default value that will be used for the server size limit if no other value is given.
    static final String
    The default attribute name for holding certificate information if no value is specified.
    static final Dn
    The DN of the entry that will serve as the base for all Directory Server backends.
    static final Dn
    The DN of the entry that will serve as the root for the Directory Server configuration.
    static final Dn
    The DN of the entry that will serve as the default root for the Directory Server schema information, unless an alternate location is defined in the configuration.
    static final Dn
    The DN of the entry that will hold the configuration for the Directory Server entry cache.
    static final Dn
    The DN of the entry that will serve as the base for all Directory Server replication changelog information.
    static final Dn
    The DN of the entry that will serve as the base for all Directory Server monitor information.
    static final Dn
    The DN of the entry that will serve as the base for all Directory Server task information.
    static final String
    The name of the environment variable that the Directory Server may check to determine the installation root.
    static final String
    The name (with no path information) of the file in the schema directory that will contain user-defined schema definitions.
    static final Path
    The path to the directory that should serve as the MakeLDIF resource directory.
    static final String
    The prefix that will be applied to all custom attribute and objectclass names in the Directory Server configuration.
    static final String
    The name of the objectclass that will be used for a Directory Server recurring task definition.
    static final String
    The name of the objectclass that will be used for a Directory Server task definition.
    static final String
    The name of the operational attribute that will appear in a user's entry to indicate whether the account has been disabled.
    static final String
    The name of the operational attribute that may appear in a user's entry to indicate when that account will expire (and therefore may no longer be used to authenticate).
    static final String
    The name of the operational attribute that will appear in an entry to indicate when it was created.
    static final String
    The name of the create timestamp attribute, in all lowercase characters.
    static final String
    The name of the creatorsName attribute, in all lowercase characters.
    static final String
    The name of the modifiersName attribute, in all lowercase characters.
    static final String
    The name of the modify timestamp attribute, in all lowercase characters.
    static final String
    The name of the operational attribute that will appear in a user's entry to specify the set of privileges assigned to that user.
    static final String
    The name of the operational attribute which will be put in user's entry in order to cache a copy of their password for pass through authentication.
    static final String
    The name of the operational attribute which will be put in user's entry in order to record the time at which their password was cached for pass through authentication.
    static final String
    The name of the operational attribute that will appear in a user's entry to indicate the time that the user changed their password as a result of a policy-wide required change.
    static final String
    The name of the operational attribute that will appear in a user's entry to indicate the time that the password was last changed.
    static final String
    The name of the operational attribute that specifies the time that an authentication attempt failed.
    static final String
    The name of the operational attribute that will appear in a user's entry to indicate the times of the grace logins by that user.
    static final String
    The name of the operational attribute that is used to maintain the password history for the user, in all lowercase characters.
    static final String
    The name of the operational attribute that specifies the time that the account was locked due to too many failed attempts.
    static final String
    The name of the operational attribute that will appear in a user's entry to indicate which password policy should be used.
    static final String
    The name of the operational attribute that will appear in a user's entry to indicate whether the password must be changed at the next authentication.
    static final String
    The name of the operational attribute that indicates when the user was first warned about an upcoming password expiration.
    static final String
    The name of the operational attribute that may be included in user entries to specify an idle time limit to be applied for that user.
    static final String
    The name of the operational attribute that may be included in user entries to specify a cursor entry limit for that user.
    static final String
    The name of the operational attribute that may be included in user entries to specify a size limit to be applied for that user.
    static final String
    The name of the operational attribute that may be included in user entries to specify a time limit to be applied for that user.
    static final String
    Used to specify that the rebuild all boolean should be set.
    static final String
    Used to specify that the rebuild degraded boolean should be set.
    static final String
    The string representation of the RDN that should be used for the entry that is the immediate parent of all recurring task definitions in the server.
    static final String
    The string representation of the RDN that should be used for the entry that is the immediate parent of all scheduled task definitions in the server.
  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • NAME_PREFIX_CFG

      public static final String NAME_PREFIX_CFG
      The prefix that will be applied to all custom attribute and objectclass names in the Directory Server configuration.
      See Also:
    • ATTR_DESCRIPTION

      public static final String ATTR_DESCRIPTION
      The name of the attribute that is used to hold the description of an objectclass.
      See Also:
    • ATTR_ROOTDSE_SHOW_ALL_ATTRIBUTES

      public static final String ATTR_ROOTDSE_SHOW_ALL_ATTRIBUTES
      The name of the configuration attribute that indicates whether the root DSE should treat all attributes as user attributes or if it should treat them as per their definition in the schema.
      See Also:
    • ATTR_SCHEMA_SHOW_ALL_ATTRIBUTES

      public static final String ATTR_SCHEMA_SHOW_ALL_ATTRIBUTES
      The name of the configuration attribute that indicates whether the subschema entry should treat all attributes as user attributes or if it should treat them as per their definition in the schema.
      See Also:
    • ATTR_ATTRIBUTE_TYPES

      public static final String ATTR_ATTRIBUTE_TYPES
      The name of the configuration attribute that holds the set of attribute type definitions in the server schema, formatted in camelCase.
      See Also:
    • ATTR_ATTRIBUTE_TYPES_LC

      public static final String ATTR_ATTRIBUTE_TYPES_LC
      The name of the configuration attribute that holds the set of attribute type definitions in the server schema, formatted in all lowercase.
      See Also:
    • ATTR_BACKEND_BASE_DN

      public static final String ATTR_BACKEND_BASE_DN
      The name of the configuration attribute that specifies the base DN(s) for a backend.
      See Also:
    • ATTR_BACKEND_CLASS

      public static final String ATTR_BACKEND_CLASS
      The name of the configuration attribute that holds the fully-qualified name of the Java class for a backend implementation.
      See Also:
    • ATTR_BACKEND_ENABLED

      public static final String ATTR_BACKEND_ENABLED
      The name of the configuration attribute that indicates whether a particular backend is enabled.
      See Also:
    • ATTR_BACKEND_ID

      public static final String ATTR_BACKEND_ID
      The name of the configuration attribute that specifies the unique ID for a backend.
      See Also:
    • ATTR_BACKEND_WRITABILITY_MODE

      public static final String ATTR_BACKEND_WRITABILITY_MODE
      The name of the configuration attribute that specifies the writability mode for a backend.
      See Also:
    • ATTR_BACKUP_LOCATION

      public static final String ATTR_BACKUP_LOCATION
      The name of the configuration attribute that holds the location of the backup directory.
      See Also:
    • ATTR_BACKUP_ID

      public static final String ATTR_BACKUP_ID
      The name of the configuration attribute that holds the backup ID.
      See Also:
    • ATTR_DEFAULT_ROOT_PRIVILEGE_NAME

      public static final String ATTR_DEFAULT_ROOT_PRIVILEGE_NAME
      The name of the configuration attribute that specifies the set of privileges that root users should automatically be granted in the server.
      See Also:
    • ATTR_DIT_CONTENT_RULES

      public static final String ATTR_DIT_CONTENT_RULES
      The name of the attribute that is used to hold the DIT content rule definitions in the server schema, formatted in camelCase.
      See Also:
    • ATTR_DIT_CONTENT_RULES_LC

      public static final String ATTR_DIT_CONTENT_RULES_LC
      The name of the attribute that is used to hold the DIT content rule definitions in the server schema, formatted in all lowercase.
      See Also:
    • ATTR_DIT_STRUCTURE_RULES

      public static final String ATTR_DIT_STRUCTURE_RULES
      The name of the attribute that is used to hold the DIT structure rule definitions in the server schema, formatted in camelCase.
      See Also:
    • ATTR_DIT_STRUCTURE_RULES_LC

      public static final String ATTR_DIT_STRUCTURE_RULES_LC
      The name of the attribute that is used to hold the DIT structure rule definitions in the server schema, formatted in all lowercase.
      See Also:
    • ATTR_LDAP_SYNTAXES

      public static final String ATTR_LDAP_SYNTAXES
      The name of the configuration attribute that holds the set of attribute syntax definitions in the server schema, formatted in camelCase.
      See Also:
    • ATTR_LDAP_SYNTAXES_LC

      public static final String ATTR_LDAP_SYNTAXES_LC
      The name of the configuration attribute that holds the set of attribute syntax definitions in the server schema, formatted in all lowercase.
      See Also:
    • ATTR_MATCHING_RULE_USE

      public static final String ATTR_MATCHING_RULE_USE
      The name of the configuration attribute that holds the set of matching rule use definitions in the server schema, formatted in camelCase.
      See Also:
    • ATTR_MATCHING_RULE_USE_LC

      public static final String ATTR_MATCHING_RULE_USE_LC
      The name of the configuration attribute that holds the set of matching rule use definitions in the server schema, formatted in all lowercase.
      See Also:
    • ATTR_NAME_FORMS

      public static final String ATTR_NAME_FORMS
      The name of the attribute that is used to hold the name form definitions in the server schema, formatted in camelCase.
      See Also:
    • ATTR_NAME_FORMS_LC

      public static final String ATTR_NAME_FORMS_LC
      The name of the attribute that is used to hold the name form definitions in the server schema, formatted in all lowercase.
      See Also:
    • ATTR_OBJECTCLASS

      public static final String ATTR_OBJECTCLASS
      The name of the standard attribute that holds the objectclass values for the entry, formatted in camelCase.
      See Also:
    • ATTR_OBJECTCLASSES

      public static final String ATTR_OBJECTCLASSES
      The name of the configuration attribute that holds the set of objectclass definitions in the server schema, formatted in camelCase.
      See Also:
    • ATTR_OBJECTCLASSES_LC

      public static final String ATTR_OBJECTCLASSES_LC
      The name of the configuration attribute that holds the set of objectclass definitions in the server schema, formatted in all lowercase.
      See Also:
    • ATTR_RECURRING_TASK_SCHEDULE

      public static final String ATTR_RECURRING_TASK_SCHEDULE
      The name of the configuration attribute that holds the schedule for a recurring task.
      See Also:
    • ATTR_RECURRING_TASK_ID

      public static final String ATTR_RECURRING_TASK_ID
      The name of the configuration attribute that holds the recurring task ID for a recurring task that may be associated with a task.
      See Also:
    • ATTR_RESTART_SERVER

      public static final String ATTR_RESTART_SERVER
      The name of the configuration attribute that indicates whether the Directory Server should be restarted instead of shut down.
      See Also:
    • ATTR_ROOT_DSE_SUBORDINATE_BASE_DN

      public static final String ATTR_ROOT_DSE_SUBORDINATE_BASE_DN
      The name of the configuration attribute that specifies the set of subordinate base DNs that should be used for non-base-level searches against the root DSE.
      See Also:
    • ATTR_SCHEMA_ENTRY_DN

      public static final String ATTR_SCHEMA_ENTRY_DN
      The name of the configuration attribute that specifies the location(s) of the entries used to publish the Directory Server schema information.
      See Also:
    • ATTR_SHUTDOWN_MESSAGE

      public static final String ATTR_SHUTDOWN_MESSAGE
      The name of the configuration attribute that holds a message that may be provided for the reason the Directory Server has been requested to shutdown.
      See Also:
    • DEFAULT_SIZE_LIMIT

      public static final int DEFAULT_SIZE_LIMIT
      The default value that will be used for the server size limit if no other value is given.
      See Also:
    • ATTR_AUTHZ_GLOBAL_ACI

      public static final String ATTR_AUTHZ_GLOBAL_ACI
      The name of the configuration attribute that specifies a global attribute access control instruction.
      See Also:
    • ATTR_TASK_ACTUAL_START_TIME

      public static final String ATTR_TASK_ACTUAL_START_TIME
      The name of the configuration attribute that holds the actual start time for a task.
      See Also:
    • ATTR_TASK_CLASS

      public static final String ATTR_TASK_CLASS
      The name of the configuration attribute that holds the name of the class providing the task logic.
      See Also:
    • ATTR_TASK_COMPLETION_TIME

      public static final String ATTR_TASK_COMPLETION_TIME
      The name of the configuration attribute that holds the completion time for a task.
      See Also:
    • ATTR_TASK_DEPENDENCY_IDS

      public static final String ATTR_TASK_DEPENDENCY_IDS
      The name of the configuration attribute that holds task IDs of any tasks on which a given task is dependent.
      See Also:
    • ATTR_TASK_FAILED_DEPENDENCY_ACTION

      public static final String ATTR_TASK_FAILED_DEPENDENCY_ACTION
      The name of the configuration attribute that holds the indication of what to do in the event that one of the dependencies for a task has failed.
      See Also:
    • ATTR_TASK_LOG_MESSAGES

      public static final String ATTR_TASK_LOG_MESSAGES
      The name of the configuration attribute that holds the set of log messages for a task.
      See Also:
    • ATTR_TASK_NOTIFY_ON_COMPLETION

      public static final String ATTR_TASK_NOTIFY_ON_COMPLETION
      The name of the configuration attribute that holds the set of e-mail addresses of the users to notify when a task has completed.
      See Also:
    • ATTR_TASK_NOTIFY_ON_ERROR

      public static final String ATTR_TASK_NOTIFY_ON_ERROR
      The name of the configuration attribute that holds the set of e-mail addresses of the users to notify if a task fails.
      See Also:
    • ATTR_TASK_SCHEDULED_START_TIME

      public static final String ATTR_TASK_SCHEDULED_START_TIME
      The name of the configuration attribute that holds the scheduled start time for a task.
      See Also:
    • ATTR_TASK_ID

      public static final String ATTR_TASK_ID
      The name of the configuration attribute that holds the task ID for a task.
      See Also:
    • ATTR_TASK_STATE

      public static final String ATTR_TASK_STATE
      The name of the configuration attribute that holds the current state for a task.
      See Also:
    • DEFAULT_VALIDATION_CERT_ATTRIBUTE

      public static final String DEFAULT_VALIDATION_CERT_ATTRIBUTE
      The default attribute name for holding certificate information if no value is specified.
      See Also:
    • CONFIG_ARCHIVE_DIR_NAME

      public static final String CONFIG_ARCHIVE_DIR_NAME
      The base name (with no path information) of the directory that will hold the archived versions of previous configurations.
      See Also:
    • DN_CONFIG_ROOT

      public static final Dn DN_CONFIG_ROOT
      The DN of the entry that will serve as the root for the Directory Server configuration.
    • DN_BACKEND_BASE

      public static final Dn DN_BACKEND_BASE
      The DN of the entry that will serve as the base for all Directory Server backends.
    • DN_DEFAULT_SCHEMA_ROOT

      public static final Dn DN_DEFAULT_SCHEMA_ROOT
      The DN of the entry that will serve as the default root for the Directory Server schema information, unless an alternate location is defined in the configuration.
    • DN_ENTRY_CACHE_BASE

      public static final Dn DN_ENTRY_CACHE_BASE
      The DN of the entry that will hold the configuration for the Directory Server entry cache.
    • DN_MONITOR_ROOT

      public static final Dn DN_MONITOR_ROOT
      The DN of the entry that will serve as the base for all Directory Server monitor information.
    • DN_MONITOR_CHANGELOG

      public static final Dn DN_MONITOR_CHANGELOG
      The DN of the entry that will serve as the base for all Directory Server replication changelog information.
    • DN_TASK_ROOT

      public static final Dn DN_TASK_ROOT
      The DN of the entry that will serve as the base for all Directory Server task information.
    • ENV_VAR_INSTALL_ROOT

      public static final String ENV_VAR_INSTALL_ROOT
      The name of the environment variable that the Directory Server may check to determine the installation root.
      See Also:
    • OC_RECURRING_TASK

      public static final String OC_RECURRING_TASK
      The name of the objectclass that will be used for a Directory Server recurring task definition.
      See Also:
    • OC_TASK

      public static final String OC_TASK
      The name of the objectclass that will be used for a Directory Server task definition.
      See Also:
    • OP_ATTR_ACCOUNT_DISABLED

      public static final String OP_ATTR_ACCOUNT_DISABLED
      The name of the operational attribute that will appear in a user's entry to indicate whether the account has been disabled.
      See Also:
    • OP_ATTR_ACCOUNT_EXPIRATION_TIME

      public static final String OP_ATTR_ACCOUNT_EXPIRATION_TIME
      The name of the operational attribute that may appear in a user's entry to indicate when that account will expire (and therefore may no longer be used to authenticate).
      See Also:
    • OP_ATTR_CREATE_TIMESTAMP

      public static final String OP_ATTR_CREATE_TIMESTAMP
      The name of the operational attribute that will appear in an entry to indicate when it was created.
      See Also:
    • OP_ATTR_CREATE_TIMESTAMP_LC

      public static final String OP_ATTR_CREATE_TIMESTAMP_LC
      The name of the create timestamp attribute, in all lowercase characters.
      See Also:
    • OP_ATTR_CREATORS_NAME_LC

      public static final String OP_ATTR_CREATORS_NAME_LC
      The name of the creatorsName attribute, in all lowercase characters.
      See Also:
    • OP_ATTR_MODIFIERS_NAME_LC

      public static final String OP_ATTR_MODIFIERS_NAME_LC
      The name of the modifiersName attribute, in all lowercase characters.
      See Also:
    • OP_ATTR_MODIFY_TIMESTAMP_LC

      public static final String OP_ATTR_MODIFY_TIMESTAMP_LC
      The name of the modify timestamp attribute, in all lowercase characters.
      See Also:
    • OP_ATTR_PRIVILEGE_NAME

      public static final String OP_ATTR_PRIVILEGE_NAME
      The name of the operational attribute that will appear in a user's entry to specify the set of privileges assigned to that user.
      See Also:
    • OP_ATTR_PWPOLICY_CHANGED_TIME

      public static final String OP_ATTR_PWPOLICY_CHANGED_TIME
      The name of the operational attribute that will appear in a user's entry to indicate the time that the password was last changed.
      See Also:
    • OP_ATTR_PWPOLICY_GRACE_LOGIN_TIME

      public static final String OP_ATTR_PWPOLICY_GRACE_LOGIN_TIME
      The name of the operational attribute that will appear in a user's entry to indicate the times of the grace logins by that user.
      See Also:
    • OP_ATTR_PWPOLICY_FAILURE_TIME

      public static final String OP_ATTR_PWPOLICY_FAILURE_TIME
      The name of the operational attribute that specifies the time that an authentication attempt failed.
      See Also:
    • OP_ATTR_PWPOLICY_HISTORY_LC

      public static final String OP_ATTR_PWPOLICY_HISTORY_LC
      The name of the operational attribute that is used to maintain the password history for the user, in all lowercase characters.
      See Also:
    • OP_ATTR_PWPOLICY_LOCKED_TIME

      public static final String OP_ATTR_PWPOLICY_LOCKED_TIME
      The name of the operational attribute that specifies the time that the account was locked due to too many failed attempts.
      See Also:
    • OP_ATTR_PWPOLICY_CHANGED_BY_REQUIRED_TIME

      public static final String OP_ATTR_PWPOLICY_CHANGED_BY_REQUIRED_TIME
      The name of the operational attribute that will appear in a user's entry to indicate the time that the user changed their password as a result of a policy-wide required change.
      See Also:
    • OP_ATTR_PWPOLICY_RESET_REQUIRED

      public static final String OP_ATTR_PWPOLICY_RESET_REQUIRED
      The name of the operational attribute that will appear in a user's entry to indicate whether the password must be changed at the next authentication.
      See Also:
    • OP_ATTR_PWPOLICY_POLICY_DN

      public static final String OP_ATTR_PWPOLICY_POLICY_DN
      The name of the operational attribute that will appear in a user's entry to indicate which password policy should be used.
      See Also:
    • OP_ATTR_PWPOLICY_WARNED_TIME

      public static final String OP_ATTR_PWPOLICY_WARNED_TIME
      The name of the operational attribute that indicates when the user was first warned about an upcoming password expiration.
      See Also:
    • OP_ATTR_USER_IDLE_TIME_LIMIT

      public static final String OP_ATTR_USER_IDLE_TIME_LIMIT
      The name of the operational attribute that may be included in user entries to specify an idle time limit to be applied for that user.
      See Also:
    • OP_ATTR_USER_SIZE_LIMIT

      public static final String OP_ATTR_USER_SIZE_LIMIT
      The name of the operational attribute that may be included in user entries to specify a size limit to be applied for that user.
      See Also:
    • OP_ATTR_USER_TIME_LIMIT

      public static final String OP_ATTR_USER_TIME_LIMIT
      The name of the operational attribute that may be included in user entries to specify a time limit to be applied for that user.
      See Also:
    • OP_ATTR_USER_MAX_CANDIDATE_SET_SIZE

      public static final String OP_ATTR_USER_MAX_CANDIDATE_SET_SIZE
      The name of the operational attribute that may be included in user entries to specify a cursor entry limit for that user.
      See Also:
    • OP_ATTR_PTAPOLICY_CACHED_PASSWORD

      public static final String OP_ATTR_PTAPOLICY_CACHED_PASSWORD
      The name of the operational attribute which will be put in user's entry in order to cache a copy of their password for pass through authentication.
      See Also:
    • OP_ATTR_PTAPOLICY_CACHED_PASSWORD_TIME

      public static final String OP_ATTR_PTAPOLICY_CACHED_PASSWORD_TIME
      The name of the operational attribute which will be put in user's entry in order to record the time at which their password was cached for pass through authentication.
      See Also:
    • MAKELDIF_RESOURCES_DIR

      public static final Path MAKELDIF_RESOURCES_DIR
      The path to the directory that should serve as the MakeLDIF resource directory. It is relative to the server root.
    • FILE_USER_SCHEMA_ELEMENTS

      public static final String FILE_USER_SCHEMA_ELEMENTS
      The name (with no path information) of the file in the schema directory that will contain user-defined schema definitions.
      See Also:
    • RECURRING_TASK_BASE_RDN

      public static final String RECURRING_TASK_BASE_RDN
      The string representation of the RDN that should be used for the entry that is the immediate parent of all recurring task definitions in the server.
      See Also:
    • SCHEDULED_TASK_BASE_RDN

      public static final String SCHEDULED_TASK_BASE_RDN
      The string representation of the RDN that should be used for the entry that is the immediate parent of all scheduled task definitions in the server.
      See Also:
    • ATTR_IMPORT_LDIF_FILE

      public static final String ATTR_IMPORT_LDIF_FILE
      The name of the attribute in an import task definition that specifies the path to the file containing the LDIF data to import.
      See Also:
    • ATTR_IMPORT_TEMPLATE_FILE

      public static final String ATTR_IMPORT_TEMPLATE_FILE
      The name of the attribute in an import task definition that specifies the path to the file containing the template data to import.
      See Also:
    • ATTR_IMPORT_RANDOM_SEED

      public static final String ATTR_IMPORT_RANDOM_SEED
      The name of the attribute in an import task definition that specifies the random seed to be used when we pass a template file to the import.
      See Also:
    • ATTR_IMPORT_THREAD_COUNT

      public static final String ATTR_IMPORT_THREAD_COUNT
      The name of the attribute in an import task definition that specifies the thread count to be used during the import.
      See Also:
    • ATTR_IMPORT_BACKEND_ID

      public static final String ATTR_IMPORT_BACKEND_ID
      The name of the attribute in an import task definition that specifies the backend ID for the backend into which the date should be imported.
      See Also:
    • ATTR_IMPORT_INCLUDE_BRANCH

      public static final String ATTR_IMPORT_INCLUDE_BRANCH
      The name of the attribute in an import task definition that specifies the base DN of a branch that should be included in the LDIF import.
      See Also:
    • ATTR_IMPORT_EXCLUDE_BRANCH

      public static final String ATTR_IMPORT_EXCLUDE_BRANCH
      The name of the attribute in an import task definition that specifies the base DN of a branch that should be excluded from the LDIF import.
      See Also:
    • ATTR_IMPORT_INCLUDE_ATTRIBUTE

      public static final String ATTR_IMPORT_INCLUDE_ATTRIBUTE
      The name of the attribute in an import task definition that specifies an attribute that should be included in the LDIF import.
      See Also:
    • ATTR_IMPORT_EXCLUDE_ATTRIBUTE

      public static final String ATTR_IMPORT_EXCLUDE_ATTRIBUTE
      The name of the attribute in an import task definition that specifies an attribute that should be excluded from the LDIF import.
      See Also:
    • ATTR_IMPORT_INCLUDE_FILTER

      public static final String ATTR_IMPORT_INCLUDE_FILTER
      The name of the attribute in an import task definition that specifies a search filter that may be used to control which entries are included in the import.
      See Also:
    • ATTR_IMPORT_EXCLUDE_FILTER

      public static final String ATTR_IMPORT_EXCLUDE_FILTER
      The name of the attribute in an import task definition that specifies a search filter that may be used to control which entries are excluded from the import.
      See Also:
    • ATTR_IMPORT_REJECT_FILE

      public static final String ATTR_IMPORT_REJECT_FILE
      The name of the attribute in an import task definition that specifies the path to a file into which rejected entries may be written if they are not accepted during the import process.
      See Also:
    • ATTR_IMPORT_SKIP_FILE

      public static final String ATTR_IMPORT_SKIP_FILE
      The name of the attribute in an import task definition that specifies the path to a file into which skipped entries may be written if they do not match criteria during the import process.
      See Also:
    • ATTR_IMPORT_OVERWRITE

      public static final String ATTR_IMPORT_OVERWRITE
      The name of the attribute in an import task definition that specifies whether to overwrite an existing rejects and/or skip file when performing an LDIF import rather than appending to it.
      See Also:
    • ATTR_IMPORT_SKIP_SCHEMA_VALIDATION

      public static final String ATTR_IMPORT_SKIP_SCHEMA_VALIDATION
      The name of the attribute in an import task definition that specifies whether to skip schema validation during the import.
      See Also:
    • ATTR_IMPORT_IS_COMPRESSED

      public static final String ATTR_IMPORT_IS_COMPRESSED
      The name of the attribute in an import task definition that specifies whether the LDIF file containing the data to import is compressed.
      See Also:
    • ATTR_IMPORT_IS_ENCRYPTED

      public static final String ATTR_IMPORT_IS_ENCRYPTED
      The name of the attribute in an import task definition that specifies whether the LDIF file containing the data to import is encrypted.
      See Also:
    • ATTR_IMPORT_TMP_DIRECTORY

      public static final String ATTR_IMPORT_TMP_DIRECTORY
      The name of the attribute in an import task definition that specifies the temp directory path.
      See Also:
    • ATTR_TASK_INITIALIZE_DOMAIN_DN

      public static final String ATTR_TASK_INITIALIZE_DOMAIN_DN
      The name of the attribute in an initialize task definition that specifies the base dn related to the synchonization domain to initialize.
      See Also:
    • ATTR_TASK_INITIALIZE_SOURCE

      public static final String ATTR_TASK_INITIALIZE_SOURCE
      The name of the attribute in an initialize target task definition that specifies the source in terms of source server from which to initialize.
      See Also:
    • ATTR_TASK_INITIALIZE_TARGET_DOMAIN_DN

      public static final String ATTR_TASK_INITIALIZE_TARGET_DOMAIN_DN
      The name of the attribute in an initialize target task definition that specifies the base dn related to the synchonization domain to initialize.
      See Also:
    • ATTR_TASK_INITIALIZE_TARGET_SCOPE

      public static final String ATTR_TASK_INITIALIZE_TARGET_SCOPE
      The name of the attribute in an initialize target task definition that specifies the scope in terms of servers to initialize.
      See Also:
    • ATTR_TASK_INITIALIZE_LEFT

      public static final String ATTR_TASK_INITIALIZE_LEFT
      The name of the attribute in an initialize target task definition that specifies the scope in terms of servers to initialize.
      See Also:
    • ATTR_TASK_INITIALIZE_DONE

      public static final String ATTR_TASK_INITIALIZE_DONE
      The name of the attribute in an initialize target task definition that specifies the scope in terms of servers to initialize.
      See Also:
    • ATTR_TASK_EXPORT_LDIF_FILE

      public static final String ATTR_TASK_EXPORT_LDIF_FILE
      The name of the attribute in an export task definition that specifies the path to the file to which the LDIF data should be written.
      See Also:
    • ATTR_TASK_EXPORT_APPEND_TO_LDIF

      public static final String ATTR_TASK_EXPORT_APPEND_TO_LDIF
      The name of the attribute in an export task definition that specifies whether the export process should append to an existing LDIF file rather than overwrite it.
      See Also:
    • ATTR_TASK_EXPORT_BACKEND_ID

      public static final String ATTR_TASK_EXPORT_BACKEND_ID
      The name of the attribute in an export task definition that specifies the backend ID for the backend from which the data should be exported.
      See Also:
    • ATTR_TASK_EXPORT_INCLUDE_BRANCH

      public static final String ATTR_TASK_EXPORT_INCLUDE_BRANCH
      The name of the attribute in an export task definition that specifies the base DN of a branch that should be included in the LDIF export.
      See Also:
    • ATTR_TASK_EXPORT_EXCLUDE_BRANCH

      public static final String ATTR_TASK_EXPORT_EXCLUDE_BRANCH
      The name of the attribute in an export task definition that specifies the base DN of a branch that should be excluded from the LDIF export.
      See Also:
    • ATTR_TASK_EXPORT_INCLUDE_ATTRIBUTE

      public static final String ATTR_TASK_EXPORT_INCLUDE_ATTRIBUTE
      The name of the attribute in an export task definition that specifies an attribute that should be included in the LDIF export.
      See Also:
    • ATTR_TASK_EXPORT_EXCLUDE_ATTRIBUTE

      public static final String ATTR_TASK_EXPORT_EXCLUDE_ATTRIBUTE
      The name of the attribute in an export task definition that specifies an attribute that should be excluded from the LDIF export.
      See Also:
    • ATTR_TASK_EXPORT_INCLUDE_FILTER

      public static final String ATTR_TASK_EXPORT_INCLUDE_FILTER
      The name of the attribute in an export task definition that specifies a search filter that may be used to control which entries are included in the export.
      See Also:
    • ATTR_TASK_EXPORT_EXCLUDE_FILTER

      public static final String ATTR_TASK_EXPORT_EXCLUDE_FILTER
      The name of the attribute in an export task definition that specifies a search filter that may be used to control which entries are excluded from the export.
      See Also:
    • ATTR_TASK_EXPORT_WRAP_COLUMN

      public static final String ATTR_TASK_EXPORT_WRAP_COLUMN
      The name of the attribute in an export task definition that specifies the column at which long lines should be wrapped.
      See Also:
    • ATTR_TASK_EXPORT_INCLUDE_OPERATIONAL_ATTRIBUTES

      public static final String ATTR_TASK_EXPORT_INCLUDE_OPERATIONAL_ATTRIBUTES
      The name of the attribute in an export task definition that specifies that operational attributes have to be included.
      See Also:
    • ATTR_TASK_EXPORT_COMPRESS_LDIF

      public static final String ATTR_TASK_EXPORT_COMPRESS_LDIF
      The name of the attribute in an export task definition that specifies whether the LDIF data should be compressed as it is exported.
      See Also:
    • ATTR_TASK_EXPORT_ENCRYPT_LDIF

      public static final String ATTR_TASK_EXPORT_ENCRYPT_LDIF
      The name of the attribute in an export task definition that specifies whether the LDIF data should be encrypted as it is exported.
      See Also:
    • ATTR_TASK_EXPORT_SIGN_HASH

      public static final String ATTR_TASK_EXPORT_SIGN_HASH
      The name of the attribute in an export task definition that specifies whether a signed hash of the export data should be appended to the LDIF file.
      See Also:
    • ATTR_TASK_BACKUP_BACKEND_ID

      public static final String ATTR_TASK_BACKUP_BACKEND_ID
      The name of the attribute in a backup or restore task definition that specifies the backend ID for a backend that should be backed up or restored.
      See Also:
    • ATTR_TASK_BACKUP_STORAGE_PROPERTY

      public static final String ATTR_TASK_BACKUP_STORAGE_PROPERTY
      The name of the attribute in a backup task definition that specifies a property of the storage.
      See Also:
    • ATTR_TASK_PURGE_BACKUP_ID

      public static final String ATTR_TASK_PURGE_BACKUP_ID
      The name of the attribute in a purge task definition that specifies the backup ID for a backup that should be purged.
      See Also:
    • ATTR_TASK_PURGE_KEEP_COUNT

      public static final String ATTR_TASK_PURGE_KEEP_COUNT
      The name of the attribute in a purge task definition that specifies the number of backups to keep safe.
      See Also:
    • ATTR_TASK_PURGE_OLDER_THAN

      public static final String ATTR_TASK_PURGE_OLDER_THAN
      The name of the attribute in a purge task definition that specifies the duration threshold above which backups are purged.
      See Also:
    • ATTR_TASK_PURGE_FORCE_OLDER_THAN

      public static final String ATTR_TASK_PURGE_FORCE_OLDER_THAN
      The name of the attribute in a purge task definition that specifies whether ATTR_TASK_PURGE_OLDER_THAN may purge all the backups of the backends or keep the latest ones for each backend in all the cases.
      See Also:
    • ATTR_TASK_PURGE_BACKEND_NAME

      public static final String ATTR_TASK_PURGE_BACKEND_NAME
      The name of the attribute in a purge task definition that specifies to which backend purge should apply.
      See Also:
    • ATTR_TASK_ADDSCHEMAFILE_FILENAME

      public static final String ATTR_TASK_ADDSCHEMAFILE_FILENAME
      The name of the attribute in the add schema file task definition that specifies the name of the schema file to be added.
      See Also:
    • ATTR_REBUILD_BASE_DN

      public static final String ATTR_REBUILD_BASE_DN
      The name of the attribute in an rebuild task definition that specifies the base DN of the indexes to do the rebuild in.
      See Also:
    • ATTR_REBUILD_INDEX

      public static final String ATTR_REBUILD_INDEX
      The name of the attribute in an rebuild task definition that specifies the indexes to rebuild.
      See Also:
    • ATTR_REBUILD_INDEX_CLEARDEGRADEDSTATE

      public static final String ATTR_REBUILD_INDEX_CLEARDEGRADEDSTATE
      The name of the attribute in an rebuild task definition that specifies the degraded index which needs to be clear.
      See Also:
    • ATTR_REBUILD_TMP_DIRECTORY

      public static final String ATTR_REBUILD_TMP_DIRECTORY
      The name of the attribute in an rebuild task definition that specifies the temporary scratch file.
      See Also:
    • REBUILD_ALL

      public static final String REBUILD_ALL
      Used to specify that the rebuild all boolean should be set.
      See Also:
    • REBUILD_DEGRADED

      public static final String REBUILD_DEGRADED
      Used to specify that the rebuild degraded boolean should be set.
      See Also:
    • ATTR_TASK_SET_GENERATION_ID_DOMAIN_DN

      public static final String ATTR_TASK_SET_GENERATION_ID_DOMAIN_DN
      The name of the attribute containing the baseDn related to the replication domain to which applies the task.
      See Also:
    • ATTR_IMPORT_CLEAR_BACKEND

      public static final String ATTR_IMPORT_CLEAR_BACKEND
      The name of the attribute in an import task definition that specifies whether the backend should be cleared before the import.
      See Also:
    • ATTR_TASK_CONFLICTS_HIST_PURGE_DOMAIN_DN

      public static final String ATTR_TASK_CONFLICTS_HIST_PURGE_DOMAIN_DN
      The name of the attribute in a purge conflicts historical task definition that specifies the base dn related to the synchonization domain to purge.
      See Also:
    • ATTR_TASK_CONFLICTS_HIST_PURGE_MAX_DURATION

      public static final String ATTR_TASK_CONFLICTS_HIST_PURGE_MAX_DURATION
      The name of the attribute in a purge conflicts historical task definition that specifies the maximum duration of the task.
      See Also:
    • ATTR_TASK_CONFLICTS_HIST_PURGE_FIRST_CSN

      public static final String ATTR_TASK_CONFLICTS_HIST_PURGE_FIRST_CSN
      The name of the attribute in a purge conflicts historical task definition that specifies the oldest CSN that has been purged.
      See Also:
    • ATTR_TASK_CONFLICTS_HIST_PURGE_LAST_CSN

      public static final String ATTR_TASK_CONFLICTS_HIST_PURGE_LAST_CSN
      The name of the attribute in a purge conflicts historical task definition that specifies the newest CSN that has been purged.
      See Also:
    • ATTR_TASK_CONFLICTS_HIST_PURGE_COMPLETED_IN_TIME

      public static final String ATTR_TASK_CONFLICTS_HIST_PURGE_COMPLETED_IN_TIME
      The name of the attribute in a purge conflicts historical task definition that specifies whether this task run has been able to complete in the allocated time. Only meaningful when "ds-task-state" is COMPLETED_SUCCESSFULLY.
      See Also:
    • ATTR_TASK_CONFLICTS_HIST_PURGE_COUNT

      public static final String ATTR_TASK_CONFLICTS_HIST_PURGE_COUNT
      The name of the attribute in a purge conflicts historical task definition that specifies the number of values that have been purged.
      See Also:
    • ATTR_TASK_RESET_CHANGE_NUMBER_TO

      public static final String ATTR_TASK_RESET_CHANGE_NUMBER_TO
      The name of the attribute in a reset change number task that specifies the change number for the first change.
      See Also:
    • ATTR_TASK_RESET_CHANGE_NUMBER_CSN

      public static final String ATTR_TASK_RESET_CHANGE_NUMBER_CSN
      The name of the attribute in a reset change number task that specifies the csn of the new first change.
      See Also:
    • ATTR_TASK_RESET_CHANGE_NUMBER_BASE_DN

      public static final String ATTR_TASK_RESET_CHANGE_NUMBER_BASE_DN
      The name of the attribute in a reset change number task that specifies the basedn where the csn applies.
      See Also: