|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.core.WorkflowImpl
public class WorkflowImpl
This class implements the workflow interface. Each task in the workflow is implemented by a WorkflowElement. All the tasks in the workflow are structured in a tree of tasks and the root node of the task tree is stored in the Workflow class itself. To execute a workflow, one just need to call the execute method on the root node of the task tree. Then each task in turn will execute its subordinate nodes and synchronizes them as needed.
Constructor Summary | |
---|---|
WorkflowImpl(java.lang.String workflowId,
DN baseDN,
WorkflowElement rootWorkflowElement)
Creates a new instance of a workflow implementation. |
Method Summary | |
---|---|
void |
deregister()
Deregisters the current worklow (this) with the server. |
WorkflowImpl |
deregister(java.lang.String workflowID)
Deregisters a worklow with the server. |
static void |
deregisterAllOnShutdown()
Deregisters all Workflows that have been registered. |
void |
execute(Operation operation)
Executes all the tasks defined by the workflow task tree for a given operation. |
void |
finalizeWorkflow()
Performs any finalization that might be required when this workflow is unloaded. |
DN |
getBaseDN()
Gets the base DN of the data set being handled by the workflow. |
static Workflow |
getWorkflow(java.lang.String workflowID)
Gets a workflow that was registered with the server. |
java.lang.String |
getWorkflowId()
Gets the workflow internal identifier. |
static java.util.Collection<Workflow> |
getWorkflows()
Gets all the workflows that were registered with the server. |
boolean |
isPrivate()
Indicates whether the root node of the workflow task tree is handling a private local backend. |
void |
register()
Registers the current worklow (this) with the server. |
static void |
resetConfig()
Resets all the registered workflows. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WorkflowImpl(java.lang.String workflowId, DN baseDN, WorkflowElement rootWorkflowElement)
workflowId
- workflow internal identifierbaseDN
- identifies the data handled by the workflowrootWorkflowElement
- the root node of the workflow task treeMethod Detail |
---|
public void finalizeWorkflow()
public DN getBaseDN()
getBaseDN
in interface Workflow
public java.lang.String getWorkflowId()
public boolean isPrivate()
true
if the workflow encapsulates a private local
backendpublic void execute(Operation operation) throws CanceledOperationException
execute
in interface Workflow
operation
- the operation to execute
CanceledOperationException
- if this operation should
be cancelled.public void register() throws DirectoryException
DirectoryException
- If the workflow ID for the provided workflow
conflicts with the workflow ID of an existing
workflow.public void deregister()
public WorkflowImpl deregister(java.lang.String workflowID)
workflowID
- the identifier of the workflow to deregister
null
if no workflow has been found.public static void deregisterAllOnShutdown()
public static Workflow getWorkflow(java.lang.String workflowID)
workflowID
- the ID of the workflow to get
public static java.util.Collection<Workflow> getWorkflows()
public static void resetConfig()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |