com.dtolabs.rundeck.core.execution.workflow

Class WorkflowStrategyService

java.lang.Object

com.dtolabs.rundeck.core.plugins.ChainedProviderService<WorkflowStrategy>

com.dtolabs.rundeck.core.execution.workflow.WorkflowStrategyService

All Implemented Interfaces:

FrameworkSupportService, ProviderService<WorkflowStrategy>, DescribableService, PluggableProviderService<WorkflowStrategy>, PluggableService<WorkflowStrategy>

public class WorkflowStrategyService
extends ChainedProviderService<WorkflowStrategy>
implements DescribableService, PluggableProviderService<WorkflowStrategy>

Builtin and plugin providers for WorkflowStrategy

Since:

5/5/16

Method Summary

Modifier and Type	Method and Description
boolean	canLoadWithLoader(ProviderLoader loader)
static WorkflowStrategyService	getInstanceForFramework(IFramework framework)
java.lang.String	getName()
protected java.util.List<ProviderService<WorkflowStrategy>>	getServiceList()
WorkflowStrategy	getStrategyForWorkflow(WorkflowExecutionItem workflow, java.util.Map<java.lang.String,java.lang.Object> config, java.lang.String projectName) Get a configured strategy instance
WorkflowStrategy	getStrategyForWorkflow(WorkflowExecutionItem workflow, PropertyResolver resolver) Get a configured strategy instance
java.util.List<ProviderIdent>	listDescribableProviders()
java.util.List<Description>	listDescriptions()
CloseableProvider<WorkflowStrategy>	loadCloseableWithLoader(java.lang.String providerName, ProviderLoader loader) Load a closeable provider with the given loader
WorkflowStrategy	loadWithLoader(java.lang.String providerName, ProviderLoader loader) Load provider with the given loader
void	registerClass(java.lang.String name, java.lang.Class<? extends WorkflowStrategy> clazz)
void	registerInstance(java.lang.String name, WorkflowStrategy object)

Methods inherited from class com.dtolabs.rundeck.core.plugins.ChainedProviderService

closeableProviderOfType, listProviders, providerOfType

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.dtolabs.rundeck.core.plugins.PluggableProviderService

adapter

Methods inherited from interface com.dtolabs.rundeck.core.common.ProviderService

closeableProviderOfType, listProviders, providerOfType

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface FrameworkSupportService

Returns:

the name used to identify the service

canLoadWithLoader

public boolean canLoadWithLoader(ProviderLoader loader)

Specified by:

canLoadWithLoader in interface PluggableService<WorkflowStrategy>

Parameters:

loader - loader

Returns:

true if the loader can be used for this service, by default delegates to the loader's ProviderLoader.canLoadForService(FrameworkSupportService)

loadWithLoader

public WorkflowStrategy loadWithLoader(java.lang.String providerName,
                                       ProviderLoader loader)
                                throws ProviderLoaderException

Description copied from interface: PluggableService

Load provider with the given loader

Specified by:

loadWithLoader in interface PluggableService<WorkflowStrategy>

Parameters:

providerName - provider name

loader - loader

Returns:

loaded provider instance, by default delegates to the loader's ProviderLoader.load(PluggableService, String)

Throws:

ProviderLoaderException - if an error occurs

loadCloseableWithLoader

public CloseableProvider<WorkflowStrategy> loadCloseableWithLoader(java.lang.String providerName,
                                                                   ProviderLoader loader)
                                                            throws ProviderLoaderException

Description copied from interface: PluggableService

Load a closeable provider with the given loader

Specified by:

loadCloseableWithLoader in interface PluggableService<WorkflowStrategy>

Parameters:

providerName - provider name

loader - loader

Returns:

closeable provider for instance, by default delegates to the loader's ProviderLoader.loadCloseable(PluggableService, String)

Throws:

ProviderLoaderException - if an error occurs

getServiceList

protected java.util.List<ProviderService<WorkflowStrategy>> getServiceList()

Specified by:

getServiceList in class ChainedProviderService<WorkflowStrategy>

getInstanceForFramework

public static WorkflowStrategyService getInstanceForFramework(IFramework framework)

getStrategyForWorkflow

public WorkflowStrategy getStrategyForWorkflow(WorkflowExecutionItem workflow,
                                               java.util.Map<java.lang.String,java.lang.Object> config,
                                               java.lang.String projectName)
                                        throws ExecutionServiceException

Get a configured strategy instance

Parameters:

workflow - workflow

config - config data

Returns:

instance with configuration applied

Throws:

ExecutionServiceException - if provider cannot be loaded

getStrategyForWorkflow

public WorkflowStrategy getStrategyForWorkflow(WorkflowExecutionItem workflow,
                                               PropertyResolver resolver)
                                        throws ExecutionServiceException

Get a configured strategy instance

Parameters:

workflow - workflow

resolver - config resolver

Returns:

instance with configuration applied

Throws:

ExecutionServiceException - if provider cannot be loaded

listDescriptions

public java.util.List<Description> listDescriptions()

Specified by:

listDescriptions in interface DescribableService

listDescribableProviders

public java.util.List<ProviderIdent> listDescribableProviders()

Specified by:

listDescribableProviders in interface DescribableService

registerClass

public void registerClass(java.lang.String name,
                          java.lang.Class<? extends WorkflowStrategy> clazz)

registerInstance

public void registerInstance(java.lang.String name,
                             WorkflowStrategy object)