Groovy Documentation

org.hidetake.gradle.ssh.plugin
[Groovy] Interface SshTaskHandler


interface SshTaskHandler

An interface delegating into SshTask.

Authors:
hidetake.org


Method Summary
java.lang.Object execute(CompositeSettings globalSettings)

Execute the task.

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

Add a session.

void session(java.util.Collection remotes, groovy.lang.Closure closure)

Add sessions.

void session(java.util.Map remoteProperties, groovy.lang.Closure closure)

Add a session.

void ssh(groovy.lang.Closure closure)

Configure task specific settings.

 

Method Detail

execute

java.lang.Object execute(CompositeSettings globalSettings)
Execute the task. This method should be called by plugin internally.
Returns:
returned value of the last session
Parameters:
globalSettings


session

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


session

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


session

void session(java.util.Map remoteProperties, groovy.lang.Closure closure)
Add a session. This method creates a Remote instance and add a session with it.
Parameters:
remoteProperties - properties of a Remote
closure - closure for SessionHandler (run in execution phase)


ssh

void ssh(groovy.lang.Closure closure)
Configure task specific settings.
Parameters:
closure - closure for CompositeSettings


 

Groovy Documentation