Package com.dtolabs.rundeck.core.execution

Interface ExecutionService

All Superinterfaces:

AppService, FrameworkSupportService, NodeExecutionService

All Known Implementing Classes:

ExecutionServiceImpl

public interface ExecutionService
extends FrameworkSupportService, NodeExecutionService

ExecutionService provides interface to all dispatcher and command execution services.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
DispatcherResult	dispatchToNodes(StepExecutionContext context, Dispatchable item)	Dispatch the command (execution item) to all the nodes within the context.
DispatcherResult	dispatchToNodes(StepExecutionContext context, NodeStepExecutionItem item)	Dispatch the command (execution item) to all the nodes within the context.
NodeExecutorResult	executeCommand(ExecutionContext context, ExecArgList command, INodeEntry node)	Execute a command within the context on the node.
NodeExecutorResult	executeCommand(ExecutionContext context, java.lang.String[] command, INodeEntry node)	Deprecated. use executeCommand(ExecutionContext, ExecArgList, com.dtolabs.rundeck.core.common.INodeEntry)
NodeStepResult	executeNodeStep(StepExecutionContext context, NodeStepExecutionItem item, INodeEntry node)	Interpret the execution item within the context for the given node.
StepExecutionResult	executeStep(StepExecutionContext context, StepExecutionItem item)	Execute a workflow step item for the given context and return the result.
java.lang.String	fileCopyFile(ExecutionContext context, java.io.File file, INodeEntry node, java.lang.String destinationPath)	Copy file to the node to a specific path
java.lang.String[]	fileCopyFiles(ExecutionContext context, java.io.File basedir, java.util.List<java.io.File> files, java.lang.String remotePath, INodeEntry node)	Copy multiple files to the node to a specific path
java.lang.String	fileCopyFileStream(ExecutionContext context, java.io.InputStream input, INodeEntry node, java.lang.String destinationPath)	Copy inputstream as a file to the node to a specific path
java.lang.String	fileCopyScriptContent(ExecutionContext context, java.lang.String script, INodeEntry node, java.lang.String destinationPath)	Copy string as a file to the node to a specific path

Methods inherited from interface com.dtolabs.rundeck.core.common.FrameworkSupportService

getName

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

executeStep

StepExecutionResult executeStep(StepExecutionContext context,
                                StepExecutionItem item)
                         throws StepException

Execute a workflow step item for the given context and return the result.

Parameters:

context - context

item - item

Returns:

not-null result

Throws:

StepException - on error

executeNodeStep

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

Interpret the execution item within the context for the given node.

Parameters:

context - context

item - step item

node - node

Returns:

result

Throws:

NodeStepException - on error

dispatchToNodes

DispatcherResult dispatchToNodes(StepExecutionContext context,
                                 NodeStepExecutionItem item)
                          throws DispatcherException,
                                 ExecutionServiceException

Dispatch the command (execution item) to all the nodes within the context.

Parameters:

context - context

item - step item

Returns:

result

Throws:

DispatcherException - on dispatch error

ExecutionServiceException - on service error

dispatchToNodes

DispatcherResult dispatchToNodes(StepExecutionContext context,
                                 Dispatchable item)
                          throws DispatcherException,
                                 ExecutionServiceException

Dispatch the command (execution item) to all the nodes within the context.

Parameters:

context - context

item - step item

Returns:

result

Throws:

DispatcherException - on dispatch error

ExecutionServiceException - on service error

fileCopyFileStream

java.lang.String fileCopyFileStream(ExecutionContext context,
                                    java.io.InputStream input,
                                    INodeEntry node,
                                    java.lang.String destinationPath)
                             throws FileCopierException

Copy inputstream as a file to the node to a specific path

Specified by:

fileCopyFileStream in interface NodeExecutionService

Parameters:

context - context

input - input stream

node - node

destinationPath - destination path

Returns:

filepath on the node for the destination file.

Throws:

FileCopierException - on error

fileCopyFile

java.lang.String fileCopyFile(ExecutionContext context,
                              java.io.File file,
                              INodeEntry node,
                              java.lang.String destinationPath)
                       throws FileCopierException

Copy file to the node to a specific path

Specified by:

fileCopyFile in interface NodeExecutionService

Parameters:

context - context

file - input file

node - node

destinationPath - destination path

Returns:

filepath

Throws:

FileCopierException - on error

fileCopyFiles

java.lang.String[] fileCopyFiles(ExecutionContext context,
                                 java.io.File basedir,
                                 java.util.List<java.io.File> files,
                                 java.lang.String remotePath,
                                 INodeEntry node)
                          throws FileCopierException

Copy multiple files to the node to a specific path

Parameters:

context - context

basedir - base directory for copied files

files - array of input files

remotePath - remote path destination for files

node - node

Returns:

list of copied paths from the remote node

Throws:

FileCopierException - on error

fileCopyScriptContent

java.lang.String fileCopyScriptContent(ExecutionContext context,
                                       java.lang.String script,
                                       INodeEntry node,
                                       java.lang.String destinationPath)
                                throws FileCopierException

Copy string as a file to the node to a specific path

Parameters:

context - context

script - script string

node - node

destinationPath - destination path

Returns:

filepath for the copied file on the node

Throws:

FileCopierException - on error

executeCommand

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

Deprecated.

use executeCommand(ExecutionContext, ExecArgList, com.dtolabs.rundeck.core.common.INodeEntry)

Execute a command within the context on the node.

Parameters:

context - context

command - command strings

node - node

Returns:

result

executeCommand

NodeExecutorResult executeCommand(ExecutionContext context,
                                  ExecArgList command,
                                  INodeEntry node)

Execute a command within the context on the node.

Specified by:

executeCommand in interface NodeExecutionService

Parameters:

context - context

command - command

node - node

Returns:

result