org.opends.server.workflowelement.localbackend

Class LocalBackendWorkflowElement

java.lang.Object

org.opends.server.workflowelement.localbackend.LocalBackendWorkflowElement

public class LocalBackendWorkflowElement
extends Object

This class defines a local backend workflow element; e-g an entity that handle the processing of an operation against a local backend.

Method Summary

Methods

Modifier and Type	Method and Description
static LocalBackendWorkflowElement	createAndRegister(DN baseDN, Backend<?> backend) Creates and registers a local backend with the server.
static boolean	execute(Operation operation, DN entryDN) Executes the supplied operation.
Backend<?>	getBackend() Gets the backend associated with this local backend workflow element.
DN	getBaseDN() Provides the workflow element identifier.
boolean	isPrivate() Indicates whether the workflow element encapsulates a private local backend.
static void	remove(DN baseDN) Removes a local backend that was registered with the server.
static void	removeAll() Removes all the local backends that were registered with the server.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

isPrivate

public boolean isPrivate()

Indicates whether the workflow element encapsulates a private local backend.

Returns:

true if the workflow element encapsulates a private local backend, false otherwise

createAndRegister

public static LocalBackendWorkflowElement createAndRegister(DN baseDN,
                                            Backend<?> backend)

Creates and registers a local backend with the server.

Parameters:

baseDN - the backend's baseDN mapped by this object

backend - the backend to associate with the local backend workflow element

Returns:

the existing local backend workflow element if it was already created or a newly created local backend workflow element.

remove

public static void remove(DN baseDN)

Removes a local backend that was registered with the server.

Parameters:

baseDN - the identifier of the workflow to remove

removeAll

public static void removeAll()

Removes all the local backends that were registered with the server. This function is intended to be called when the server is shutting down.

getBaseDN

public DN getBaseDN()

Provides the workflow element identifier.

Returns:

the workflow element identifier

getBackend

public Backend<?> getBackend()

Gets the backend associated with this local backend workflow element.

Returns:

The backend associated with this local backend workflow element.

execute

public static boolean execute(Operation operation,
              DN entryDN)
                       throws CanceledOperationException

Executes the supplied operation.

Parameters:

operation - the operation to execute

entryDN - the entry DN whose backend will be used

Returns:

true if the operation successfully executed, false otherwise

Throws:

CanceledOperationException - if this operation should be cancelled.

toString

public String toString()

Overrides:

toString in class Object