org.opends.server.admin.std.server
Interface ReferentialIntegrityPluginCfg

All Superinterfaces:

Configuration, PluginCfg

public interface ReferentialIntegrityPluginCfg
extends PluginCfg

A server-side interface for querying Referential Integrity Plugin settings.

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

Method Summary

void	addReferentialIntegrityChangeListener(ConfigurationChangeListener<ReferentialIntegrityPluginCfg> listener) Register to be notified when this Referential Integrity Plugin is changed.
java.lang.Class<? extends ReferentialIntegrityPluginCfg>	configurationClass() Gets the configuration class 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	removeReferentialIntegrityChangeListener(ConfigurationChangeListener<ReferentialIntegrityPluginCfg> listener) Deregister an existing Referential Integrity Plugin configuration change listener.

Methods inherited from interface org.opends.server.admin.std.server.PluginCfg

addChangeListener, isEnabled, isInvokeForInternalOperations, removeChangeListener

Methods inherited from interface org.opends.server.admin.Configuration

dn

Method Detail

configurationClass

java.lang.Class<? extends ReferentialIntegrityPluginCfg> configurationClass()

Gets the configuration class associated with this Referential Integrity Plugin.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface PluginCfg

Returns:

Returns the configuration class associated with this Referential Integrity Plugin.

addReferentialIntegrityChangeListener

void addReferentialIntegrityChangeListener(ConfigurationChangeListener<ReferentialIntegrityPluginCfg> listener)

Register to be notified when this Referential Integrity Plugin is changed.

Parameters:

listener - The Referential Integrity Plugin configuration change listener.

removeReferentialIntegrityChangeListener

void removeReferentialIntegrityChangeListener(ConfigurationChangeListener<ReferentialIntegrityPluginCfg> listener)

Deregister an existing Referential Integrity Plugin configuration change listener.

Parameters:

listener - The Referential Integrity Plugin configuration change listener.

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 an unmodifiable set containing the values of the "attribute-type" property.

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 an unmodifiable set containing the values of the "base-dn" property.

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 PluginCfg

Returns:

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

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.

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 PluginCfg

Returns:

Returns an unmodifiable set containing the values of the "plugin-type" property.

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.