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

Interface AccessControlHandlerCfgClient

All Superinterfaces:

ConfigurationClient

All Known Subinterfaces:

DseeCompatAccessControlHandlerCfgClient

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 Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends AccessControlHandlerCfgClient,? extends AccessControlHandlerCfg>	definition()	Get the configuration definition associated with this Access Control Handler.
String	getJavaClass()	Gets the "java-class" property.
Boolean	isEnabled()	Gets the "enabled" property.
void	setEnabled(boolean value)	Sets the "enabled" property.
void	setJavaClass(String value)	Sets the "java-class" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Method Detail

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

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.

setEnabled

void setEnabled(boolean value)
         throws PropertyException

Sets 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.

Parameters:

value - The value of the "enabled" property.

Throws:

PropertyException - If the new value is invalid.

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.

setJavaClass

void setJavaClass(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.