|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GlobalCfgClient
A client-side interface for reading and modifying Global Configuration settings.
The Global Configuration contains properties that affect the overall operation of the OpenDS Directory Server .
Method Summary | |
---|---|
ManagedObjectDefinition<? extends GlobalCfgClient,? extends GlobalCfg> |
definition()
Get the configuration definition 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. |
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. |
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 |
setAddMissingRDNAttributes(java.lang.Boolean value)
Sets the "add-missing-rdn-attributes" property. |
void |
setAllowAttributeNameExceptions(java.lang.Boolean value)
Sets the "allow-attribute-name-exceptions" property. |
void |
setAllowedTask(java.util.Collection<java.lang.String> values)
Sets the "allowed-task" property. |
void |
setBindWithDNRequiresPassword(java.lang.Boolean value)
Sets the "bind-with-dn-requires-password" property. |
void |
setCheckSchema(java.lang.Boolean value)
Sets the "check-schema" property. |
void |
setDefaultPasswordPolicy(java.lang.String value)
Sets the "default-password-policy" property. |
void |
setDisabledPrivilege(java.util.Collection<GlobalCfgDefn.DisabledPrivilege> values)
Sets the "disabled-privilege" property. |
void |
setEntryCachePreload(java.lang.Boolean value)
Sets the "entry-cache-preload" property. |
void |
setEtimeResolution(GlobalCfgDefn.EtimeResolution value)
Sets the "etime-resolution" property. |
void |
setIdleTimeLimit(java.lang.Long value)
Sets the "idle-time-limit" property. |
void |
setInvalidAttributeSyntaxBehavior(GlobalCfgDefn.InvalidAttributeSyntaxBehavior value)
Sets the "invalid-attribute-syntax-behavior" property. |
void |
setLookthroughLimit(java.lang.Integer value)
Sets the "lookthrough-limit" property. |
void |
setNotifyAbandonedOperations(java.lang.Boolean value)
Sets the "notify-abandoned-operations" property. |
void |
setProxiedAuthorizationIdentityMapper(java.lang.String value)
Sets the "proxied-authorization-identity-mapper" property. |
void |
setRejectUnauthenticatedRequests(java.lang.Boolean value)
Sets the "reject-unauthenticated-requests" property. |
void |
setReturnBindErrorMessages(java.lang.Boolean value)
Sets the "return-bind-error-messages" property. |
void |
setSaveConfigOnSuccessfulStartup(java.lang.Boolean value)
Sets the "save-config-on-successful-startup" property. |
void |
setServerErrorResultCode(java.lang.Integer value)
Sets the "server-error-result-code" property. |
void |
setSingleStructuralObjectclassBehavior(GlobalCfgDefn.SingleStructuralObjectclassBehavior value)
Sets the "single-structural-objectclass-behavior" property. |
void |
setSizeLimit(java.lang.Integer value)
Sets the "size-limit" property. |
void |
setSMTPServer(java.util.Collection<java.lang.String> values)
Sets the "smtp-server" property. |
void |
setTimeLimit(java.lang.Long value)
Sets the "time-limit" property. |
void |
setWorkflowConfigurationMode(GlobalCfgDefn.WorkflowConfigurationMode value)
Sets the "workflow-configuration-mode" property. |
void |
setWritabilityMode(GlobalCfgDefn.WritabilityMode value)
Sets the "writability-mode" property. |
Methods inherited from interface org.opends.server.admin.ConfigurationClient |
---|
commit, properties |
Method Detail |
---|
ManagedObjectDefinition<? extends GlobalCfgClient,? extends GlobalCfg> definition()
definition
in interface ConfigurationClient
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.
void setAddMissingRDNAttributes(java.lang.Boolean value) throws IllegalPropertyValueException
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.
value
- The value of the "add-missing-rdn-attributes" property.
IllegalPropertyValueException
- If the new value is invalid.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).
void setAllowAttributeNameExceptions(java.lang.Boolean value) throws IllegalPropertyValueException
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).
value
- The value of the "allow-attribute-name-exceptions" property.
IllegalPropertyValueException
- If the new value is invalid.java.util.SortedSet<java.lang.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.
void setAllowedTask(java.util.Collection<java.lang.String> values) throws IllegalPropertyValueException
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.
values
- The values of the "allowed-task" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.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.
void setBindWithDNRequiresPassword(java.lang.Boolean value) throws IllegalPropertyValueException
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.
value
- The value of the "bind-with-dn-requires-password" property.
IllegalPropertyValueException
- If the new value is invalid.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.
void setCheckSchema(java.lang.Boolean value) throws IllegalPropertyValueException
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.
value
- The value of the "check-schema" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.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).
void setDefaultPasswordPolicy(java.lang.String value) throws IllegalPropertyValueException
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).
value
- The value of the "default-password-policy" property.
IllegalPropertyValueException
- If the new value is invalid.java.util.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.
void setDisabledPrivilege(java.util.Collection<GlobalCfgDefn.DisabledPrivilege> values) throws IllegalPropertyValueException
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.
values
- The values of the "disabled-privilege" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.boolean isEntryCachePreload()
Indicates whether or not to preload the entry cache on startup.
void setEntryCachePreload(java.lang.Boolean value) throws IllegalPropertyValueException
Indicates whether or not to preload the entry cache on startup.
value
- The value of the "entry-cache-preload" property.
IllegalPropertyValueException
- If the new value is invalid.GlobalCfgDefn.EtimeResolution getEtimeResolution()
Specifies the resolution to use for operation elapsed processing time (etime) measurements.
void setEtimeResolution(GlobalCfgDefn.EtimeResolution value) throws IllegalPropertyValueException
Specifies the resolution to use for operation elapsed processing time (etime) measurements.
value
- The value of the "etime-resolution" property.
IllegalPropertyValueException
- If the new value is invalid.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.
void setIdleTimeLimit(java.lang.Long value) throws IllegalPropertyValueException
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.
value
- The value of the "idle-time-limit" property.
IllegalPropertyValueException
- If the new value is invalid.GlobalCfgDefn.InvalidAttributeSyntaxBehavior getInvalidAttributeSyntaxBehavior()
Specifies how the Directory Server should handle operations whenever an attribute value violates the associated attribute syntax.
void setInvalidAttributeSyntaxBehavior(GlobalCfgDefn.InvalidAttributeSyntaxBehavior value) throws IllegalPropertyValueException
Specifies how the Directory Server should handle operations whenever an attribute value violates the associated attribute syntax.
value
- The value of the "invalid-attribute-syntax-behavior" property.
IllegalPropertyValueException
- If the new value is invalid.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.
void setLookthroughLimit(java.lang.Integer value) throws IllegalPropertyValueException
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.
value
- The value of the "lookthrough-limit" property.
IllegalPropertyValueException
- If the new value is invalid.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.
void setNotifyAbandonedOperations(java.lang.Boolean value) throws IllegalPropertyValueException
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.
value
- The value of the "notify-abandoned-operations" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.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.
void setProxiedAuthorizationIdentityMapper(java.lang.String value) throws IllegalPropertyValueException
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.
value
- The value of the "proxied-authorization-identity-mapper" property.
IllegalPropertyValueException
- If the new value is invalid.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.
void setRejectUnauthenticatedRequests(java.lang.Boolean value) throws IllegalPropertyValueException
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.
value
- The value of the "reject-unauthenticated-requests" property.
IllegalPropertyValueException
- If the new value is invalid.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.
void setReturnBindErrorMessages(java.lang.Boolean value) throws IllegalPropertyValueException
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.
value
- The value of the "return-bind-error-messages" property.
IllegalPropertyValueException
- If the new value is invalid.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.
void setSaveConfigOnSuccessfulStartup(java.lang.Boolean value) throws IllegalPropertyValueException
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.
value
- The value of the "save-config-on-successful-startup" property.
IllegalPropertyValueException
- If the new value is invalid.int getServerErrorResultCode()
Specifies the numeric value of the result code when request processing fails due to an internal server error.
void setServerErrorResultCode(java.lang.Integer value) throws IllegalPropertyValueException
Specifies the numeric value of the result code when request processing fails due to an internal server error.
value
- The value of the "server-error-result-code" property.
IllegalPropertyValueException
- If the new value is invalid.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.
void setSingleStructuralObjectclassBehavior(GlobalCfgDefn.SingleStructuralObjectclassBehavior value) throws IllegalPropertyValueException
Specifies how the Directory Server should handle operations an entry does not contain a structural object class or contains multiple structural classes.
value
- The value of the "single-structural-objectclass-behavior" property.
IllegalPropertyValueException
- If the new value is invalid.int getSizeLimit()
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.
void setSizeLimit(java.lang.Integer value) throws IllegalPropertyValueException
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.
value
- The value of the "size-limit" property.
IllegalPropertyValueException
- If the new value is invalid.java.util.SortedSet<java.lang.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.
void setSMTPServer(java.util.Collection<java.lang.String> values) throws IllegalPropertyValueException
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.
values
- The values of the "smtp-server" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.long getTimeLimit()
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.
void setTimeLimit(java.lang.Long value) throws IllegalPropertyValueException
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.
value
- The value of the "time-limit" property.
IllegalPropertyValueException
- If the new value is invalid.GlobalCfgDefn.WorkflowConfigurationMode getWorkflowConfigurationMode()
Specifies the workflow configuration mode (auto vs. manual).
void setWorkflowConfigurationMode(GlobalCfgDefn.WorkflowConfigurationMode value) throws IllegalPropertyValueException
Specifies the workflow configuration mode (auto vs. manual).
value
- The value of the "workflow-configuration-mode" property.
IllegalPropertyValueException
- If the new value is invalid.GlobalCfgDefn.WritabilityMode getWritabilityMode()
Specifies the kinds of write operations the Directory Server can process.
void setWritabilityMode(GlobalCfgDefn.WritabilityMode value) throws IllegalPropertyValueException
Specifies the kinds of write operations the Directory Server can process.
value
- The value of the "writability-mode" property.
IllegalPropertyValueException
- If the new value is invalid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |