com.dtolabs.rundeck.core.execution.impl.jsch

Class JschNodeExecutor

java.lang.Object

com.dtolabs.rundeck.core.execution.impl.jsch.JschNodeExecutor

All Implemented Interfaces:

NodeExecutor, Describable

public class JschNodeExecutor
extends java.lang.Object
implements NodeExecutor, Describable

JschNodeExecutor is ...

Field Summary

Fields

Modifier and Type	Field and Description
static Property	ALWAYS_SET_PTY
static java.lang.String	CONFIG_AUTHENTICATION
static java.lang.String	CONFIG_COMMAND_TIMEOUT
static java.lang.String	CONFIG_CON_TIMEOUT
static java.lang.String	CONFIG_KEYPATH
static java.lang.String	CONFIG_KEYSTORE_PATH
static java.lang.String	CONFIG_PASSPHRASE_STORE_PATH
static java.lang.String	CONFIG_PASSSTORE_PATH
static java.lang.String	CONFIG_SET_PTY
static java.lang.String	CONFIG_SUDO_PASSSTORE_PATH
static java.lang.String	DEFAULT_SSH_KEY_PASSPHRASE_OPTION
static java.lang.String	DEFAULT_SSH_PASSWORD_OPTION
static java.lang.String	DEFAULT_SUDO_COMMAND_PATTERN
static boolean	DEFAULT_SUDO_FAIL_ON_PROMPT_MAX_LINES
static boolean	DEFAULT_SUDO_FAIL_ON_PROMPT_TIMEOUT
static boolean	DEFAULT_SUDO_FAIL_ON_RESPONSE_TIMEOUT
static java.lang.String	DEFAULT_SUDO_FAILURE_PATTERN
static java.lang.String	DEFAULT_SUDO_PASSWORD_OPTION
static int	DEFAULT_SUDO_PROMPT_MAX_LINES
static long	DEFAULT_SUDO_PROMPT_MAX_TIMEOUT
static java.lang.String	DEFAULT_SUDO_PROMPT_PATTERN
static int	DEFAULT_SUDO_RESPONSE_MAX_LINES
static long	DEFAULT_SUDO_RESPONSE_MAX_TIMEOUT
static boolean	DEFAULT_SUDO_SUCCESS_ON_PROMPT_THRESHOLD
static java.lang.String	DEFAULT_SUDO2_COMMAND_PATTERN
static java.lang.String	DEFAULT_SUDO2_PASSWORD_OPTION
static java.lang.String	FRAMEWORK_SSH_COMMAND_TIMEOUT_PROP
static java.lang.String	FRAMEWORK_SSH_CONNECT_TIMEOUT_PROP
static java.lang.String	FWK_PROP_AUTH_CANCEL_MSG
static java.lang.String	FWK_PROP_AUTH_CANCEL_MSG_DEFAULT
static java.lang.String	FWK_PROP_AUTH_FAIL_MSG
static java.lang.String	FWK_PROP_AUTH_FAIL_MSG_DEFAULT
static java.lang.String	FWK_PROP_COMMAND_TIMEOUT
static java.lang.String	FWK_PROP_CON_TIMEOUT
static java.lang.String	FWK_PROP_PREFIX
static java.lang.String	FWK_PROP_SET_PTY
static java.lang.String	FWK_PROP_SSH_AUTHENTICATION
static java.lang.String	FWK_PROP_SSH_KEY_PASSPHRASE_STORAGE_PATH
static java.lang.String	FWK_PROP_SSH_KEY_RESOURCE
static java.lang.String	FWK_PROP_SSH_KEYPATH
static java.lang.String	FWK_PROP_SSH_PASSWORD_STORAGE_PATH
static java.lang.String	FWK_SSH_CONFIG_PREFIX
static org.apache.log4j.Logger	logger
static java.lang.String	NODE_ATTR_ALWAYS_SET_PTY
static java.lang.String	NODE_ATTR_LOCAL_SSH_AGENT
static java.lang.String	NODE_ATTR_LOCAL_TTL_SSH_AGENT
static java.lang.String	NODE_ATTR_SSH_AUTHENTICATION
static java.lang.String	NODE_ATTR_SSH_COMMAND_TIMEOUT_PROP
static java.lang.String	NODE_ATTR_SSH_CONNECT_TIMEOUT_PROP
static java.lang.String	NODE_ATTR_SSH_KEY_PASSPHRASE_OPTION
static java.lang.String	NODE_ATTR_SSH_KEY_PASSPHRASE_STORAGE_PATH
static java.lang.String	NODE_ATTR_SSH_KEY_RESOURCE
static java.lang.String	NODE_ATTR_SSH_KEYPATH
static java.lang.String	NODE_ATTR_SSH_PASSWORD_OPTION
static java.lang.String	NODE_ATTR_SSH_PASSWORD_STORAGE_PATH
static java.lang.String	NODE_ATTR_SUDO_COMMAND_ENABLED
static java.lang.String	NODE_ATTR_SUDO_COMMAND_PATTERN
static java.lang.String	NODE_ATTR_SUDO_FAIL_ON_PROMPT_MAX_LINES
static java.lang.String	NODE_ATTR_SUDO_FAIL_ON_PROMPT_TIMEOUT
static java.lang.String	NODE_ATTR_SUDO_FAIL_ON_RESPONSE_TIMEOUT
static java.lang.String	NODE_ATTR_SUDO_FAILURE_PATTERN
static java.lang.String	NODE_ATTR_SUDO_PASSWORD_OPTION
static java.lang.String	NODE_ATTR_SUDO_PASSWORD_STORAGE_PATH
static java.lang.String	NODE_ATTR_SUDO_PROMPT_MAX_LINES
static java.lang.String	NODE_ATTR_SUDO_PROMPT_MAX_TIMEOUT
static java.lang.String	NODE_ATTR_SUDO_PROMPT_PATTERN
static java.lang.String	NODE_ATTR_SUDO_RESPONSE_MAX_LINES
static java.lang.String	NODE_ATTR_SUDO_RESPONSE_MAX_TIMEOUT
static java.lang.String	NODE_ATTR_SUDO_SUCCESS_ON_PROMPT_THRESHOLD
static java.lang.String	PROJ_PROP_COMMAND_TIMEOUT
static java.lang.String	PROJ_PROP_CON_TIMEOUT
static java.lang.String	PROJ_PROP_PREFIX
static java.lang.String	PROJ_PROP_SET_PTY
static java.lang.String	PROJ_PROP_SSH_AUTHENTICATION
static java.lang.String	PROJ_PROP_SSH_KEY_PASSPHRASE_STORAGE_PATH
static java.lang.String	PROJ_PROP_SSH_KEY_RESOURCE
static java.lang.String	PROJ_PROP_SSH_KEYPATH
static java.lang.String	PROJ_PROP_SSH_PASSWORD_STORAGE_PATH
static java.lang.String	PROJ_SSH_CONFIG_PREFIX
static java.lang.String	PROJECT_SSH_USER
static Property	PROP_COMMAND_TIMEOUT
static Property	PROP_CON_TIMEOUT
static java.lang.String	SERVICE_PROVIDER_TYPE
static Property	SSH_AUTH_TYPE_PROP
static java.lang.String	SSH_CONFIG_PREFIX
static java.lang.String	SSH_TIMEOUT_PROP deprecated Global command & connection timeout framework property
static java.lang.String	SUDO_OPT_PREFIX
static java.lang.String	SUDO2_OPT_PREFIX

Constructor Summary

Constructors

Constructor and Description
JschNodeExecutor(Framework framework)

Method Summary

Modifier and Type	Method and Description
NodeExecutorResult	executeCommand(ExecutionContext context, java.lang.String[] command, INodeEntry node) Execute a command on a node and return the result.
Description	getDescription()

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.apache.log4j.Logger logger

SERVICE_PROVIDER_TYPE

public static final java.lang.String SERVICE_PROVIDER_TYPE

See Also:

Constant Field Values

FWK_PROP_AUTH_CANCEL_MSG

public static final java.lang.String FWK_PROP_AUTH_CANCEL_MSG

See Also:

Constant Field Values

FWK_PROP_AUTH_CANCEL_MSG_DEFAULT

public static final java.lang.String FWK_PROP_AUTH_CANCEL_MSG_DEFAULT

See Also:

Constant Field Values

FWK_PROP_AUTH_FAIL_MSG

public static final java.lang.String FWK_PROP_AUTH_FAIL_MSG

See Also:

Constant Field Values

FWK_PROP_AUTH_FAIL_MSG_DEFAULT

public static final java.lang.String FWK_PROP_AUTH_FAIL_MSG_DEFAULT

See Also:

Constant Field Values

NODE_ATTR_SSH_KEYPATH

