org.opends.server.admin.std.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
 ManagedObjectDefinition<? extends LastModPluginCfgClient,? extends LastModPluginCfg> definition()
          Get the configuration definition associated with this Last Mod Plugin.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.util.SortedSet<PluginCfgDefn.PluginType> getPluginType()
          Gets the "plugin-type" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setPluginType(java.util.Collection<PluginCfgDefn.PluginType> values)
          Sets the "plugin-type" property.
 
Methods inherited from interface org.opends.server.admin.std.client.PluginCfgClient
isEnabled, isInvokeForInternalOperations, setEnabled, setInvokeForInternalOperations
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

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

java.lang.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(java.lang.String value)
                  throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

getPluginType

java.util.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(java.util.Collection<PluginCfgDefn.PluginType> values)
                   throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If one or more of the new values are invalid.