Referential Integrity Plugin
The Referential Integrity Plugin maintains referential integrity for DN valued attributes.
The values of these attributes can reference entries that have been deleted by a delete operation or renamed by a modify DN operation. The referential integrity plug-in either removes stale references to deleted entries or updates references to renamed entries. The plug-in allows the scope of this referential check to be limited to a set of base DNs if desired. The plug-in also can be configured to perform the referential checking in the background mode specified intervals.
Parent
The Referential Integrity Plugin object inherits from Plugin.
Referential Integrity Plugin Properties
You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.
Basic Properties | Advanced Properties |
---|---|
attribute-type |
attribute-type
Synopsis |
Specifies the attribute types for which referential integrity is to be maintained. |
Description |
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). |
Default Value |
None |
Allowed Values |
The name of an attribute type defined in the LDAP schema. |
Multi-valued |
Yes |
Required |
Yes |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
base-dn
Synopsis |
Specifies the base DN that limits the scope within which referential integrity is maintained. |
Default Value |
Referential integrity is maintained in all public naming contexts. |
Allowed Values |
A valid DN. |
Multi-valued |
Yes |
Required |
No |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
check-references
Synopsis |
Specifies whether reference attributes must refer to existing entries. |
Description |
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. |
Default Value |
false |
Allowed Values |
true false |
Multi-valued |
No |
Required |
No |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
check-references-filter-criteria
Synopsis |
Specifies additional filter criteria which will be enforced when checking references. |
Description |
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. |
Default Value |
None |
Allowed Values |
An attribute-filter mapping. |
Multi-valued |
Yes |
Required |
No |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
check-references-scope-criteria
Synopsis |
Specifies whether referenced entries must reside within the same naming context as the entry containing the reference. |
Description |
The reference scope will only be enforced when reference checking is enabled. |
Default Value |
global |
Allowed Values |
|
Multi-valued |
No |
Required |
No |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
enabled
Synopsis |
Indicates whether the plug-in is enabled for use. |
Default Value |
None |
Allowed Values |
true false |
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
log-file
Synopsis |
Specifies the log file location where the update records are written when the plug-in is in background-mode processing. |
Description |
The default location is the logs directory of the server instance, using the file name "referint". |
Default Value |
logs/referint |
Allowed Values |
A path to an existing file that is readable by the server. |
Multi-valued |
No |
Required |
No |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
update-interval
Synopsis |
Specifies the interval in seconds when referential integrity updates are made. |
Description |
If this value is 0, then the updates are made synchronously in the foreground. |
Default Value |
0 seconds |
Allowed Values |
Uses duration syntax. Lower limit: 0 seconds. |
Multi-valued |
No |
Required |
No |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
Advanced Properties
Use the --advanced
option to access advanced properties.
invoke-for-internal-operations
Synopsis |
Indicates whether the plug-in should be invoked for internal operations. |
Description |
Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked. |
Default Value |
true |
Allowed Values |
true false |
Multi-valued |
No |
Required |
No |
Admin Action Required |
None |
Advanced |
Yes |
Read-Only |
No |
java-class
Synopsis |
Specifies the fully-qualified name of the Java class that provides the plug-in implementation. |
Default Value |
org.opends.server.plugins.ReferentialIntegrityPlugin |
Allowed Values |
A Java class that extends or implements:
|
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
None |
Advanced |
Yes |
Read-Only |
No |
plugin-type
Synopsis |
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked. |
Default Value |
postoperationdelete postoperationmodifydn subordinatemodifydn subordinatedelete preoperationadd preoperationmodify |
Allowed Values |
|
Multi-valued |
Yes |
Required |
Yes |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
Yes |
Read-Only |
No |