A

AbstractOperationHandler - Class in org.hidetake.gradle.ssh.internal

add(Channel) - Method in ChannelManager

Add a channel to be managed.

alterInteractionRules(List) - Method in Engine

apply(Project) - Method in SshPlugin

attach(LineOutputStream, Stream) - Method in Engine

attachRemoteContainer(Project) - Method in SshPlugin

B

C

ChannelManager - Class in org.hidetake.gradle.ssh.internal.session

Channel lifecycle manager.

checkPoint() - Method in FileTransferLogger.Status

close() - Method in LineOutputStream

CommandContext - Interface in org.hidetake.gradle.ssh.api

Context interface for command execution.

computeMerged(SshSpec) - Method in SshSpec

Computes merged settings.

config(Map) - Method in SshSpec

Adds configuration.

count(long) - Method in FileTransferLogger

create(ChannelExec, String) - Method in DefaultCommandContext

Create an instance for the channel.

create(ChannelShell, String) - Method in DefaultShellContext

Create an instance for the channel.

create(Map, Closure) - Method in InteractionRule

create(Remote) - Method in SessionManager

Establish a JSch session.

createVia(Remote, String, int) - Method in SessionManager

Establish a JSch session via given host and port.

currentTime() - Method in FileTransferLogger.Status

D

DefaultCommandContext - Class in org.hidetake.gradle.ssh.internal

DefaultOperationHandler - Class in org.hidetake.gradle.ssh.internal

Default implementation of OperationHandler.

DefaultShellContext - Class in org.hidetake.gradle.ssh.internal

DefaultSshService - Class in org.hidetake.gradle.ssh.internal

Default implementation of SshService.

disconnect() - Method in ChannelManager

Disconnect all channels.

disconnect() - Method in SessionManager

Disconnect all sessions.

DryRunCommandContext - Class in org.hidetake.gradle.ssh.internal

Null implementation of CommandContext for dry-run.

DryRunOperationHandler - Class in org.hidetake.gradle.ssh.internal

Null implementation of OperationHandler for dry-run.

dryRunService - Field in SshPluginConvention

dryRunService - Field in SshTask

DryRunSshService - Class in org.hidetake.gradle.ssh.internal

Dry run implementation of SshService.

E

enableLogging(LogLevel, LogLevel) - Method in DefaultCommandContext

enableLogging(LogLevel) - Method in DefaultShellContext

end() - Method in FileTransferLogger

Engine - Class in org.hidetake.gradle.ssh.internal.command

A rule engine for processing stream events.

Engine.Counter - Class in org.hidetake.gradle.ssh.internal.command

evaluate(Closure) - Method in InteractionDelegate

Evaluate the closure.

execute(Map, String) - Method in AbstractOperationHandler

execute(Map, String, Closure) - Method in DefaultOperationHandler

execute(SshSpec) - Method in DefaultSshService

execute(Map, String, Closure) - Method in DryRunOperationHandler

execute(SshSpec) - Method in DryRunSshService

execute(Map, String, Closure) - Method in OperationHandler

Performs an execution operation.

execute(SshSpec) - Method in SshService

Executes a SSH task.

executeBackground(String) - Method in AbstractOperationHandler

executeBackground(Map, String) - Method in DefaultOperationHandler

executeBackground(Map, String) - Method in DryRunOperationHandler

executeBackground(Map, String) - Method in OperationHandler

Performs an execution operation.

executeSudo(String) - Method in AbstractOperationHandler

executeSudo(Map, String) - Method in DefaultOperationHandler

executeSudo(Map, String) - Method in DryRunOperationHandler

executeSudo(Map, String) - Method in OperationHandler

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

ExecutionSettings - Class in org.hidetake.gradle.ssh.api.operation

Settings for command execution.

F

FileTransferLogger - Class in org.hidetake.gradle.ssh.internal.operation

Logger for file transfer.

FileTransferLogger.Status - Class in org.hidetake.gradle.ssh.internal.operation

filterByRole - Field in SshPlugin

find(Map) - Method in InteractionRule.EventMatcher

flush() - Method in LineOutputStream

Flush the buffer.

G

generate(def) - Method in InteractionRule.StreamMatcher

generate(def) - Method in InteractionRule.TextMatcher

get(String, String) - Method in AbstractOperationHandler

get(Map, String, String) - Method in DefaultOperationHandler

get(Map, String, String) - Method in DryRunOperationHandler

get(Map, String, String) - Method in OperationHandler

Performs a GET operation.

getBytesPerSecond() - Method in FileTransferLogger.Status

getElapsedTime() - Method in FileTransferLogger.Status

