A

add(Remote, Closure) - Method in DefaultSessions

add(Remote, Closure) - Method in Sessions

Add a session.

alterInteractionRules(List) - Method in Engine

apply(Project) - Method in SshPlugin

attach(LineOutputStream, Stream) - Method in Engine

attachRemoteContainer(Project) - Method in SshPlugin

B

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

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

BackgroundCommandException(List) - Constructor in BackgroundCommandException

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

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

BadExitStatusException(String, int) - Constructor in BadExitStatusException

C

cd(String) - Method in DefaultSftpHandler

cd(String) - Method in SftpHandler

Change current directory.

checkPoint() - Method in FileTransferLogger.Status

cleanup() - Method in Connection

Cleanup all channels.

cleanup() - Method in ConnectionManager

Cleanup all connections.

cleanup() - Method in DefaultConnection

cleanup() - Method in DefaultConnectionManager

close() - Method in LineOutputStream

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

A SSH connection.

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

A factory of Connection.

ConnectionManager.Factory - Interface in org.hidetake.gradle.ssh.api.ssh

A factory of ConnectionManager.

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

connectionSettings - Field in GlobalSettings

count(long) - Method in FileTransferLogger

create(ConnectionSettings) - Method in ConnectionManager.Factory

create(Remote) - Method in DefaultOperationsFactory

create(Map, Closure) - Method in InteractionRule

create(Remote) - Method in Operations.Factory

Create an instance for dry run.

create(Operations, OperationSettings) - Method in SessionHandler.Factory

create() - Method in Sessions.Factory

create(ChannelSftp) - Method in SftpHandler.Factory

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.ssh

A default implementation of SSH connection.

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

A default implementation of ConnectionManager.

DefaultFileTransfer - Class in org.hidetake.gradle.ssh.internal.session.handler

A default implementation of FileTransfer.

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

Default implementation of Operations.

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

Default implementation of Operations.Factory.

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

A default implementation of SessionHandler.

DefaultSessionHandler(Operations, OperationSettings) - Constructor in DefaultSessionHandler

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

A default implementation of Sessions.

DefaultSessions.EstablishedSession - Class in org.hidetake.gradle.ssh.internal.session

DefaultSessions.Session - Class in org.hidetake.gradle.ssh.internal.session

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

DefaultSudoExecution - Class in org.hidetake.gradle.ssh.internal.session.handler

A default implementation of SudoExecution.

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

Dry-run implementation of Operations.

E

end() - Method in FileTransferLogger

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

A rule engine for processing stream events.

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

establish(Remote) - Method in ConnectionManager

Establish a connection.

establish(Remote) - Method in DefaultConnectionManager

establish(ConnectionManager, OperationSettings) - Method in DefaultSessions.Session

evaluate(Closure) - Method in InteractionDelegate

Evaluate the closure.

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

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

execute(ConnectionSettings, OperationSettings) - Method in DefaultSessions

execute(OperationSettings) - Method in DefaultSessions.EstablishedSession

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(ConnectionSettings, OperationSettings) - Method in Sessions

Execute all sessions.

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 DefaultSudoExecution

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

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

F

factory(Class) - Method in RegistrySupport

Sets a auto-generated factory object.

FileTransfer - Interface in org.hidetake.gradle.ssh.api.session.handler

Handler for file transfer.

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

Logger for file transfer.

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

FileTransferLogger() - Constructor in FileTransferLogger

filterByRole - Field in SshPlugin

find(Map) - Method in InteractionRule.EventMatcher

findNotNull(E, E) - Method in Settings

Find not null item from arguments in order.

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 DefaultFileTransfer

get(String, String) - Method in FileTransfer

Get a file from the remote host.

getAt(Class) - Method in RegistrySupport

Returns the instance.

getElapsedTime() - Method in FileTransferLogger.Status

getElapsedTimeFromCheckPoint() - Method in FileTransferLogger.Status

getFile(String, String) - Method in DefaultSftpHandler

getFile(String, String) - Method in SftpHandler

Get a file from the remote host.

getKiloBytesPerSecond() - Method in FileTransferLogger.Status

getPercent() - Method in FileTransferLogger.Status

getRemote() - Method in Connection

Return the remote host.

getRemote() - Method in DefaultOperations

getRemote() - Method in DefaultSessionHandler

getRemote() - Method in Operations

getRemote() - Method in SessionHandler

