Package com.dtolabs.rundeck.core.tasks.net

Class SSHTaskBuilder

java.lang.Object

com.dtolabs.rundeck.core.tasks.net.SSHTaskBuilder

public class SSHTaskBuilder
extends java.lang.Object

SSHTaskFactory constructs a ExtSSHExec task

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SSHTaskBuilder.AuthenticationType
static class	SSHTaskBuilder.BuilderException
static interface	SSHTaskBuilder.SSHBaseInterface	interface that mimics SSHBase methods called
static interface	SSHTaskBuilder.SSHConnectionInfo	Defines the authentication input for a build

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SSH_CONFIG_SERVER_ALIVE_COUNT_MAX
static java.lang.String	SSH_CONFIG_SERVER_ALIVE_INTERVAL

Constructor Summary

Constructors

Constructor	Description
SSHTaskBuilder()

Method Summary

Modifier and Type	Method	Description
static ExtSSHExec	build(INodeEntry nodeentry, java.lang.String[] args, org.apache.tools.ant.Project project, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> dataContext, SSHTaskBuilder.SSHConnectionInfo sshConnectionInfo, int loglevel, PluginLogger logger)	Build a Task that performs SSH command
static org.apache.tools.ant.taskdefs.optional.ssh.Scp	buildMultiScp(INodeEntry nodeentry, org.apache.tools.ant.Project project, java.io.File basedir, java.util.List<java.io.File> files, java.lang.String remotePath, SSHTaskBuilder.SSHConnectionInfo sshConnectionInfo, int loglevel, PluginLogger logger)
static org.apache.tools.ant.taskdefs.optional.ssh.Scp	buildRecursiveScp(INodeEntry nodeentry, org.apache.tools.ant.Project project, java.lang.String remotepath, java.io.File sourceFile, SSHTaskBuilder.SSHConnectionInfo sshConnectionInfo, int loglevel, PluginLogger logger)
static org.apache.tools.ant.taskdefs.optional.ssh.Scp	buildScp(INodeEntry nodeentry, org.apache.tools.ant.Project project, java.lang.String remotepath, java.io.File sourceFile, SSHTaskBuilder.SSHConnectionInfo sshConnectionInfo, int loglevel, PluginLogger logger)
static void	configureSession(java.util.Map<java.lang.String,java.lang.String> config, com.jcraft.jsch.Session session)
static java.util.Map<java.lang.String,java.lang.String>	getDefaultSshConfig()
static com.jcraft.jsch.Session	openSession(SSHTaskBuilder.SSHBaseInterface base)	Open Jsch session, applies private key configuration, timeout and custom ssh configuration
static byte[]	streamBytes(java.io.InputStream sshKeyData)

Methods inherited from class java.lang.Object

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

Field Detail

SSH_CONFIG_SERVER_ALIVE_COUNT_MAX

public static final java.lang.String SSH_CONFIG_SERVER_ALIVE_COUNT_MAX

See Also:

Constant Field Values

SSH_CONFIG_SERVER_ALIVE_INTERVAL

public static final java.lang.String SSH_CONFIG_SERVER_ALIVE_INTERVAL

See Also:

Constant Field Values

Constructor Detail

SSHTaskBuilder

public SSHTaskBuilder()

Method Detail

getDefaultSshConfig

public static java.util.Map<java.lang.String,java.lang.String> getDefaultSshConfig()

openSession

public static com.jcraft.jsch.Session openSession(SSHTaskBuilder.SSHBaseInterface base)
                                           throws com.jcraft.jsch.JSchException

Open Jsch session, applies private key configuration, timeout and custom ssh configuration

Parameters:

base - base

Returns:

session

Throws:

com.jcraft.jsch.JSchException - on jsch error

configureSession

public static void configureSession(java.util.Map<java.lang.String,java.lang.String> config,
                                    com.jcraft.jsch.Session session)

streamBytes

public static byte[] streamBytes(java.io.InputStream sshKeyData)
                          throws java.io.IOException

Throws:

java.io.IOException

build

public static ExtSSHExec build(INodeEntry nodeentry,
                               java.lang.String[] args,
                               org.apache.tools.ant.Project project,
                               java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> dataContext,
                               SSHTaskBuilder.SSHConnectionInfo sshConnectionInfo,
                               int loglevel,
                               PluginLogger logger)
                        throws SSHTaskBuilder.BuilderException

Build a Task that performs SSH command

Parameters:

loglevel - level

nodeentry - target node

args - arguments

project - ant project

dataContext - data

logger - logger

sshConnectionInfo - connection info

Returns:

task

Throws:

SSHTaskBuilder.BuilderException - on error

buildScp

public static org.apache.tools.ant.taskdefs.optional.ssh.Scp buildScp(INodeEntry nodeentry,
                                                                      org.apache.tools.ant.Project project,
                                                                      java.lang.String remotepath,
                                                                      java.io.File sourceFile,
                                                                      SSHTaskBuilder.SSHConnectionInfo sshConnectionInfo,
                                                                      int loglevel,
                                                                      PluginLogger logger)
                                                               throws SSHTaskBuilder.BuilderException

Throws:

SSHTaskBuilder.BuilderException

buildMultiScp

public static org.apache.tools.ant.taskdefs.optional.ssh.Scp buildMultiScp(INodeEntry nodeentry,
                                                                           org.apache.tools.ant.Project project,
                                                                           java.io.File basedir,
                                                                           java.util.List<java.io.File> files,
                                                                           java.lang.String remotePath,
                                                                           SSHTaskBuilder.SSHConnectionInfo sshConnectionInfo,
                                                                           int loglevel,
                                                                           PluginLogger logger)
                                                                    throws SSHTaskBuilder.BuilderException

Throws:

SSHTaskBuilder.BuilderException

buildRecursiveScp

public static org.apache.tools.ant.taskdefs.optional.ssh.Scp buildRecursiveScp(INodeEntry nodeentry,
                                                                               org.apache.tools.ant.Project project,
                                                                               java.lang.String remotepath,
                                                                               java.io.File sourceFile,
                                                                               SSHTaskBuilder.SSHConnectionInfo sshConnectionInfo,
                                                                               int loglevel,
                                                                               PluginLogger logger)
                                                                        throws SSHTaskBuilder.BuilderException

Throws:

SSHTaskBuilder.BuilderException