Class ReferentialIntegrityPluginCfgDefn
- java.lang.Object
-
- org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
-
- org.forgerock.opendj.config.ManagedObjectDefinition<ReferentialIntegrityPluginCfgClient,ReferentialIntegrityPluginCfg>
-
- org.forgerock.opendj.server.config.meta.ReferentialIntegrityPluginCfgDefn
-
public final class ReferentialIntegrityPluginCfgDefn extends ManagedObjectDefinition<ReferentialIntegrityPluginCfgClient,ReferentialIntegrityPluginCfg>
An interface for querying the Referential Integrity Plugin managed object definition meta information.The Referential Integrity Plugin maintains referential integrity for DN valued attributes.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ReferentialIntegrityPluginCfgDefn.CheckReferencesScopeCriteria
Defines the set of permissable values for the "check-references-scope-criteria" property.
-
Method Summary
-
Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition
getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString
-
-
-
-
Method Detail
-
getInstance
public static ReferentialIntegrityPluginCfgDefn getInstance()
Get the Referential Integrity Plugin configuration definition singleton.- Returns:
- Returns the Referential Integrity Plugin configuration definition singleton.
-
createClientConfiguration
public ReferentialIntegrityPluginCfgClient createClientConfiguration(ManagedObject<? extends ReferentialIntegrityPluginCfgClient> impl)
Description copied from class:ManagedObjectDefinition
Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.- Specified by:
createClientConfiguration
in classManagedObjectDefinition<ReferentialIntegrityPluginCfgClient,ReferentialIntegrityPluginCfg>
- Parameters:
impl
- The managed object.- Returns:
- Returns a client configuration view of the provided managed object.
-
createServerConfiguration
public ReferentialIntegrityPluginCfg createServerConfiguration(ServerManagedObject<? extends ReferentialIntegrityPluginCfg> impl)
Description copied from class:ManagedObjectDefinition
Creates a server configuration view of the provided server managed object.- Specified by:
createServerConfiguration
in classManagedObjectDefinition<ReferentialIntegrityPluginCfgClient,ReferentialIntegrityPluginCfg>
- Parameters:
impl
- The server managed object.- Returns:
- Returns a server configuration view of the provided server managed object.
-
getServerConfigurationClass
public Class<ReferentialIntegrityPluginCfg> getServerConfigurationClass()
Description copied from class:ManagedObjectDefinition
Gets the server configuration class instance associated with this managed object definition.- Specified by:
getServerConfigurationClass
in classManagedObjectDefinition<ReferentialIntegrityPluginCfgClient,ReferentialIntegrityPluginCfg>
- Returns:
- Returns the server configuration class instance associated with this managed object definition.
-
getAttributeTypePropertyDefinition
public AttributeTypePropertyDefinition getAttributeTypePropertyDefinition()
Get the "attribute-type" property definition.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 "attribute-type" property definition.
-
getBaseDnPropertyDefinition
public DnPropertyDefinition getBaseDnPropertyDefinition()
Get the "base-dn" property definition.Specifies the base DN that limits the scope within which referential integrity is maintained.
- Returns:
- Returns the "base-dn" property definition.
-
getCheckReferencesPropertyDefinition
public BooleanPropertyDefinition getCheckReferencesPropertyDefinition()
Get the "check-references" property definition.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.
- Returns:
- Returns the "check-references" property definition.
-
getCheckReferencesFilterCriteriaPropertyDefinition
public StringPropertyDefinition getCheckReferencesFilterCriteriaPropertyDefinition()
Get the "check-references-filter-criteria" property definition.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.
- Returns:
- Returns the "check-references-filter-criteria" property definition.
-
getCheckReferencesScopeCriteriaPropertyDefinition
public EnumPropertyDefinition<ReferentialIntegrityPluginCfgDefn.CheckReferencesScopeCriteria> getCheckReferencesScopeCriteriaPropertyDefinition()
Get the "check-references-scope-criteria" property definition.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.
- Returns:
- Returns the "check-references-scope-criteria" property definition.
-
getEnabledPropertyDefinition
public BooleanPropertyDefinition getEnabledPropertyDefinition()
Get the "enabled" property definition.Indicates whether the plug-in is enabled for use.
- Returns:
- Returns the "enabled" property definition.
-
getInvokeForInternalOperationsPropertyDefinition
public BooleanPropertyDefinition getInvokeForInternalOperationsPropertyDefinition()
Get the "invoke-for-internal-operations" property definition.Indicates whether the plug-in should be invoked for internal operations.
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.
- Returns:
- Returns the "invoke-for-internal-operations" property definition.
-
getJavaClassPropertyDefinition
public ClassPropertyDefinition getJavaClassPropertyDefinition()
Get the "java-class" property definition.Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
- Returns:
- Returns the "java-class" property definition.
-
getLogFilePropertyDefinition
public StringPropertyDefinition getLogFilePropertyDefinition()
Get the "log-file" property definition.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 "log-file" property definition.
-
getPluginTypePropertyDefinition
public EnumPropertyDefinition<PluginCfgDefn.PluginType> getPluginTypePropertyDefinition()
Get the "plugin-type" property definition.Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
- Returns:
- Returns the "plugin-type" property definition.
-
getUpdateIntervalPropertyDefinition
public DurationPropertyDefinition getUpdateIntervalPropertyDefinition()
Get the "update-interval" property definition.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 "update-interval" property definition.
-
-