Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD DETAIL: FIELD | PROPERTY | CONSTR | METHOD

org.hidetake.gradle.ssh.api
[Groovy] Class SshSpec

java.lang.Object
  org.hidetake.gradle.ssh.api.SshSpec

@Slf4j
class SshSpec

Specification of a SSH task.

Authors:
hidetake.org

Property Summary
static java.lang.Object allowAnyHosts

java.lang.Object config

JSch configuration.
java.lang.Boolean dryRun

Dry-run flag.

java.lang.String encoding

Encoding of input and output stream.
LogLevel errorLogLevel

Log level for standard error of commands.
java.io.File identity

Identity key file for public-key authentication.
java.io.File knownHosts

Known hosts file.

LogLevel outputLogLevel

Log level for standard output of commands.
java.lang.String passphrase

Pass-phrase for the identity key.

java.lang.Integer retryCount

Retry count for connecting to a host.
java.lang.Integer retryWaitSec

Interval time in seconds between retries.
java.lang.Object sessionSpecs

Sessions.
 
Method Summary
static SshSpec computeMerged(SshSpec... specs)

Computes merged settings.
void config(java.util.Map pairs)

Adds configuration.

void session(Remote remote, groovy.lang.Closure operationClosure)

Adds a session.
void session(java.util.Collection remotes, groovy.lang.Closure operationClosure)

Adds sessions.
 
Methods inherited from class java.lang.Object
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Property Detail

allowAnyHosts

static final java.lang.Object allowAnyHosts

config

final java.lang.Object config
JSch configuration.
deprecated:
removed in v0.3.0

dryRun

java.lang.Boolean dryRun
Dry-run flag. If true, performs no action.

encoding

java.lang.String encoding
Encoding of input and output stream.

errorLogLevel

LogLevel errorLogLevel
Log level for standard error of commands.

identity

java.io.File identity
Identity key file for public-key authentication.

knownHosts

java.io.File knownHosts
Known hosts file. If allowAnyHosts, strict host key checking is turned off.

outputLogLevel

LogLevel outputLogLevel
Log level for standard output of commands.

passphrase

java.lang.String passphrase
Pass-phrase for the identity key. This may be null.

retryCount

java.lang.Integer retryCount
Retry count for connecting to a host.

retryWaitSec

java.lang.Integer retryWaitSec
Interval time in seconds between retries.

sessionSpecs

final java.lang.Object sessionSpecs
Sessions.

 
Method Detail

computeMerged

static SshSpec computeMerged(SshSpec... specs)
Computes merged settings.
Parameters:
specs - list of SshSpecs in priority order (first item is highest priority)
Returns:
merged one

config

void config(java.util.Map pairs)
Adds configuration. For example: 
 config(StrictHostKeyChecking: 'no')
deprecated:
removed in v0.3.0
Parameters:
pairs - key value pairs of configuration

session

void session(Remote remote, groovy.lang.Closure operationClosure)
Adds a session.
Parameters:
remote - the remote
operationClosure - closure for OperationHandler (run in execution phase)

session

void session(java.util.Collection remotes, groovy.lang.Closure operationClosure)
Adds sessions.
Parameters:
remotes - collection of Remotes
operationClosure - closure for OperationHandler (run in execution phase)

 

Groovy Documentation