org.opends.server.admin.std.server
Interface AccessControlHandlerCfg

All Superinterfaces:
Configuration
All Known Subinterfaces:
DseeCompatAccessControlHandlerCfg

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 OpenDS 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 Summary
 void addChangeListener(ConfigurationChangeListener<AccessControlHandlerCfg> listener)
          Register to be notified when this Access Control Handler is changed.
 java.lang.Class<? extends AccessControlHandlerCfg> configurationClass()
          Gets the configuration class associated with this Access Control Handler.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 boolean isEnabled()
          Gets the "enabled" property.
 void removeChangeListener(ConfigurationChangeListener<AccessControlHandlerCfg> listener)
          Deregister an existing Access Control Handler configuration change listener.
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.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 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.

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

getJavaClass

java.lang.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.