public static final java.lang.String NODE_ATTR_SSH_KEYPATH

See Also:

Constant Field Values

NODE_ATTR_SSH_KEY_RESOURCE

public static final java.lang.String NODE_ATTR_SSH_KEY_RESOURCE

See Also:

Constant Field Values

NODE_ATTR_SSH_PASSWORD_STORAGE_PATH

public static final java.lang.String NODE_ATTR_SSH_PASSWORD_STORAGE_PATH

See Also:

Constant Field Values

NODE_ATTR_LOCAL_SSH_AGENT

public static final java.lang.String NODE_ATTR_LOCAL_SSH_AGENT

See Also:

Constant Field Values

NODE_ATTR_LOCAL_TTL_SSH_AGENT

public static final java.lang.String NODE_ATTR_LOCAL_TTL_SSH_AGENT

See Also:

Constant Field Values

PROJ_PROP_PREFIX

public static final java.lang.String PROJ_PROP_PREFIX

See Also:

Constant Field Values

FWK_PROP_PREFIX

public static final java.lang.String FWK_PROP_PREFIX

See Also:

Constant Field Values

FWK_PROP_SSH_KEYPATH

public static final java.lang.String FWK_PROP_SSH_KEYPATH

See Also:

Constant Field Values

PROJ_PROP_SSH_KEYPATH

public static final java.lang.String PROJ_PROP_SSH_KEYPATH

See Also:

Constant Field Values

FWK_PROP_SSH_KEY_RESOURCE

public static final java.lang.String FWK_PROP_SSH_KEY_RESOURCE

See Also:

Constant Field Values

FWK_PROP_SSH_PASSWORD_STORAGE_PATH

public static final java.lang.String FWK_PROP_SSH_PASSWORD_STORAGE_PATH

See Also:

Constant Field Values

PROJ_PROP_SSH_KEY_RESOURCE

public static final java.lang.String PROJ_PROP_SSH_KEY_RESOURCE

See Also:

Constant Field Values

PROJ_PROP_SSH_PASSWORD_STORAGE_PATH

public static final java.lang.String PROJ_PROP_SSH_PASSWORD_STORAGE_PATH

See Also:

Constant Field Values

NODE_ATTR_SSH_AUTHENTICATION

public static final java.lang.String NODE_ATTR_SSH_AUTHENTICATION

See Also:

Constant Field Values

NODE_ATTR_SSH_PASSWORD_OPTION

public static final java.lang.String NODE_ATTR_SSH_PASSWORD_OPTION

See Also:

Constant Field Values

DEFAULT_SSH_PASSWORD_OPTION

public static final java.lang.String DEFAULT_SSH_PASSWORD_OPTION

See Also:

Constant Field Values

SUDO_OPT_PREFIX

public static final java.lang.String SUDO_OPT_PREFIX

See Also:

Constant Field Values

SUDO2_OPT_PREFIX

public static final java.lang.String SUDO2_OPT_PREFIX

