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

Interface DseeCompatAccessControlHandlerCfgClient

All Superinterfaces:

AccessControlHandlerCfgClient, ConfigurationClient

public interface DseeCompatAccessControlHandlerCfgClient
extends AccessControlHandlerCfgClient

A client-side interface for reading and modifying DSEE Compatible Access Control Handler settings.

The DSEE Compatible Access Control Handler provides an implementation that uses syntax compatible with the Sun Java System Directory Server Enterprise Edition access control handlers.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends DseeCompatAccessControlHandlerCfgClient,? extends DseeCompatAccessControlHandlerCfg>	definition()	Get the configuration definition associated with this DSEE Compatible Access Control Handler.
SortedSet<ValueOrExpression<String>>	getGlobalAci()	Gets the "global-aci" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
void	setGlobalAci(Collection<ValueOrExpression<String>> values)	Sets the "global-aci" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

Methods inherited from interface org.forgerock.opendj.server.config.client.AccessControlHandlerCfgClient

isEnabled, setEnabled

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

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends DseeCompatAccessControlHandlerCfgClient,? extends DseeCompatAccessControlHandlerCfg> definition()

Get the configuration definition associated with this DSEE Compatible Access Control Handler.

Specified by:

definition in interface AccessControlHandlerCfgClient

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this DSEE Compatible Access Control Handler.

getGlobalAci

SortedSet<ValueOrExpression<String>> getGlobalAci()

Gets the "global-aci" property.

Defines global access control rules.

Global access control rules apply to all entries anywhere in the data managed by the OpenDJ directory server. The global access control rules may be overridden by more specific access control rules placed in the data.

Returns:

Returns the values of the "global-aci" property.

setGlobalAci

void setGlobalAci(Collection<ValueOrExpression<String>> values)
           throws PropertyException

Sets the "global-aci" property.

Defines global access control rules.

Global access control rules apply to all entries anywhere in the data managed by the OpenDJ directory server. The global access control rules may be overridden by more specific access control rules placed in the data.

Parameters:

values - The values of the "global-aci" property.

Throws:

PropertyException - If one or more of the new values are invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

Default value: org.opends.server.authorization.dseecompat.AciHandler

Specified by:

getJavaClass in interface AccessControlHandlerCfgClient

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 DSEE Compatible Access Control Handler implementation.

Specified by:

setJavaClass in interface AccessControlHandlerCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.