org.opends.server.admin.std.meta
Class GlobalCfgDefn

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<GlobalCfgClient,GlobalCfg>
          extended by org.opends.server.admin.std.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 OpenDS Directory Server .


Nested Class Summary
static class GlobalCfgDefn.DisabledPrivilege
          Defines the set of permissable values for the "disabled-privilege" property.
static class GlobalCfgDefn.EtimeResolution
          Defines the set of permissable values for the "etime-resolution" property.
static class GlobalCfgDefn.InvalidAttributeSyntaxBehavior
          Defines the set of permissable values for the "invalid-attribute-syntax-behavior" property.
static class GlobalCfgDefn.SingleStructuralObjectclassBehavior
          Defines the set of permissable values for the "single-structural-objectclass-behavior" property.
static class GlobalCfgDefn.WorkflowConfigurationMode
          Defines the set of permissable values for the "workflow-configuration-mode" property.
static class GlobalCfgDefn.WritabilityMode
          Defines the set of permissable values for the "writability-mode" property.
 
Method Summary
 GlobalCfgClient createClientConfiguration(ManagedObject<? extends GlobalCfgClient> impl)
          Creates a client configuration view of the provided managed object.
 GlobalCfg createServerConfiguration(ServerManagedObject<? extends GlobalCfg> impl)
          Creates a server configuration view of the provided server managed object.
 BooleanPropertyDefinition getAddMissingRDNAttributesPropertyDefinition()
          Get the "add-missing-rdn-attributes" property definition.
 BooleanPropertyDefinition getAllowAttributeNameExceptionsPropertyDefinition()
          Get the "allow-attribute-name-exceptions" property definition.
 StringPropertyDefinition getAllowedTaskPropertyDefinition()
          Get the "allowed-task" property definition.
 BooleanPropertyDefinition getBindWithDNRequiresPasswordPropertyDefinition()
          Get the "bind-with-dn-requires-password" property definition.
 BooleanPropertyDefinition getCheckSchemaPropertyDefinition()
          Get the "check-schema" property definition.
 AggregationPropertyDefinition<PasswordPolicyCfgClient,PasswordPolicyCfg> getDefaultPasswordPolicyPropertyDefinition()
          Get the "default-password-policy" property definition.
 EnumPropertyDefinition<GlobalCfgDefn.DisabledPrivilege> getDisabledPrivilegePropertyDefinition()
          Get the "disabled-privilege" property definition.
 BooleanPropertyDefinition getEntryCachePreloadPropertyDefinition()
          Get the "entry-cache-preload" property definition.
 EnumPropertyDefinition<GlobalCfgDefn.EtimeResolution> getEtimeResolutionPropertyDefinition()
          Get the "etime-resolution" property definition.
 DurationPropertyDefinition getIdleTimeLimitPropertyDefinition()
          Get the "idle-time-limit" property definition.
static GlobalCfgDefn getInstance()
          Get the Global Configuration configuration definition singleton.
 EnumPropertyDefinition<GlobalCfgDefn.InvalidAttributeSyntaxBehavior> getInvalidAttributeSyntaxBehaviorPropertyDefinition()
          Get the "invalid-attribute-syntax-behavior" property definition.
 IntegerPropertyDefinition getLookthroughLimitPropertyDefinition()
          Get the "lookthrough-limit" property definition.
 BooleanPropertyDefinition getNotifyAbandonedOperationsPropertyDefinition()
          Get the "notify-abandoned-operations" property definition.
 AggregationPropertyDefinition<IdentityMapperCfgClient,IdentityMapperCfg> getProxiedAuthorizationIdentityMapperPropertyDefinition()
          Get the "proxied-authorization-identity-mapper" property definition.
 BooleanPropertyDefinition getRejectUnauthenticatedRequestsPropertyDefinition()
          Get the "reject-unauthenticated-requests" property definition.
 BooleanPropertyDefinition getReturnBindErrorMessagesPropertyDefinition()
          Get the "return-bind-error-messages" property definition.
 BooleanPropertyDefinition getSaveConfigOnSuccessfulStartupPropertyDefinition()
          Get the "save-config-on-successful-startup" property definition.
 java.lang.Class<GlobalCfg> getServerConfigurationClass()
          Gets the server configuration class instance associated with this managed object definition.
 IntegerPropertyDefinition getServerErrorResultCodePropertyDefinition()
          Get the "server-error-result-code" property definition.
 EnumPropertyDefinition<GlobalCfgDefn.SingleStructuralObjectclassBehavior> getSingleStructuralObjectclassBehaviorPropertyDefinition()
          Get the "single-structural-objectclass-behavior" property definition.
 IntegerPropertyDefinition getSizeLimitPropertyDefinition()
          Get the "size-limit" property definition.
 StringPropertyDefinition getSMTPServerPropertyDefinition()
          Get the "smtp-server" property definition.
 DurationPropertyDefinition getTimeLimitPropertyDefinition()
          Get the "time-limit" property definition.
 EnumPropertyDefinition<GlobalCfgDefn.WorkflowConfigurationMode> getWorkflowConfigurationModePropertyDefinition()
          Get the "workflow-configuration-mode" property definition.
 EnumPropertyDefinition<GlobalCfgDefn.WritabilityMode> getWritabilityModePropertyDefinition()
          Get the "writability-mode" property definition.
 
Methods inherited from class org.opends.server.admin.AbstractManagedObjectDefinition
getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

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)
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)
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 java.lang.Class<GlobalCfg> getServerConfigurationClass()
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.

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.

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

Returns:
Returns the "default-password-policy" 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.

getEntryCachePreloadPropertyDefinition

public BooleanPropertyDefinition getEntryCachePreloadPropertyDefinition()
Get the "entry-cache-preload" property definition.

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

Returns:
Returns the "entry-cache-preload" 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.

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.

getLookthroughLimitPropertyDefinition

public IntegerPropertyDefinition getLookthroughLimitPropertyDefinition()
Get the "lookthrough-limit" property definition.

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 "lookthrough-limit" 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 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.

getRejectUnauthenticatedRequestsPropertyDefinition

public BooleanPropertyDefinition getRejectUnauthenticatedRequestsPropertyDefinition()
Get the "reject-unauthenticated-requests" property definition.

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 "reject-unauthenticated-requests" 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.

getServerErrorResultCodePropertyDefinition

public IntegerPropertyDefinition getServerErrorResultCodePropertyDefinition()
Get the "server-error-result-code" property definition.

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

Returns:
Returns the "server-error-result-code" 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 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 "size-limit" property definition.

getSMTPServerPropertyDefinition

public StringPropertyDefinition getSMTPServerPropertyDefinition()
Get the "smtp-server" property definition.

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 the "smtp-server" property definition.

getTimeLimitPropertyDefinition

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

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 "time-limit" property definition.

getWorkflowConfigurationModePropertyDefinition

public EnumPropertyDefinition<GlobalCfgDefn.WorkflowConfigurationMode> getWorkflowConfigurationModePropertyDefinition()
Get the "workflow-configuration-mode" property definition.

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

Returns:
Returns the "workflow-configuration-mode" 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.