JavaScript is disabled on your browser.
Overview
Package
Class
Deprecated
Index
Help
Frames
No Frames
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
_
A
add(T)
- Method in
Container
Add an item.
add(Closure)
- Method in
Interactions
Adds an interaction.
add(Processor)
- Method in
Listener
addAll(Collection<T>)
- Method in
Container
Add items.
addInteraction(Closure)
- Method in
Command
addInteraction(Closure)
- Method in
DryRunOperation
addInteraction(Closure)
- Method in
Operation
Adds an interaction.
addInteraction(Closure)
- Method in
Shell
addTo(HostKeyRepository)
- Method in
HostKeys
AllowAnyHosts
- Class in
org.hidetake.groovy.ssh.connection
allRoles(String)
- Method in
RoleAccessible
Find remote hosts associated with all given roles.
append(String)
- Method in
Buffer
Append string to last.
B
BackgroundCommand
- Trait in
org.hidetake.groovy.ssh.session.execution
Provides the non-blocking command execution.
BackgroundCommandException
- Class in
org.hidetake.groovy.ssh.session
An exception thrown if at least one background command occurs any error.
BackgroundCommandException(List<Exception>)
- Constructor in
BackgroundCommandException
BadExitStatusException
- Class in
org.hidetake.groovy.ssh.session
An exception class thrown if the remote command returns bad exit status.
BadExitStatusException(String, int)
- Constructor in
BadExitStatusException
Buffer
- Class in
org.hidetake.groovy.ssh.interaction
A byte buffer which supports last-in and first-out.
Buffer(String)
- Constructor in
Buffer
BufferRule
- Interface in
org.hidetake.groovy.ssh.interaction
A rule to inspect and manipulate buffer.
BufferRule.AnyLineRule
- Class in
org.hidetake.groovy.ssh.interaction
A rule to be matched to any line.
BufferRule.AnyPartialStringRule
- Class in
org.hidetake.groovy.ssh.interaction
A rule to be matched to any string if it is not terminated by new-line.
BufferRule.BytesRule
- Class in
org.hidetake.groovy.ssh.interaction
A rule to be matched to next bytes up to given length.
BufferRule.BytesRule(Number)
- Constructor in
BufferRule.BytesRule
BufferRule.Factory
- Class in
org.hidetake.groovy.ssh.interaction
BufferRule.LinePatternRule
- Class in
org.hidetake.groovy.ssh.interaction
A rule to be matched to line of given java.util.regex.Pattern.
BufferRule.LinePatternRule(Pattern)
- Constructor in
BufferRule.LinePatternRule
BufferRule.LineStringRule
- Class in
org.hidetake.groovy.ssh.interaction
Same as
match(org.hidetake.groovy.ssh.interaction.Buffer)
but try match at end of stream.
BufferRule.LineStringRule(String)
- Constructor in
BufferRule.LineStringRule
BufferRule.PartialPatternRule
- Class in
org.hidetake.groovy.ssh.interaction
A rule to be matched to partial string of given java.util.regex.Pattern.
BufferRule.PartialPatternRule(Pattern)
- Constructor in
BufferRule.PartialPatternRule
BufferRule.PartialStringRule
- Class in
org.hidetake.groovy.ssh.interaction
A rule to be matched to partial string.
BufferRule.PartialStringRule(String)
- Constructor in
BufferRule.PartialStringRule
C
callWithDelegate(Closure<T>, def, def)
- Method in
Utility
cd(String)
- Method in
SftpOperations
Change current directory.
checkPoint()
- Method in
FileTransferProgress.Status
Commit a checkpoint.
close()
- Method in
Connection
Cleanup the connection and all channels.
Command
- Trait in
org.hidetake.groovy.ssh.session.execution
Provides the blocking command execution.
Command(Connection, CommandSettings, String)
- Constructor in
Command
command(CommandSettings, String)
- Method in
DefaultOperations
command(CommandSettings, String)
- Method in
DryRunOperations
command(CommandSettings, String)
- Method in
Operations
CommandSettings
- Trait in
org.hidetake.groovy.ssh.operation
Settings for
Command
.
CommandSettings.With
- Class in
org.hidetake.groovy.ssh.operation
CommandSettings.With(CommandSettings)
- Constructor in
CommandSettings.With
CompositeSettings
- Trait in
org.hidetake.groovy.ssh.core.settings
Represents overall settings configurable in
Service.settings
and
RunHandler.settings
.
CompositeSettings.With
- Class in
org.hidetake.groovy.ssh.core.settings
CompositeSettings.With(CompositeSettings)
- Constructor in
CompositeSettings.With
computePropertiesToString(def)
- Method in
SettingsHelper
Compute properties for string representation.
configureHostAuthentication(JSch, Session, Remote, HostAuthenticationSettings)
- Method in
HostAuthentication
configureProxyConnection(JSch, Session, Remote, ProxyConnectionSettings)
- Method in
ProxyConnection
configureUserAuthentication(JSch, Session, Remote, UserAuthenticationSettings)
- Method in
UserAuthentication
connect(Remote)
- Method in
ConnectionManager
Establish a connection.
Connection
- Class in
org.hidetake.groovy.ssh.connection
A SSH connection.
Connection(Remote, Session)
- Constructor in
Connection
ConnectionManager
- Class in
org.hidetake.groovy.ssh.connection
A manager of
Connection
s.
ConnectionManager(ConnectionSettings)
- Constructor in
ConnectionManager
ConnectionSettings
- Trait in
org.hidetake.groovy.ssh.connection
Settings for establishing the SSH connection.
ConnectionSettings.With
- Class in
org.hidetake.groovy.ssh.connection
ConnectionSettings.With(ConnectionSettings)
- Constructor in
ConnectionSettings.With
Container
- Trait in
org.hidetake.groovy.ssh.core.container
A container.
ContainerBuilder
- Class in
org.hidetake.groovy.ssh.core.container
An evaluator of a closure which contains named objects.
ContainerBuilder(Container<T>)
- Constructor in
ContainerBuilder
Context
- Class in
org.hidetake.groovy.ssh.interaction
A context class of stream interaction.
Context(List<Rule>)
- Constructor in
Context
count(long)
- Method in
SftpProgress
create(Map<String, Object>)
- Method in
BufferRule.Factory
create(String, Closure)
- Method in
Container
Create an item and add it.
create(Operations, CompositeSettings)
- Method in
SessionHandler
create(def)
- Method in
StreamRule.Factory
createExecutionChannel()
- Method in
Connection
Create an execution channel.
createFile(String)
- Method in
RecursiveReceiver
Called when the remote file is found.
createFrom(SftpException, String)
- Method in
SftpException
createSftpChannel()
- Method in
Connection
Create a SFTP channel.
createShellChannel()
- Method in
Connection
Create a shell channel.
currentTime()
- Method in
FileTransferProgress.Status
currySelf(Closure<T>)
- Method in
Utility
D
DefaultOperations
- Class in
org.hidetake.groovy.ssh.operation
Default implementation of
Operations
.
DefaultOperations(Connection)
- Constructor in
DefaultOperations
dropBytes(int)
- Method in
Buffer
Drop first bytes.
dropChars(String)
- Method in
Buffer
Drop first bytes of given characters length.
DryRunOperation
- Class in
org.hidetake.groovy.ssh.operation
DryRunOperations
- Class in
org.hidetake.groovy.ssh.operation
Dry-run implementation of
Operations
.
DryRunOperations(Remote)
- Constructor in
DryRunOperations
duplicateForGateway(String, int, String, int)
- Method in
HostKeys
E
end(Stream)
- Method in
Listener
end(Stream)
- Method in
Processor
end()
- Method in
SftpProgress
EnterDirectory
- Class in
org.hidetake.groovy.ssh.session.transfer.put
EnterDirectory(String)
- Constructor in
EnterDirectory
enterDirectory(String)
- Method in
RecursiveReceiver
Called when it entered into the remote directory.
error()
- Method in
ProxyValidator
Escape
- Class in
org.hidetake.groovy.ssh.session.execution
Shell escape utility.
escape(List<String>)
- Method in
Escape
Escape command arguments.
execute(HashMap, List<String>)
- Method in
Command
execute(List<Plan<T>>)
- Method in
Executor
Execute
Plan
s.
execute(String)
- Method in
SudoHelper
executeBackground(HashMap, List<String>, Closure)
- Method in
BackgroundCommand
executeCallbackForClosedChannels()
- Method in
Connection
Execute registered closures.
executeSudo(HashMap, List<String>, Closure)
- Method in
Sudo
Executor
- Class in
org.hidetake.groovy.ssh.session
An executor of session
Plan
s.
Executor(GlobalSettings, PerServiceSettings)
- Constructor in
Executor
F
FileGet
- Trait in
org.hidetake.groovy.ssh.session.transfer
An extension class to get a file or directory.
FilePut
- Trait in
org.hidetake.groovy.ssh.session.transfer
An extension class to put a file or directory.
FileReceiver
- Class in
org.hidetake.groovy.ssh.session.transfer.get
FileReceiver(File)
- Constructor in
FileReceiver
FileTransferMethod
- Enum in
org.hidetake.groovy.ssh.session.transfer
File transfer method type.
FileTransferProgress
- Class in
org.hidetake.groovy.ssh.util
A logger for monitoring progress of the file transfer.
FileTransferProgress.Status
- Class in
org.hidetake.groovy.ssh.util
Represents transferred bytes and elapsed time.
FileTransferProgress(long, Closure)
- Constructor in
FileTransferProgress
FileTransferSettings
- Trait in
org.hidetake.groovy.ssh.session.transfer
FileTransferSettings.With
- Class in
org.hidetake.groovy.ssh.session.transfer
FileTransferSettings.With(FileTransferSettings)
- Constructor in
FileTransferSettings.With
find(String, int)
- Method in
HostKeys
find(int)
- Method in
SftpError
findAssignableKeys(def, Closure<T>)
- Method in
SettingsHelper
Find and map assignable properties of the object.
findMethods(def, String)
- Method in
SettingsHelper
Find methods with the prefix.
forFile(File, String)
- Method in
Instructions
Create
Instructions
for a file or directory.
forFiles(Iterable<File>, String)
- Method in
Instructions
Create
Instructions
for a collection of files or directories
forFileWithFilter(File, String, Closure<Boolean>)
- Method in
Instructions
Create
Instructions
for filtered files.
forStreamContent(InputStream, String)
- Method in
Instructions
Create
Instructions
for stream content.
forwardLocalPort(LocalPortForwardSettings)
- Method in
Connection
Set up local port forwarding.
forwardLocalPort(LocalPortForwardSettings)
- Method in
DefaultOperations
forwardLocalPort(LocalPortForwardSettings)
- Method in
DryRunOperations
forwardLocalPort(LocalPortForwardSettings)
- Method in
Operations
forwardLocalPort(HashMap)
- Method in
PortForward
Forwards local port to remote port.
forwardRemotePort(RemotePortForwardSettings)
- Method in
Connection
Set up remote port forwarding.
forwardRemotePort(RemotePortForwardSettings)
- Method in
DefaultOperations
forwardRemotePort(RemotePortForwardSettings)
- Method in
DryRunOperations
forwardRemotePort(RemotePortForwardSettings)
- Method in
Operations
forwardRemotePort(HashMap)
- Method in
PortForward
Forwards remote port to local port.
fromKnownHosts(Collection<File>)
- Method in
HostKeys
G
get(HashMap)
- Method in
FileGet
Get file(s) or content from the remote host.
get(String, StreamReceiver)
- Method in
Provider
get(String, WritableReceiver)
- Method in
Scp
get(String, RecursiveReceiver)
- Method in
Sftp
getActionWithResult()
- Method in
MatchResult
getAt(String)
- Method in
RoleAccessible.RoleAccessor
Find remote hosts associated with given role.
getCode()
- Method in
SftpError
getContainerElementType()
- Method in
Container
Type of the container element.
getContent(String, OutputStream)
- Method in
SftpOperations
Get a content from the remote host.
getElapsedTime()
- Method in
FileTransferProgress.Status
Return elapsed time in milliseconds from started
getElapsedTimeFromCheckPoint()
- Method in
FileTransferProgress.Status
Return elapsed time in milliseconds from the last checkpoint
getFile(String, String)
- Method in
SftpOperations
Get a file from the remote host.
getKiloBytesPerSecond()
- Method in
FileTransferProgress.Status
Return transfer rate in kbps.
getMergedSettings()
- Method in
SessionExtension
Return the settings with default, global, per-service and per-remote.
getMessage()
- Method in
SftpError
getOperations()
- Method in
SessionExtension
Return the current
Operations
.
getPercent()
- Method in
FileTransferProgress.Status
Return percent of transferred data.
getRemote()
- Method in
Operations
getRemote()
- Method in
SessionExtension
Returns remote host for the current session.
getRemote()
- Method in
SessionHandler
getResultAsString()
- Method in
MatchResult
GlobalSettings
- Class in
org.hidetake.groovy.ssh.core.settings
A global settings.
H
HostAuthentication
- Trait in
org.hidetake.groovy.ssh.connection
HostAuthenticationSettings
- Trait in
org.hidetake.groovy.ssh.connection
HostKeys
- Class in
org.hidetake.groovy.ssh.connection
A list of host keys in a known hosts.
HostKeys(Collection<HostKey>)
- Constructor in
HostKeys
I
init(int, String, String, long)
- Method in
SftpProgress
Instructions
- Class in
org.hidetake.groovy.ssh.session.transfer.put
Represents a collection of SCP PUT instructions such as java.io.File,
StreamContent
,
EnterDirectory
or
LeaveDirectory
.
Instructions(boolean, String, Collection)
- Constructor in
Instructions
InteractionException
- Class in
org.hidetake.groovy.ssh.interaction
An exception thrown if one or more exceptions occurred while stream interaction.
InteractionException(Throwable)
- Constructor in
InteractionException
InteractionHandler
- Class in
org.hidetake.groovy.ssh.interaction
A handler of the interaction closure.
InteractionHandler(OutputStream)
- Constructor in
InteractionHandler
Interactions
- Class in
org.hidetake.groovy.ssh.interaction
An aggregation class of streams and receiver threads.
Interactions(OutputStream, InputStream, String)
- Constructor in
Interactions
Constructor.
isAnyPending()
- Method in
Connection
Return if any channel is pending.
isEnabled(int)
- Method in
JSchLogger
iterator()
- Method in
Instructions
J
JSchLogger
- Class in
org.hidetake.groovy.ssh.connection
A logger which bridges JSch and SLF4J.
K
keyTypes(String, int)
- Method in
HostKeys
L
LeaveDirectory
- Class in
org.hidetake.groovy.ssh.session.transfer.put
leaveDirectory()
- Method in
RecursiveReceiver
Called when it left from the remote directory.
leftShift(long)
- Method in
FileTransferProgress.Status
Report the progress that data has been transferred.
Listener
- Class in
org.hidetake.groovy.ssh.interaction
A listener of lines and partial strings from streams.
LOCALHOST
- Field in
ConnectionManager
LocalPortForwardSettings
- Trait in
org.hidetake.groovy.ssh.session.forwarding
Settings for the local port forwarding.
LocalPortForwardSettings.With
- Class in
org.hidetake.groovy.ssh.session.forwarding
LocalPortForwardSettings.With(LocalPortForwardSettings)
- Constructor in
LocalPortForwardSettings.With
LOG_INTERVAL_MILLIS
- Field in
FileTransferProgress
log(int, String)
- Method in
JSchLogger
LoggingMethod
- Enum in
org.hidetake.groovy.ssh.core.settings
Logging method type.
ls(String)
- Method in
SftpOperations
Get a directory listing.
M
match(Buffer)
- Method in
BufferRule
Inspect the buffer and return match result.
match(Buffer)
- Method in
BufferRule.AnyLineRule
match(Buffer)
- Method in
BufferRule.AnyPartialStringRule
match(Buffer)
- Method in
BufferRule.BytesRule
match(Buffer)
- Method in
BufferRule.LinePatternRule
match(Buffer)
- Method in
BufferRule.LineStringRule
match(Buffer)
- Method in
BufferRule.PartialPatternRule
match(Buffer)
- Method in
BufferRule.PartialStringRule
match(Stream, Buffer)
- Method in
Context
match(Stream, Buffer)
- Method in
Rule
matches(Stream)
- Method in
StreamRule
MatchResult
- Class in
org.hidetake.groovy.ssh.interaction
MatchResult(Rule, E)
- Constructor in
MatchResult
mergeProperties(def, def)
- Method in
SettingsHelper
Compute and set merged properties.
methodMissing(String, def)
- Method in
ContainerBuilder
mkdir(String)
- Method in
SftpOperations
Create a directory.
N
newService()
- Method in
Ssh
Create an instance of
Service
.
newShell()
- Method in
Ssh
Create a groovy.lang.GroovyShell object to run a Groovy script.
O
Operation
- Interface in
org.hidetake.groovy.ssh.operation
An operation such as a command or shell execution.
Operations
- Interface in
org.hidetake.groovy.ssh.operation
An aggregate of core SSH operations.
P
PerServiceSettings
- Class in
org.hidetake.groovy.ssh.core.settings
Per-service settings.
pipe(Stream, OutputStream)
- Method in
Interactions
Pipes the stream into another stream.
Plan
- Class in
org.hidetake.groovy.ssh.session
An execution plan of SSH session.
plus__extensions(SessionSettings)
- Method in
SessionSettings
plus__passphrase(UserAuthenticationSettings)
- Method in
UserAuthenticationSettings
popContext()
- Method in
InteractionHandler
Pop context stack of
Processor
.
PortForward
- Trait in
org.hidetake.groovy.ssh.session.forwarding
An extension class of port forwarding.
Processor
- Class in
org.hidetake.groovy.ssh.interaction
A class to process received bytes by predefined rules.
Processor(Closure, OutputStream, String)
- Constructor in
Processor
Provider
- Interface in
org.hidetake.groovy.ssh.session.transfer.get
An interface of file GET provider.
proxies(Closure)
- Method in
Service
Configure the container of proxy hosts.
Proxy
- Class in
org.hidetake.groovy.ssh.core
Represents a connection proxy to use when establishing a
Connection
.
Proxy(String)
- Constructor in
Proxy
ProxyConnection
- Trait in
org.hidetake.groovy.ssh.connection
ProxyConnectionSettings
- Trait in
org.hidetake.groovy.ssh.connection
ProxyContainer
- Class in
org.hidetake.groovy.ssh.core.container
A container of proxies.
ProxyType
- Enum in
org.hidetake.groovy.ssh.core
Proxy type.
ProxyValidator
- Class in
org.hidetake.groovy.ssh.connection
Basic validation and defaults for proxied connections created by
ConnectionManager
.
ProxyValidator(Proxy)
- Constructor in
ProxyValidator
put(HashMap)
- Method in
FilePut
Put file(s) or content to the remote host.
put(Instructions)
- Method in
Provider
put(Instructions)
- Method in
Scp
put(Instructions)
- Method in
Sftp
putContent(InputStream, String)
- Method in
SftpOperations
Put a content to the remote host.
putFile(String, String)
- Method in
SftpOperations
Put a file to the remote host.
Q
R
receive(Stream, byte[], int)
- Method in
Listener
receive(Stream, byte[], int)
- Method in
Processor
Receiver
- Class in
org.hidetake.groovy.ssh.interaction
A receiver thread reading lines from the stream.
Receiver(Listener, Stream, InputStream)
- Constructor in
Receiver
RecursiveReceiver
- Class in
org.hidetake.groovy.ssh.session.transfer.get
RecursiveReceiver(File, Closure<Boolean>)
- Constructor in
RecursiveReceiver
Release
- Class in
org.hidetake.groovy.ssh
Release metadata.
Remote
- Class in
org.hidetake.groovy.ssh.core
Represents a remote host.
Remote(Map<String, Object>)
- Constructor in
Remote
RemoteContainer
- Class in
org.hidetake.groovy.ssh.core.container
A container of remote hosts.
RemotePortForwardSettings
- Trait in
org.hidetake.groovy.ssh.session.forwarding
Settings for the remote port forwarding.
RemotePortForwardSettings.With
- Class in
org.hidetake.groovy.ssh.session.forwarding
RemotePortForwardSettings.With(RemotePortForwardSettings)
- Constructor in
RemotePortForwardSettings.With
remotes(Closure)
- Method in
Service
Configure the container of remote hosts.
remove(String)
- Method in
SftpRemove
Remove files or directories.
report(long)
- Method in
FileTransferProgress
reset(long)
- Method in
FileTransferProgress
retry(int, int, Closure<T>)
- Method in
Utility
Execute the closure with retrying.
rm(String)
- Method in
SftpOperations
Removes one or several files.
rmdir(String)
- Method in
SftpOperations
Removes one or several directories.
role(String)
- Method in
Remote
Add the role.
role(String)
- Method in
RoleAccessible
Find remote hosts associated with given roles.
RoleAccessible
- Trait in
org.hidetake.groovy.ssh.core.container
Provides role access for remote hosts.
RoleAccessible.RoleAccessor
- Interface in
org.hidetake.groovy.ssh.core.container
Rule
- Class in
org.hidetake.groovy.ssh.interaction
A rule of interaction with the stream.
Rule(Map<String, Object>, Closure)
- Constructor in
Rule
run()
- Method in
Receiver
run(Closure)
- Method in
Service
Run a closure.
RunHandler
- Class in
org.hidetake.groovy.ssh.core
A handler of
Service.run
.
S
Scp
- Class in
org.hidetake.groovy.ssh.session.transfer.get
A helper class for SCP get operation.
Scp(Operations, CompositeSettings)
- Constructor in
Scp
Service
- Class in
org.hidetake.groovy.ssh.core
An entry point of SSH service.
session(Object)
- Method in
RunHandler
Add sessions.
SessionExtension
- Trait in
org.hidetake.groovy.ssh.session
A base trait of session extensions.
SessionExtensions
- Trait in
org.hidetake.groovy.ssh.session
A set of extensions to be shipped as default.
SessionHandler
- Class in
org.hidetake.groovy.ssh.session
A handler of
RunHandler.session
.
SessionSettings
- Trait in
org.hidetake.groovy.ssh.session
Settings for
SessionHandler
s.
SessionSettings.With
- Class in
org.hidetake.groovy.ssh.session
SessionSettings.With(SessionSettings)
- Constructor in
SessionSettings.With
settings(Closure)
- Method in
RunHandler
Configure per service settings.
settings(Closure)
- Method in
Service
Configure global settings.
SettingsHelper
- Class in
org.hidetake.groovy.ssh.core.settings
A helper class for settings manipulation.
Sftp
- Class in
org.hidetake.groovy.ssh.session.transfer.put
Recursive SFTP PUT executor.
sftp(FileTransferSettings, Closure<T>)
- Method in
DefaultOperations
sftp(FileTransferSettings, Closure<T>)
- Method in
DryRunOperations
sftp(FileTransferSettings, Closure<T>)
- Method in
Operations
sftp(Closure<T>)
- Method in
SessionExtension
Perform SFTP operations.
sftp(Closure<T>)
- Method in
SessionHandler
Sftp(Operations, FileTransferSettings)
- Constructor in
Sftp
SftpError
- Enum in
org.hidetake.groovy.ssh.operation
SFTP errors defined in the SFTP protocol.
SftpException
- Class in
org.hidetake.groovy.ssh.operation
Represents SFTP error.
SftpException(String, SftpException, SftpError)
- Constructor in
SftpException
SftpFailureException
- Class in
org.hidetake.groovy.ssh.operation
SftpFailureException(String, SftpException)
- Constructor in
SftpFailureException
SftpNoSuchFileException
- Class in
org.hidetake.groovy.ssh.operation
SftpNoSuchFileException(String, SftpException)
- Constructor in
SftpNoSuchFileException
SftpOperations
- Class in
org.hidetake.groovy.ssh.operation
An aggregate of file transfer operations.
SftpOperations(Remote, ChannelSftp)
- Constructor in
SftpOperations
SftpProgress
- Class in
org.hidetake.groovy.ssh.operation
A bridge class between com.jcraft.jsch.SftpProgressMonitor and
FileTransferProgress
.
SftpProgress(Closure)
- Constructor in
SftpProgress
SftpRemove
- Trait in
org.hidetake.groovy.ssh.session.transfer
An extension class to remove a file or directory via SFTP.
Shell
- Class in
org.hidetake.groovy.ssh.operation
A shell operation.
shell(ShellSettings)
- Method in
DefaultOperations
shell(ShellSettings)
- Method in
DryRunOperations
shell(ShellSettings)
- Method in
Operations
Shell(Connection, ShellSettings)
- Constructor in
Shell
ShellSettings
- Trait in
org.hidetake.groovy.ssh.operation
Settings for
Shell
.
ShellSettings.With
- Class in
org.hidetake.groovy.ssh.operation
ShellSettings.With(ShellSettings)
- Constructor in
ShellSettings.With
size()
- Method in
Buffer
Return size of the buffer.
SOCKS_DEFAULT_VERSION
- Field in
ProxyValidator
SOCKS_SUPPORTED_VERSIONS
- Field in
ProxyValidator
Ssh
- Class in
org.hidetake.groovy.ssh
Entry point of Groovy SSH library.
start()
- Method in
Interactions
Starts receiver threads.
start(Stream)
- Method in
Listener
start(Stream)
- Method in
Processor
startAsync(Closure)
- Method in
Command
startAsync(Closure)
- Method in
DryRunOperation
startAsync(Closure)
- Method in
Operation
Start the operation asynchronously.
startAsync(Closure)
- Method in
Shell
startSync()
- Method in
Command
startSync()
- Method in
DryRunOperation
startSync()
- Method in
Operation
Start the operation synchronously.
startSync()
- Method in
Shell
stat(String)
- Method in
SftpOperations
Get a directory entry.
status
- Field in
FileTransferProgress
Stream
- Enum in
org.hidetake.groovy.ssh.interaction
Stream type.
StreamContent
- Class in
org.hidetake.groovy.ssh.session.transfer.put
StreamContent(String, InputStream)
- Constructor in
StreamContent
StreamReceiver
- Class in
org.hidetake.groovy.ssh.session.transfer.get
StreamReceiver(OutputStream)
- Constructor in
StreamReceiver
StreamRule
- Interface in
org.hidetake.groovy.ssh.interaction
StreamRule.Factory
- Class in
org.hidetake.groovy.ssh.interaction
Sudo
- Trait in
org.hidetake.groovy.ssh.session.execution
An extension class of sudo command execution.
SudoHelper
- Class in
org.hidetake.groovy.ssh.session.execution
SudoHelper.SudoCommandSettings
- Class in
org.hidetake.groovy.ssh.session.execution
Settings class for handling map argument by
Sudo.executeSudo
and
Sudo.executeSudo
.
SudoHelper(Operations, CompositeSettings, SudoHelper.SudoCommandSettings)
- Constructor in
SudoHelper
SudoSettings
- Trait in
org.hidetake.groovy.ssh.session.execution
SudoSettings.With
- Class in
org.hidetake.groovy.ssh.session.execution
SudoSettings.With(SudoSettings)
- Constructor in
SudoSettings.With
T
toString__allowAnyHosts()
- Method in
HostAuthenticationSettings
Hides constant from result of
toString()
.
toString__extensions()
- Method in
SessionSettings
Do not show if it is empty or null.
toString__identity()
- Method in
UserAuthenticationSettings
toString()
formatter to hide credential.
toString__passphrase()
- Method in
UserAuthenticationSettings
Hides credential from result of
toString()
.
toString__password()
- Method in
UserAuthenticationSettings
Hides credential from result of
toString()
.
toString()
- Method in
AllowAnyHosts
toString()
- Method in
Buffer
Return string representation of the buffer.
toString()
- Method in
Connection
toString()
- Method in
Context
toString()
- Method in
MatchResult
toString()
- Method in
Proxy
toString()
- Method in
Receiver
toString()
- Method in
Release
toString()
- Method in
Remote
toString()
- Method in
Rule
toString()
- Method in
ToStringProperties
Returns a string representation of this settings.
toString()
- Method in
Wildcard
ToStringProperties
- Trait in
org.hidetake.groovy.ssh.core.settings
A trait for overriding java.lang.Object#toString() to show properties of this object.
U
UserAuthentication
- Trait in
org.hidetake.groovy.ssh.connection
UserAuthenticationSettings
- Trait in
org.hidetake.groovy.ssh.connection
Utility
- Class in
org.hidetake.groovy.ssh.util
Provides utility methods.
V
validateHostAuthentication(HostAuthenticationSettings, Remote)
- Method in
HostAuthentication
validateProxyConnection(ProxyConnectionSettings, Remote)
- Method in
ProxyConnection
validateUserAuthentication(UserAuthenticationSettings, Remote)
- Method in
UserAuthentication
W
waitAndClose()
- Method in
ConnectionManager
Wait for pending connections and close all.
waitForEndOfStream()
- Method in
Interactions
Waits for all receiver threads.
warnings()
- Method in
ProxyValidator
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.
Wildcard
- Class in
org.hidetake.groovy.ssh.interaction
Represents a wildcard.
WritableReceiver
- Interface in
org.hidetake.groovy.ssh.session.transfer.get
write(byte[])
- Method in
FileReceiver
write(byte[])
- Method in
StreamReceiver
write(byte[])
- Method in
WritableReceiver
X
Y
Z
_
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
_
Overview
Package
Class
Deprecated
Index
Help
Frames
No Frames
Groovy Documentation