A

alterInteractionRules(List) - Method in Engine

apply(Project) - Method in SshPlugin

attach(LineOutputStream, Stream) - Method in Engine

B

BackgroundCommandException - Class in org.hidetake.gradle.ssh.plugin.session

An exception thrown if at least one background command occurs any error.

BackgroundCommandException(List) - Constructor in BackgroundCommandException

BadExitStatusException - Class in org.hidetake.gradle.ssh.plugin.session

An exception class thrown if the remote command returns bad exit status.

BadExitStatusException(String, int) - Constructor in BadExitStatusException

C

callWithDelegate(Closure, Object) - Method in ClosureUtil

cd(String) - Method in DefaultSftpOperations

cd(String) - Method in SftpOperations

Change current directory.

checkPoint() - Method in FileTransferLogger.Status

Commit a checkpoint.

close() - Method in Connection

Cleanup the connection and all channels.

close() - Method in DefaultConnection

close() - Method in LineOutputStream

ClosureUtil - Class in org.hidetake.gradle.ssh.util

An utility class of the closure.

CompositeSettings - Class in org.hidetake.gradle.ssh.plugin

Represents overall settings configurable in global or task.

connect(Remote) - Method in ConnectionManager

Establish a connection.

connect(Remote) - Method in DefaultConnectionManager

Connection - Interface in org.hidetake.gradle.ssh.internal.connection

A SSH connection.

ConnectionManager - Interface in org.hidetake.gradle.ssh.internal.connection

A manager of Connections.

ConnectionService - Class in org.hidetake.gradle.ssh.internal.connection

ConnectionSettings - Class in org.hidetake.gradle.ssh.plugin

ConnectionSettings.Constants - Class in org.hidetake.gradle.ssh.plugin

count(long) - Method in FileTransferLogger

create(Remote, OperationSettings, ConnectionManager) - Method in OperationService

createDelegate(Remote, OperationSettings, ConnectionManager) - Method in SessionService

createDelegate() - Method in SshTaskService

Create a task delegate object.

createExecutionChannel(String, OperationSettings) - Method in Connection

Create an execution channel.

createExecutionChannel(String, OperationSettings) - Method in DefaultConnection

createSftpChannel() - Method in Connection

Create a SFTP channel.

createSftpChannel() - Method in DefaultConnection

createShellChannel(OperationSettings) - Method in Connection

Create a shell channel.

createShellChannel(OperationSettings) - Method in DefaultConnection

currentTime() - Method in FileTransferLogger.Status

D

DefaultConnection - Class in org.hidetake.gradle.ssh.internal.connection

A default implementation of SSH connection.

DefaultConnection(Remote, Session) - Constructor in DefaultConnection

DefaultConnectionManager - Class in org.hidetake.gradle.ssh.internal.connection

A default implementation of ConnectionManager.

DefaultConnectionManager(ConnectionSettings) - Constructor in DefaultConnectionManager

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

Default implementation of Operations.

DefaultOperations(Connection) - Constructor in DefaultOperations

DefaultProxyValidator - Class in org.hidetake.gradle.ssh.internal.connection

Basic validation and defaults for proxied connections created by DefaultConnectionManager.

DefaultProxyValidator(Proxy) - Constructor in DefaultProxyValidator

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

A default implementation of SessionHandler.

DefaultSessionHandler(Operations, OperationSettings) - Constructor in DefaultSessionHandler

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

DefaultSftpOperations(ChannelSftp) - Constructor in DefaultSftpOperations

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

A delegate class of ssh task.

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

Dry-run implementation of Operations.

DryRunOperations(Remote) - Constructor in DryRunOperations

E

end() - Method in FileTransferLogger

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

A rule engine for processing stream events.

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

Engine(InteractionDelegate) - Constructor in Engine

error() - Method in DefaultProxyValidator

evaluate(Closure) - Method in InteractionDelegate

Evaluate the closure.

execute(OperationSettings, String, Closure) - Method in DefaultOperations

execute(HashMap, String, Closure) - Method in DefaultSessionHandler

execute(CompositeSettings) - Method in DefaultSshTaskHandler

execute(OperationSettings, String, Closure) - Method in DryRunOperations

execute(OperationSettings, String, Closure) - Method in Operations

execute(HashMap, String, Closure) - Method in SessionHandler

Performs an execution operation.

execute(CompositeSettings) - Method in SshTaskHandler

