Note: this component has a complexity level of "expert", which means that objects of this type are not expected to be created or altered. Please contact UnboundID support for assistance if you believe that you have a need to create or modify this type of object.
Note: this is an abstract component that cannot be instantiated.
Access Control Handlers manage the application-wide access control. The Metrics Engine access control handler is defined through an extensible interface, so that alternate implementations can be created. Only one access control handler may be active in the server at any given time.
Note that the Metrics Engine also has a privilege subsystem, which may have an impact on what clients may be allowed to do in the server. For example, any user with the bypass-acl privilege is not subject to access control checking regardless of whether the access control implementation is enabled, and any user with the bypass-read-acl privilege will be exempt from access control evaluation for bind, compare, and search operations.
↓Direct Subcomponents
↓Properties
↓dsconfig Usage
The following Access Control Handlers are available in the server :
These Access Control Handlers inherit from the properties described below.
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ enabled | None |
| ↓ java-class |
| Description | Indicates whether this Access Control Handler is enabled. If set to FALSE, then no access control is enforced, and any client (including unauthenticated or anonymous clients) could be allowed to perform any operation if not subject to other restrictions, such as those enforced by the privilege subsystem. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the fully-qualified name of the Java class that provides the Access Control Handler implementation. |
| Default Value | None |
| Allowed Values | The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.api.AccessControlHandler |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To view the Access Control Handler configuration:
dsconfig get-access-control-handler-prop
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the Access Control Handler configuration:
dsconfig set-access-control-handler-prop
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...