Package org.forgerock.opendj.server.config.client

Interface AccessControlHandlerCfgClient

All Superinterfaces:
ConfigurationClient
All Known Subinterfaces:
DseeCompatAccessControlHandlerCfgClient, PolicyBasedAccessControlHandlerCfgClient
public interface AccessControlHandlerCfgClient extends ConfigurationClient
A client-side interface for reading and modifying Access Control Handler settings.

Access Control Handlers manage the application-wide access control. The OpenDJ 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.

  • Method Details

    • definition

      ManagedObjectDefinition<? extends AccessControlHandlerCfgClient,? extends AccessControlHandlerCfg> definition()
      Get the configuration definition associated with this Access Control Handler.
      Specified by:
      definition in interface ConfigurationClient
      Returns:
      Returns the configuration definition associated with this Access Control Handler.

    • isEnabled

      @MandatoryProperty ValueOrExpression<Boolean> isEnabled()
      Gets the "enabled" property.

      Indicates whether the Access Control Handler is enabled. If set to FALSE, then any client (including unauthenticated or anonymous clients) is allowed to bind to the server and any connection with the "bypass-acl" privilege is allowed to perform any operation.

      Returns:
      Returns the value of the "enabled" property.

    • setEnabled

      @MandatoryProperty void setEnabled(ValueOrExpression<Boolean> value) throws PropertyException
      Sets the "enabled" property.

      Indicates whether the Access Control Handler is enabled. If set to FALSE, then any client (including unauthenticated or anonymous clients) is allowed to bind to the server and any connection with the "bypass-acl" privilege is allowed to perform any operation.

      Parameters:
      value - The value of the "enabled" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getJavaClass

      @MandatoryProperty ValueOrExpression<String> getJavaClass()
      Gets the "java-class" property.

      Specifies the fully-qualified name of the Java class that provides the Access Control Handler implementation.

      Returns:
      Returns the value of the "java-class" property.

    • setJavaClass

      @MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
      Sets the "java-class" property.

      Specifies the fully-qualified name of the Java class that provides the Access Control Handler implementation.

      Parameters:
      value - The value of the "java-class" property.
      Throws:
      PropertyException - If the new value is invalid.