org.opends.server.admin.std.server
Interface GlobalCfg

All Superinterfaces:
Configuration

public interface GlobalCfg
extends Configuration

A server-side interface for querying Global Configuration settings.

The Global Configuration contains properties that affect the overall operation of the OpenDS Directory Server .


Method Summary
 void addChangeListener(ConfigurationChangeListener<GlobalCfg> listener)
          Register to be notified when this Global Configuration is changed.
 java.lang.Class<? extends GlobalCfg> configurationClass()
          Gets the configuration class associated with this Global Configuration.
 java.util.SortedSet<java.lang.String> getAllowedTask()
          Gets the "allowed-task" property.
 java.lang.String getDefaultPasswordPolicy()
          Gets the "default-password-policy" property.
 DN getDefaultPasswordPolicyDN()
          Gets the "default-password-policy" property as a DN.
 java.util.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.
 java.lang.String getProxiedAuthorizationIdentityMapper()
          Gets the "proxied-authorization-identity-mapper" property.
 DN getProxiedAuthorizationIdentityMapperDN()
          Gets the "proxied-authorization-identity-mapper" property as a DN.
 int getServerErrorResultCode()
          Gets the "server-error-result-code" property.
 GlobalCfgDefn.SingleStructuralObjectclassBehavior getSingleStructuralObjectclassBehavior()
          Gets the "single-structural-objectclass-behavior" property.
 int getSizeLimit()
          Gets the "size-limit" property.
 java.util.SortedSet<java.lang.String> getSMTPServer()
          Gets the "smtp-server" property.
 long getTimeLimit()
          Gets the "time-limit" property.
 GlobalCfgDefn.WorkflowConfigurationMode getWorkflowConfigurationMode()
          Gets the "workflow-configuration-mode" 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 isEntryCachePreload()
          Gets the "entry-cache-preload" 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.
 void removeChangeListener(ConfigurationChangeListener<GlobalCfg> listener)
          Deregister an existing Global Configuration configuration change listener.
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends GlobalCfg> configurationClass()
Gets the configuration class associated with this Global Configuration.

Specified by:
configurationClass in interface Configuration
Returns:
Returns the configuration class associated with this Global Configuration.

addChangeListener

void addChangeListener(ConfigurationChangeListener<GlobalCfg> listener)
Register to be notified when this Global Configuration is changed.

Parameters:
listener - The Global Configuration configuration change listener.

removeChangeListener

void removeChangeListener(ConfigurationChangeListener<GlobalCfg> listener)
Deregister an existing Global Configuration configuration change listener.

Parameters:
listener - The Global Configuration configuration change listener.

isAddMissingRDNAttributes

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.

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

isAllowAttributeNameExceptions

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

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

getAllowedTask

java.util.SortedSet<java.lang.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 an unmodifiable set containing the values of the "allowed-task" property.

isBindWithDNRequiresPassword

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.

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

isCheckSchema

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.

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

getDefaultPasswordPolicy

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

Returns:
Returns the value of the "default-password-policy" property.

getDefaultPasswordPolicyDN

DN getDefaultPasswordPolicyDN()
Gets the "default-password-policy" property as a DN.

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

Returns:
Returns the DN value of the "default-password-policy" property.

getDisabledPrivilege

java.util.SortedSet<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 an unmodifiable set containing the values of the "disabled-privilege" property.

isEntryCachePreload

boolean isEntryCachePreload()
Gets the "entry-cache-preload" property.

Indicates whether or not to preload the entry cache on startup.

Returns:
Returns the value of the "entry-cache-preload" property.

getEtimeResolution

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

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

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

getIdleTimeLimit

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.

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

getInvalidAttributeSyntaxBehavior

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.

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

getLookthroughLimit

int getLookthroughLimit()
Gets the "lookthrough-limit" property.

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.

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

isNotifyAbandonedOperations

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.

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

getProxiedAuthorizationIdentityMapper

java.lang.String getProxiedAuthorizationIdentityMapper()
Gets the "proxied-authorization-identity-mapper" property.

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.

Returns:
Returns the value of the "proxied-authorization-identity-mapper" property.

getProxiedAuthorizationIdentityMapperDN

DN getProxiedAuthorizationIdentityMapperDN()
Gets the "proxied-authorization-identity-mapper" property as a DN.

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.

Returns:
Returns the DN value of the "proxied-authorization-identity-mapper" property.

isRejectUnauthenticatedRequests

boolean isRejectUnauthenticatedRequests()
Gets the "reject-unauthenticated-requests" property.

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.

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

isReturnBindErrorMessages

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.

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

isSaveConfigOnSuccessfulStartup

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.

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

getServerErrorResultCode

int getServerErrorResultCode()
Gets the "server-error-result-code" property.

Specifies the numeric value of the result code when request processing fails due to an internal server error.

Returns:
Returns the value of the "server-error-result-code" property.

getSingleStructuralObjectclassBehavior

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.

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

getSizeLimit

int getSizeLimit()
Gets the "size-limit" property.

Specifies the maximum number of entries that the Directory Server should return to the client durin a 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 value of the "size-limit" property.

getSMTPServer

java.util.SortedSet<java.lang.String> getSMTPServer()
Gets the "smtp-server" property.

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.

Returns:
Returns an unmodifiable set containing the values of the "smtp-server" property.

getTimeLimit

long getTimeLimit()
Gets the "time-limit" property.

Specifies the maximum length of time that the Directory Server should spend processing a 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 value of the "time-limit" property.

getWorkflowConfigurationMode

GlobalCfgDefn.WorkflowConfigurationMode getWorkflowConfigurationMode()
Gets the "workflow-configuration-mode" property.

Specifies the workflow configuration mode (auto vs. manual).

Returns:
Returns the value of the "workflow-configuration-mode" property.

getWritabilityMode

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

Specifies the kinds of write operations the Directory Server can process.

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