|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.workflowelement.WorkflowElement<T>
T
- The type of configuration handled by this workflow elelemnt.public abstract class WorkflowElement<T extends WorkflowElementCfg>
This class defines the super class for all the workflow elements. A workflow element is a task in a workflow. A workflow element can wrap a physical repository such as a local backend, a remote LDAP server or a local ldif file. A workflow element can also be used to route operations. This is the case for load balancing and distribution. And workflow element can be used in a virtual environment to transform data (DN and attribute renaming, attribute value renaming...).
Constructor Summary | |
---|---|
WorkflowElement()
Creates a new instance of the workflow element. |
Method Summary | |
---|---|
void |
deregister()
Deregisters the workflow element (this) with the server. |
abstract void |
execute(Operation operation)
Executes the workflow element for an operation. |
void |
finalizeWorkflowElement()
Performs any finalization that might be required when this workflow element is unloaded. |
static WorkflowElement |
getWorkflowElement(java.lang.String workflowElementID)
Gets a workflow element that was registered with the server. |
java.lang.String |
getWorkflowElementID()
Provides the workflow element identifier. |
void |
initialize(java.lang.String workflowElementID)
Initializes the instance of the workflow element. |
boolean |
isConfigurationAcceptable(WorkflowElementCfg configuration,
java.util.List<java.lang.String> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this workflow elelement. |
boolean |
isPrivate()
Indicates whether the workflow element encapsulates a private local backend. |
void |
register()
Registers the workflow element (this) with the server. |
static void |
resetConfig()
Resets all the registered workflows. |
protected void |
setParent(WorkflowElement<?> parent)
Set the parent of the current workflow element. |
protected void |
setPrivate(boolean isPrivate)
Specifies whether the workflow element encapsulates a private local backend. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WorkflowElement()
Method Detail |
---|
public void initialize(java.lang.String workflowElementID)
workflowElementID
- the workflow element identifier as defined
in the configuration.protected void setParent(WorkflowElement<?> parent)
parent
- the parent of the workflow elementpublic boolean isConfigurationAcceptable(WorkflowElementCfg configuration, java.util.List<java.lang.String> unacceptableReasons)
configuration
- The workflow element configuration for
which to make the determination.unacceptableReasons
- A list that may be used to hold the
reasons that the provided
configuration is not acceptable.
true
if the provided configuration is acceptable
for this workflow element, or false
if not.public void finalizeWorkflowElement()
public abstract void execute(Operation operation) throws CanceledOperationException
operation
- the operation to execute
CanceledOperationException
- if this operation should be
cancelledpublic boolean isPrivate()
true
if the workflow element encapsulates a private
local backend, false
otherwiseprotected void setPrivate(boolean isPrivate)
isPrivate
- Indicates whether the workflow element encapsulates a
private local backend.public java.lang.String getWorkflowElementID()
public void register() throws ConfigException
ConfigException
- If the workflow element ID for the provided
workflow element conflicts with the workflow
element ID of an existing workflow element.public void deregister()
public static WorkflowElement getWorkflowElement(java.lang.String workflowElementID)
workflowElementID
- the ID of the workflow element to get
public static void resetConfig()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |