public interface GlobalCfg extends Configuration
The Global Configuration contains properties that affect the overall operation of the OpenDJ.
Modifier and Type | Method and Description |
---|---|
void |
addChangeListener(ConfigurationChangeListener<GlobalCfg> listener)
Register to be notified when this Global Configuration is changed.
|
Class<? extends GlobalCfg> |
configurationClass()
Gets the configuration class associated with this Global Configuration.
|
SortedSet<String> |
getAllowedTask()
Gets the "allowed-task" property.
|
int |
getCursorEntryLimit()
Gets the "cursor-entry-limit" property.
|
String |
getDefaultPasswordPolicy()
Gets the "default-password-policy" property.
|
Dn |
getDefaultPasswordPolicyDn()
Gets the "default-password-policy" property as a DN.
|
SortedSet<GlobalCfgDefn.DisabledPrivilege> |
getDisabledPrivilege()
Gets the "disabled-privilege" property.
|
GlobalCfgDefn.EtimeResolution |
getEtimeResolution()
Gets the "etime-resolution" property.
|
long |
getIdleTimeLimit()
Gets the "idle-time-limit" property.
|
GlobalCfgDefn.InvalidAttributeSyntaxBehavior |
getInvalidAttributeSyntaxBehavior()
Gets the "invalid-attribute-syntax-behavior" property.
|
int |
getLookthroughLimit()
Gets the "lookthrough-limit" property.
|
int |
getMaxAllowedClientConnections()
Gets the "max-allowed-client-connections" property.
|
long |
getMaxInternalBufferSize()
Gets the "max-internal-buffer-size" property.
|
int |
getMaxPsearches()
Gets the "max-psearches" property.
|
String |
getProxiedAuthorizationIdentityMapper()
Gets the "proxied-authorization-identity-mapper" property.
|
Dn |
getProxiedAuthorizationIdentityMapperDn()
Gets the "proxied-authorization-identity-mapper" property as a
DN.
|
Integer |
getServerId()
Gets the "server-id" property.
|
GlobalCfgDefn.SingleStructuralObjectclassBehavior |
getSingleStructuralObjectclassBehavior()
Gets the "single-structural-objectclass-behavior" property.
|
int |
getSizeLimit()
Gets the "size-limit" property.
|
SortedSet<String> |
getSmtpServer()
Gets the "smtp-server" property.
|
SortedSet<Dn> |
getSubordinateBaseDn()
Gets the "subordinate-base-dn" property.
|
long |
getTimeLimit()
Gets the "time-limit" property.
|
GlobalCfgDefn.WritabilityMode |
getWritabilityMode()
Gets the "writability-mode" property.
|
boolean |
isAddMissingRdnAttributes()
Gets the "add-missing-rdn-attributes" property.
|
boolean |
isAllowAttributeNameExceptions()
Gets the "allow-attribute-name-exceptions" property.
|
boolean |
isBindWithDnRequiresPassword()
Gets the "bind-with-dn-requires-password" property.
|
boolean |
isCheckSchema()
Gets the "check-schema" property.
|
boolean |
isNotifyAbandonedOperations()
Gets the "notify-abandoned-operations" property.
|
boolean |
isRejectUnauthenticatedRequests()
Gets the "reject-unauthenticated-requests" property.
|
boolean |
isReturnBindErrorMessages()
Gets the "return-bind-error-messages" property.
|
boolean |
isSaveConfigOnSuccessfulStartup()
Gets the "save-config-on-successful-startup" property.
|
boolean |
isTrustTransactionIds()
Gets the "trust-transaction-ids" property.
|
void |
removeChangeListener(ConfigurationChangeListener<GlobalCfg> listener)
Deregister an existing Global Configuration configuration change listener.
|
dn, name
Class<? extends GlobalCfg> configurationClass()
configurationClass
in interface Configuration
void addChangeListener(ConfigurationChangeListener<GlobalCfg> listener)
listener
- The Global Configuration configuration change listener.void removeChangeListener(ConfigurationChangeListener<GlobalCfg> listener)
listener
- The Global Configuration configuration change listener.boolean isAddMissingRdnAttributes()
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.
boolean isAllowAttributeNameExceptions()
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).
SortedSet<String> getAllowedTask()
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.
boolean isBindWithDnRequiresPassword()
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.
boolean isCheckSchema()
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.
int getCursorEntryLimit()
Specifies the maximum number of entry IDs that the directory server may retrieve by cursoring through an index during a search.
A value of 0 indicates that no cursor entry 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-cursor-entry-limit operational attribute.
String getDefaultPasswordPolicy()
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.
Dn getDefaultPasswordPolicyDn()
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.
SortedSet<GlobalCfgDefn.DisabledPrivilege> getDisabledPrivilege()
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.
GlobalCfgDefn.EtimeResolution getEtimeResolution()
Specifies the resolution to use for operation elapsed processing time (etime) measurements.
long getIdleTimeLimit()
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.
GlobalCfgDefn.InvalidAttributeSyntaxBehavior getInvalidAttributeSyntaxBehavior()
Specifies how the directory server should handle operations whenever an attribute value violates the associated attribute syntax.
int getLookthroughLimit()
Specifies the maximum number of entries that the directory server should "look through" in the course of processing a search request.
This includes any entry that the server must examine in the course of processing the request, regardless of whether it actually matches the search criteria. A value of 0 indicates that no lookthrough 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-lookthrough-limit operational attribute.
int getMaxAllowedClientConnections()
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.
long getMaxInternalBufferSize()
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.
int getMaxPsearches()
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.
boolean isNotifyAbandonedOperations()
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.
String getProxiedAuthorizationIdentityMapper()
Specifies the name of the identity mapper to map authorization ID values (using the "u:" form) provided in the proxied authorization control to the corresponding user entry.
Dn getProxiedAuthorizationIdentityMapperDn()
Specifies the name of the identity mapper to map authorization ID values (using the "u:" form) provided in the proxied authorization control to the corresponding user entry.
boolean isRejectUnauthenticatedRequests()
Indicates whether the directory server should reject any request (other than bind or StartTLS 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.
boolean isReturnBindErrorMessages()
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.
boolean isSaveConfigOnSuccessfulStartup()
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.
Integer getServerId()
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.
GlobalCfgDefn.SingleStructuralObjectclassBehavior getSingleStructuralObjectclassBehavior()
Specifies how the directory server should handle operations an entry does not contain a structural object class or contains multiple structural classes.
int getSizeLimit()
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.
SortedSet<String> getSmtpServer()
Specifies the address (and optional port number) for a mail server that can be used to send email messages via SMTP.
It may be an IP address or resolvable hostname, optionally followed by a colon and a port number.
SortedSet<Dn> getSubordinateBaseDn()
Specifies the set of base DNs used for singleLevel, wholeSubtree, and subordinateSubtree searches based at the root DSE.
long getTimeLimit()
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.
boolean isTrustTransactionIds()
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.
GlobalCfgDefn.WritabilityMode getWritabilityMode()
Specifies the kinds of write operations the directory server can process.
Copyright 2010-2018 ForgeRock AS.