public interface ReferentialIntegrityPluginCfgClient extends PluginCfgClient
The Referential Integrity Plugin maintains referential integrity for DN valued attributes.
isEnabled, isInvokeForInternalOperations, setEnabled, setInvokeForInternalOperations
commit, properties
ManagedObjectDefinition<? extends ReferentialIntegrityPluginCfgClient,? extends ReferentialIntegrityPluginCfg> definition()
definition
in interface ConfigurationClient
definition
in interface PluginCfgClient
SortedSet<ValueOrExpression<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).
void setAttributeType(Collection<ValueOrExpression<AttributeType>> values) throws PropertyException
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).
values
- The values of the "attribute-type" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<Dn>> getBaseDn()
Specifies the base DN that limits the scope within which referential integrity is maintained.
void setBaseDn(Collection<ValueOrExpression<Dn>> values) throws PropertyException
Specifies the base DN that limits the scope within which referential integrity is maintained.
values
- The values of the "base-dn" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<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.
void setCheckReferences(ValueOrExpression<Boolean> value) throws PropertyException
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.
value
- The value of the "check-references" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<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.
void setCheckReferencesFilterCriteria(Collection<ValueOrExpression<String>> values) throws PropertyException
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.
values
- The values of the "check-references-filter-criteria" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<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.
void setCheckReferencesScopeCriteria(ValueOrExpression<ReferentialIntegrityPluginCfgDefn.CheckReferencesScopeCriteria> value) throws PropertyException
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.
value
- The value of the "check-references-scope-criteria" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getJavaClass()
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
getJavaClass
in interface PluginCfgClient
void setJavaClass(ValueOrExpression<String> value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
setJavaClass
in interface PluginCfgClient
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.ValueOrExpression<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".
void setLogFile(ValueOrExpression<String> value) throws PropertyException
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".
value
- The value of the "log-file" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<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 PluginCfgClient
void setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values) throws PropertyException
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
setPluginType
in interface PluginCfgClient
values
- The values of the "plugin-type" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<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.
void setUpdateInterval(ValueOrExpression<Long> value) throws PropertyException
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.
value
- The value of the "update-interval" property.PropertyException
- If the new value is invalid.Copyright 2010-2018 ForgeRock AS.