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

Interface LastModPluginCfgClient

All Superinterfaces:

ConfigurationClient, PluginCfgClient

public interface LastModPluginCfgClient
extends PluginCfgClient

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

The Last Mod Plugin is used to ensure that the creatorsName and createTimestamp attributes are included in an entry whenever it is added to the server and also to ensure that the modifiersName and modifyTimestamp attributes are updated whenever an entry is modified or renamed.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends LastModPluginCfgClient,? extends LastModPluginCfg>	definition()	Get the configuration definition associated with this Last Mod Plugin.
String	getJavaClass()	Gets the "java-class" property.
SortedSet<PluginCfgDefn.PluginType>	getPluginType()	Gets the "plugin-type" property.
void	setJavaClass(String value)	Sets the "java-class" property.
void	setPluginType(Collection<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 Detail

definition

ManagedObjectDefinition<? extends LastModPluginCfgClient,? extends LastModPluginCfg> definition()

Get the configuration definition associated with this Last Mod Plugin.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface PluginCfgClient

Returns:

Returns the configuration definition associated with this Last Mod Plugin.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the plug-in implementation.

Specified by:

getJavaClass in interface PluginCfgClient

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

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

Specified by:

getPluginType in interface PluginCfgClient

Returns:

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

setPluginType

void setPluginType(Collection<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.