See Also:

Constant Field Values

NODE_ATTR_SUDO_PASSWORD_OPTION

public static final java.lang.String NODE_ATTR_SUDO_PASSWORD_OPTION

See Also:

Constant Field Values

DEFAULT_SUDO_PASSWORD_OPTION

public static final java.lang.String DEFAULT_SUDO_PASSWORD_OPTION

See Also:

Constant Field Values

DEFAULT_SUDO2_PASSWORD_OPTION

public static final java.lang.String DEFAULT_SUDO2_PASSWORD_OPTION

See Also:

Constant Field Values

NODE_ATTR_SSH_KEY_PASSPHRASE_OPTION

public static final java.lang.String NODE_ATTR_SSH_KEY_PASSPHRASE_OPTION

See Also:

Constant Field Values

NODE_ATTR_SSH_KEY_PASSPHRASE_STORAGE_PATH

public static final java.lang.String NODE_ATTR_SSH_KEY_PASSPHRASE_STORAGE_PATH

See Also:

Constant Field Values

DEFAULT_SSH_KEY_PASSPHRASE_OPTION

public static final java.lang.String DEFAULT_SSH_KEY_PASSPHRASE_OPTION

See Also:

Constant Field Values

FWK_PROP_SSH_KEY_PASSPHRASE_STORAGE_PATH

public static final java.lang.String FWK_PROP_SSH_KEY_PASSPHRASE_STORAGE_PATH

See Also:

Constant Field Values

PROJ_PROP_SSH_KEY_PASSPHRASE_STORAGE_PATH

public static final java.lang.String PROJ_PROP_SSH_KEY_PASSPHRASE_STORAGE_PATH

See Also:

Constant Field Values

NODE_ATTR_ALWAYS_SET_PTY

public static final java.lang.String NODE_ATTR_ALWAYS_SET_PTY

See Also:

Constant Field Values

FWK_PROP_SET_PTY

public static final java.lang.String FWK_PROP_SET_PTY

See Also:

Constant Field Values

PROJ_PROP_SET_PTY

public static final java.lang.String PROJ_PROP_SET_PTY

See Also:

Constant Field Values

FWK_PROP_SSH_AUTHENTICATION

public static final java.lang.String FWK_PROP_SSH_AUTHENTICATION

See Also:

Constant Field Values

PROJ_PROP_SSH_AUTHENTICATION

public static final java.lang.String PROJ_PROP_SSH_AUTHENTICATION

See Also:

Constant Field Values

NODE_ATTR_SUDO_COMMAND_ENABLED

public static final java.lang.String NODE_ATTR_SUDO_COMMAND_ENABLED

See Also:

Constant Field Values

NODE_ATTR_SUDO_PROMPT_PATTERN

public static final java.lang.String NODE_ATTR_SUDO_PROMPT_PATTERN

See Also:

Constant Field Values

DEFAULT_SUDO_PROMPT_PATTERN

public static final java.lang.String DEFAULT_SUDO_PROMPT_PATTERN

See Also:

Constant Field Values

NODE_ATTR_SUDO_FAILURE_PATTERN

public static final java.lang.String NODE_ATTR_SUDO_FAILURE_PATTERN

See Also:

Constant Field Values

DEFAULT_SUDO_FAILURE_PATTERN

public static final java.lang.String DEFAULT_SUDO_FAILURE_PATTERN

See Also:

Constant Field Values

NODE_ATTR_SUDO_COMMAND_PATTERN

public static final java.lang.String NODE_ATTR_SUDO_COMMAND_PATTERN

See Also:

Constant Field Values

DEFAULT_SUDO_COMMAND_PATTERN

public static final java.lang.String DEFAULT_SUDO_COMMAND_PATTERN

See Also:

Constant Field Values

DEFAULT_SUDO2_COMMAND_PATTERN

public static final java.lang.String DEFAULT_SUDO2_COMMAND_PATTERN

See Also:

Constant Field Values

NODE_ATTR_SUDO_PROMPT_MAX_LINES

public static final java.lang.String NODE_ATTR_SUDO_PROMPT_MAX_LINES

See Also:

Constant Field Values

DEFAULT_SUDO_PROMPT_MAX_LINES

public static final int DEFAULT_SUDO_PROMPT_MAX_LINES

See Also:

Constant Field Values

NODE_ATTR_SUDO_RESPONSE_MAX_LINES

public static final java.lang.String NODE_ATTR_SUDO_RESPONSE_MAX_LINES

See Also:

Constant Field Values

DEFAULT_SUDO_RESPONSE_MAX_LINES

public static final int DEFAULT_SUDO_RESPONSE_MAX_LINES

See Also:

Constant Field Values

NODE_ATTR_SUDO_PROMPT_MAX_TIMEOUT

public static final java.lang.String NODE_ATTR_SUDO_PROMPT_MAX_TIMEOUT

See Also:

Constant Field Values

DEFAULT_SUDO_PROMPT_MAX_TIMEOUT

public static final long DEFAULT_SUDO_PROMPT_MAX_TIMEOUT

See Also:

Constant Field Values

NODE_ATTR_SUDO_RESPONSE_MAX_TIMEOUT

public static final java.lang.String NODE_ATTR_SUDO_RESPONSE_MAX_TIMEOUT

See Also:

Constant Field Values

DEFAULT_SUDO_RESPONSE_MAX_TIMEOUT

public static final long DEFAULT_SUDO_RESPONSE_MAX_TIMEOUT

See Also:

Constant Field Values

NODE_ATTR_SUDO_FAIL_ON_PROMPT_MAX_LINES

public static final java.lang.String NODE_ATTR_SUDO_FAIL_ON_PROMPT_MAX_LINES

See Also:

Constant Field Values

DEFAULT_SUDO_FAIL_ON_PROMPT_MAX_LINES

public static final boolean DEFAULT_SUDO_FAIL_ON_PROMPT_MAX_LINES

See Also:

Constant Field Values

NODE_ATTR_SUDO_FAIL_ON_PROMPT_TIMEOUT

public static final java.lang.String NODE_ATTR_SUDO_FAIL_ON_PROMPT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_SUDO_FAIL_ON_PROMPT_TIMEOUT

public static final boolean DEFAULT_SUDO_FAIL_ON_PROMPT_TIMEOUT

See Also:

Constant Field Values

NODE_ATTR_SUDO_FAIL_ON_RESPONSE_TIMEOUT

public static final java.lang.String NODE_ATTR_SUDO_FAIL_ON_RESPONSE_TIMEOUT

See Also:

Constant Field Values

DEFAULT_SUDO_FAIL_ON_RESPONSE_TIMEOUT

public static final boolean DEFAULT_SUDO_FAIL_ON_RESPONSE_TIMEOUT

See Also:

Constant Field Values

NODE_ATTR_SUDO_SUCCESS_ON_PROMPT_THRESHOLD

public static final java.lang.String NODE_ATTR_SUDO_SUCCESS_ON_PROMPT_THRESHOLD

See Also:

Constant Field Values

NODE_ATTR_SUDO_PASSWORD_STORAGE_PATH

public static final java.lang.String NODE_ATTR_SUDO_PASSWORD_STORAGE_PATH

See Also:

Constant Field Values

DEFAULT_SUDO_SUCCESS_ON_PROMPT_THRESHOLD

public static final boolean DEFAULT_SUDO_SUCCESS_ON_PROMPT_THRESHOLD

See Also:

Constant Field Values

PROJECT_SSH_USER

public static final java.lang.String PROJECT_SSH_USER

See Also:

Constant Field Values

SSH_TIMEOUT_PROP

public static final java.lang.String SSH_TIMEOUT_PROP

deprecated Global command & connection timeout framework property

See Also:

Constant Field Values