Execute the task.

execute(CompositeSettings, Closure) - Method in SshTaskService

Execute a closure.

executeBackground(OperationSettings, String, Closure) - Method in DefaultOperations

executeBackground(HashMap, String, Closure) - Method in DefaultSessionHandler

executeBackground(OperationSettings, String, Closure) - Method in DryRunOperations

executeBackground(OperationSettings, String, Closure) - Method in Operations

executeBackground(HashMap, String, Closure) - Method in SessionHandler

Performs an execution operation.

executeCallbackForClosedChannels() - Method in Connection

Execute registered closures.

executeCallbackForClosedChannels() - Method in DefaultConnection

executeSudo(HashMap, String, Closure) - Method in SudoExecution

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

F

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

A logger for monitoring progress of the file transfer.

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

Represents transferred bytes and elapsed time.

FileTransferLogger() - Constructor in FileTransferLogger

findNotNull(E, E) - Method in Settings

Find not null item from arguments in order.

flush() - Method in LineOutputStream

Flush the buffer.

G

generate(Map) - Method in Matcher

generate(Map) - Method in Matcher.EventMatcher

generate(Map) - Method in Matcher.StreamMatcher

generate(def) - Method in Matcher.TextMatcher

get(String, String) - Method in SftpGet

Get a file or directory from the remote host.

getElapsedTime() - Method in FileTransferLogger.Status

Return elapsed time in milliseconds from started

getElapsedTimeFromCheckPoint() - Method in FileTransferLogger.Status

Return elapsed time in milliseconds from the last checkpoint

getFile(String, String) - Method in DefaultSftpOperations

getFile(String, String) - Method in SftpOperations

Get a file from the remote host.

getKiloBytesPerSecond() - Method in FileTransferLogger.Status

Return transfer rate in kbps.

getOperations() - Method in SessionHandler

Access to the Operations object.

getPercent() - Method in FileTransferLogger.Status

Return percent of transferred data.

getRemote() - Method in Connection

Return the remote host.

getRemote() - Method in DefaultSessionHandler

getRemote() - Method in Operations

getRemote() - Method in SessionHandler

Returns remote host for current operation.

getResult() - Method in SudoExecution.InteractionSupport

getStandardInput() - Method in InteractionHandler

Get the standard input for the remote command.

getValue() - Method in Engine.Counter

H

I

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

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

A delegate class for interaction closure.

InteractionDelegate(OutputStream) - Constructor in InteractionDelegate

InteractionHandler - Interface in org.hidetake.gradle.ssh.plugin.interaction

Represents stream interaction with the server.

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

A rule of interaction with the stream.

interactionRules - Field in Engine

isAnyPending() - Method in Connection

Return if any channel is pending.

isAnyPending() - Method in DefaultConnection

isEnabled(int) - Method in JSchLogger

J

JSchLogger - Class in org.hidetake.gradle.ssh.internal.connection

A logger which bridges JSch and SLF4J.

K

L

leftShift(long) - Method in FileTransferLogger.Status

Report the progress that data has been transferred.

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

An implementation of line oriented java.io.OutputStream.

LineOutputStream(String) - Constructor in LineOutputStream

listenLine(Closure) - Method in LineOutputStream

Add a listener for line processing.

listenLogging(Closure) - Method in LineOutputStream

Add a listeners for logging output.

listenPartial(Closure) - Method in LineOutputStream

Add a listener for partial matching to the line buffer.

LOCALHOST - Field in DefaultConnectionManager

LOG_INTERVAL_MILLIS - Field in FileTransferLogger

log(int, String) - Method in JSchLogger

ls(String) - Method in DefaultSftpOperations

ls(String) - Method in SftpOperations

Get a directory listing.

M

Matcher - Class in org.hidetake.gradle.ssh.internal.interaction

Matcher classes.

Matcher.Event - Enum in org.hidetake.gradle.ssh.internal.interaction

mkdir(String) - Method in DefaultSftpOperations

mkdir(String) - Method in SftpOperations

Create a directory.

N

next() - Method in Engine.Counter

O

Operations - Interface in org.hidetake.gradle.ssh.plugin.operation

An aggregate of core SSH operations.

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

OperationSettings - Class in org.hidetake.gradle.ssh.plugin

P

perform() - Method in SshTask

plus(CompositeSettings) - Method in CompositeSettings

