org.opends.server.workflowelement
Class WorkflowElementConfigManager

java.lang.Object
  extended by org.opends.server.workflowelement.WorkflowElementConfigManager
All Implemented Interfaces:
ConfigurationAddListener<WorkflowElementCfg>, ConfigurationChangeListener<WorkflowElementCfg>, ConfigurationDeleteListener<WorkflowElementCfg>

public class WorkflowElementConfigManager
extends java.lang.Object
implements ConfigurationChangeListener<WorkflowElementCfg>, ConfigurationAddListener<WorkflowElementCfg>, ConfigurationDeleteListener<WorkflowElementCfg>

This class defines a utility that will be used to manage the configuration for the set of workflow elements defined in the Directory Server. It will perform the necessary initialization of those backends when the server is first started, and then will manage any changes to them while the server is running.


Constructor Summary
WorkflowElementConfigManager()
          Creates a new instance of this workflow config manager.
 
Method Summary
 ConfigChangeResult applyConfigurationAdd(WorkflowElementCfg configuration)
          Adds a new configuration to this add listener.
 ConfigChangeResult applyConfigurationChange(WorkflowElementCfg configuration)
          Applies the configuration changes to this change listener.
 ConfigChangeResult applyConfigurationDelete(WorkflowElementCfg configuration)
          Deletes an existing configuration from this delete listener.
 void initializeWorkflowElements()
          Initializes all workflow elements currently defined in the Directory Server configuration.
 boolean isConfigurationAddAcceptable(WorkflowElementCfg configuration, java.util.List<Message> unacceptableReasons)
          Indicates whether the proposed addition of a new configuration is acceptable to this add listener.
 boolean isConfigurationChangeAcceptable(WorkflowElementCfg configuration, java.util.List<Message> unacceptableReasons)
          Indicates whether the proposed change to the configuration is acceptable to this change listener.
 boolean isConfigurationDeleteAcceptable(WorkflowElementCfg configuration, java.util.List<Message> unacceptableReasons)
          Indicates whether the proposed deletion of an existing configuration is acceptable to this delete listener.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WorkflowElementConfigManager

public WorkflowElementConfigManager()
Creates a new instance of this workflow config manager.

Method Detail

initializeWorkflowElements

public void initializeWorkflowElements()
                                throws ConfigException,
                                       InitializationException
Initializes all workflow elements currently defined in the Directory Server configuration. This should only be called at Directory Server startup.

Throws:
ConfigException - If a configuration problem causes the workflow element initialization process to fail.
InitializationException - If a problem occurs while the workflow element is loaded and registered with the server

isConfigurationAddAcceptable

public boolean isConfigurationAddAcceptable(WorkflowElementCfg configuration,
                                            java.util.List<Message> unacceptableReasons)
Indicates whether the proposed addition of a new configuration is acceptable to this add listener.

Specified by:
isConfigurationAddAcceptable in interface ConfigurationAddListener<WorkflowElementCfg>
Parameters:
configuration - The configuration that will be added.
unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.
Returns:
Returns true if the proposed addition is acceptable, or false if it is not.

applyConfigurationAdd

public ConfigChangeResult applyConfigurationAdd(WorkflowElementCfg configuration)
Adds a new configuration to this add listener.

Specified by:
applyConfigurationAdd in interface ConfigurationAddListener<WorkflowElementCfg>
Parameters:
configuration - The configuration that will be added.
Returns:
Returns information about the result of adding the configuration.

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(WorkflowElementCfg configuration,
                                               java.util.List<Message> unacceptableReasons)
Indicates whether the proposed deletion of an existing configuration is acceptable to this delete listener.

Specified by:
isConfigurationDeleteAcceptable in interface ConfigurationDeleteListener<WorkflowElementCfg>
Parameters:
configuration - The configuration that will be deleted.
unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.
Returns:
Returns true if the proposed deletion is acceptable, or false if it is not.

applyConfigurationDelete

public ConfigChangeResult applyConfigurationDelete(WorkflowElementCfg configuration)
Deletes an existing configuration from this delete listener.

Specified by:
applyConfigurationDelete in interface ConfigurationDeleteListener<WorkflowElementCfg>
Parameters:
configuration - The existing configuration that will be deleted.
Returns:
Returns information about the result of deleting the configuration.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(WorkflowElementCfg configuration,
                                               java.util.List<Message> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:
isConfigurationChangeAcceptable in interface ConfigurationChangeListener<WorkflowElementCfg>
Parameters:
configuration - The new configuration containing the changes.
unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.
Returns:
Returns true if the proposed change is acceptable, or false if it is not.

applyConfigurationChange

public ConfigChangeResult applyConfigurationChange(WorkflowElementCfg configuration)
Applies the configuration changes to this change listener.

Specified by:
applyConfigurationChange in interface ConfigurationChangeListener<WorkflowElementCfg>
Parameters:
configuration - The new configuration containing the changes.
Returns:
Returns information about the result of changing the configuration.