Package org.forgerock.opendj.server.config.client

Interface GlobalCfgClient

  • All Superinterfaces:
    ConfigurationClient
    public interface GlobalCfgClient
extends ConfigurationClient
    A client-side interface for reading and modifying Global Configuration settings.

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

    • Method Detail

      • isAddMissingRdnAttributes

        ValueOrExpression<Boolean> isAddMissingRdnAttributes()
        Gets the "add-missing-rdn-attributes" property.

        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.

        Default value: true

        Returns:
        Returns the value of the "add-missing-rdn-attributes" property.

      • setAddMissingRdnAttributes

        void setAddMissingRdnAttributes​(ValueOrExpression<Boolean> value)
                         throws PropertyException
        Sets the "add-missing-rdn-attributes" property.

        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.

        Parameters:
        value - The value of the "add-missing-rdn-attributes" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getAdvertisedListenAddress

        @MandatoryProperty
SortedSet<ValueOrExpression<com.forgerock.opendj.util.Host>> getAdvertisedListenAddress()
        Gets the "advertised-listen-address" property.

        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 values of the "advertised-listen-address" property.

      • setAdvertisedListenAddress

        @MandatoryProperty
void setAdvertisedListenAddress​(Collection<ValueOrExpression<com.forgerock.opendj.util.Host>> values)
                         throws PropertyException
        Sets the "advertised-listen-address" property.

        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.

        Parameters:
        values - The values of the "advertised-listen-address" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • isAllowAttributeNameExceptions

        ValueOrExpression<Boolean> isAllowAttributeNameExceptions()
        Gets the "allow-attribute-name-exceptions" property.

        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).

        Default value: false

        Returns:
        Returns the value of the "allow-attribute-name-exceptions" property.

      • setAllowAttributeNameExceptions

        void setAllowAttributeNameExceptions​(ValueOrExpression<Boolean> value)
                              throws PropertyException
        Sets the "allow-attribute-name-exceptions" property.

        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).

        Parameters:
        value - The value of the "allow-attribute-name-exceptions" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getAllowedClient

        SortedSet<ValueOrExpression<AddressMask>> getAllowedClient()
        Gets the "allowed-client" property.

        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 values of the "allowed-client" property.

      • setAllowedClient

        void setAllowedClient​(Collection<ValueOrExpression<AddressMask>> values)
               throws PropertyException
        Sets the "allowed-client" property.

        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.

        Parameters:
        values - The values of the "allowed-client" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getAllowedTask

        SortedSet<ValueOrExpression<String>> getAllowedTask()
        Gets the "allowed-task" property.

        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 values of the "allowed-task" property.

      • setAllowedTask

        void setAllowedTask​(Collection<ValueOrExpression<String>> values)
             throws PropertyException
        Sets the "allowed-task" property.

        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.

        Parameters:
        values - The values of the "allowed-task" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • isBindWithDnRequiresPassword

        ValueOrExpression<Boolean> isBindWithDnRequiresPassword()
        Gets the "bind-with-dn-requires-password" property.

        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.

        Default value: true

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

      • setBindWithDnRequiresPassword

        void setBindWithDnRequiresPassword​(ValueOrExpression<Boolean> value)
                            throws PropertyException
        Sets the "bind-with-dn-requires-password" property.

        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.

        Parameters:
        value - The value of the "bind-with-dn-requires-password" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isCheckSchema

        ValueOrExpression<Boolean> isCheckSchema()
        Gets the "check-schema" property.

        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.

        Default value: true

        Returns:
        Returns the value of the "check-schema" property.

      • setCheckSchema

        void setCheckSchema​(ValueOrExpression<Boolean> value)
             throws PropertyException
        Sets the "check-schema" property.

        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.

        Parameters:
        value - The value of the "check-schema" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getDefaultPasswordPolicy

        @MandatoryProperty
ValueOrExpression<String> getDefaultPasswordPolicy()
        Gets the "default-password-policy" property.

        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 value of the "default-password-policy" property.

      • setDefaultPasswordPolicy

        @MandatoryProperty
