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
<X extends WorkflowStrategy> WorkflowStrategy	createProviderInstance(java.lang.Class<X> clazz, java.lang.String name)
WorkflowStrategy	createScriptProviderInstance(ScriptPluginProvider provider)
static WorkflowStrategyService	getInstanceForFramework(Framework 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
boolean	isScriptPluggable()
boolean	isValidProviderClass(java.lang.Class clazz)
java.util.List<ProviderIdent>	listDescribableProviders()
java.util.List<Description>	listDescriptions()
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.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

getServiceList

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

Specified by:

getServiceList in class ChainedProviderService<WorkflowStrategy>

getInstanceForFramework

public static WorkflowStrategyService getInstanceForFramework(Framework 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

isValidProviderClass

public boolean isValidProviderClass(java.lang.Class clazz)

Specified by:

isValidProviderClass in interface PluggableService<WorkflowStrategy>

Parameters:

clazz - the class

Returns:

true if the class is a valid provider class for the service

createProviderInstance

public <X extends WorkflowStrategy> WorkflowStrategy createProviderInstance(java.lang.Class<X> clazz,
                                                                            java.lang.String name)
                                                                     throws PluginException,
                                                                            ProviderCreationException

Specified by:

createProviderInstance in interface PluggableService<WorkflowStrategy>

Type Parameters:

X - subtype of T

Parameters:

clazz - the class

name - the provider name

Returns:

Create provider instance from a class

Throws:

PluginException - if the plugin has an error

ProviderCreationException - if creating the instance has an error

isScriptPluggable

public boolean isScriptPluggable()

Specified by:

isScriptPluggable in interface PluggableService<WorkflowStrategy>

Returns:

true if the service supports script plugins

createScriptProviderInstance

public WorkflowStrategy createScriptProviderInstance(ScriptPluginProvider provider)
                                              throws PluginException

Specified by:

createScriptProviderInstance in interface PluggableService<WorkflowStrategy>

Parameters:

provider - the script plugin provider

Returns:

the instance for a ScriptPluginProvider definition

Throws:

PluginException - if the plugin has an error

registerClass

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

registerInstance

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