org.opends.server.admin.std.client
Interface ReferentialIntegrityPluginCfgClient

All Superinterfaces:
ConfigurationClient, PluginCfgClient

public interface ReferentialIntegrityPluginCfgClient
extends PluginCfgClient

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

The Referential Integrity Plugin maintains referential integrity for DN valued attributes.


Method Summary
 ManagedObjectDefinition<? extends ReferentialIntegrityPluginCfgClient,? extends ReferentialIntegrityPluginCfg> definition()
          Get the configuration definition associated with this Referential Integrity Plugin.
 java.util.SortedSet<AttributeType> getAttributeType()
          Gets the "attribute-type" property.
 java.util.SortedSet<DN> getBaseDN()
          Gets the "base-dn" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.lang.String getLogFile()
          Gets the "log-file" property.
 java.util.SortedSet<PluginCfgDefn.PluginType> getPluginType()
          Gets the "plugin-type" property.
 long getUpdateInterval()
          Gets the "update-interval" property.
 void setAttributeType(java.util.Collection<AttributeType> values)
          Sets the "attribute-type" property.
 void setBaseDN(java.util.Collection<DN> values)
          Sets the "base-dn" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setLogFile(java.lang.String value)
          Sets the "log-file" property.
 void setPluginType(java.util.Collection<PluginCfgDefn.PluginType> values)
          Sets the "plugin-type" property.
 void setUpdateInterval(java.lang.Long value)
          Sets the "update-interval" 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 ReferentialIntegrityPluginCfgClient,? extends ReferentialIntegrityPluginCfg> definition()
Get the configuration definition associated with this Referential Integrity Plugin.

Specified by:
definition in interface ConfigurationClient
Specified by:
definition in interface PluginCfgClient
Returns:
Returns the configuration definition associated with this Referential Integrity Plugin.

getAttributeType

java.util.SortedSet<AttributeType> getAttributeType()
Gets the "attribute-type" property.

Specifies the attribute types for which referential integrity is to be maintained.

At least one attribute type must be specified, and the syntax of any attributes must be either a distinguished name (1.3.6.1.4.1.1466.115.121.1.12) or name and optional UID (1.3.6.1.4.1.1466.115.121.1.34).

Returns:
Returns the values of the "attribute-type" property.

setAttributeType

void setAttributeType(java.util.Collection<AttributeType> values)
                      throws IllegalPropertyValueException
Sets the "attribute-type" property.

Specifies the attribute types for which referential integrity is to be maintained.

At least one attribute type must be specified, and the syntax of any attributes must be either a distinguished name (1.3.6.1.4.1.1466.115.121.1.12) or name and optional UID (1.3.6.1.4.1.1466.115.121.1.34).

Parameters:
values - The values of the "attribute-type" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.

getBaseDN

java.util.SortedSet<DN> getBaseDN()
Gets the "base-dn" property.

Specifies the base DN that limits the scope within which referential integrity is maintained.

Returns:
Returns the values of the "base-dn" property.

setBaseDN

void setBaseDN(java.util.Collection<DN> values)
               throws IllegalPropertyValueException
Sets the "base-dn" property.

Specifies the base DN that limits the scope within which referential integrity is maintained.

Parameters:
values - The values of the "base-dn" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.

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.

getLogFile

java.lang.String getLogFile()
Gets the "log-file" property.

Specifies the log file location where the update records are written when the plug-in is in background-mode processing.

The default location is the logs directory of the server instance, using the file name "referint".

Returns:
Returns the value of the "log-file" property.

setLogFile

void setLogFile(java.lang.String value)
                throws IllegalPropertyValueException
Sets the "log-file" property.

Specifies the log file location where the update records are written when the plug-in is in background-mode processing.

The default location is the logs directory of the server instance, using the file name "referint".

Parameters:
value - The value of the "log-file" 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.

getUpdateInterval

long getUpdateInterval()
Gets the "update-interval" property.

Specifies the interval in seconds when referential integrity updates are made.

If this value is 0, then the updates are made synchronously in the foreground.

Returns:
Returns the value of the "update-interval" property.

setUpdateInterval

void setUpdateInterval(java.lang.Long value)
                       throws IllegalPropertyValueException
Sets the "update-interval" property.

Specifies the interval in seconds when referential integrity updates are made.

If this value is 0, then the updates are made synchronously in the foreground.

Parameters:
value - The value of the "update-interval" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.