plus(ConnectionSettings) - Method in ConnectionSettings

plus(OperationSettings) - Method in OperationSettings

plus(Object) - Method in Settings

Compute a merged settings.

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

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

Proxy - Class in org.hidetake.gradle.ssh.plugin

Represents a connection proxy to use when establishing a Session.

Proxy(String) - Constructor in Proxy

ProxyType - Enum in org.hidetake.gradle.ssh.plugin

put(Iterable, String) - Method in SftpPut

Put a collection of a file or directory to the remote host.

putFile(String, String) - Method in DefaultSftpOperations

putFile(String, String) - Method in SftpOperations

Put a file to the remote host.

Q

R

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

Represents a remote host.

Remote(String) - Constructor in Remote

RemoteContainerExtension - Class in org.hidetake.gradle.ssh.plugin

An extension class of the remote container.

remoteIdentityRepository - Field in DefaultConnectionManager

reset() - Method in Engine.Counter

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

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

Execute the closure with retrying.

role(String) - Method in Remote

role(Collection, String) - Method in RemoteContainerExtension

Find remote hosts associated with given roles.

S

session(Map, Closure) - Method in DefaultSshTaskHandler

session(Map, Closure) - Method in SshTaskHandler

Add a session.

SessionHandler - Interface in org.hidetake.gradle.ssh.plugin.session

A core handler for session closure.

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

Settings - Class in org.hidetake.gradle.ssh.plugin

Represents a settings class.

sftp(Closure) - Method in DefaultOperations

sftp(Closure) - Method in DryRunOperations

sftp(Closure) - Method in Operations

Perform SFTP operations.

SftpGet - Class in org.hidetake.gradle.ssh.extension

An extension class to get a file or directory via SFTP.

SftpOperations - Interface in org.hidetake.gradle.ssh.plugin.operation

An aggregate of file transfer operations.

SftpPut - Class in org.hidetake.gradle.ssh.extension

An extension class to put a file or directory via SFTP.

shell(OperationSettings) - Method in DefaultOperations

shell(HashMap) - Method in DefaultSessionHandler

shell(OperationSettings) - Method in DryRunOperations

shell(OperationSettings) - Method in Operations

shell(HashMap) - Method in SessionHandler

Performs a shell operation.

SOCKS_DEFAULT_VERSION - Field in DefaultProxyValidator

SOCKS_SUPPORTED_VERSIONS - Field in DefaultProxyValidator

ssh(Closure) - Method in DefaultSshTaskHandler

ssh(Closure) - Method in SshTaskHandler

Configure task specific settings.

sshexec(Closure) - Method in SshPlugin.Convention

Execute a SSH closure.

SshPlugin - Class in org.hidetake.gradle.ssh.plugin

Gradle SSH plugin.

SshPlugin.Convention - Class in org.hidetake.gradle.ssh.plugin

SshTask - Class in org.hidetake.gradle.ssh.plugin

A SSH task for Gradle.

SshTaskHandler - Interface in org.hidetake.gradle.ssh.plugin

An interface delegating into SshTask.

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

A service for SSH tasks.

status - Field in FileTransferLogger

Stream - Enum in org.hidetake.gradle.ssh.plugin.interaction

Stream.

SudoExecution - Class in org.hidetake.gradle.ssh.extension

An extension class of sudo command execution.

SudoExecution.InteractionSupport(String, Remote, Map) - Constructor in SudoExecution.InteractionSupport

Constructor.

T

toString() - Method in Engine.Counter

toString() - Method in InteractionRule

toString() - Method in Proxy

toString() - Method in Remote

toString() - Method in Wildcard

U

V

W

waitAndClose() - Method in ConnectionManager

Wait for pending connections and close all.

waitAndClose() - Method in DefaultConnectionManager

warnings() - Method in DefaultProxyValidator

when(Map, Closure) - Method in InteractionDelegate

when(Map, Closure) - Method in InteractionHandler

Declare an interaction rule.

whenClosed(Channel, Closure) - Method in Connection

Register a closure called when the channel is closed.

whenClosed(Channel, Closure) - Method in DefaultConnection

Wildcard - Class in org.hidetake.gradle.ssh.plugin.interaction

withManager(ConnectionSettings, Closure) - Method in ConnectionService

Execute the closure with the connection manager.

write(int) - Method in LineOutputStream

X

Y

Z

_

Groovy Documentation