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

Interface AccessControlHandlerCfg

All Superinterfaces:
Configuration
All Known Subinterfaces:
DseeCompatAccessControlHandlerCfg, PolicyBasedAccessControlHandlerCfg
public interface AccessControlHandlerCfg extends Configuration
A server-side interface for querying 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

    • configurationClass

      Class<? extends AccessControlHandlerCfg> configurationClass()
      Gets the configuration class associated with this Access Control Handler.
      Specified by:
      configurationClass in interface Configuration
      Returns:
      Returns the configuration class associated with this Access Control Handler.

    • addChangeListener

      void addChangeListener(ConfigurationChangeListener<AccessControlHandlerCfg> listener)
      Register to be notified when this Access Control Handler is changed.
      Parameters:
      listener - The Access Control Handler configuration change listener.

    • removeChangeListener

      void removeChangeListener(ConfigurationChangeListener<AccessControlHandlerCfg> listener)
      Deregister an existing Access Control Handler configuration change listener.
      Parameters:
      listener - The Access Control Handler configuration change listener.

    • isEnabled

      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.

    • getJavaClass

      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.