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

Class GlobalCfgDefn

java.lang.Object
org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
org.forgerock.opendj.config.ManagedObjectDefinition<GlobalCfgClient,GlobalCfg>
org.forgerock.opendj.server.config.meta.GlobalCfgDefn
public final class GlobalCfgDefn extends ManagedObjectDefinition<GlobalCfgClient,GlobalCfg>
An interface for querying the Global Configuration managed object definition meta information.

The Global Configuration contains properties that affect the overall operation of the OpenDJ.

  • Method Details

    • getInstance

      public static GlobalCfgDefn getInstance()
      Get the Global Configuration configuration definition singleton.
      Returns:
      Returns the Global Configuration configuration definition singleton.

    • createClientConfiguration

      public GlobalCfgClient createClientConfiguration(ManagedObject<? extends GlobalCfgClient> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.
      Specified by:
      createClientConfiguration in class ManagedObjectDefinition<GlobalCfgClient,GlobalCfg>
      Parameters:
      impl - The managed object.
      Returns:
      Returns a client configuration view of the provided managed object.

    • createServerConfiguration

      public GlobalCfg createServerConfiguration(ServerManagedObject<? extends GlobalCfg> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a server configuration view of the provided server managed object.
      Specified by:
      createServerConfiguration in class ManagedObjectDefinition<GlobalCfgClient,GlobalCfg>
      Parameters:
      impl - The server managed object.
      Returns:
      Returns a server configuration view of the provided server managed object.

    • getServerConfigurationClass

      public Class<GlobalCfg> getServerConfigurationClass()
      Description copied from class: ManagedObjectDefinition
      Gets the server configuration class instance associated with this managed object definition.
      Specified by:
      getServerConfigurationClass in class ManagedObjectDefinition<GlobalCfgClient,GlobalCfg>
      Returns:
      Returns the server configuration class instance associated with this managed object definition.

    • getAddMissingRdnAttributesPropertyDefinition

      public BooleanPropertyDefinition getAddMissingRdnAttributesPropertyDefinition()
      Get the "add-missing-rdn-attributes" property definition.

      Indicates whether the directory server should automatically add any attribute values contained in the entry's RDN into that entry when processing an add request.

      Returns:
      Returns the "add-missing-rdn-attributes" property definition.

    • getAdvertisedListenAddressPropertyDefinition

      public HostPropertyDefinition getAdvertisedListenAddressPropertyDefinition()
      Get the "advertised-listen-address" property definition.

      The advertised address(es) which clients should use for connecting to this Global Configuration.

      Multiple addresses may be provided as separate values for this attribute. The meta-address 0.0.0.0 is not permitted.

      Returns:
      Returns the "advertised-listen-address" property definition.

    • getAllowAttributeNameExceptionsPropertyDefinition

      public BooleanPropertyDefinition getAllowAttributeNameExceptionsPropertyDefinition()
      Get the "allow-attribute-name-exceptions" property definition.

      Indicates whether the directory server should allow underscores in attribute names and allow attribute names to begin with numeric digits (both of which are violations of the LDAP standards).

      Returns:
      Returns the "allow-attribute-name-exceptions" property definition.

    • getAllowedClientPropertyDefinition

      public IpAddressMaskPropertyDefinition getAllowedClientPropertyDefinition()
      Get the "allowed-client" property definition.

      A set of clients who will be allowed to establish connections to this Global Configuration.

      Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. Specifying a value for this property in a connection handler will override any value set in the global configuration.

      Returns:
      Returns the "allowed-client" property definition.

    • getAllowedTaskPropertyDefinition

      public StringPropertyDefinition getAllowedTaskPropertyDefinition()
      Get the "allowed-task" property definition.

      Specifies the fully-qualified name of a Java class that may be invoked in the server.

      Any attempt to invoke a task not included in the list of allowed tasks is rejected.

      Returns:
      Returns the "allowed-task" property definition.

    • getBindWithDnRequiresPasswordPropertyDefinition

      public BooleanPropertyDefinition getBindWithDnRequiresPasswordPropertyDefinition()
      Get the "bind-with-dn-requires-password" property definition.

      Indicates whether the directory server should reject any simple bind request that contains a DN but no password.

      Although such bind requests are technically allowed by the LDAPv3 specification (and should be treated as anonymous simple authentication), they may introduce security problems in applications that do not verify that the client actually provided a password.

      Returns:
      Returns the "bind-with-dn-requires-password" property definition.

    • getCheckSchemaPropertyDefinition

      public BooleanPropertyDefinition getCheckSchemaPropertyDefinition()
      Get the "check-schema" property definition.

      Indicates whether schema enforcement is active.

      When schema enforcement is activated, the directory server ensures that all operations result in entries are valid according to the defined server schema. It is strongly recommended that this option be left enabled to prevent the inadvertent addition of invalid data into the server.

      Returns:
      Returns the "check-schema" property definition.

    • getDefaultPasswordPolicyPropertyDefinition

      public AggregationPropertyDefinition<PasswordPolicyCfgClient,PasswordPolicyCfg> getDefaultPasswordPolicyPropertyDefinition()
      Get the "default-password-policy" property definition.

      Specifies the name of the password policy that is in effect for users whose entries do not specify an alternate password policy (either via a real or virtual attribute).

      In addition, the default password policy will be used for providing default parameters for sub-entry based password policies when not provided or supported by the sub-entry itself. This property must reference a password policy and no other type of authentication policy.

      Returns:
      Returns the "default-password-policy" property definition.

    • getDeniedClientPropertyDefinition

      public IpAddressMaskPropertyDefinition getDeniedClientPropertyDefinition()
      Get the "denied-client" property definition.

      A set of clients who are not allowed to establish connections to this Global Configuration.

      Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. If both allowed and denied client masks are defined and a client connection matches one or more masks in both lists, then the connection is denied. If only a denied list is specified, then any client not matching a mask in that list is allowed. Specifying a value for this property in a connection handler will override any value set in the global configuration.

      Returns:
      Returns the "denied-client" property definition.

    • getDisabledPrivilegePropertyDefinition

      public EnumPropertyDefinition<GlobalCfgDefn.DisabledPrivilege> getDisabledPrivilegePropertyDefinition()
      Get the "disabled-privilege" property definition.

      Specifies the name of a privilege that should not be evaluated by the server.

      If a privilege is disabled, then it is assumed that all clients (including unauthenticated clients) have that privilege.

      Returns:
      Returns the "disabled-privilege" property definition.

    • getEtimeResolutionPropertyDefinition

      public EnumPropertyDefinition<GlobalCfgDefn.EtimeResolution> getEtimeResolutionPropertyDefinition()
      Get the "etime-resolution" property definition.

      Specifies the resolution to use for operation elapsed processing time (etime) measurements.

      Returns:
      Returns the "etime-resolution" property definition.

    • getGroupIdPropertyDefinition

      public StringPropertyDefinition getGroupIdPropertyDefinition()
      Get the "group-id" property definition.

      Specifies the unique identifier of the group in which the directory server belongs.

      Directory servers are typically grouped according to their physical location, such as a rack or data center. Servers will prefer connecting to other servers within the same group.

      Returns:
      Returns the "group-id" property definition.

    • getGroupIdFailoverOrderPropertyDefinition

      public StringPropertyDefinition getGroupIdFailoverOrderPropertyDefinition()
      Get the "group-id-failover-order" property definition.

      Comma separated list of group-ids, highest priority first, controlling how the server successively fail over between groups.

      Servers pertaining to the group ID of the current server are first tried. If none respond, then servers pertaining to the first group ID in the list are tried. If none respond, then servers pertaining to the second group ID in the list are tried, etc. Finally, when no servers from the listed groups respond, then all the remaining servers are considered.

      Returns:
      Returns the "group-id-failover-order" property definition.

    • getIdleTimeLimitPropertyDefinition

      public DurationPropertyDefinition getIdleTimeLimitPropertyDefinition()
      Get the "idle-time-limit" property definition.

      Specifies the maximum length of time that a client connection may remain established since its last completed operation.

      A value of "0 seconds" indicates that no idle time limit is enforced.

      Returns:
      Returns the "idle-time-limit" property definition.

    • getInvalidAttributeSyntaxBehaviorPropertyDefinition

      public EnumPropertyDefinition<GlobalCfgDefn.InvalidAttributeSyntaxBehavior> getInvalidAttributeSyntaxBehaviorPropertyDefinition()
      Get the "invalid-attribute-syntax-behavior" property definition.

      Specifies how the directory server should handle operations whenever an attribute value violates the associated attribute syntax.

      Returns:
      Returns the "invalid-attribute-syntax-behavior" property definition.

    • getJeBackendSharedCacheEnabledPropertyDefinition

      public BooleanPropertyDefinition getJeBackendSharedCacheEnabledPropertyDefinition()
      Get the "je-backend-shared-cache-enabled" property definition.

      Indicates whether all the JE backends should share the same cache.

      When enabled, all the JE backends share the same cache. JE backends will make better use of memory: the cache will use around at most 75% of the JVM Old Gen size. Note that when this setting is enabled, it overrides all db-cache-percent and db-cache-size settings. Note also that cache misses in one backend could cause cached data for other backends to be evicted. When disabled, each JE backend will have its own cache sized according to their options db-cache-percent/db-cache-size.

      Returns:
      Returns the "je-backend-shared-cache-enabled" property definition.

    • getListenAddressPropertyDefinition

      public HostPropertyDefinition getListenAddressPropertyDefinition()
      Get the "listen-address" property definition.

      The network interface(s) on which this Global Configuration should listen for incoming client connections.

      Multiple addresses may be provided as separate values for this attribute. If no values are provided, then the directory server will listen on all interfaces.

      Returns:
      Returns the "listen-address" property definition.

    • getMaxAllowedClientConnectionsPropertyDefinition

      public IntegerPropertyDefinition getMaxAllowedClientConnectionsPropertyDefinition()
      Get the "max-allowed-client-connections" property definition.

      Specifies the maximum number of client connections that may be established at any given time

      A value of 0 indicates that unlimited client connection is allowed.

      Returns:
      Returns the "max-allowed-client-connections" property definition.

    • getMaxCandidateSetSizePropertyDefinition

      public IntegerPropertyDefinition getMaxCandidateSetSizePropertyDefinition()
      Get the "max-candidate-set-size" property definition.

      Controls the maximum amount of memory that may be used when processing search requests. The value corresponds to the maximum number of candidate entries that the directory server may maintain in memory when querying attribute indexes.

      Note that this is the default server-wide limit, but it may be overridden on a per-user basis using the ds-rlim-max-candidate-set-size operational attribute. A value of 0 indicates that no maximum size for a candidate set is enforced.

      Returns:
      Returns the "max-candidate-set-size" property definition.

    • getMaxInternalBufferSizePropertyDefinition

      public SizePropertyDefinition getMaxInternalBufferSizePropertyDefinition()
      Get the "max-internal-buffer-size" property definition.

      The threshold capacity beyond which internal cached buffers used for encoding and decoding entries and protocol messages will be trimmed after use.

      Individual buffers may grow very large when encoding and decoding large entries and protocol messages and should be reduced in size when they are no longer needed. This setting specifies the threshold at which a buffer is determined to have grown too big and should be trimmed down after use.

      Returns:
      Returns the "max-internal-buffer-size" property definition.

    • getMaxPsearchesPropertyDefinition

      public IntegerPropertyDefinition getMaxPsearchesPropertyDefinition()
      Get the "max-psearches" property definition.

      Defines the maximum number of concurrent persistent searches that can be performed on directory server

      The persistent search mechanism provides an active channel through which entries that change, and information about the changes that occur, can be communicated. Because each persistent search operation consumes resources, limiting the number of simultaneous persistent searches keeps the performance impact minimal. A value of -1 indicates that there is no limit on the persistent searches.

      Returns:
      Returns the "max-psearches" property definition.

    • getNotifyAbandonedOperationsPropertyDefinition

      public BooleanPropertyDefinition getNotifyAbandonedOperationsPropertyDefinition()
      Get the "notify-abandoned-operations" property definition.

      Indicates whether the directory server should send a response to any operation that is interrupted via an abandon request.

      The LDAP specification states that abandoned operations should not receive any response, but this may cause problems with client applications that always expect to receive a response to each request.

      Returns:
      Returns the "notify-abandoned-operations" property definition.

    • getProxiedAuthorizationIdentityMapperPropertyDefinition

      public AggregationPropertyDefinition<IdentityMapperCfgClient,IdentityMapperCfg> getProxiedAuthorizationIdentityMapperPropertyDefinition()
      Get the "proxied-authorization-identity-mapper" property definition.

      Specifies the name of the identity mapper(s) to map authorization ID values (using the "u:" form) provided in the proxied authorization control to the corresponding user entry.

      Returns:
      Returns the "proxied-authorization-identity-mapper" property definition.

    • getProxyProtocolAllowedClientPropertyDefinition

      public IpAddressMaskPropertyDefinition getProxyProtocolAllowedClientPropertyDefinition()
      Get the "proxy-protocol-allowed-client" property definition.

      When the proxy protocol is enabled, this property represents the set of clients who will be allowed to establish connections to this Global Configuration and will be required to use proxy protocol.

      Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. Specifying a value for this property in a connection handler will override any value set in the global configuration.

      Returns:
      Returns the "proxy-protocol-allowed-client" property definition.

    • getProxyProtocolEnabledPropertyDefinition

      public BooleanPropertyDefinition getProxyProtocolEnabledPropertyDefinition()
      Get the "proxy-protocol-enabled" property definition.

      Indicates whether the proxy protocol is enabled.

      If enabled, the Global Configuration makes the server use proxy protocol for connections with a source IP address matching an address in the proxy-protocol-allowed-client list.

      Returns:
      Returns the "proxy-protocol-enabled" property definition.

    • getRestrictedClientPropertyDefinition

      public IpAddressMaskPropertyDefinition getRestrictedClientPropertyDefinition()
      Get the "restricted-client" property definition.

      A set of clients who will be limited to the maximum number of connections specified by the "restricted-client-connection-limit" property.

      Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. Specifying a value for this property in a connection handler will override any value set in the global configuration.

      Returns:
      Returns the "restricted-client" property definition.

    • getRestrictedClientConnectionLimitPropertyDefinition

      public IntegerPropertyDefinition getRestrictedClientConnectionLimitPropertyDefinition()
      Get the "restricted-client-connection-limit" property definition.

      Specifies the maximum number of connections a restricted client can open at the same time to this Global Configuration.

      Once Directory Server accepts the specified number of connections from a client specified in restricted-client, any additional connection will be rejected. The number of connections is maintained by IP address. Specifying a value for this property in a connection handler will override any value set in the global configuration.

      Returns:
      Returns the "restricted-client-connection-limit" property definition.

    • getReturnBindErrorMessagesPropertyDefinition

      public BooleanPropertyDefinition getReturnBindErrorMessagesPropertyDefinition()
      Get the "return-bind-error-messages" property definition.

      Indicates whether responses for failed bind operations should include a message string providing the reason for the authentication failure.

      Note that these messages may include information that could potentially be used by an attacker. If this option is disabled, then these messages appears only in the server's access log.

      Returns:
      Returns the "return-bind-error-messages" property definition.

    • getSaveConfigOnSuccessfulStartupPropertyDefinition

      public BooleanPropertyDefinition getSaveConfigOnSuccessfulStartupPropertyDefinition()
      Get the "save-config-on-successful-startup" property definition.

      Indicates whether the directory server should save a copy of its configuration whenever the startup process completes successfully.

      This ensures that the server provides a "last known good" configuration, which can be used as a reference (or copied into the active config) if the server fails to start with the current "active" configuration.

      Returns:
      Returns the "save-config-on-successful-startup" property definition.

    • getServerIdPropertyDefinition

      public StringPropertyDefinition getServerIdPropertyDefinition()
      Get the "server-id" property definition.

      Specifies a unique identifier for the directory server which will identify the server within a replication topology.

      Each directory server within the same replication topology must have a different server identifier. If no server identifier is specified then one must be provided in each replication server and replication domain configuration.

      Returns:
      Returns the "server-id" property definition.

    • getSingleStructuralObjectclassBehaviorPropertyDefinition

      public EnumPropertyDefinition<GlobalCfgDefn.SingleStructuralObjectclassBehavior> getSingleStructuralObjectclassBehaviorPropertyDefinition()
      Get the "single-structural-objectclass-behavior" property definition.

      Specifies how the directory server should handle operations an entry does not contain a structural object class or contains multiple structural classes.

      Returns:
      Returns the "single-structural-objectclass-behavior" property definition.

    • getSizeLimitPropertyDefinition

      public IntegerPropertyDefinition getSizeLimitPropertyDefinition()
      Get the "size-limit" property definition.

      Specifies the maximum number of entries that can be returned to the client during a single search operation.

      A value of 0 indicates that no size limit is enforced. Note that this is the default server-wide limit, but it may be overridden on a per-user basis using the ds-rlim-size-limit operational attribute.

      Returns:
      Returns the "size-limit" property definition.

    • getSubordinateBaseDnPropertyDefinition

      public DnPropertyDefinition getSubordinateBaseDnPropertyDefinition()
      Get the "subordinate-base-dn" property definition.

      Specifies the set of base DNs used for singleLevel, wholeSubtree, and subordinateSubtree searches based at the root DSE.

      Returns:
      Returns the "subordinate-base-dn" property definition.

    • getTimeLimitPropertyDefinition

      public DurationPropertyDefinition getTimeLimitPropertyDefinition()
      Get the "time-limit" property definition.

      Specifies the maximum length of time that should be spent processing a single search operation.

      A value of 0 seconds indicates that no time limit is enforced. Note that this is the default server-wide time limit, but it may be overridden on a per-user basis using the ds-rlim-time-limit operational attribute.

      Returns:
      Returns the "time-limit" property definition.

    • getTrustTransactionIdsPropertyDefinition

      public BooleanPropertyDefinition getTrustTransactionIdsPropertyDefinition()
      Get the "trust-transaction-ids" property definition.

      Indicates whether the directory server should trust the transaction ids that may be received from requests, either through a LDAP control or through a HTTP header.

      When enabled, the transaction IDs are created when the requests do not include one, then are logged; in addition, the server will add a sub-transaction ID control to all forwarded requests. When disabled, the incoming transaction IDs are discarded and new ones are created.

      Returns:
      Returns the "trust-transaction-ids" property definition.

    • getUnauthenticatedRequestsPolicyPropertyDefinition

      public EnumPropertyDefinition<GlobalCfgDefn.UnauthenticatedRequestsPolicy> getUnauthenticatedRequestsPolicyPropertyDefinition()
      Get the "unauthenticated-requests-policy" property definition.

      Controls how the directory server should handle requests received from a client that has not yet been authenticated, whose last authentication attempt was unsuccessful, or whose last authentication attempt used anonymous authentication.

      Returns:
      Returns the "unauthenticated-requests-policy" property definition.

    • getUseVirtualThreadsIfAvailablePropertyDefinition

      public BooleanPropertyDefinition getUseVirtualThreadsIfAvailablePropertyDefinition()
      Get the "use-virtual-threads-if-available" property definition.

      Indicates whether virtual threads should be used for network IO and core processing (EXPERIMENTAL).

      Virtual threads, introduced in Java 21, allow applications to scale more easily and make more efficient use of available resources. OpenDJ includes EXPERIMENTAL support for virtual threads that may be enabled by using Java 21 (or newer) and setting this option to true. This feature is available as an EARLY ACCESS technology preview which should not be used in production.

      Returns:
      Returns the "use-virtual-threads-if-available" property definition.

    • getWritabilityModePropertyDefinition

      public EnumPropertyDefinition<GlobalCfgDefn.WritabilityMode> getWritabilityModePropertyDefinition()
      Get the "writability-mode" property definition.

      Specifies the kinds of write operations the directory server can process.

      Returns:
      Returns the "writability-mode" property definition.