Package com.dtolabs.rundeck.core.execution.service

Class ScriptPluginNodeExecutor

java.lang.Object

com.dtolabs.rundeck.core.plugins.AbstractDescribableScriptPlugin

com.dtolabs.rundeck.core.plugins.BaseScriptPlugin

com.dtolabs.rundeck.core.execution.service.ScriptPluginNodeExecutor

All Implemented Interfaces:

ProxySecretBundleCreator, NodeExecutor, Describable

public class ScriptPluginNodeExecutor
extends BaseScriptPlugin
implements NodeExecutor

ScriptPluginNodeExecutor wraps the execution of the script and supplies the NodeExecutor interface.

Field Summary

Fields inherited from class com.dtolabs.rundeck.core.plugins.AbstractDescribableScriptPlugin

CONFIG_BLANK_IF_UNEXPANDED, CONFIG_DEFAULT, CONFIG_DESCRIPTION, CONFIG_LABELS, CONFIG_NAME, CONFIG_PROP_PREFIX, CONFIG_RENDERING_OPTIONS, CONFIG_REQUIRED, CONFIG_SCOPE, CONFIG_TITLE, CONFIG_TYPE, CONFIG_VALUES, DESCRIPTION_PROP, SETTING_MERGE_ENVIRONMENT, TITLE_PROP

Constructor Summary

Constructors

Constructor	Description
ScriptPluginNodeExecutor(ScriptPluginProvider provider, Framework framework)

Method Summary

Modifier and Type	Method	Description
NodeExecutorResult	executeCommand(ExecutionContext executionContext, java.lang.String[] command, INodeEntry node)	Execute a command on a node and return the result.
NodeExecutorResult	executeCommand(ExecutionContext executionContext, java.lang.String[] command, INodeEntry node, boolean showError)
boolean	isAllowCustomProperties()
boolean	isUseConventionalPropertiesMapping()

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

createScriptArgs, createScriptArgsList, createScriptDataContext, createScriptDataContext, createStepItemDataContext, getScriptExecHelper, listSecretsPath, listSecretsPathWorkflowNodeStep, listSecretsPathWorkflowStep, prepareSecretBundle, prepareSecretBundleWorkflowNodeStep, prepareSecretBundleWorkflowStep, runPluginScript, setScriptExecHelper

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

createDescription, createDescription, createPluginData, getDescription, getFramework, getProvider, loadConfigData, loadContentConversionPropertyValues, loadInstanceDataFromNodeAttributes

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.execution.service.NodeExecutor

supportVariableInjection

Methods inherited from interface com.dtolabs.rundeck.core.execution.proxy.ProxySecretBundleCreator

listSecretsPathResourceModel, prepareSecretBundleResourceModel

Constructor Detail

ScriptPluginNodeExecutor

public ScriptPluginNodeExecutor(ScriptPluginProvider provider,
                                Framework framework)

Method Detail

isAllowCustomProperties

public boolean isAllowCustomProperties()

Specified by:

isAllowCustomProperties in class AbstractDescribableScriptPlugin

Returns:

true if the script-plugin allows custom configuration properties defined in plugin metadata.

isUseConventionalPropertiesMapping

public boolean isUseConventionalPropertiesMapping()

Overrides:

isUseConventionalPropertiesMapping in class AbstractDescribableScriptPlugin

Returns:

true to provide conventional mapping from config properties to framework/project properties.

executeCommand

public NodeExecutorResult executeCommand(ExecutionContext executionContext,
                                         java.lang.String[] command,
                                         INodeEntry node)

Description copied from interface: NodeExecutor

Execute a command on a node and return the result.

Specified by:

executeCommand in interface NodeExecutor

Parameters:

executionContext - the execution context

command - the array of strings for the command line, with any necessary data context references replaced.

node - the node to execute on

Returns:

a result

executeCommand

public NodeExecutorResult executeCommand(ExecutionContext executionContext,
                                         java.lang.String[] command,
                                         INodeEntry node,
                                         boolean showError)