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

Class DefaultScriptFileNodeStepUtils

java.lang.Object

com.dtolabs.rundeck.core.execution.workflow.steps.node.impl.DefaultScriptFileNodeStepUtils

All Implemented Interfaces:

ScriptFileNodeStepUtils

public class DefaultScriptFileNodeStepUtils
extends java.lang.Object
implements ScriptFileNodeStepUtils

Created by greg on 7/15/16.

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	logger
static java.lang.String	MESSAGE_ERROR_FILE_BUSY_PATTERN
static java.lang.String	NODE_ATTR_ENABLE_SYNC_COMMAND
static java.lang.String	NODE_ATTR_FILE_BUSY_ERR_RETRY
static java.lang.String	SCRIPT_FILE_REMOVE_TMP

Constructor Summary

Constructors

Constructor	Description
DefaultScriptFileNodeStepUtils()

Method Summary

Modifier and Type	Method	Description
NodeStepResult	executeRemoteScript(ExecutionContext context, IFramework framework, INodeEntry node, java.lang.String[] args, java.lang.String filepath)	Execute a scriptfile already copied to a remote node with the given args
NodeStepResult	executeRemoteScript(ExecutionContext context, IFramework framework, INodeEntry node, java.lang.String[] args, java.lang.String filepath, java.lang.String scriptInterpreter, boolean interpreterargsquoted)	Execute a scriptfile already copied to a remote node with the given args
NodeStepResult	executeRemoteScript(ExecutionContext context, IFramework framework, INodeEntry node, java.lang.String[] args, java.lang.String filepath, java.lang.String scriptInterpreter, boolean interpreterargsquoted, boolean removeFile)	Execute a scriptfile already copied to a remote node with the given args
NodeStepResult	executeRemoteScript(ExecutionContext context, IFramework framework, INodeEntry node, java.lang.String[] args, java.lang.String filepath, java.lang.String scriptInterpreter, boolean interpreterargsquoted, boolean removeFile, java.io.InputStream input)	Execute a scriptfile already copied to a remote node with the given args
NodeStepResult	executeRemoteScript(ExecutionContext context, IFramework framework, INodeEntry node, java.lang.String[] args, java.lang.String filepath, java.lang.String scriptInterpreter, boolean interpreterargsquoted, java.io.InputStream inputStream)	Execute a scriptfile already copied to a remote node with the given args
NodeStepResult	executeScriptFile(StepExecutionContext context, INodeEntry node, java.lang.String scriptString, java.lang.String serverScriptFilePath, java.io.InputStream scriptAsStream, java.lang.String fileExtension, java.lang.String[] args, java.lang.String scriptInterpreter, boolean quoted, NodeExecutionService executionService, boolean expandTokens)	Execute a script on a remote node
NodeStepResult	executeScriptFile(StepExecutionContext context, INodeEntry node, java.lang.String scriptString, java.lang.String serverScriptFilePath, java.io.InputStream scriptAsStream, java.lang.String fileExtension, java.lang.String[] args, java.lang.String scriptInterpreter, java.io.InputStream input, boolean quoted, NodeExecutionService executionService, boolean expandTokens, FileCopierUtil.ContentModifier modifier)	Execute a script on a remote node
FileCopierUtil	getFileCopierUtil()
ExecArgList	removeArgsForOsFamily(java.lang.String filepath, java.lang.String osFamily)	Return ExecArgList for removing a file for the given OS family
void	setFileCopierUtil(FileCopierUtil fileCopierUtil)
java.io.File	writeScriptToTempFile(StepExecutionContext context, INodeEntry node, java.lang.String scriptString, java.lang.String serverScriptFilePath, java.io.InputStream scriptAsStream, boolean expandTokens)	Copy the script input to a temp file and expand embedded tokens, if it is a string or inputstream.
java.io.File	writeScriptToTempFile(StepExecutionContext context, INodeEntry node, java.lang.String scriptString, java.lang.String serverScriptFilePath, java.io.InputStream scriptAsStream, boolean expandTokens, FileCopierUtil.ContentModifier scriptModifierUtil)	Copy the script input to a temp file and expand embedded tokens, if it is a string or inputstream.

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final org.slf4j.Logger logger

SCRIPT_FILE_REMOVE_TMP

