org.opends.server.core
Class WorkflowTopology

java.lang.Object
  extended by org.opends.server.core.WorkflowTopology
All Implemented Interfaces:
Workflow
Direct Known Subclasses:
RootDseWorkflowTopology, WorkflowTopologyNode

public abstract class WorkflowTopology
extends java.lang.Object
implements Workflow

This class is the base class used to build the workflow topology. A workflow topology is a tree of workflows. Each node in the tree is attached to a WorkflowImpl which contains the task tree (ie. the processing). There are two types of workflow nodes. The first one is used to build nodes in the workflow topology (WorkflowTopologyNode) and the second one is used to implement the root DSE node (RootDseWorkflowTopology).


Constructor Summary
protected WorkflowTopology(WorkflowImpl workflowImpl)
          Create a new instance of the workflow topology base class.
 
Method Summary
protected  SearchScope elaborateScopeForSearchInSubordinates(SearchScope currentScope)
          Elaborates a new search scope according to the current search scope.
 DN getBaseDN()
          Gets the base DN of the workflow node.
 WorkflowImpl getWorkflowImpl()
          Returns the workflow implementation which contains the task tree (ie.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.opends.server.core.Workflow
execute
 

Constructor Detail

WorkflowTopology

protected WorkflowTopology(WorkflowImpl workflowImpl)
Create a new instance of the workflow topology base class. The instance is initialized with the workflow implementation which contains the task tree (ie. the processing).

Parameters:
workflowImpl - the workflow which contains the processing
Method Detail

getWorkflowImpl

public WorkflowImpl getWorkflowImpl()
Returns the workflow implementation which contains the task tree (ie. the processing).

Returns:
the workflow implementation which contains the processing

getBaseDN

public DN getBaseDN()
Gets the base DN of the workflow node. The base DN of the workflow node is the base DN of the attached workflow implementation containing the processing.

Specified by:
getBaseDN in interface Workflow
Returns:
the base DN of the workflow containing the processing.

elaborateScopeForSearchInSubordinates

protected SearchScope elaborateScopeForSearchInSubordinates(SearchScope currentScope)
Elaborates a new search scope according to the current search scope. The new scope is intended to be used for searches on subordinate workflows.

Parameters:
currentScope - the current search scope
Returns:
the new scope to use for searches on subordinate workflows, null when current scope is 'base'