org.opends.server.admin.std.meta
Class ReferentialIntegrityPluginCfgDefn

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<ReferentialIntegrityPluginCfgClient,ReferentialIntegrityPluginCfg>
          extended by org.opends.server.admin.std.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.


Method Summary
 ReferentialIntegrityPluginCfgClient createClientConfiguration(ManagedObject<? extends ReferentialIntegrityPluginCfgClient> impl)
          Creates a client configuration view of the provided managed object.
 ReferentialIntegrityPluginCfg createServerConfiguration(ServerManagedObject<? extends ReferentialIntegrityPluginCfg> impl)
          Creates a server configuration view of the provided server managed object.
 AttributeTypePropertyDefinition getAttributeTypePropertyDefinition()
          Get the "attribute-type" property definition.
 DNPropertyDefinition getBaseDNPropertyDefinition()
          Get the "base-dn" property definition.
 BooleanPropertyDefinition getEnabledPropertyDefinition()
          Get the "enabled" property definition.
static ReferentialIntegrityPluginCfgDefn getInstance()
          Get the Referential Integrity Plugin configuration definition singleton.
 BooleanPropertyDefinition getInvokeForInternalOperationsPropertyDefinition()
          Get the "invoke-for-internal-operations" property definition.
 ClassPropertyDefinition getJavaClassPropertyDefinition()
          Get the "java-class" property definition.
 StringPropertyDefinition getLogFilePropertyDefinition()
          Get the "log-file" property definition.
 EnumPropertyDefinition<PluginCfgDefn.PluginType> getPluginTypePropertyDefinition()
          Get the "plugin-type" property definition.
 java.lang.Class<ReferentialIntegrityPluginCfg> getServerConfigurationClass()
          Gets the server configuration class instance associated with this managed object definition.
 DurationPropertyDefinition getUpdateIntervalPropertyDefinition()
          Get the "update-interval" property definition.
 
Methods inherited from class org.opends.server.admin.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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

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)
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 class ManagedObjectDefinition<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)
Creates a server configuration view of the provided server managed object.

Specified by:
createServerConfiguration in class ManagedObjectDefinition<ReferentialIntegrityPluginCfgClient,ReferentialIntegrityPluginCfg>
Parameters:
impl - The server managed object.
Returns:
Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public java.lang.Class<ReferentialIntegrityPluginCfg> getServerConfigurationClass()
Gets the server configuration class instance associated with this managed object definition.

Specified by:
getServerConfigurationClass in class ManagedObjectDefinition<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.

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.