getElapsedTimeFromCheckPoint() - Method in FileTransferLogger.Status

getPercent() - Method in FileTransferLogger.Status

getRemote() - Method in DefaultOperationHandler

getRemote() - Method in DryRunOperationHandler

getRemote() - Method in OperationHandler

Returns remote host for current operation.

getStandardInput() - Method in Interaction

Get the standard input for the remote command.

getValue() - Method in Engine.Counter

H

I

init(int, String, String, long) - Method in FileTransferLogger

Interaction - Interface in org.hidetake.gradle.ssh.api.command

Represents stream interaction with the server.

interaction(Closure) - Method in CommandContext

Declares stream interactions with the server.

interaction(Closure) - Method in DefaultCommandContext

interaction(Closure) - Method in DefaultShellContext

interaction(Closure) - Method in DryRunCommandContext

InteractionDelegate - Class in org.hidetake.gradle.ssh.internal.command

A delegate class for interaction closure.

InteractionRule - Class in org.hidetake.gradle.ssh.internal.command

A rule of interaction with the stream.

InteractionRule.Event - Enum in org.hidetake.gradle.ssh.internal.command

J

K

L

leftShift(long) - Method in FileTransferLogger.Status

LineOutputStream - Class in org.hidetake.gradle.ssh.internal.command

An implementation of line oriented java.io.OutputStream.

LOCALHOST - Field in SessionManager

LOG_INTERVAL_MILLIS - Field in FileTransferLogger

M

N

next() - Method in Engine.Counter

O

OperationHandler - Interface in org.hidetake.gradle.ssh.api

Handler for a operation closure.

P

perform() - Method in SshTask

processLine(Stream, Engine.Counter, String) - Method in Engine

processPartial(Stream, Engine.Counter, String) - Method in Engine

put(String, String) - Method in AbstractOperationHandler

put(Map, String, String) - Method in DefaultOperationHandler

put(Map, String, String) - Method in DryRunOperationHandler

put(Map, String, String) - Method in OperationHandler

Performs a PUT operation.

Q

R

Remote - Class in org.hidetake.gradle.ssh.api

Represents a remote host.

remoteIdentityRepository - Field in SessionManager

reset() - Method in Engine.Counter

Retry - Class in org.hidetake.gradle.ssh.internal.session

retry(int, int, Closure) - Method in Retry

Execute the closure with retrying.

role(String) - Method in Remote

Add a role to this remote.

S

service - Field in SshPluginConvention

service - Field in SshTask

session(Collection, Closure) - Method in SshSpec

Adds sessions.

SessionManager - Class in org.hidetake.gradle.ssh.internal.session

Factory and lifecycle manager class of JSch session.

SessionManager(SshSpec) - Constructor in SessionManager

Constructor.

SessionSpec - Class in org.hidetake.gradle.ssh.api

Specification of a session.

shell(Closure) - Method in AbstractOperationHandler

shell(Map, Closure) - Method in DefaultOperationHandler

shell(Map, Closure) - Method in DryRunOperationHandler

shell(Closure) - Method in OperationHandler

Performs a shell operation.

ShellSettings - Class in org.hidetake.gradle.ssh.api.operation

Settings for shell operation.

ssh(Closure) - Method in SshPluginConvention

Configures global settings.

sshexec(Closure) - Method in SshPluginConvention

Executes SSH operations instead of a project task.

SshPlugin - Class in org.hidetake.gradle.ssh

Gradle SSH plugin.

SshPluginConvention - Class in org.hidetake.gradle.ssh

Convention properties and methods.

SshService - Interface in org.hidetake.gradle.ssh.api

Service to execute a SSH task specified by SshSpec.

SshSpec - Class in org.hidetake.gradle.ssh.api

Specification of a SSH task.

sshSpec - Field in SshPluginConvention

SshTask - Class in org.hidetake.gradle.ssh

SSH task.

status - Field in FileTransferLogger

Stream - Enum in org.hidetake.gradle.ssh.api.command

Stream.

T

toString() - Method in Engine.Counter

toString() - Method in InteractionRule

toString() - Method in Remote

Returns a string representation of this remote host.

toString() - Method in Wildcard

U

V

validateExitStatus() - Method in ChannelManager

Validates exit status of channels.

W

waitForPending(Closure) - Method in ChannelManager

Wait for pending channels.

when(Map, Closure) - Method in Interaction

Declare an interaction rule.

when(Map, Closure) - Method in InteractionDelegate

Wildcard - Class in org.hidetake.gradle.ssh.api.command

write(int) - Method in LineOutputStream

X

Y

Z

_

Groovy Documentation