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

Interface AttributeCleanupPluginCfgClient

All Superinterfaces:

ConfigurationClient, PluginCfgClient

public interface AttributeCleanupPluginCfgClient
extends PluginCfgClient

A client-side interface for reading and modifying Attribute Cleanup Plugin settings.

A pre-parse plugin which can be used to remove and rename attributes in ADD and MODIFY requests before being processed.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends AttributeCleanupPluginCfgClient,? extends AttributeCleanupPluginCfg>	definition()	Get the configuration definition associated with this Attribute Cleanup Plugin.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
SortedSet<ValueOrExpression<PluginCfgDefn.PluginType>>	getPluginType()	Gets the "plugin-type" property.
SortedSet<ValueOrExpression<String>>	getRemoveInboundAttributes()	Gets the "remove-inbound-attributes" property.
SortedSet<ValueOrExpression<String>>	getRenameInboundAttributes()	Gets the "rename-inbound-attributes" property.
ValueOrExpression<Boolean>	isInvokeForInternalOperations()	Gets the "invoke-for-internal-operations" property.
void	setInvokeForInternalOperations(ValueOrExpression<Boolean> value)	Sets the "invoke-for-internal-operations" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values)	Sets the "plugin-type" property.
void	setRemoveInboundAttributes(Collection<ValueOrExpression<String>> values)	Sets the "remove-inbound-attributes" property.
void	setRenameInboundAttributes(Collection<ValueOrExpression<String>> values)	Sets the "rename-inbound-attributes" property.

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

commit, properties

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

isEnabled, setEnabled

Method Detail

definition

ManagedObjectDefinition<? extends AttributeCleanupPluginCfgClient,? extends AttributeCleanupPluginCfg> definition()

Get the configuration definition associated with this Attribute Cleanup Plugin.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface PluginCfgClient

Returns:

Returns the configuration definition associated with this Attribute Cleanup Plugin.

isInvokeForInternalOperations

ValueOrExpression<Boolean> isInvokeForInternalOperations()

Gets the "invoke-for-internal-operations" property.

Indicates whether the plug-in should be invoked for internal operations.

Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.

Default value: false

Specified by:

isInvokeForInternalOperations in interface PluginCfgClient

Returns:

Returns the value of the "invoke-for-internal-operations" property.

setInvokeForInternalOperations

void setInvokeForInternalOperations(ValueOrExpression<Boolean> value)
                             throws PropertyException

Sets the "invoke-for-internal-operations" property.

Indicates whether the plug-in should be invoked for internal operations.

Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.

Specified by:

setInvokeForInternalOperations in interface PluginCfgClient

Parameters:

value - The value of the "invoke-for-internal-operations" 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 plug-in implementation.

Default value: org.opends.server.plugins.AttributeCleanupPlugin

Specified by:

getJavaClass in interface PluginCfgClient

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 plug-in implementation.

Specified by:

setJavaClass in interface PluginCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getPluginType

@MandatoryProperty
SortedSet<ValueOrExpression<PluginCfgDefn.PluginType>> getPluginType()

Gets the "plugin-type" property.

Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.

Default values: preparseadd, preparsemodify

Specified by:

getPluginType in interface PluginCfgClient

Returns:

Returns the values of the "plugin-type" property.

setPluginType

@MandatoryProperty
void setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values)
            throws PropertyException

Sets the "plugin-type" property.

Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.

Specified by:

setPluginType in interface PluginCfgClient

Parameters:

values - The values of the "plugin-type" property.

Throws:

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

getRemoveInboundAttributes

SortedSet<ValueOrExpression<String>> getRemoveInboundAttributes()

Gets the "remove-inbound-attributes" property.

A list of attributes which should be removed from incoming add or modify requests.

Returns:

Returns the values of the "remove-inbound-attributes" property.

setRemoveInboundAttributes

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

Sets the "remove-inbound-attributes" property.

A list of attributes which should be removed from incoming add or modify requests.

Parameters:

values - The values of the "remove-inbound-attributes" property.

Throws:

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

getRenameInboundAttributes

SortedSet<ValueOrExpression<String>> getRenameInboundAttributes()

Gets the "rename-inbound-attributes" property.

A list of attributes which should be renamed in incoming add or modify requests.

Returns:

Returns the values of the "rename-inbound-attributes" property.

setRenameInboundAttributes

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

Sets the "rename-inbound-attributes" property.

A list of attributes which should be renamed in incoming add or modify requests.

Parameters:

values - The values of the "rename-inbound-attributes" property.

Throws:

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