public static final java.lang.String SCRIPT_FILE_REMOVE_TMP

See Also:

Constant Field Values

MESSAGE_ERROR_FILE_BUSY_PATTERN

public static final java.lang.String MESSAGE_ERROR_FILE_BUSY_PATTERN

See Also:

Constant Field Values

NODE_ATTR_FILE_BUSY_ERR_RETRY

public static final java.lang.String NODE_ATTR_FILE_BUSY_ERR_RETRY

See Also:

Constant Field Values

NODE_ATTR_ENABLE_SYNC_COMMAND

public static final java.lang.String NODE_ATTR_ENABLE_SYNC_COMMAND

See Also:

Constant Field Values

Constructor Detail

DefaultScriptFileNodeStepUtils

public DefaultScriptFileNodeStepUtils()

Method Detail

executeScriptFile

public NodeStepResult executeScriptFile(StepExecutionContext context,
                                        INodeEntry node,
                                        java.lang.String scriptString,
                                        java.lang.String serverScriptFilePath,
                                        java.io.InputStream scriptAsStream,
                                        java.lang.String fileExtension,
                                        java.lang.String[] args,
                                        java.lang.String scriptInterpreter,
                                        boolean quoted,
                                        NodeExecutionService executionService,
                                        boolean expandTokens)
                                 throws NodeStepException

Execute a script on a remote node

Specified by:

executeScriptFile in interface ScriptFileNodeStepUtils

Parameters:

context - context

node - node

scriptString - string

serverScriptFilePath - file

scriptAsStream - stream

fileExtension - file extension

args - script args

scriptInterpreter - invoker string

quoted - true if args are quoted

executionService - service

Returns:

execution result

Throws:

NodeStepException - on error

executeScriptFile

public NodeStepResult executeScriptFile(StepExecutionContext context,
                                        INodeEntry node,
                                        java.lang.String scriptString,
                                        java.lang.String serverScriptFilePath,
                                        java.io.InputStream scriptAsStream,
                                        java.lang.String fileExtension,
                                        java.lang.String[] args,
                                        java.lang.String scriptInterpreter,
                                        java.io.InputStream input,
                                        boolean quoted,
                                        NodeExecutionService executionService,
                                        boolean expandTokens,
                                        FileCopierUtil.ContentModifier modifier)
                                 throws NodeStepException

Execute a script on a remote node

Specified by:

executeScriptFile in interface ScriptFileNodeStepUtils

Parameters:

context - context

node - node

scriptString - string

serverScriptFilePath - file

scriptAsStream - stream

fileExtension - file extension

args - script args

scriptInterpreter - invoker string

quoted - true if args are quoted

executionService - service

input - inputstream to send to the script

Returns:

execution result

Throws:

NodeStepException - on error

writeScriptToTempFile

public java.io.File writeScriptToTempFile(StepExecutionContext context,
                                          INodeEntry node,
                                          java.lang.String scriptString,
                                          java.lang.String serverScriptFilePath,
                                          java.io.InputStream scriptAsStream,
                                          boolean expandTokens)
                                   throws FileCopierException

Copy the script input to a temp file and expand embedded tokens, if it is a string or inputstream. If it is a local file, use the original without modification

Specified by:

writeScriptToTempFile in interface ScriptFileNodeStepUtils

Parameters:

context - context

node - node

scriptString - string

serverScriptFilePath - file

scriptAsStream - stream

Returns:

temp file

Throws:

FileCopierException - on error

writeScriptToTempFile

public java.io.File writeScriptToTempFile(StepExecutionContext context,
                                          INodeEntry node,
                                          java.lang.String scriptString,
                                          java.lang.String serverScriptFilePath,
                                          java.io.InputStream scriptAsStream,
                                          boolean expandTokens,
                                          FileCopierUtil.ContentModifier scriptModifierUtil)
                                   throws FileCopierException

Copy the script input to a temp file and expand embedded tokens, if it is a string or inputstream. If it is a local file, use the original without modification

Specified by:

writeScriptToTempFile in interface ScriptFileNodeStepUtils

Parameters:

context - context

node - node

scriptString - string

serverScriptFilePath - file

scriptAsStream - stream

Returns:

temp file

Throws:

FileCopierException - on error

executeRemoteScript

