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

Class RemoteScriptNodeStepPluginAdapter_Ext

java.lang.Object

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

All Implemented Interfaces:

Configurable, Describable, NodeStepPlugin

public class RemoteScriptNodeStepPluginAdapter_Ext
extends java.lang.Object
implements NodeStepPlugin, Configurable, Describable

Adapts a RemoteScriptNodeStepPlugin into a NodeStepPlugin

Field Summary

Fields

Modifier and Type	Field	Description
static com.dtolabs.rundeck.core.execution.workflow.steps.node.RemoteScriptNodeStepPluginAdapter_Ext.NodeStepPluginConverter	CONVERT_TO_NODE_STEP_PLUGIN

Constructor Summary

Constructors

Constructor	Description
RemoteScriptNodeStepPluginAdapter_Ext(RemoteScriptNodeStepPlugin plugin, boolean blankIfUnexpanded)

Method Summary

Modifier and Type	Method	Description
boolean	blankIfUnexpanded()
void	configure(java.util.Properties configuration)	Configure the object with the configuration properties.
void	executeNodeStep(PluginStepContext pluginContext, java.util.Map<java.lang.String,java.lang.Object> config, INodeEntry node)	Execute the plugin step logic for the given node.
static NodeStepResult	executeRemoteScript(StepExecutionContext context, INodeEntry node, GeneratedScript script, java.lang.String ident, java.lang.String providerName, ScriptFileNodeStepUtils scriptUtils)
Description	getDescription()
ScriptFileNodeStepUtils	getScriptUtils()
void	setScriptUtils(ScriptFileNodeStepUtils scriptUtils)

Methods inherited from class java.lang.Object

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

Field Detail

CONVERT_TO_NODE_STEP_PLUGIN

public static final com.dtolabs.rundeck.core.execution.workflow.steps.node.RemoteScriptNodeStepPluginAdapter_Ext.NodeStepPluginConverter CONVERT_TO_NODE_STEP_PLUGIN

Constructor Detail

RemoteScriptNodeStepPluginAdapter_Ext

public RemoteScriptNodeStepPluginAdapter_Ext(RemoteScriptNodeStepPlugin plugin,
                                             boolean blankIfUnexpanded)

Method Detail

blankIfUnexpanded

public boolean blankIfUnexpanded()

Specified by:

blankIfUnexpanded in interface NodeStepPlugin

getDescription

public Description getDescription()

Specified by:

getDescription in interface Describable

Returns:

the configuration description

getScriptUtils

public ScriptFileNodeStepUtils getScriptUtils()

setScriptUtils

public void setScriptUtils(ScriptFileNodeStepUtils scriptUtils)

configure

public void configure(java.util.Properties configuration)
               throws ConfigurationException

Description copied from interface: Configurable

Configure the object with the configuration properties.

Specified by:

configure in interface Configurable

Parameters:

configuration - the properties to use

Throws:

ConfigurationException - if there is an invalid configuration

executeNodeStep

public void executeNodeStep(PluginStepContext pluginContext,
                            java.util.Map<java.lang.String,java.lang.Object> config,
                            INodeEntry node)
                     throws NodeStepException

Description copied from interface: NodeStepPlugin

Execute the plugin step logic for the given node.

Specified by:

executeNodeStep in interface NodeStepPlugin

Parameters:

pluginContext - the step context

config - Any configuration property values not otherwise applied to the plugin

node - the Node

Throws:

NodeStepException - if an error occurs

executeRemoteScript

public static NodeStepResult executeRemoteScript(StepExecutionContext context,
                                                 INodeEntry node,
                                                 GeneratedScript script,
                                                 java.lang.String ident,
                                                 java.lang.String providerName,
                                                 ScriptFileNodeStepUtils scriptUtils)
                                          throws NodeStepException

Throws:

NodeStepException