NODE_ATTR_SSH_COMMAND_TIMEOUT_PROP

public static final java.lang.String NODE_ATTR_SSH_COMMAND_TIMEOUT_PROP

See Also:

Constant Field Values

FRAMEWORK_SSH_COMMAND_TIMEOUT_PROP

public static final java.lang.String FRAMEWORK_SSH_COMMAND_TIMEOUT_PROP

See Also:

Constant Field Values

NODE_ATTR_SSH_CONNECT_TIMEOUT_PROP

public static final java.lang.String NODE_ATTR_SSH_CONNECT_TIMEOUT_PROP

See Also:

Constant Field Values

FRAMEWORK_SSH_CONNECT_TIMEOUT_PROP

public static final java.lang.String FRAMEWORK_SSH_CONNECT_TIMEOUT_PROP

See Also:

Constant Field Values

PROJ_PROP_CON_TIMEOUT

public static final java.lang.String PROJ_PROP_CON_TIMEOUT

See Also:

Constant Field Values

FWK_PROP_CON_TIMEOUT

public static final java.lang.String FWK_PROP_CON_TIMEOUT

See Also:

Constant Field Values

PROJ_PROP_COMMAND_TIMEOUT

public static final java.lang.String PROJ_PROP_COMMAND_TIMEOUT

See Also:

Constant Field Values

FWK_PROP_COMMAND_TIMEOUT

public static final java.lang.String FWK_PROP_COMMAND_TIMEOUT

See Also:

Constant Field Values

SSH_CONFIG_PREFIX

public static final java.lang.String SSH_CONFIG_PREFIX

See Also:

Constant Field Values

FWK_SSH_CONFIG_PREFIX

public static final java.lang.String FWK_SSH_CONFIG_PREFIX

See Also:

Constant Field Values

PROJ_SSH_CONFIG_PREFIX

public static final java.lang.String PROJ_SSH_CONFIG_PREFIX

See Also:

Constant Field Values

CONFIG_KEYPATH

public static final java.lang.String CONFIG_KEYPATH

See Also:

Constant Field Values

CONFIG_KEYSTORE_PATH

public static final java.lang.String CONFIG_KEYSTORE_PATH

See Also:

Constant Field Values

CONFIG_PASSSTORE_PATH

public static final java.lang.String CONFIG_PASSSTORE_PATH

See Also:

Constant Field Values

CONFIG_PASSPHRASE_STORE_PATH

public static final java.lang.String CONFIG_PASSPHRASE_STORE_PATH

See Also:

Constant Field Values

CONFIG_SUDO_PASSSTORE_PATH

public static final java.lang.String CONFIG_SUDO_PASSSTORE_PATH

See Also:

Constant Field Values

CONFIG_AUTHENTICATION

public static final java.lang.String CONFIG_AUTHENTICATION

See Also:

Constant Field Values

CONFIG_SET_PTY

public static final java.lang.String CONFIG_SET_PTY

See Also:

Constant Field Values

CONFIG_CON_TIMEOUT

public static final java.lang.String CONFIG_CON_TIMEOUT

See Also:

Constant Field Values

CONFIG_COMMAND_TIMEOUT

public static final java.lang.String CONFIG_COMMAND_TIMEOUT

See Also:

Constant Field Values

SSH_AUTH_TYPE_PROP

public static final Property SSH_AUTH_TYPE_PROP

ALWAYS_SET_PTY

public static final Property ALWAYS_SET_PTY

PROP_CON_TIMEOUT

public static final Property PROP_CON_TIMEOUT

PROP_COMMAND_TIMEOUT

public static final Property PROP_COMMAND_TIMEOUT

Constructor Detail

JschNodeExecutor

public JschNodeExecutor(Framework framework)

Method Detail

getDescription

public Description getDescription()

Specified by:

getDescription in interface Describable

Returns:

the configuration description

executeCommand

public NodeExecutorResult executeCommand(ExecutionContext context,
                                         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:

context - 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