com.dtolabs.rundeck.core.execution
Interface ExecutionService

All Superinterfaces:

FrameworkSupportService

public interface ExecutionService
extends FrameworkSupportService

ExecutionService provides interface to all dispatcher and command execution services.

Field Summary

static java.lang.String

SERVICE_NAME

Method Summary

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)
ExecutionResult	executeItem(StepExecutionContext context, StepExecutionItem item) Deprecated. use executeStep(com.dtolabs.rundeck.core.execution.workflow.StepExecutionContext, StepExecutionItem)
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) Copy file to the node as a script file to the temp file location.
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	fileCopyFileStream(ExecutionContext context, java.io.InputStream input, INodeEntry node) Copy inputstream as a file to the node.
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) Copy string as a file to the node,
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

executeItem

ExecutionResult executeItem(StepExecutionContext context,
                            StepExecutionItem item)
                            throws ExecutionException,
                                   ExecutionServiceException

Deprecated. use executeStep(com.dtolabs.rundeck.core.execution.workflow.StepExecutionContext, StepExecutionItem)

Execute the item for the given context and return the result.

Parameters:

item - item

Returns:

result

Throws:

ExecutionException

ExecutionServiceException

executeStep

StepExecutionResult executeStep(StepExecutionContext context,
                                StepExecutionItem item)
                                throws StepException

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

Parameters:

item - item

Returns:

not-null result

Throws:

StepException

executeNodeStep

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

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

Throws:

NodeStepException

dispatchToNodes

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

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

Throws:

DispatcherException

ExecutionServiceException

dispatchToNodes

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

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

Throws:

DispatcherException

ExecutionServiceException

fileCopyFileStream

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

Copy inputstream as a file to the node.

Returns:

filepath on the node for the destination file.

Throws:

FileCopierException

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

Returns:

filepath on the node for the destination file.

Throws:

FileCopierException

fileCopyFile

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

Copy file to the node as a script file to the temp file location.

Returns:

filepath for the copied file on the node.

Throws:

FileCopierException

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

Parameters:

context -

file -

node -

destinationPath -

Returns:

Throws:

FileCopierException

fileCopyScriptContent

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

Copy string as a file to the node,

Returns:

filepath for the copied file on the node

Throws:

FileCopierException

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

Returns:

filepath for the copied file on the node

Throws:

FileCopierException

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.

executeCommand

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

Execute a command within the context on the node.