org.opends.server.core
Class WorkflowConfigManager

java.lang.Object
  extended by org.opends.server.core.WorkflowConfigManager
All Implemented Interfaces:
ConfigurationAddListener<WorkflowCfg>, ConfigurationChangeListener<WorkflowCfg>, ConfigurationDeleteListener<WorkflowCfg>

public class WorkflowConfigManager
extends java.lang.Object
implements ConfigurationChangeListener<WorkflowCfg>, ConfigurationAddListener<WorkflowCfg>, ConfigurationDeleteListener<WorkflowCfg>

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


Constructor Summary
WorkflowConfigManager()
          Creates a new instance of this workflow config manager.
 
Method Summary
 ConfigChangeResult applyConfigurationAdd(WorkflowCfg configuration)
          Adds a new configuration to this add listener.
 ConfigChangeResult applyConfigurationChange(WorkflowCfg configuration)
          Applies the configuration changes to this change listener.
 ConfigChangeResult applyConfigurationDelete(WorkflowCfg configuration)
          Deletes an existing configuration from this delete listener.
 void initializeWorkflows()
          Initializes all workflows currently defined in the Directory Server configuration.
 boolean isConfigurationAddAcceptable(WorkflowCfg configuration, java.util.List<Message> unacceptableReasons)
          Indicates whether the proposed addition of a new configuration is acceptable to this add listener.
 boolean isConfigurationChangeAcceptable(WorkflowCfg configuration, java.util.List<Message> unacceptableReasons)
          Indicates whether the proposed change to the configuration is acceptable to this change listener.
 boolean isConfigurationDeleteAcceptable(WorkflowCfg 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

WorkflowConfigManager

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

Method Detail

initializeWorkflows

public void initializeWorkflows()
                         throws ConfigException
Initializes all workflows 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 initialization process to fail.

isConfigurationAddAcceptable

public boolean isConfigurationAddAcceptable(WorkflowCfg 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<WorkflowCfg>
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(WorkflowCfg configuration)
Adds a new configuration to this add listener.

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

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(WorkflowCfg 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<WorkflowCfg>
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(WorkflowCfg configuration)
Deletes an existing configuration from this delete listener.

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

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(WorkflowCfg 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<WorkflowCfg>
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(WorkflowCfg configuration)
Applies the configuration changes to this change listener.

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