void setDefaultPasswordPolicy​(ValueOrExpression<String> value)
                       throws PropertyException
        Sets the "default-password-policy" property.

        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.

        Parameters:
        value - The value of the "default-password-policy" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getDeniedClient

        SortedSet<ValueOrExpression<AddressMask>> getDeniedClient()
        Gets the "denied-client" property.

        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 values of the "denied-client" property.

      • setDeniedClient

        void setDeniedClient​(Collection<ValueOrExpression<AddressMask>> values)
              throws PropertyException
        Sets the "denied-client" property.

        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.

        Parameters:
        values - The values of the "denied-client" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getDisabledPrivilege

        SortedSet<ValueOrExpression<GlobalCfgDefn.DisabledPrivilege>> getDisabledPrivilege()
        Gets the "disabled-privilege" property.

        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 values of the "disabled-privilege" property.

      • setDisabledPrivilege

        void setDisabledPrivilege​(Collection<ValueOrExpression<GlobalCfgDefn.DisabledPrivilege>> values)
                   throws PropertyException
        Sets the "disabled-privilege" property.

        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.

        Parameters:
        values - The values of the "disabled-privilege" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getEtimeResolution

        ValueOrExpression<GlobalCfgDefn.EtimeResolution> getEtimeResolution()
        Gets the "etime-resolution" property.

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

        Default value: milliseconds

        Returns:
        Returns the value of the "etime-resolution" property.

      • getGroupId

        ValueOrExpression<String> getGroupId()
        Gets the "group-id" property.

        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.

        Default value: default

        Returns:
        Returns the value of the "group-id" property.

      • setGroupId

        void setGroupId​(ValueOrExpression<String> value)
         throws PropertyException
        Sets the "group-id" property.

        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.

        Parameters:
        value - The value of the "group-id" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getGroupIdFailoverOrder

        ValueOrExpression<String> getGroupIdFailoverOrder()
        Gets the "group-id-failover-order" property.

        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 value of the "group-id-failover-order" property.

      • setGroupIdFailoverOrder

        void setGroupIdFailoverOrder​(ValueOrExpression<String> value)
                      throws PropertyException
        Sets the "group-id-failover-order" property.

        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.

        Parameters:
        value - The value of the "group-id-failover-order" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getIdleTimeLimit

        ValueOrExpression<Long> getIdleTimeLimit()
        Gets the "idle-time-limit" property.

        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.

        Default value: 0 seconds

        Returns:
        Returns the value of the "idle-time-limit" property.

      • setIdleTimeLimit

        void setIdleTimeLimit​(ValueOrExpression<Long> value)
               throws PropertyException
        Sets the "idle-time-limit" property.

        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.

        Parameters:
        value - The value of the "idle-time-limit" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getInvalidAttributeSyntaxBehavior

        ValueOrExpression<GlobalCfgDefn.InvalidAttributeSyntaxBehavior> getInvalidAttributeSyntaxBehavior()
        Gets the "invalid-attribute-syntax-behavior" property.

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

        Default value: reject

        Returns:
        Returns the value of the "invalid-attribute-syntax-behavior" property.

      • setInvalidAttributeSyntaxBehavior

        void setInvalidAttributeSyntaxBehavior​(ValueOrExpression<GlobalCfgDefn.InvalidAttributeSyntaxBehavior> value)
                                throws PropertyException
        Sets the "invalid-attribute-syntax-behavior" property.

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

        Parameters:
        value - The value of the "invalid-attribute-syntax-behavior" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isJeBackendSharedCacheEnabled

        ValueOrExpression<Boolean> isJeBackendSharedCacheEnabled()
        Gets the "je-backend-shared-cache-enabled" property.

        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.

        Default value: true

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

      • setJeBackendSharedCacheEnabled

        void setJeBackendSharedCacheEnabled​(ValueOrExpression<Boolean> value)
                             throws PropertyException
        Sets the "je-backend-shared-cache-enabled" property.

        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.

        Parameters:
        value - The value of the "je-backend-shared-cache-enabled" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getListenAddress

        SortedSet<ValueOrExpression<com.forgerock.opendj.util.Host>> getListenAddress()
        Gets the "listen-address" property.

        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.

        Default value: 0.0.0.0

        Returns:
        Returns the values of the "listen-address" property.

      • setListenAddress

        void setListenAddress​(Collection<ValueOrExpression<com.forgerock.opendj.util.Host>> values)
               throws PropertyException
        Sets the "listen-address" property.

        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.

        Parameters:
        values - The values of the "listen-address" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getMaxAllowedClientConnections

        ValueOrExpression<Integer> getMaxAllowedClientConnections()
        Gets the "max-allowed-client-connections" property.

        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.

        Default value: 0

        Returns:
        Returns the value of the "max-allowed-client-connections" property.

      • setMaxAllowedClientConnections

        void setMaxAllowedClientConnections​(ValueOrExpression<Integer> value)
                             throws PropertyException
        Sets the "max-allowed-client-connections" property.

        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.

        Parameters:
        value - The value of the "max-allowed-client-connections" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getMaxCandidateSetSize

        ValueOrExpression<Integer> getMaxCandidateSetSize()
        Gets the "max-candidate-set-size" property.

        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.

        Default value: 100000

        Returns:
        Returns the value of the "max-candidate-set-size" property.

      • setMaxCandidateSetSize

        void setMaxCandidateSetSize​(ValueOrExpression<Integer> value)
                     throws PropertyException
        Sets the "max-candidate-set-size" property.

        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.

        Parameters:
        value - The value of the "max-candidate-set-size" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getMaxInternalBufferSize

        ValueOrExpression<Long> getMaxInternalBufferSize()
        Gets the "max-internal-buffer-size" property.

        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.

        Default value: 32 KB

        Returns:
        Returns the value of the "max-internal-buffer-size" property.

      • setMaxInternalBufferSize

        void setMaxInternalBufferSize​(ValueOrExpression<Long> value)
                       throws PropertyException
        Sets the "max-internal-buffer-size" property.

        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.

        Parameters:
        value - The value of the "max-internal-buffer-size" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getMaxPsearches

        ValueOrExpression<Integer> getMaxPsearches()
        Gets the "max-psearches" property.

        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.

        Default value: -1

        Returns:
        Returns the value of the "max-psearches" property.

      • setMaxPsearches

        void setMaxPsearches​(ValueOrExpression<Integer> value)
              throws PropertyException
        Sets the "max-psearches" property.

        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.

        Parameters:
        value - The value of the "max-psearches" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isNotifyAbandonedOperations

        ValueOrExpression<Boolean> isNotifyAbandonedOperations()
        Gets the "notify-abandoned-operations" property.

        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.

        Default value: false

        Returns:
        Returns the value of the "notify-abandoned-operations" property.

      • setNotifyAbandonedOperations

        void setNotifyAbandonedOperations​(ValueOrExpression<Boolean> value)
                           throws PropertyException
        Sets the "notify-abandoned-operations" property.

        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.

        Parameters:
        value - The value of the "notify-abandoned-operations" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getProxiedAuthorizationIdentityMapper

        @MandatoryProperty