Returns remote host for current operation.

getStandardInput() - Method in InteractionHandler

Get the standard input for the remote command.

getValue() - Method in Engine.Counter

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

A delegate class for global settings.

globalSettings - Field in SshPluginConvention

Global settings.

globalSettings - Field in SshTaskDelegate

Task specific settings.

H

I

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

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

A delegate class for interaction closure.

InteractionHandler - Interface in org.hidetake.gradle.ssh.api.operation.interaction

Represents stream interaction with the server.

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

A rule of interaction with the stream.

InteractionRule.Event - Enum in org.hidetake.gradle.ssh.internal.operation.interaction

isAnyPending() - Method in Connection

Return if any channel is pending.

isAnyPending() - Method in DefaultConnection

J

K

L

leftShift(long) - Method in FileTransferLogger.Status

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

An implementation of line oriented java.io.OutputStream.

LOCALHOST - Field in DefaultConnectionManager

LOG_INTERVAL_MILLIS - Field in FileTransferLogger

ls(String) - Method in DefaultSftpHandler

ls(String) - Method in SftpHandler

Get a directory listing.

M

mkdir(String) - Method in DefaultSftpHandler

mkdir(String) - Method in SftpHandler

Create a directory.

N

next() - Method in Engine.Counter

O

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

Interface of operations.

Operations.Factory - Interface in org.hidetake.gradle.ssh.api.operation

A factory of Operations.

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

operationSettings - Field in GlobalSettings

P

perform() - Method in SshTask

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

put(String, String) - Method in DefaultFileTransfer

put(String, String) - Method in FileTransfer

Put a file to the remote host.

putFile(String, String) - Method in DefaultSftpHandler

putFile(String, String) - Method in SftpHandler

Put a file to the remote host.

Q

R

Registry - Class in org.hidetake.gradle.ssh.registry

A component registry.

RegistrySupport - Class in org.hidetake.gradle.ssh.registry

A support class for component registry.

RegistrySupport.FactoryHandler - Interface in org.hidetake.gradle.ssh.registry

RegistrySupport.SingletonHandler - Interface in org.hidetake.gradle.ssh.registry

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

Represents a remote host.

remoteIdentityRepository - Field in DefaultConnectionManager

reset() - Method in Engine.Counter

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

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

Execute the closure with retrying.

rightShift(Class) - Method in RegistrySupport.FactoryHandler

rightShift(Object) - Method in RegistrySupport.SingletonHandler

role(String) - Method in Remote

Add a role to this remote.

S

session(Collection, Closure) - Method in SshTaskDelegate

Add sessions.

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

A core handler for session closure.

SessionHandler.Factory - Interface in org.hidetake.gradle.ssh.api.session

A factory of SessionHandler.

Sessions - Interface in org.hidetake.gradle.ssh.api.session

A list of session.

Sessions.Factory - Interface in org.hidetake.gradle.ssh.api.session

A factory of Sessions.

sessions - Field in SshTaskDelegate

Sessions.

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

Represents a settings class.

sftp(Closure) - Method in DefaultOperations

sftp(Closure) - Method in DryRunOperations

sftp(Closure) - Method in Operations

Perform SFTP operations.

SftpHandler - Interface in org.hidetake.gradle.ssh.api.operation

Handler for closure of file transfer.

SftpHandler.Factory - Interface in org.hidetake.gradle.ssh.api.operation

A factory of SftpHandler.

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.

singleton(Class) - Method in RegistrySupport

Sets a singleton object.

ssh(Closure) - Method in SshPluginConvention

Configure global settings.

ssh(Closure) - Method in SshTaskDelegate

Configure task specific settings.

sshexec(Closure) - Method in SshPluginConvention

Execute a task.

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

Gradle SSH plugin.

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

Convention properties and methods.

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

A SSH task for Gradle.

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

A delegate class of ssh task.

sshTaskDelegate - Field in SshTask

status - Field in FileTransferLogger

Stream - Enum in org.hidetake.gradle.ssh.api.operation.interaction

Stream.

SudoExecution - Interface in org.hidetake.gradle.ssh.api.session.handler

Handler for sudo execution.

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

W

waitForPending() - Method in ConnectionManager

Wait for pending sessions.

waitForPending() - Method in DefaultConnectionManager

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.api.operation.interaction

write(int) - Method in LineOutputStream

X

Y

Z

_

Groovy Documentation