GlobalCfgClient (OpenDJ 3.0.0 Documentation)

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 Summary

Methods
Modifier and Type	Method and Description
`ManagedObjectDefinition<? extends GlobalCfgClient,? extends GlobalCfg>`	`definition()` Get the configuration definition associated with this Global Configuration.
`SortedSet<String>`	`getAllowedTask()` Gets the "allowed-task" property.
`String`	`getDefaultPasswordPolicy()` Gets the "default-password-policy" property.
`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.
`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.
`SortedSet<String>`	`getSMTPServer()` Gets the "smtp-server" 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`	`setAddMissingRDNAttributes(Boolean value)` Sets the "add-missing-rdn-attributes" property.
`void`	`setAllowAttributeNameExceptions(Boolean value)` Sets the "allow-attribute-name-exceptions" property.
`void`	`setAllowedTask(Collection<String> values)` Sets the "allowed-task" property.
`void`	`setBindWithDNRequiresPassword(Boolean value)` Sets the "bind-with-dn-requires-password" property.
`void`	`setCheckSchema(Boolean value)` Sets the "check-schema" property.
`void`	`setDefaultPasswordPolicy(String value)` Sets the "default-password-policy" property.
`void`	`setDisabledPrivilege(Collection<GlobalCfgDefn.DisabledPrivilege> values)` Sets the "disabled-privilege" property.
`void`	`setEtimeResolution(GlobalCfgDefn.EtimeResolution value)` Sets the "etime-resolution" property.
`void`	`setIdleTimeLimit(Long value)` Sets the "idle-time-limit" property.
`void`	`setInvalidAttributeSyntaxBehavior(GlobalCfgDefn.InvalidAttributeSyntaxBehavior value)` Sets the "invalid-attribute-syntax-behavior" property.
`void`	`setLookthroughLimit(Integer value)` Sets the "lookthrough-limit" property.
`void`	`setMaxAllowedClientConnections(Integer value)` Sets the "max-allowed-client-connections" property.
`void`	`setMaxInternalBufferSize(Long value)` Sets the "max-internal-buffer-size" property.
`void`	`setMaxPsearches(Integer value)` Sets the "max-psearches" property.
`void`	`setNotifyAbandonedOperations(Boolean value)` Sets the "notify-abandoned-operations" property.
`void`	`setProxiedAuthorizationIdentityMapper(String value)` Sets the "proxied-authorization-identity-mapper" property.
`void`	`setRejectUnauthenticatedRequests(Boolean value)` Sets the "reject-unauthenticated-requests" property.
`void`	`setReturnBindErrorMessages(Boolean value)` Sets the "return-bind-error-messages" property.
`void`	`setSaveConfigOnSuccessfulStartup(Boolean value)` Sets the "save-config-on-successful-startup" property.
`void`	`setServerErrorResultCode(Integer value)` Sets the "server-error-result-code" property.
`void`	`setSingleStructuralObjectclassBehavior(GlobalCfgDefn.SingleStructuralObjectclassBehavior value)` Sets the "single-structural-objectclass-behavior" property.
`void`	`setSizeLimit(Integer value)` Sets the "size-limit" property.
`void`	`setSMTPServer(Collection<String> values)` Sets the "smtp-server" property.
`void`	`setTimeLimit(Long value)` Sets the "time-limit" property.
`void`	`setTrustTransactionIds(Boolean value)` Sets the "trust-transaction-ids" property.
`void`	`setWritabilityMode(GlobalCfgDefn.WritabilityMode value)` Sets the "writability-mode" property.

Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties

- Method Detail
  - definition
```
ManagedObjectDefinition<? extends GlobalCfgClient,? extends GlobalCfg> definition()
```
    Get the configuration definition associated with this Global Configuration.
    
    Specified by:
    
    definition in interface ConfigurationClient
    
    Returns:
    Returns the configuration definition associated with this Global Configuration.
  - 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.
  - setAddMissingRDNAttributes
```
void setAddMissingRDNAttributes(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.
  - 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.
  - setAllowAttributeNameExceptions
```
void setAllowAttributeNameExceptions(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.
  - getAllowedTask
```
SortedSet<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<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
```
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.
  - setBindWithDNRequiresPassword
```
void setBindWithDNRequiresPassword(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
```
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.
  - setCheckSchema
```
void setCheckSchema(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
```
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
```
void setDefaultPasswordPolicy(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.
  - getDisabledPrivilege
```
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 the values of the "disabled-privilege" property.
  - setDisabledPrivilege
```
void setDisabledPrivilege(Collection<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
```
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.
  - setEtimeResolution
```
void setEtimeResolution(GlobalCfgDefn.EtimeResolution value)
                        throws PropertyException
```
    Sets the "etime-resolution" property.
    Specifies the resolution to use for operation elapsed processing time (etime) measurements.
    
    Parameters:
    value - The value of the "etime-resolution" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - 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.
  - setIdleTimeLimit
```
void setIdleTimeLimit(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
```
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.
  - setInvalidAttributeSyntaxBehavior
```
void setInvalidAttributeSyntaxBehavior(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.
  - 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.
  - setLookthroughLimit
```
void setLookthroughLimit(Integer value)
                         throws PropertyException
```
    Sets 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.
    
    Parameters:
    value - The value of the "lookthrough-limit" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - getMaxAllowedClientConnections
```
int 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.
    
    Returns:
    Returns the value of the "max-allowed-client-connections" property.
  - setMaxAllowedClientConnections
```
void setMaxAllowedClientConnections(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.
  - getMaxInternalBufferSize
```
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.
    
    Returns:
    Returns the value of the "max-internal-buffer-size" property.
  - setMaxInternalBufferSize
```
void setMaxInternalBufferSize(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
```
int 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.
    
    Returns:
    Returns the value of the "max-psearches" property.
  - setMaxPsearches
```
void setMaxPsearches(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
```
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.
  - setNotifyAbandonedOperations
```
void setNotifyAbandonedOperations(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
```
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.
  - setProxiedAuthorizationIdentityMapper
```
void setProxiedAuthorizationIdentityMapper(String value)
                                           throws PropertyException
```
    Sets 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.
    
    Parameters:
    value - The value of the "proxied-authorization-identity-mapper" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - 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.
  - setRejectUnauthenticatedRequests
```
void setRejectUnauthenticatedRequests(Boolean value)
                                      throws PropertyException
```
    Sets 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.
    
    Parameters:
    value - The value of the "reject-unauthenticated-requests" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - 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.
  - setReturnBindErrorMessages
```
void setReturnBindErrorMessages(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
```
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.
  - setSaveConfigOnSuccessfulStartup
```
void setSaveConfigOnSuccessfulStartup(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.
  - 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.
  - setServerErrorResultCode
```
void setServerErrorResultCode(Integer value)
                              throws PropertyException
```
    Sets the "server-error-result-code" property.
    Specifies the numeric value of the result code when request processing fails due to an internal server error.
    
    Parameters:
    value - The value of the "server-error-result-code" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - 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.
  - setSingleStructuralObjectclassBehavior
```
void setSingleStructuralObjectclassBehavior(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
```
int 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.
    
    Returns:
    Returns the value of the "size-limit" property.
  - setSizeLimit
```
void setSizeLimit(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.
  - getSMTPServer
```
SortedSet<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 the values of the "smtp-server" property.
  - setSMTPServer
```
void setSMTPServer(Collection<String> values)
                   throws PropertyException
```
    Sets 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.
    
    Parameters:
    values - The values of the "smtp-server" property.
    
    Throws:
    
    PropertyException - If one or more of the new values are invalid.
  - getTimeLimit
```
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.
    
    Returns:
    Returns the value of the "time-limit" property.
  - setTimeLimit
```
void setTimeLimit(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
```
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.
    
    Returns:
    Returns the value of the "trust-transaction-ids" property.
  - setTrustTransactionIds
```
void setTrustTransactionIds(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.
    
    Parameters:
    value - The value of the "trust-transaction-ids" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.
  - 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.
  - setWritabilityMode
```
void setWritabilityMode(GlobalCfgDefn.WritabilityMode value)
                        throws PropertyException
```
    Sets the "writability-mode" property.
    Specifies the kinds of write operations the directory server can process.
    
    Parameters:
    value - The value of the "writability-mode" property.
    
    Throws:
    
    PropertyException - If the new value is invalid.

Interface GlobalCfgClient

Method Summary

Methods inherited from interface org.opends.server.admin.ConfigurationClient

Method Detail

definition

isAddMissingRDNAttributes

setAddMissingRDNAttributes

isAllowAttributeNameExceptions

setAllowAttributeNameExceptions

getAllowedTask

setAllowedTask

isBindWithDNRequiresPassword

setBindWithDNRequiresPassword

isCheckSchema

setCheckSchema

getDefaultPasswordPolicy

setDefaultPasswordPolicy

getDisabledPrivilege

setDisabledPrivilege

getEtimeResolution

setEtimeResolution

getIdleTimeLimit

setIdleTimeLimit

getInvalidAttributeSyntaxBehavior

setInvalidAttributeSyntaxBehavior

getLookthroughLimit

setLookthroughLimit

getMaxAllowedClientConnections

setMaxAllowedClientConnections

getMaxInternalBufferSize

setMaxInternalBufferSize

getMaxPsearches

setMaxPsearches

isNotifyAbandonedOperations

setNotifyAbandonedOperations

getProxiedAuthorizationIdentityMapper

setProxiedAuthorizationIdentityMapper

isRejectUnauthenticatedRequests

setRejectUnauthenticatedRequests

isReturnBindErrorMessages

setReturnBindErrorMessages

isSaveConfigOnSuccessfulStartup

setSaveConfigOnSuccessfulStartup

getServerErrorResultCode

setServerErrorResultCode

getSingleStructuralObjectclassBehavior

setSingleStructuralObjectclassBehavior

getSizeLimit

setSizeLimit

getSMTPServer

setSMTPServer

getTimeLimit

setTimeLimit

isTrustTransactionIds

setTrustTransactionIds

getWritabilityMode

setWritabilityMode