Groovy Documentation

org.hidetake.gradle.ssh.plugin.session
[Groovy] Interface SessionHandler


interface SessionHandler

A core handler for session closure.

Authors:
hidetake.org


Method Summary
java.lang.String execute(java.lang.String command)

Performs an execution operation.

void execute(java.lang.String command, groovy.lang.Closure callback)

Performs an execution operation.

java.lang.String execute(java.util.HashMap settings, java.lang.String command)

Performs an execution operation.

void execute(java.util.HashMap settings, java.lang.String command, groovy.lang.Closure callback)

Performs an execution operation.

void executeBackground(java.lang.String command)

Performs an execution operation.

void executeBackground(java.lang.String command, groovy.lang.Closure callback)

Performs an execution operation.

void executeBackground(java.util.HashMap settings, java.lang.String command)

Performs an execution operation.

void executeBackground(java.util.HashMap settings, java.lang.String command, groovy.lang.Closure callback)

Performs an execution operation.

Operations getOperations()

Access to the Operations object.

Remote getRemote()

Returns remote host for current operation.

void shell(java.util.HashMap settings)

Performs a shell operation.

 

Method Detail

execute

java.lang.String execute(java.lang.String command)
Performs an execution operation. This method blocks until channel is closed.
Returns:
output value of the command
Parameters:
command


execute

void execute(java.lang.String command, groovy.lang.Closure callback)
Performs an execution operation. This method blocks until channel is closed.
Returns:
output value of the command
Parameters:
command
callback - closure called with an output value of the command


execute

java.lang.String execute(java.util.HashMap settings, java.lang.String command)
Performs an execution operation. This method blocks until channel is closed.
Returns:
output value of the command
Parameters:
settings - execution settings
command


execute

void execute(java.util.HashMap settings, java.lang.String command, groovy.lang.Closure callback)
Performs an execution operation. This method blocks until channel is closed.
Returns:
output value of the command
Parameters:
settings - execution settings
command
callback - closure called with an output value of the command


executeBackground

void executeBackground(java.lang.String command)
Performs an execution operation. This method returns immediately and executes the command concurrently.
Parameters:
command


executeBackground

void executeBackground(java.lang.String command, groovy.lang.Closure callback)
Performs an execution operation. This method returns immediately and executes the command concurrently.
Parameters:
command
callback - closure called with an output value of the command


executeBackground

void executeBackground(java.util.HashMap settings, java.lang.String command)
Performs an execution operation. This method returns immediately and executes the command concurrently.
Parameters:
settings - execution settings
command


executeBackground

void executeBackground(java.util.HashMap settings, java.lang.String command, groovy.lang.Closure callback)
Performs an execution operation. This method returns immediately and executes the command concurrently.
Parameters:
settings - execution settings
command
callback - closure called with an output value of the command


getOperations

Operations getOperations()
Access to the Operations object. This method should be called internally by extension classes. Build script should not access to the operations object.
Returns:
the operations object


getRemote

Remote getRemote()
Returns remote host for current operation.
Returns:
the remote host


shell

void shell(java.util.HashMap settings)
Performs a shell operation. This method blocks until channel is closed.
Returns:
output value of the command
Parameters:
settings - shell settings


 

Groovy Documentation