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

Interface EntryUuidPluginCfgClient

All Superinterfaces:

ConfigurationClient, PluginCfgClient

public interface EntryUuidPluginCfgClient
extends PluginCfgClient

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

The entryUUID Plugin generates values for the entryUUID operational attribute whenever an entry is added via protocol or imported from LDIF.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends EntryUuidPluginCfgClient,? extends EntryUuidPluginCfg>	definition()	Get the configuration definition associated with this entryUUID Plugin.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
SortedSet<ValueOrExpression<PluginCfgDefn.PluginType>>	getPluginType()	Gets the "plugin-type" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values)	Sets the "plugin-type" property.

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

commit, properties

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

isEnabled, isInvokeForInternalOperations, setEnabled, setInvokeForInternalOperations

Method Details

definition

ManagedObjectDefinition<? extends EntryUuidPluginCfgClient,? extends EntryUuidPluginCfg> definition()

Get the configuration definition associated with this entryUUID Plugin.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface PluginCfgClient

Returns:

Returns the configuration definition associated with this entryUUID Plugin.

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

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: ldifimport, preoperationadd

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.