SortedSet<ValueOrExpression<String>> getProxiedAuthorizationIdentityMapper()
        Gets the "proxied-authorization-identity-mapper" property.

        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 values of the "proxied-authorization-identity-mapper" property.

      • setProxiedAuthorizationIdentityMapper

        @MandatoryProperty
void setProxiedAuthorizationIdentityMapper​(Collection<ValueOrExpression<String>> values)
                                    throws PropertyException
        Sets the "proxied-authorization-identity-mapper" property.

        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.

        Parameters:
        values - The values of the "proxied-authorization-identity-mapper" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getProxyProtocolAllowedClient

        SortedSet<ValueOrExpression<AddressMask>> getProxyProtocolAllowedClient()
        Gets the "proxy-protocol-allowed-client" property.

        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 values of the "proxy-protocol-allowed-client" property.

      • setProxyProtocolAllowedClient

        void setProxyProtocolAllowedClient​(Collection<ValueOrExpression<AddressMask>> values)
                            throws PropertyException
        Sets the "proxy-protocol-allowed-client" property.

        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.

        Parameters:
        values - The values of the "proxy-protocol-allowed-client" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • isProxyProtocolEnabled

        ValueOrExpression<Boolean> isProxyProtocolEnabled()
        Gets the "proxy-protocol-enabled" property.

        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.

        Default value: false

        Returns:
        Returns the value of the "proxy-protocol-enabled" property.

      • setProxyProtocolEnabled

        void setProxyProtocolEnabled​(ValueOrExpression<Boolean> value)
                      throws PropertyException
        Sets the "proxy-protocol-enabled" property.

        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.

        Parameters:
        value - The value of the "proxy-protocol-enabled" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getRestrictedClient

        SortedSet<ValueOrExpression<AddressMask>> getRestrictedClient()
        Gets the "restricted-client" property.

        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 values of the "restricted-client" property.

      • setRestrictedClient

        void setRestrictedClient​(Collection<ValueOrExpression<AddressMask>> values)
                  throws PropertyException
        Sets the "restricted-client" property.

        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.

        Parameters:
        values - The values of the "restricted-client" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getRestrictedClientConnectionLimit

        ValueOrExpression<Integer> getRestrictedClientConnectionLimit()
        Gets the "restricted-client-connection-limit" property.

        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.

        Default value: 100

        Returns:
        Returns the value of the "restricted-client-connection-limit" property.

      • setRestrictedClientConnectionLimit

        void setRestrictedClientConnectionLimit​(ValueOrExpression<Integer> value)
                                 throws PropertyException
        Sets the "restricted-client-connection-limit" property.

        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.

        Parameters:
        value - The value of the "restricted-client-connection-limit" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isReturnBindErrorMessages

        ValueOrExpression<Boolean> isReturnBindErrorMessages()
        Gets the "return-bind-error-messages" property.

        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.

        Default value: false

        Returns:
        Returns the value of the "return-bind-error-messages" property.

      • setReturnBindErrorMessages

        void setReturnBindErrorMessages​(ValueOrExpression<Boolean> value)
                         throws PropertyException
        Sets the "return-bind-error-messages" property.

        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.

        Parameters:
        value - The value of the "return-bind-error-messages" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isSaveConfigOnSuccessfulStartup

        ValueOrExpression<Boolean> isSaveConfigOnSuccessfulStartup()
        Gets the "save-config-on-successful-startup" property.

        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.

        Default value: true

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

      • setSaveConfigOnSuccessfulStartup

        void setSaveConfigOnSuccessfulStartup​(ValueOrExpression<Boolean> value)
                               throws PropertyException
        Sets the "save-config-on-successful-startup" property.

        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.

        Parameters:
        value - The value of the "save-config-on-successful-startup" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getServerId

        @MandatoryProperty
