Package com.dtolabs.rundeck.core.execution.workflow.steps.node

Class NodeStepPluginAdapter

java.lang.Object

com.dtolabs.rundeck.core.execution.workflow.steps.node.NodeStepPluginAdapter

All Implemented Interfaces:

NodeStepExecutor, Describable, DynamicProperties

public class NodeStepPluginAdapter
extends java.lang.Object
implements NodeStepExecutor, Describable, DynamicProperties

NodeStepPluginAdapter implements NodeStepExecutor, and makes use of a NodeStepPlugin instance to perform the execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NodeStepPluginAdapter.ConvertToNodeStepExecutor

Field Summary

Fields

Modifier and Type	Field	Description
static NodeStepPluginAdapter.ConvertToNodeStepExecutor	CONVERT_TO_NODE_STEP_EXECUTOR
static java.lang.String	DEPRECATED_CONFIGURATION_MODE
protected static org.slf4j.Logger	log
static java.lang.String	SKIP

Constructor Summary

Constructors

Constructor	Description
NodeStepPluginAdapter(NodeStepPlugin plugin)
NodeStepPluginAdapter(java.lang.String serviceName, NodeStepPlugin plugin, boolean blankIfUnexpanded)

Method Summary

Modifier and Type	Method	Description
static boolean	canAdaptType(java.lang.Class<?> testType)
java.util.Map<java.lang.String,java.lang.Object>	createConfig(StepExecutionContext context, NodeStepExecutionItem item, INodeEntry node)
java.util.Map<java.lang.String,java.lang.Object>	dynamicDefaults(java.util.Map<java.lang.String,java.lang.Object> projectAndFrameworkValues, Services services)	Return dynamic default values for config properties, keyed by property name
java.util.Map<java.lang.String,java.lang.Object>	dynamicProperties(java.util.Map<java.lang.String,java.lang.Object> projectAndFrameworkValues, Services services)	Return dynamic allowed values for config properties, keyed by property name
NodeStepResult	executeNodeStep(StepExecutionContext context, NodeStepExecutionItem item, INodeEntry node)	Execute the step
Description	getDescription()
java.util.Map<java.lang.String,java.lang.Object>	getStepConfiguration(StepExecutionItem item)

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.configuration.DynamicProperties

dynamicProperties

Field Detail

DEPRECATED_CONFIGURATION_MODE

public static final java.lang.String DEPRECATED_CONFIGURATION_MODE

See Also:

Constant Field Values

SKIP

public static final java.lang.String SKIP

See Also:

Constant Field Values

log

protected static org.slf4j.Logger log

CONVERT_TO_NODE_STEP_EXECUTOR

public static final NodeStepPluginAdapter.ConvertToNodeStepExecutor CONVERT_TO_NODE_STEP_EXECUTOR

Constructor Detail

NodeStepPluginAdapter

public NodeStepPluginAdapter(NodeStepPlugin plugin)

NodeStepPluginAdapter

public NodeStepPluginAdapter(java.lang.String serviceName,
                             NodeStepPlugin plugin,
                             boolean blankIfUnexpanded)

Method Detail

getDescription

public Description getDescription()

Specified by:

getDescription in interface Describable

Returns:

the configuration description

dynamicProperties

public java.util.Map<java.lang.String,java.lang.Object> dynamicProperties(java.util.Map<java.lang.String,java.lang.Object> projectAndFrameworkValues,
                                                                                Services services)

Description copied from interface: DynamicProperties

Return dynamic allowed values for config properties, keyed by property name

Specified by:

dynamicProperties in interface DynamicProperties

Parameters:

projectAndFrameworkValues - config values for this plugin resolved from the framework/project

services - authorized services access

dynamicDefaults

public java.util.Map<java.lang.String,java.lang.Object> dynamicDefaults(java.util.Map<java.lang.String,java.lang.Object> projectAndFrameworkValues,
                                                                              Services services)

Description copied from interface: DynamicProperties

Return dynamic default values for config properties, keyed by property name

Specified by:

dynamicDefaults in interface DynamicProperties

Parameters:

projectAndFrameworkValues - config values for this plugin resolved from the framework/project

services - authorized services access

canAdaptType

public static boolean canAdaptType(java.lang.Class<?> testType)

executeNodeStep

public NodeStepResult executeNodeStep(StepExecutionContext context,
                                      NodeStepExecutionItem item,
                                      INodeEntry node)
                               throws NodeStepException

Description copied from interface: NodeStepExecutor

Execute the step

Specified by:

executeNodeStep in interface NodeStepExecutor

Parameters:

context - context

item - step item

node - node

Returns:

result

Throws:

NodeStepException - on step error

createConfig

public java.util.Map<java.lang.String,java.lang.Object> createConfig(StepExecutionContext context,
                                                                           NodeStepExecutionItem item,
                                                                           INodeEntry node)

getStepConfiguration

public java.util.Map<java.lang.String,java.lang.Object> getStepConfiguration(StepExecutionItem item)