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

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<LocalBackendWorkflowElementCfgClient,LocalBackendWorkflowElementCfg>
          extended by org.opends.server.admin.std.meta.LocalBackendWorkflowElementCfgDefn

public final class LocalBackendWorkflowElementCfgDefn
extends ManagedObjectDefinition<LocalBackendWorkflowElementCfgClient,LocalBackendWorkflowElementCfg>

An interface for querying the Local Backend Workflow Element managed object definition meta information.

The Local Backend Workflow Element provides access to a backend.


Method Summary
 LocalBackendWorkflowElementCfgClient createClientConfiguration(ManagedObject<? extends LocalBackendWorkflowElementCfgClient> impl)
          Creates a client configuration view of the provided managed object.
 LocalBackendWorkflowElementCfg createServerConfiguration(ServerManagedObject<? extends LocalBackendWorkflowElementCfg> impl)
          Creates a server configuration view of the provided server managed object.
 AggregationPropertyDefinition<BackendCfgClient,BackendCfg> getBackendPropertyDefinition()
          Get the "backend" property definition.
 BooleanPropertyDefinition getEnabledPropertyDefinition()
          Get the "enabled" property definition.
static LocalBackendWorkflowElementCfgDefn getInstance()
          Get the Local Backend Workflow Element configuration definition singleton.
 ClassPropertyDefinition getJavaClassPropertyDefinition()
          Get the "java-class" property definition.
 java.lang.Class<LocalBackendWorkflowElementCfg> getServerConfigurationClass()
          Gets the server configuration class instance associated with this managed object definition.
 StringPropertyDefinition getWorkflowElementIdPropertyDefinition()
          Get the "workflow-element-id" 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 LocalBackendWorkflowElementCfgDefn getInstance()
Get the Local Backend Workflow Element configuration definition singleton.

Returns:
Returns the Local Backend Workflow Element configuration definition singleton.

createClientConfiguration

public LocalBackendWorkflowElementCfgClient createClientConfiguration(ManagedObject<? extends LocalBackendWorkflowElementCfgClient> 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<LocalBackendWorkflowElementCfgClient,LocalBackendWorkflowElementCfg>
Parameters:
impl - The managed object.
Returns:
Returns a client configuration view of the provided managed object.

createServerConfiguration

public LocalBackendWorkflowElementCfg createServerConfiguration(ServerManagedObject<? extends LocalBackendWorkflowElementCfg> impl)
Creates a server configuration view of the provided server managed object.

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

getServerConfigurationClass

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

Specified by:
getServerConfigurationClass in class ManagedObjectDefinition<LocalBackendWorkflowElementCfgClient,LocalBackendWorkflowElementCfg>
Returns:
Returns the server configuration class instance associated with this managed object definition.

getBackendPropertyDefinition

public AggregationPropertyDefinition<BackendCfgClient,BackendCfg> getBackendPropertyDefinition()
Get the "backend" property definition.

Identifies the backend accessed by the workflow element.

Returns:
Returns the "backend" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()
Get the "enabled" property definition.

Indicates whether the Local Backend Workflow Element is enabled for use in the server.

If a Local Backend Workflow Element is not enabled, then its contents are not accessible when processing operations.

Returns:
Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()
Get the "java-class" property definition.

Specifies the fully-qualified name of the Java class that provides the Local Backend Workflow Element implementation.

Returns:
Returns the "java-class" property definition.

getWorkflowElementIdPropertyDefinition

public StringPropertyDefinition getWorkflowElementIdPropertyDefinition()
Get the "workflow-element-id" property definition.

Provides a name that identifies the associated Local Backend Workflow Element .

The name must be unique among all Local Backend Workflow Elements in the server.

Returns:
Returns the "workflow-element-id" property definition.