ValueOrExpression<String> getServerId()
        Gets the "server-id" property.

        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 value of the "server-id" property.

      • setServerId

        @MandatoryProperty
void setServerId​(ValueOrExpression<String> value)
          throws PropertyException
        Sets the "server-id" property.

        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.

        Parameters:
        value - The value of the "server-id" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getSingleStructuralObjectclassBehavior

        ValueOrExpression<GlobalCfgDefn.SingleStructuralObjectclassBehavior> getSingleStructuralObjectclassBehavior()
        Gets the "single-structural-objectclass-behavior" property.

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

        Default value: reject

        Returns:
        Returns the value of the "single-structural-objectclass-behavior" property.

      • setSingleStructuralObjectclassBehavior

        void setSingleStructuralObjectclassBehavior​(ValueOrExpression<GlobalCfgDefn.SingleStructuralObjectclassBehavior> value)
                                     throws PropertyException
        Sets the "single-structural-objectclass-behavior" property.

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

        Parameters:
        value - The value of the "single-structural-objectclass-behavior" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getSizeLimit

        ValueOrExpression<Integer> getSizeLimit()
        Gets the "size-limit" property.

        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.

        Default value: 1000

        Returns:
        Returns the value of the "size-limit" property.

      • setSizeLimit

        void setSizeLimit​(ValueOrExpression<Integer> value)
           throws PropertyException
        Sets the "size-limit" property.

        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.

        Parameters:
        value - The value of the "size-limit" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getSubordinateBaseDn

        SortedSet<ValueOrExpression<Dn>> getSubordinateBaseDn()
        Gets the "subordinate-base-dn" property.

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

        Returns:
        Returns the values of the "subordinate-base-dn" property.

      • setSubordinateBaseDn

        void setSubordinateBaseDn​(Collection<ValueOrExpression<Dn>> values)
                   throws PropertyException
        Sets the "subordinate-base-dn" property.

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

        Parameters:
        values - The values of the "subordinate-base-dn" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getTimeLimit

        ValueOrExpression<Long> getTimeLimit()
        Gets the "time-limit" property.

        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.

        Default value: 60 seconds

        Returns:
        Returns the value of the "time-limit" property.

      • setTimeLimit

        void setTimeLimit​(ValueOrExpression<Long> value)
           throws PropertyException
        Sets the "time-limit" property.

        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.

        Parameters:
        value - The value of the "time-limit" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isTrustTransactionIds

        ValueOrExpression<Boolean> isTrustTransactionIds()
        Gets the "trust-transaction-ids" property.

        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.

        Default value: false

        Returns:
        Returns the value of the "trust-transaction-ids" property.

      • setTrustTransactionIds

        void setTrustTransactionIds​(ValueOrExpression<Boolean> value)
                     throws PropertyException
        Sets the "trust-transaction-ids" property.

        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.

        Parameters:
        value - The value of the "trust-transaction-ids" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getUnauthenticatedRequestsPolicy

        ValueOrExpression<GlobalCfgDefn.UnauthenticatedRequestsPolicy> getUnauthenticatedRequestsPolicy()
        Gets the "unauthenticated-requests-policy" property.

        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.

        Default value: allow

        Returns:
        Returns the value of the "unauthenticated-requests-policy" property.

      • setUnauthenticatedRequestsPolicy

        void setUnauthenticatedRequestsPolicy​(ValueOrExpression<GlobalCfgDefn.UnauthenticatedRequestsPolicy> value)
                               throws PropertyException
        Sets the "unauthenticated-requests-policy" property.

        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.

        Parameters:
        value - The value of the "unauthenticated-requests-policy" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getWritabilityMode

        ValueOrExpression<GlobalCfgDefn.WritabilityMode> getWritabilityMode()
        Gets the "writability-mode" property.

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

        Default value: enabled

        Returns:
        Returns the value of the "writability-mode" property.