Groovy Documentation

org.hidetake.gradle.ssh.api
[Groovy] Interface OperationHandler


interface OperationHandler

Handler for a operation closure.

Authors:
hidetake.org


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

Performs an execution operation.

java.lang.String execute(java.lang.String command, groovy.lang.Closure interactions)

Performs an execution operation.

java.lang.String execute(java.util.Map options, java.lang.String command)

Performs an execution operation.

java.lang.String execute(java.util.Map options, java.lang.String command, groovy.lang.Closure interactions)

Performs an execution operation.

CommandContext executeBackground(java.lang.String command)

Performs an execution operation.

CommandContext executeBackground(java.util.Map options, java.lang.String command)

Performs an execution operation.

java.lang.String executeSudo(java.lang.String command)

Performs a sudo operation, explicitly providing password for the sudo user.

java.lang.String executeSudo(java.util.Map options, java.lang.String command)

Performs a sudo operation, explicitly providing password for the sudo user.

void get(java.lang.String remote, java.lang.String local)

Performs a GET operation.

void get(java.util.Map options, java.lang.String remote, java.lang.String local)

Performs a GET operation.

Remote getRemote()

Returns remote host for current operation.

void put(java.lang.String local, java.lang.String remote)

Performs a PUT operation.

void put(java.util.Map options, java.lang.String local, java.lang.String remote)

Performs a PUT operation.

void shell(java.util.Map options, groovy.lang.Closure interactions)

Performs a shell operation.

void shell(groovy.lang.Closure interactions)

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.
Parameters:
command
Returns:
output value of the command


execute

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


execute

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


execute

java.lang.String execute(java.util.Map options, java.lang.String command, groovy.lang.Closure interactions)
Performs an execution operation. This method blocks until channel is closed.
Parameters:
options - properties to configure the channel
command
interactions - closure including interactions
Returns:
output value of the command


executeBackground

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


executeBackground

CommandContext executeBackground(java.util.Map options, java.lang.String command)
Performs an execution operation. This method returns immediately and executes the command concurrently.
Parameters:
options - properties to configure the channel
command


executeSudo

java.lang.String executeSudo(java.lang.String command)
Performs a sudo operation, explicitly providing password for the sudo user. This method blocks until channel is closed
Parameters:
command


executeSudo

java.lang.String executeSudo(java.util.Map options, java.lang.String command)
Performs a sudo operation, explicitly providing password for the sudo user. This method blocks until channel is closed
Parameters:
options - properties to configure the channel
command


get

void get(java.lang.String remote, java.lang.String local)
Performs a GET operation. This method blocks until channel is closed.
Parameters:
remote
local


get

void get(java.util.Map options, java.lang.String remote, java.lang.String local)
Performs a GET operation. This method blocks until channel is closed.
Parameters:
options - properties to configure the channel
remote
local


getRemote

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


put

void put(java.lang.String local, java.lang.String remote)
Performs a PUT operation. This method blocks until channel is closed.
Parameters:
local
remote


put

void put(java.util.Map options, java.lang.String local, java.lang.String remote)
Performs a PUT operation. This method blocks until channel is closed.
Parameters:
options - properties to configure the channel
local
remote


shell

void shell(java.util.Map options, groovy.lang.Closure interactions)
Performs a shell operation. This method blocks until channel is closed.
Parameters:
options - properties to configure the channel
interactions - closure including interactions
Returns:
output value of the command


shell

void shell(groovy.lang.Closure interactions)
Performs a shell operation. This method blocks until channel is closed.
Parameters:
interactions - closure including interactions
Returns:
output value of the command


 

Groovy Documentation