public NodeStepResult executeRemoteScript(ExecutionContext context,
                                          IFramework framework,
                                          INodeEntry node,
                                          java.lang.String[] args,
                                          java.lang.String filepath)
                                   throws NodeStepException

Execute a scriptfile already copied to a remote node with the given args

Specified by:

executeRemoteScript in interface ScriptFileNodeStepUtils

Parameters:

context - context

framework - framework

node - the node

args - arguments to script

filepath - the remote path for the script

Returns:

the result

Throws:

NodeStepException - on error

executeRemoteScript

public NodeStepResult executeRemoteScript(ExecutionContext context,
                                          IFramework framework,
                                          INodeEntry node,
                                          java.lang.String[] args,
                                          java.lang.String filepath,
                                          java.lang.String scriptInterpreter,
                                          boolean interpreterargsquoted)
                                   throws NodeStepException

Execute a scriptfile already copied to a remote node with the given args

Specified by:

executeRemoteScript in interface ScriptFileNodeStepUtils

Parameters:

context - context

framework - framework

node - the node

args - arguments to script

filepath - the remote path for the script

scriptInterpreter - interpreter used to invoke the script

interpreterargsquoted - if true, pass the file and script args as a single argument to the interpreter

Returns:

result

Throws:

NodeStepException - on error

executeRemoteScript

public NodeStepResult executeRemoteScript(ExecutionContext context,
                                          IFramework framework,
                                          INodeEntry node,
                                          java.lang.String[] args,
                                          java.lang.String filepath,
                                          java.lang.String scriptInterpreter,
                                          boolean interpreterargsquoted,
                                          java.io.InputStream inputStream)
                                   throws NodeStepException

Execute a scriptfile already copied to a remote node with the given args

Specified by:

executeRemoteScript in interface ScriptFileNodeStepUtils

Parameters:

context - context

framework - framework

node - the node

args - arguments to script

filepath - the remote path for the script

scriptInterpreter - interpreter used to invoke the script

interpreterargsquoted - if true, pass the file and script args as a single argument to the interpreter

inputStream - input to send to the script

Returns:

result

Throws:

NodeStepException - on error

executeRemoteScript

public NodeStepResult executeRemoteScript(ExecutionContext context,
                                          IFramework framework,
                                          INodeEntry node,
                                          java.lang.String[] args,
                                          java.lang.String filepath,
                                          java.lang.String scriptInterpreter,
                                          boolean interpreterargsquoted,
                                          boolean removeFile)
                                   throws NodeStepException

Execute a scriptfile already copied to a remote node with the given args

Specified by:

executeRemoteScript in interface ScriptFileNodeStepUtils

Parameters:

context - context

framework - framework

node - the node

args - arguments to script

filepath - the remote path for the script

scriptInterpreter - interpreter used to invoke the script

interpreterargsquoted - if true, pass the file and script args as a single argument to the interpreter

removeFile - if true, remove the file after execution

Returns:

result

Throws:

NodeStepException - on error

executeRemoteScript

public NodeStepResult executeRemoteScript(ExecutionContext context,
                                          IFramework framework,
                                          INodeEntry node,
                                          java.lang.String[] args,
                                          java.lang.String filepath,
                                          java.lang.String scriptInterpreter,
                                          boolean interpreterargsquoted,
                                          boolean removeFile,
                                          java.io.InputStream input)

Execute a scriptfile already copied to a remote node with the given args

Specified by:

executeRemoteScript in interface ScriptFileNodeStepUtils

Parameters:

context - context

framework - framework

node - the node

args - arguments to script

filepath - the remote path for the script

scriptInterpreter - interpreter used to invoke the script

interpreterargsquoted - if true, pass the file and script args as a single argument to the interpreter

removeFile - if true, remove the file after execution

input - input to send to the script

Returns:

result

removeArgsForOsFamily

public ExecArgList removeArgsForOsFamily(java.lang.String filepath,
                                         java.lang.String osFamily)

Return ExecArgList for removing a file for the given OS family

Specified by:

removeArgsForOsFamily in interface ScriptFileNodeStepUtils

Parameters:

filepath - path

osFamily - family

Returns:

arg list

getFileCopierUtil

public FileCopierUtil getFileCopierUtil()

setFileCopierUtil

public void setFileCopierUtil(FileCopierUtil fileCopierUtil)