public interface ReferentialIntegrityPluginCfg extends PluginCfg
The Referential Integrity Plugin maintains referential integrity for DN valued attributes.
Modifier and Type | Method and Description |
---|---|
void |
addReferentialIntegrityChangeListener(ConfigurationChangeListener<ReferentialIntegrityPluginCfg> listener)
Register to be notified when this Referential Integrity Plugin is changed.
|
Class<? extends ReferentialIntegrityPluginCfg> |
configurationClass()
Gets the configuration class associated with this Referential Integrity Plugin.
|
SortedSet<AttributeType> |
getAttributeType()
Gets the "attribute-type" property.
|
SortedSet<Dn> |
getBaseDn()
Gets the "base-dn" property.
|
SortedSet<String> |
getCheckReferencesFilterCriteria()
Gets the "check-references-filter-criteria" property.
|
ReferentialIntegrityPluginCfgDefn.CheckReferencesScopeCriteria |
getCheckReferencesScopeCriteria()
Gets the "check-references-scope-criteria" property.
|
String |
getJavaClass()
Gets the "java-class" property.
|
String |
getLogFile()
Gets the "log-file" property.
|
SortedSet<PluginCfgDefn.PluginType> |
getPluginType()
Gets the "plugin-type" property.
|
long |
getUpdateInterval()
Gets the "update-interval" property.
|
boolean |
isCheckReferences()
Gets the "check-references" property.
|
void |
removeReferentialIntegrityChangeListener(ConfigurationChangeListener<ReferentialIntegrityPluginCfg> listener)
Deregister an existing Referential Integrity Plugin configuration change listener.
|
addChangeListener, isEnabled, isInvokeForInternalOperations, removeChangeListener
dn, name
Class<? extends ReferentialIntegrityPluginCfg> configurationClass()
configurationClass
in interface Configuration
configurationClass
in interface PluginCfg
void addReferentialIntegrityChangeListener(ConfigurationChangeListener<ReferentialIntegrityPluginCfg> listener)
listener
- The Referential Integrity Plugin configuration change listener.void removeReferentialIntegrityChangeListener(ConfigurationChangeListener<ReferentialIntegrityPluginCfg> listener)
listener
- The Referential Integrity Plugin configuration change listener.SortedSet<AttributeType> getAttributeType()
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).
SortedSet<Dn> getBaseDn()
Specifies the base DN that limits the scope within which referential integrity is maintained.
boolean isCheckReferences()
Specifies whether reference attributes must refer to existing entries.
When this property is set to true, this plugin will ensure that any new references added as part of an add or modify operation point to existing entries, and that the referenced entries match the filter criteria for the referencing attribute, if specified.
SortedSet<String> getCheckReferencesFilterCriteria()
Specifies additional filter criteria which will be enforced when checking references.
If a reference attribute has filter criteria defined then this plugin will ensure that any new references added as part of an add or modify operation refer to an existing entry which matches the specified filter.
ReferentialIntegrityPluginCfgDefn.CheckReferencesScopeCriteria getCheckReferencesScopeCriteria()
Specifies whether referenced entries must reside within the same naming context as the entry containing the reference.
The reference scope will only be enforced when reference checking is enabled.
String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
getJavaClass
in interface PluginCfg
String getLogFile()
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".
SortedSet<PluginCfgDefn.PluginType> getPluginType()
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
getPluginType
in interface PluginCfg
long getUpdateInterval()
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.
Copyright 2010-2018 ForgeRock AS.