Skip navigation links
A B C D E F G H I J K L M N O P Q R S T U V W _ 

A

add(HostKey, UserInfo) - Method in interface com.jcraft.jsch.HostKeyRepository
Adds a hostname-key-pair to the repository.
add(byte[]) - Method in interface com.jcraft.jsch.IdentityRepository
Adds a new identity to this repository, in the form of the raw (unencrypted) private key bytes.
add(byte[]) - Method in class com.jcraft.jsch.IdentityRepository.Wrapper
 
addIdentity(String) - Method in class com.jcraft.jsch.JSch
Adds an identity to be used for public-key authentication.
addIdentity(String, String) - Method in class com.jcraft.jsch.JSch
Adds an identity to be used for public-key authentication.
addIdentity(String, byte[]) - Method in class com.jcraft.jsch.JSch
Adds an identity to be used for public-key authentication.
addIdentity(String, String, byte[]) - Method in class com.jcraft.jsch.JSch
Adds an identity to be used for public-key authentication.
addIdentity(String, byte[], byte[], byte[]) - Method in class com.jcraft.jsch.JSch
Adds an identity to be used for public-key authentication.
addIdentity(Identity, byte[]) - Method in class com.jcraft.jsch.JSch
Adds an identity to be used for public-key authentication.
addSession(Session) - Method in class com.jcraft.jsch.JSch
Adds a session to our session pool.
APPEND - Static variable in class com.jcraft.jsch.ChannelSftp
file transfer mode: append to existing file, if any.

B

BREAK - Static variable in interface com.jcraft.jsch.ChannelSftp.LsEntrySelector
 

C

cd(String) - Method in class com.jcraft.jsch.ChannelSftp
Changes the current remote directory.
CHANGED - Static variable in interface com.jcraft.jsch.HostKeyRepository
Constant for the result of HostKeyRepository.check(java.lang.String, byte[]): The host has another key.
Channel - Class in com.jcraft.jsch
The abstract base class for the different types of channel which may be associated with a Session.
ChannelDirectTCPIP - Class in com.jcraft.jsch
A Channel which allows forwarding a pair of local streams to/from a TCP-connection to a server on the remote side.
ChannelExec - Class in com.jcraft.jsch
A channel connected to a remotely executing program.
ChannelExec() - Constructor for class com.jcraft.jsch.ChannelExec
 
ChannelForwardedTCPIP - Class in com.jcraft.jsch
A Channel created when a forwarded port at the remote side is connected.
ChannelSftp - Class in com.jcraft.jsch
A Channel connected to an sftp server (as a subsystem of the ssh server).
ChannelSftp() - Constructor for class com.jcraft.jsch.ChannelSftp
 
ChannelSftp.LsEntry - Class in com.jcraft.jsch
Represents a directory entry, representing a remote file or directory.
ChannelSftp.LsEntrySelector - Interface in com.jcraft.jsch
Objects implementing this interface can be passed as an argument for ChannelSftp's ChannelSftp.ls(java.lang.String) method.
ChannelShell - Class in com.jcraft.jsch
A channel connected to a remote shell.
ChannelSubsystem - Class in com.jcraft.jsch
A channel connected to a subsystem of the server process.
ChannelSubsystem() - Constructor for class com.jcraft.jsch.ChannelSubsystem
 
check(String, byte[]) - Method in interface com.jcraft.jsch.HostKeyRepository
Checks whether some host has a given key.
chgrp(int, String) - Method in class com.jcraft.jsch.ChannelSftp
Changes the owner group of one or several remote files.
chmod(int, String) - Method in class com.jcraft.jsch.ChannelSftp
Changes the permissions of one or several remote files.
chown(int, String) - Method in class com.jcraft.jsch.ChannelSftp
Changes the owning user of one or several remote files.
clear() - Method in interface com.jcraft.jsch.Identity
Disposes internally allocated data, like byte array for the private key.
close() - Method in interface com.jcraft.jsch.Proxy
Closes the connection.
close() - Method in class com.jcraft.jsch.ProxyHTTP
 
close() - Method in class com.jcraft.jsch.ProxySOCKS4
 
close() - Method in class com.jcraft.jsch.ProxySOCKS5
 
com.jcraft.jsch - package com.jcraft.jsch
Java Secure Channel - main package.
comment - Variable in class com.jcraft.jsch.HostKey
 
compareTo(Object) - Method in class com.jcraft.jsch.ChannelSftp.LsEntry
compares this LsEntry to another LsEntry, alphabetically by filename.
ConfigRepository - Interface in com.jcraft.jsch
A repository for host-specific configuration settings, retrievable by host name (or an alias).
ConfigRepository.Config - Interface in com.jcraft.jsch
A configuration for connections to a remote host name (or alias).
connect() - Method in class com.jcraft.jsch.Channel
Opens the channel without any timeout.
connect(int) - Method in class com.jcraft.jsch.Channel
Opens the channel.
connect(int) - Method in class com.jcraft.jsch.ChannelDirectTCPIP
opens the channel.
connect(SocketFactory, String, int, int) - Method in interface com.jcraft.jsch.Proxy
Opens a connection to the target server.
connect(SocketFactory, String, int, int) - Method in class com.jcraft.jsch.ProxyHTTP
 
connect(SocketFactory, String, int, int) - Method in class com.jcraft.jsch.ProxySOCKS4
 
connect(SocketFactory, String, int, int) - Method in class com.jcraft.jsch.ProxySOCKS5
 
connect() - Method in class com.jcraft.jsch.Session
opens the connection, using the timeout set with Session.setTimeout(int).
connect(int) - Method in class com.jcraft.jsch.Session
opens the connection, using the specified timeout.
CONTINUE - Static variable in interface com.jcraft.jsch.ChannelSftp.LsEntrySelector
 
count(long) - Method in interface com.jcraft.jsch.SftpProgressMonitor
Will be called periodically as more data is transfered.
createServerSocket(int, int, InetAddress) - Method in interface com.jcraft.jsch.ServerSocketFactory
Creates a ServerSocket.
createSocket(String, int) - Method in interface com.jcraft.jsch.SocketFactory
Creates a Socket connected to a given host/port.

D

daemon_thread - Variable in class com.jcraft.jsch.Session
 
DEBUG - Static variable in interface com.jcraft.jsch.Logger
Log level constant - the lowest level (only use for debugging).
decrypt() - Method in interface com.jcraft.jsch.Identity
Deprecated.
The decryption should be done automatically in #setPassphase(byte[] passphrase)
defaultConfig - Static variable in interface com.jcraft.jsch.ConfigRepository
An implementation of ConfigRepository.Config which returns null (or -1) for every method.
delPortForwardingL(int) - Method in class com.jcraft.jsch.Session
Cancels the local port forwarding assigned at local TCP port lport on loopback interface.
delPortForwardingL(String, int) - Method in class com.jcraft.jsch.Session
Cancels the local port forwarding assigned at local TCP port lport on bind_address interface.
delPortForwardingR(int) - Method in class com.jcraft.jsch.Session
Cancels the remote port forwarding assigned at remote TCP port rport.
delPortForwardingR(String, int) - Method in class com.jcraft.jsch.Session
Cancels the remote port forwarding assigned at remote TCP port rport bound on the interface at bind_address.
disconnect() - Method in class com.jcraft.jsch.Channel
disconnects this channel.
disconnect() - Method in class com.jcraft.jsch.ChannelSftp
closes this channel.
disconnect() - Method in class com.jcraft.jsch.Session
Closes the connection to the server.

E

ECDSA256 - Static variable in class com.jcraft.jsch.HostKey
 
ECDSA384 - Static variable in class com.jcraft.jsch.HostKey
 
ECDSA521 - Static variable in class com.jcraft.jsch.HostKey
 
encode(Packet) - Method in class com.jcraft.jsch.Session
(not to be invoked from outside)
end() - Method in interface com.jcraft.jsch.SftpProgressMonitor
Will be called when the transfer ended, either because all the data was transferred, or because the transfer was cancelled.
ERROR - Static variable in interface com.jcraft.jsch.Logger
Log level constant: the second-highest level, something occured which should not have.
exit() - Method in class com.jcraft.jsch.ChannelSftp
Exits the Channel.

F

FATAL - Static variable in interface com.jcraft.jsch.Logger
Log level constant: the highest level: something did get so wrong that recovering is not possible.
fill(byte[], int, int) - Method in interface com.jcraft.jsch.Random
Fills a segment of a byte array with random bits.
ForwardedTCPIPDaemon - Interface in com.jcraft.jsch
A local deamon process executed when a host connects to to a forwarded port at the remote side.

G

genChannelOpenPacket() - Method in class com.jcraft.jsch.Channel
 
genChannelOpenPacket() - Method in class com.jcraft.jsch.ChannelDirectTCPIP
 
get(String, String) - Method in class com.jcraft.jsch.ChannelSftp
Downloads a file.
get(String, String, SftpProgressMonitor) - Method in class com.jcraft.jsch.ChannelSftp
Downloads a file.
get(String, String, SftpProgressMonitor, int) - Method in class com.jcraft.jsch.ChannelSftp
Downloads a file.
get(String, OutputStream) - Method in class com.jcraft.jsch.ChannelSftp
Downloads a file to an OutputStream.
get(String, OutputStream, SftpProgressMonitor) - Method in class com.jcraft.jsch.ChannelSftp
Downloads a file to an OutputStream.
get(String, OutputStream, SftpProgressMonitor, int, long) - Method in class com.jcraft.jsch.ChannelSftp
Downloads a file to an OutputStream.
get(String) - Method in class com.jcraft.jsch.ChannelSftp
Starts downloading a file as an InputStream.
get(String, SftpProgressMonitor) - Method in class com.jcraft.jsch.ChannelSftp
Starts downloading a file as an InputStream.
get(String, int) - Method in class com.jcraft.jsch.ChannelSftp
Deprecated.
This method will be deleted in the future. A transfer mode is not meaningful here, as you can't really overwrite or append an InputStream.
get(String, SftpProgressMonitor, int) - Method in class com.jcraft.jsch.ChannelSftp
Deprecated.
This method will be deleted in the future. A transfer mode is not meaningful here, as you can't really overwrite or append an InputStream.
get(String, SftpProgressMonitor, long) - Method in class com.jcraft.jsch.ChannelSftp
Starts downloading a file as an InputStream.
GET - Static variable in interface com.jcraft.jsch.SftpProgressMonitor
Direction constant for download.
getAlgName() - Method in interface com.jcraft.jsch.Identity
Returns the name of the algorithm.
getATime() - Method in class com.jcraft.jsch.SftpATTRS
returns the last access time.
getAtimeString() - Method in class com.jcraft.jsch.SftpATTRS
returns a string representation of the access time.
getAttrs() - Method in class com.jcraft.jsch.ChannelSftp.LsEntry
return the attributes of the file.
getBulkRequests() - Method in class com.jcraft.jsch.ChannelSftp
This method will return the value how many requests may be sent at any one time.
getCause() - Method in exception com.jcraft.jsch.JSchException
retrieves the cause.
getCause() - Method in exception com.jcraft.jsch.SftpException
Returns the cause of the exception.
getClientVersion() - Method in class com.jcraft.jsch.Session
returns the version string (to be) sent to the server.
getComment() - Method in class com.jcraft.jsch.HostKey
 
getConfig(String) - Method in interface com.jcraft.jsch.ConfigRepository
Returns the configuration for a specific host name (or host name alias).
getConfig(String) - Static method in class com.jcraft.jsch.JSch
Retrieves a default configuration option.
getConfig(String) - Method in class com.jcraft.jsch.Session
Retrieves a configuration option of this session.
getConfigRepository() - Method in class com.jcraft.jsch.JSch
 
getDefaultPort() - Static method in class com.jcraft.jsch.ProxyHTTP
returns the default proxy port - this is 80 as defined for HTTP.
getDefaultPort() - Static method in class com.jcraft.jsch.ProxySOCKS4
returns the default proxy port - this is 1080 as defined for SOCKS.
getDefaultPort() - Static method in class com.jcraft.jsch.ProxySOCKS5
returns the default proxy port - this is 1080 as defined for SOCKS.
getErrStream() - Method in class com.jcraft.jsch.ChannelExec
Gets the error stream.
getErrStream() - Method in class com.jcraft.jsch.ChannelSubsystem
Gets the error stream.
getExitStatus() - Method in class com.jcraft.jsch.Channel
retrieves the exit status of the remote command corresponding to this channel.
getExtended() - Method in class com.jcraft.jsch.SftpATTRS
returns extended attributes, if any.
getExtension(String) - Method in class com.jcraft.jsch.ChannelSftp
returns the extension data sent by the server corresponding to some extension name.
getExtInputStream() - Method in class com.jcraft.jsch.Channel
Gets an InputStream for extended data of this channel.
getFilename() - Method in class com.jcraft.jsch.ChannelSftp.LsEntry
gets the file name of this file.
getFingerPrint(JSch) - Method in class com.jcraft.jsch.HostKey
returns the key's fingerprint (i.e. a lowercase hexadecimal representation of the MD5 of the key.)
getFlags() - Method in class com.jcraft.jsch.SftpATTRS
returns the flags indicating which attributes are present.
getGId() - Method in class com.jcraft.jsch.SftpATTRS
returns the numerical group identifier of the owning group.
getHome() - Method in class com.jcraft.jsch.ChannelSftp
returns the absolute path of the remote home directory.
getHost() - Method in class com.jcraft.jsch.HostKey
returns the name of the host.
getHost() - Method in class com.jcraft.jsch.Session
gets the host name to which we will connect (or are connected).
getHostKey() - Method in interface com.jcraft.jsch.HostKeyRepository
returns all host keys in this repository.
getHostKey(String, String) - Method in interface com.jcraft.jsch.HostKeyRepository
returns all host keys of a certain host.
getHostKey() - Method in class com.jcraft.jsch.Session
retrieves the host key of the server.
getHostKeyAlias() - Method in class com.jcraft.jsch.Session
retrieves the current server host key alias.
getHostKeyRepository() - Method in class com.jcraft.jsch.JSch
Returns the current host key repository.
getHostKeyRepository() - Method in class com.jcraft.jsch.Session
Gets the hostkeyRepository.
getHostname() - Method in interface com.jcraft.jsch.ConfigRepository.Config
The actual host name to use for connecting.
getId() - Method in class com.jcraft.jsch.Channel
returns the session-specific identifier of the channel.
getIdentities() - Method in interface com.jcraft.jsch.IdentityRepository
Returns all the identies of this repository, in the form of a vector of Identity objects.
getIdentities() - Method in class com.jcraft.jsch.IdentityRepository.Wrapper
 
getIdentityNames() - Method in class com.jcraft.jsch.JSch
Lists names of identities included in the identityRepository.
getIdentityRepository() - Method in class com.jcraft.jsch.JSch
 
getInputStream() - Method in class com.jcraft.jsch.Channel
Gets an InputStream for this channel.
getInputStream() - Method in interface com.jcraft.jsch.Proxy
Returns an InputStream to read data from the remote server.
getInputStream() - Method in class com.jcraft.jsch.ProxyHTTP
 
getInputStream() - Method in class com.jcraft.jsch.ProxySOCKS4
 
getInputStream() - Method in class com.jcraft.jsch.ProxySOCKS5
 
getInputStream(Socket) - Method in interface com.jcraft.jsch.SocketFactory
Creates an InputStream for a Socket.
getKey() - Method in class com.jcraft.jsch.HostKey
returns a base64-representation of the key.
getKnownHostsRepositoryID() - Method in interface com.jcraft.jsch.HostKeyRepository
returns an identifier for this repository.
getLongname() - Method in class com.jcraft.jsch.ChannelSftp.LsEntry
returns the "longname" of a file.
getMarker() - Method in class com.jcraft.jsch.HostKey
 
getMTime() - Method in class com.jcraft.jsch.SftpATTRS
returns the last modification time.
getMtimeString() - Method in class com.jcraft.jsch.SftpATTRS
returns a string representation of the modifiying time.
getName() - Method in interface com.jcraft.jsch.Identity
returns the name of this identity.
getName() - Method in interface com.jcraft.jsch.IdentityRepository
The name of the repository instance.
getName() - Method in class com.jcraft.jsch.IdentityRepository.Wrapper
 
getOutputStream() - Method in class com.jcraft.jsch.Channel
Gets an OutputStream for this channel.
getOutputStream() - Method in interface com.jcraft.jsch.Proxy
Returns an OutputStream to write data to the remote server.
getOutputStream() - Method in class com.jcraft.jsch.ProxyHTTP
 
getOutputStream() - Method in class com.jcraft.jsch.ProxySOCKS4
 
getOutputStream() - Method in class com.jcraft.jsch.ProxySOCKS5
 
getOutputStream(Socket) - Method in interface com.jcraft.jsch.SocketFactory
Creates an OutputStream for a Socket.
getPassphrase() - Method in interface com.jcraft.jsch.UserInfo
Returns the passphrase entered by the user.
getPassword() - Method in interface com.jcraft.jsch.UserInfo
Returns the password entered by the user.
getPermissions() - Method in class com.jcraft.jsch.SftpATTRS
Returns the Unix permissions of the file.
getPermissionsString() - Method in class com.jcraft.jsch.SftpATTRS
Returns a string representation of the permissions in the format used by ls -l.
getPort() - Method in interface com.jcraft.jsch.ConfigRepository.Config
The port number to use for connecting.
getPort() - Method in class com.jcraft.jsch.Session
returns the port at the remote host we will connect (or already connected) to.
getPortForwardingL() - Method in class com.jcraft.jsch.Session
returns a snapshot of the current local port forwarding configurations.
getPortForwardingR() - Method in class com.jcraft.jsch.Session
Lists the registered remote port forwarding.
getPublicKeyBlob() - Method in interface com.jcraft.jsch.Identity
Returns the public key data.
getRemotePort() - Method in class com.jcraft.jsch.ChannelForwardedTCPIP
retrieves the local port at the remote side where this TCP connection came in.
getServerAliveCountMax() - Method in class com.jcraft.jsch.Session
Returns setting for the threshold to send keep-alive messages.
getServerAliveInterval() - Method in class com.jcraft.jsch.Session
Returns setting for the interval to send a keep-alive message.
getServerVersion() - Method in class com.jcraft.jsch.ChannelSftp
returns the server's protocol version number.
getServerVersion() - Method in class com.jcraft.jsch.Session
returns the version string sent by the server.
getSession() - Method in class com.jcraft.jsch.Channel
Retrieves the session to which this channel belongs.
getSession(String) - Method in class com.jcraft.jsch.JSch
Instantiates the Session object with host.
getSession(String, String) - Method in class com.jcraft.jsch.JSch
Instantiates the Session object with username and host.
getSession(String, String, int) - Method in class com.jcraft.jsch.JSch
Instantiates the Session object with given username, host and port.
getSignature(byte[]) - Method in interface com.jcraft.jsch.Identity
Signs some data with our private key and signature algorithm.
getSize() - Method in class com.jcraft.jsch.SftpATTRS
Returns the size of the file, in bytes.
getSocket() - Method in interface com.jcraft.jsch.Proxy
Returns the socket used for the connection.
getSocket() - Method in class com.jcraft.jsch.ProxyHTTP
 
getSocket() - Method in class com.jcraft.jsch.ProxySOCKS4
 
getSocket() - Method in class com.jcraft.jsch.ProxySOCKS5
 
getStatus() - Method in interface com.jcraft.jsch.IdentityRepository
The status of the repository instance.
getStatus() - Method in class com.jcraft.jsch.IdentityRepository.Wrapper
 
getStreamForwarder(String, int) - Method in class com.jcraft.jsch.Session
Instantiates an instance of stream-forwarder to host:port.
getTimeout() - Method in class com.jcraft.jsch.Session
retrieves the current timeout setting.
getType() - Method in class com.jcraft.jsch.HostKey
returns the type of the key.
getUId() - Method in class com.jcraft.jsch.SftpATTRS
returns the numerical user identifier of the owning user.
getUser() - Method in interface com.jcraft.jsch.ConfigRepository.Config
The user name to use for connecting.
getUserInfo() - Method in class com.jcraft.jsch.Session
returns the current value of the UserInfo object.
getUserName() - Method in class com.jcraft.jsch.Session
returns the user name used for login (and set when creating the session).
getValue(String) - Method in interface com.jcraft.jsch.ConfigRepository.Config
A configuration value for a named key, as a string.
getValues(String) - Method in interface com.jcraft.jsch.ConfigRepository.Config
A list of configuration values for a named key, as an array of strings.
GUESS - Static variable in class com.jcraft.jsch.HostKey
Type constant for "try to guess the type".

H

hardlink(String, String) - Method in class com.jcraft.jsch.ChannelSftp
 
host - Variable in class com.jcraft.jsch.HostKey
the host list
HostKey - Class in com.jcraft.jsch
The public key of a SSH server.
HostKey(String, byte[]) - Constructor for class com.jcraft.jsch.HostKey
creates a host key by guessing it's type from the data.
HostKey(String, int, byte[]) - Constructor for class com.jcraft.jsch.HostKey
creates a host key with given type.
HostKey(String, int, byte[], String) - Constructor for class com.jcraft.jsch.HostKey
 
HostKey(String, String, int, byte[], String) - Constructor for class com.jcraft.jsch.HostKey
 
HostKeyRepository - Interface in com.jcraft.jsch
A repository for known host keys.

I

id - Variable in exception com.jcraft.jsch.SftpException
The status code which caused the exception to be thrown.
Identity - Interface in com.jcraft.jsch
A user identity for public-key authentication.
IdentityRepository - Interface in com.jcraft.jsch
A repository for identities (basically key pairs usable for authentication to a server).
IdentityRepository.Wrapper - Class in com.jcraft.jsch
JSch will accept ciphered keys, but some implementations of IdentityRepository can not.
INFO - Static variable in interface com.jcraft.jsch.Logger
Log level constant: The second lowest level, information.
init(int, String, String, long) - Method in interface com.jcraft.jsch.SftpProgressMonitor
Will be called when a new operation starts.
isBlk() - Method in class com.jcraft.jsch.SftpATTRS
 
isChr() - Method in class com.jcraft.jsch.SftpATTRS
 
isClosed() - Method in class com.jcraft.jsch.Channel
returns true if this channel is already closed (or another thread is in progress of closing the channel).
isConnected() - Method in class com.jcraft.jsch.Channel
returns true if this channel is currently connected (which also means that the session is still connected).
isConnected() - Method in class com.jcraft.jsch.Session
retrieves the current connection status.
isDir() - Method in class com.jcraft.jsch.SftpATTRS
checks whether this file is a directory.
isEnabled(int) - Method in interface com.jcraft.jsch.Logger
Checks if logging of some level is actually enabled.
isEncrypted() - Method in interface com.jcraft.jsch.Identity
Checks whether the private key is encrypted.
isEOF() - Method in class com.jcraft.jsch.Channel
Checks if we have already read all the data, i.e. whether the remote side sent an end-of-file notification for this channel.
isFifo() - Method in class com.jcraft.jsch.SftpATTRS
 
isLink() - Method in class com.jcraft.jsch.SftpATTRS
checks whether this file is a symbolic link.
isReg() - Method in class com.jcraft.jsch.SftpATTRS
 
isSock() - Method in class com.jcraft.jsch.SftpATTRS
 

J

JSch - Class in com.jcraft.jsch
This class serves as a central configuration point, and as a factory for Session objects configured with these settings.
JSch() - Constructor for class com.jcraft.jsch.JSch
Creates a new JSch object.
JSchException - Exception in com.jcraft.jsch
Will be thrown if anything goes wrong with the SSH protocol.
JSchException() - Constructor for exception com.jcraft.jsch.JSchException
Creates a JSchException without message.
JSchException(String) - Constructor for exception com.jcraft.jsch.JSchException
Creates a JSchException with message.
JSchException(String, Throwable) - Constructor for exception com.jcraft.jsch.JSchException
Creates a JSchException with message and cause

K

key - Variable in class com.jcraft.jsch.HostKey
the key data

L

lcd(String) - Method in class com.jcraft.jsch.ChannelSftp
log(int, String) - Method in interface com.jcraft.jsch.Logger
Logs some message.
Logger - Interface in com.jcraft.jsch
Provides logging abilities to the library.
lpwd() - Method in class com.jcraft.jsch.ChannelSftp
returns the current local directory in absolute form.
ls(String) - Method in class com.jcraft.jsch.ChannelSftp
lists the contents of a remote directory.
ls(String, ChannelSftp.LsEntrySelector) - Method in class com.jcraft.jsch.ChannelSftp
List files specified by the remote path.
lstat(String) - Method in class com.jcraft.jsch.ChannelSftp
Retrieves the file attributes of a file or directory.

M

marker - Variable in class com.jcraft.jsch.HostKey
 
mkdir(String) - Method in class com.jcraft.jsch.ChannelSftp
creates a new remote directory.

N

name2type(String) - Static method in class com.jcraft.jsch.HostKey
 
noMoreSessionChannels() - Method in class com.jcraft.jsch.Session
 
NOT_INCLUDED - Static variable in interface com.jcraft.jsch.HostKeyRepository
Constant for the result of HostKeyRepository.check(java.lang.String, byte[]): The host does not exist yet in the list.
NOTRUNNING - Static variable in interface com.jcraft.jsch.IdentityRepository
 
nullConfig - Static variable in interface com.jcraft.jsch.ConfigRepository
A dummy ConfigRepository, where each host has an empty configuration.

O

OK - Static variable in interface com.jcraft.jsch.HostKeyRepository
Constant for the result of HostKeyRepository.check(java.lang.String, byte[]): The host has the given key.
openChannel(String) - Method in class com.jcraft.jsch.Session
Opens a new channel of some type over this connection.
OVERWRITE - Static variable in class com.jcraft.jsch.ChannelSftp
file transfer mode: overwrite the existing file, if any.

P

promptKeyboardInteractive(String, String, String, String[], boolean[]) - Method in interface com.jcraft.jsch.UIKeyboardInteractive
Retrieves answers from the user to a number of questions.
promptPassphrase(String) - Method in interface com.jcraft.jsch.UserInfo
Prompts the user for a passphrase for a public key.
promptPassword(String) - Method in interface com.jcraft.jsch.UserInfo
Prompts the user for a password used for authentication for the remote server.
promptYesNo(String) - Method in interface com.jcraft.jsch.UserInfo
Prompts the user to answer a yes-no-question.
Proxy - Interface in com.jcraft.jsch
Allows routing connections through some proxy.
ProxyHTTP - Class in com.jcraft.jsch
A Proxy implementation using a HTTP proxy.
ProxyHTTP(String) - Constructor for class com.jcraft.jsch.ProxyHTTP
Creates a new ProxyHTTP object.
ProxyHTTP(String, int) - Constructor for class com.jcraft.jsch.ProxyHTTP
Creates a new ProxyHTTP object.
ProxySOCKS4 - Class in com.jcraft.jsch
A Proxy implementation using a SOCKS V5 proxy.
ProxySOCKS4(String) - Constructor for class com.jcraft.jsch.ProxySOCKS4
Creates a new ProxySOCKS5 object.
ProxySOCKS4(String, int) - Constructor for class com.jcraft.jsch.ProxySOCKS4
Creates a new ProxyHTTP object.
ProxySOCKS5 - Class in com.jcraft.jsch
A Proxy implementation using a SOCKS V5 proxy.
ProxySOCKS5(String) - Constructor for class com.jcraft.jsch.ProxySOCKS5
Creates a new ProxySOCKS5 object.
ProxySOCKS5(String, int) - Constructor for class com.jcraft.jsch.ProxySOCKS5
Creates a new ProxyHTTP object.
put(String, String) - Method in class com.jcraft.jsch.ChannelSftp
Uploads a file.
put(String, String, int) - Method in class com.jcraft.jsch.ChannelSftp
Uploads a file.
put(String, String, SftpProgressMonitor) - Method in class com.jcraft.jsch.ChannelSftp
Uploads a file.
put(String, String, SftpProgressMonitor, int) - Method in class com.jcraft.jsch.ChannelSftp
Uploads a file.
put(InputStream, String) - Method in class com.jcraft.jsch.ChannelSftp
Uploads a file from an input stream.
put(InputStream, String, int) - Method in class com.jcraft.jsch.ChannelSftp
Uploads a file from an input stream.
put(InputStream, String, SftpProgressMonitor) - Method in class com.jcraft.jsch.ChannelSftp
Uploads a file from an input stream.
put(InputStream, String, SftpProgressMonitor, int) - Method in class com.jcraft.jsch.ChannelSftp
Uploads a file from an input stream.
put(String) - Method in class com.jcraft.jsch.ChannelSftp
Starts an upload by OutputStream.
put(String, int) - Method in class com.jcraft.jsch.ChannelSftp
Starts an upload by OutputStream.
put(String, SftpProgressMonitor, int) - Method in class com.jcraft.jsch.ChannelSftp
Starts an upload by OutputStream.
put(String, SftpProgressMonitor, int, long) - Method in class com.jcraft.jsch.ChannelSftp
Starts an upload by OutputStream.
PUT - Static variable in interface com.jcraft.jsch.SftpProgressMonitor
Direction constant for upload.
pwd() - Method in class com.jcraft.jsch.ChannelSftp
returns the current remote directory in absolute form.

Q

quit() - Method in class com.jcraft.jsch.ChannelSftp
Quits the Channel.

R

Random - Interface in com.jcraft.jsch
A random number generator.
read(Buffer) - Method in class com.jcraft.jsch.Session
reads some bytes - not to be used from outside.
readlink(String) - Method in class com.jcraft.jsch.ChannelSftp
reads a symbolic link.
realpath(String) - Method in class com.jcraft.jsch.ChannelSftp
converts a remote path to its absolute (and to a certain degree canonical) version.
rekey() - Method in class com.jcraft.jsch.Session
initiates a new key exchange.
remove(String, String) - Method in interface com.jcraft.jsch.HostKeyRepository
Removes a host key if there exists mached key with host, type.
remove(String, String, byte[]) - Method in interface com.jcraft.jsch.HostKeyRepository
removes a specific key of a host from the repository.
remove(byte[]) - Method in interface com.jcraft.jsch.IdentityRepository
Removes an identy from the repository, given the public key.
remove(byte[]) - Method in class com.jcraft.jsch.IdentityRepository.Wrapper
 
removeAll() - Method in interface com.jcraft.jsch.IdentityRepository
Removes all identities from this repository.
removeAll() - Method in class com.jcraft.jsch.IdentityRepository.Wrapper
 
removeAllIdentity() - Method in class com.jcraft.jsch.JSch
Removes all identities.
removeIdentity(String) - Method in class com.jcraft.jsch.JSch
Deprecated.
use #removeIdentity(Identity identity)
removeIdentity(Identity) - Method in class com.jcraft.jsch.JSch
Removes the identity from identityRepository.
removeSession(Session) - Method in class com.jcraft.jsch.JSch
Removes a session from our session pool.
rename(String, String) - Method in class com.jcraft.jsch.ChannelSftp
Renames a file or directory.
RESUME - Static variable in class com.jcraft.jsch.ChannelSftp
file transfer mode: resume an interrupted upload/download.
rm(String) - Method in class com.jcraft.jsch.ChannelSftp
removes one or several files.
rmdir(String) - Method in class com.jcraft.jsch.ChannelSftp
Removes one or several remote directories.
run() - Method in class com.jcraft.jsch.Channel
not to be called externally.
run() - Method in class com.jcraft.jsch.ChannelDirectTCPIP
Not for external use - the channel transfer loop.
run() - Method in class com.jcraft.jsch.ChannelForwardedTCPIP
Not for external use - the channel transfer loop.
run() - Method in interface com.jcraft.jsch.ForwardedTCPIPDaemon
Does the actual connection handling.
run() - Method in class com.jcraft.jsch.Session
Not to be called from outside.
RUNNING - Static variable in interface com.jcraft.jsch.IdentityRepository
 

S

select(ChannelSftp.LsEntry) - Method in interface com.jcraft.jsch.ChannelSftp.LsEntrySelector
The select method will be invoked in ls method for each file entry.
sendChannelOpen() - Method in class com.jcraft.jsch.Channel
 
sendIgnore() - Method in class com.jcraft.jsch.Session
sends an ignored package.
sendKeepAliveMsg() - Method in class com.jcraft.jsch.Session
Sends a keep-alive message.
sendOpenConfirmation() - Method in class com.jcraft.jsch.Channel
sends a message confirming the opening of the channel.
sendOpenFailure(int) - Method in class com.jcraft.jsch.Channel
sends a message indicating the failure of a channel-opening to the remote side.
sendSignal(String) - Method in class com.jcraft.jsch.Channel
sends a signal to the process at the other side.
ServerSocketFactory - Interface in com.jcraft.jsch
A factory for ServerSockets.
Session - Class in com.jcraft.jsch
A Session represents a connection to a SSH server.
setACMODTIME(int, int) - Method in class com.jcraft.jsch.SftpATTRS
Sets access and modification time.
setArg(Object[]) - Method in interface com.jcraft.jsch.ForwardedTCPIPDaemon
Sets additional arguments given when the forwarding was created.
setBulkRequests(int) - Method in class com.jcraft.jsch.ChannelSftp
Specify how many requests may be sent at any one time.
setChannel(ChannelForwardedTCPIP, InputStream, OutputStream) - Method in interface com.jcraft.jsch.ForwardedTCPIPDaemon
Sets the streams to be used for communication.
setClientVersion(String) - Method in class com.jcraft.jsch.Session
changes the version string to be sent to the server.
setCommand(String) - Method in class com.jcraft.jsch.ChannelExec
sets the command to be executed.
setCommand(byte[]) - Method in class com.jcraft.jsch.ChannelExec
sets the command to be executed.
setConfig(Hashtable) - Static method in class com.jcraft.jsch.JSch
Sets multiple default configuration options at once.
setConfig(String, String) - Static method in class com.jcraft.jsch.JSch
Sets a default configuration option.
setConfig(Properties) - Method in class com.jcraft.jsch.Session
sets several configuration options at once.
setConfig(Hashtable) - Method in class com.jcraft.jsch.Session
sets several configuration options at once.
setConfig(String, String) - Method in class com.jcraft.jsch.Session
sets a single configuration option for this session.
setConfigRepository(ConfigRepository) - Method in class com.jcraft.jsch.JSch
 
setDaemonThread(boolean) - Method in class com.jcraft.jsch.Session
Sets the deamon thread property.
setErrStream(OutputStream) - Method in class com.jcraft.jsch.ChannelExec
Sets the error stream.
setErrStream(OutputStream, boolean) - Method in class com.jcraft.jsch.ChannelExec
Sets the error stream.
setErrStream(OutputStream) - Method in class com.jcraft.jsch.ChannelSubsystem
Sets the error stream.
setExtOutputStream(OutputStream) - Method in class com.jcraft.jsch.Channel
Sets the OutputStream for extended data for this channel.
setExtOutputStream(OutputStream, boolean) - Method in class com.jcraft.jsch.Channel
Sets the OutputStream for extended data for this channel.
setFilenameEncoding(String) - Method in class com.jcraft.jsch.ChannelSftp
Sets the encoding used to convert file names from Strings to bytes.
setHost(String) - Method in class com.jcraft.jsch.ChannelDirectTCPIP
Sets the remote host name (or IP address) to connect to (which should be valid at the remote side).
setHost(String) - Method in class com.jcraft.jsch.Session
Sets the host to connect to.
setHostKeyAlias(String) - Method in class com.jcraft.jsch.Session
sets the host key alias used when comparing the host key to the known hosts list.
setHostKeyRepository(HostKeyRepository) - Method in class com.jcraft.jsch.JSch
Sets the Host key repository.
setHostKeyRepository(HostKeyRepository) - Method in class com.jcraft.jsch.Session
Sets the hostkeyRepository, which will be referred in checking host keys.
setIdentityRepository(IdentityRepository) - Method in class com.jcraft.jsch.JSch
Sets the identityRepository, which will be referred in the public key authentication.
setIdentityRepository(IdentityRepository) - Method in class com.jcraft.jsch.Session
Sets the identityRepository, which will be referred in the public key authentication.
setInputStream(InputStream) - Method in class com.jcraft.jsch.Channel
Sets the InputStream for this channel.
setInputStream(InputStream, boolean) - Method in class com.jcraft.jsch.Channel
Sets the InputStream for this channel.
setInputStream(InputStream) - Method in class com.jcraft.jsch.ChannelDirectTCPIP
Sets the InputStream to be forwarded.
setInputStream(InputStream) - Method in class com.jcraft.jsch.Session
(I have no idea what this is for.
setKnownHosts(String) - Method in class com.jcraft.jsch.JSch
Creates a host key repository from a file name.
setKnownHosts(InputStream) - Method in class com.jcraft.jsch.JSch
Creates a Host key repository from an InputStream.
setLogger(Logger) - Static method in class com.jcraft.jsch.JSch
sets the Logger to be used by this library.
setMtime(String, int) - Method in class com.jcraft.jsch.ChannelSftp
sets the modification time of one or several remote files.
setOrgIPAddress(String) - Method in class com.jcraft.jsch.ChannelDirectTCPIP
Sets the local originator IP address we pretend the connection came from.
setOrgPort(int) - Method in class com.jcraft.jsch.ChannelDirectTCPIP
Sets the local originator port number we pretend the connection came from.
setOutputStream(OutputStream) - Method in class com.jcraft.jsch.Channel
Sets the OutputStream for this channel.
setOutputStream(OutputStream, boolean) - Method in class com.jcraft.jsch.Channel
Sets the OutputStream for this channel.
setOutputStream(OutputStream) - Method in class com.jcraft.jsch.ChannelDirectTCPIP
Sets the OutputStream to be forwarded.
setOutputStream(OutputStream) - Method in class com.jcraft.jsch.Session
(I have no idea what this is for.
setPassphrase(byte[]) - Method in interface com.jcraft.jsch.Identity
Provides a passphrase to decrypt the private key.
setPassword(String) - Method in class com.jcraft.jsch.Session
sets the password to use for authentication.
setPassword(byte[]) - Method in class com.jcraft.jsch.Session
sets the password to use for authentication.
setPERMISSIONS(int) - Method in class com.jcraft.jsch.SftpATTRS
sets the file permissions.
setPort(int) - Method in class com.jcraft.jsch.ChannelDirectTCPIP
Sets the remote port number to connect to.
setPort(int) - Method in class com.jcraft.jsch.Session
Sets the port on the server to connect to.
setPortForwardingL(int, String, int) - Method in class com.jcraft.jsch.Session
Registers the local port forwarding for loop-back interface.
setPortForwardingL(String, int, String, int) - Method in class com.jcraft.jsch.Session
Registers the local port forwarding.
setPortForwardingL(String, int, String, int, ServerSocketFactory) - Method in class com.jcraft.jsch.Session
Registers the local port forwarding.
setPortForwardingL(String, int, String, int, ServerSocketFactory, int) - Method in class com.jcraft.jsch.Session
Registers the local port forwarding.
setPortForwardingL(String) - Method in class com.jcraft.jsch.Session
Registers the local port forwarding.
setPortForwardingR(int, String, int) - Method in class com.jcraft.jsch.Session
Registers the remote port forwarding for the loopback interface of the remote.
setPortForwardingR(String, int, String, int) - Method in class com.jcraft.jsch.Session
Registers the remote port forwarding.
setPortForwardingR(int, String, int, SocketFactory) - Method in class com.jcraft.jsch.Session
Registers the remote port forwarding for the loopback interface of the remote.
setPortForwardingR(String, int, String, int, SocketFactory) - Method in class com.jcraft.jsch.Session
Registers the remote port forwarding.
setPortForwardingR(int, String) - Method in class com.jcraft.jsch.Session
Registers the remote port forwarding for the loopback interface of the remote.
setPortForwardingR(int, String, Object[]) - Method in class com.jcraft.jsch.Session
Registers the remote port forwarding for the loopback interface of the remote.
setPortForwardingR(String, int, String, Object[]) - Method in class com.jcraft.jsch.Session
Registers the remote port forwarding.
setPortForwardingR(String) - Method in class com.jcraft.jsch.Session
Registers the remote port forwarding.
setProxy(Proxy) - Method in class com.jcraft.jsch.Session
Sets the proxy property.
setPty(boolean) - Method in class com.jcraft.jsch.ChannelSubsystem
 
setServerAliveCountMax(int) - Method in class com.jcraft.jsch.Session
Sets the number of keep-alive messages which may be sent without receiving any messages back from the server.
setServerAliveInterval(int) - Method in class com.jcraft.jsch.Session
sets the server alive interval property.
setSIZE(long) - Method in class com.jcraft.jsch.SftpATTRS
sets the size.
setSocketFactory(SocketFactory) - Method in class com.jcraft.jsch.Session
sets the socket factory.
setStat(String, SftpATTRS) - Method in class com.jcraft.jsch.ChannelSftp
Changes attributes of a remote file or directory.
setSubsystem(String) - Method in class com.jcraft.jsch.ChannelSubsystem
Sets the name of the remote subsystem name.
setTimeout(int) - Method in class com.jcraft.jsch.Session
sets the timeout setting.
setUIDGID(int, int) - Method in class com.jcraft.jsch.SftpATTRS
Sets user and group Identifier.
setUserInfo(UserInfo) - Method in class com.jcraft.jsch.Session
Sets the userInfo property.
setUserPasswd(String, String) - Method in class com.jcraft.jsch.ProxyHTTP
Sets the user name and password needed for authentication to the proxy.
setUserPasswd(String, String) - Method in class com.jcraft.jsch.ProxySOCKS4
Sets the user name and password needed for authentication to the proxy.
setUserPasswd(String, String) - Method in class com.jcraft.jsch.ProxySOCKS5
Sets the user name and password needed for authentication to the proxy.
setWantReply(boolean) - Method in class com.jcraft.jsch.ChannelSubsystem
Indicates whether we want a confirmation/error reply to this request.
setX11Cookie(String) - Method in class com.jcraft.jsch.Session
sets the X11 cookie necessary to access the local X11 server.
setX11Host(String) - Method in class com.jcraft.jsch.Session
sets the host (on the local side) where the X11 server (whose display we want to forward) can be found.
setX11Port(int) - Method in class com.jcraft.jsch.Session
sets the port (on the local side) where the X11 server (whose display we want to forward) can be found.
setXForwarding(boolean) - Method in class com.jcraft.jsch.Channel
Enables or disables X forwarding for this channel.
setXForwarding(boolean) - Method in class com.jcraft.jsch.ChannelSubsystem
 
SftpATTRS - Class in com.jcraft.jsch
Attributes of a (remote) file manipulated via Sftp.
SftpException - Exception in com.jcraft.jsch
This exception will be thrown if anything goes wrong while using the SFTP protocol.
SftpException(int, String) - Constructor for exception com.jcraft.jsch.SftpException
Creates a new SftpException.
SftpException(int, String, Throwable) - Constructor for exception com.jcraft.jsch.SftpException
Creates a new SftpException.
SftpProgressMonitor - Interface in com.jcraft.jsch
A callback to get information about the progress of a file transfer operation.
showMessage(String) - Method in interface com.jcraft.jsch.UserInfo
Shows an informational message to the user.
SocketFactory - Interface in com.jcraft.jsch
A factory for (client) sockets.
SSH_FILEXFER_ATTR_ACMODTIME - Static variable in class com.jcraft.jsch.SftpATTRS
Flag indicating the presence of the atime and mtime attributes.
SSH_FILEXFER_ATTR_EXTENDED - Static variable in class com.jcraft.jsch.SftpATTRS
Flag indicating the presence of extended attributes.
SSH_FILEXFER_ATTR_PERMISSIONS - Static variable in class com.jcraft.jsch.SftpATTRS
Flag indicating the presence of the permissions attribute.
SSH_FILEXFER_ATTR_SIZE - Static variable in class com.jcraft.jsch.SftpATTRS
Flag indicating the presence of the size attribute.
SSH_FILEXFER_ATTR_UIDGID - Static variable in class com.jcraft.jsch.SftpATTRS
Flag indicating the presence of the uid and gid attributes.
SSH_FX_BAD_MESSAGE - Static variable in class com.jcraft.jsch.ChannelSftp
 
SSH_FX_CONNECTION_LOST - Static variable in class com.jcraft.jsch.ChannelSftp
 
SSH_FX_EOF - Static variable in class com.jcraft.jsch.ChannelSftp
 
SSH_FX_FAILURE - Static variable in class com.jcraft.jsch.ChannelSftp
 
SSH_FX_NO_CONNECTION - Static variable in class com.jcraft.jsch.ChannelSftp
 
SSH_FX_NO_SUCH_FILE - Static variable in class com.jcraft.jsch.ChannelSftp
 
SSH_FX_OK - Static variable in class com.jcraft.jsch.ChannelSftp
 
SSH_FX_OP_UNSUPPORTED - Static variable in class com.jcraft.jsch.ChannelSftp
 
SSH_FX_PERMISSION_DENIED - Static variable in class com.jcraft.jsch.ChannelSftp
 
SSHDSS - Static variable in class com.jcraft.jsch.HostKey
Type constant for a DSS key.
SSHRSA - Static variable in class com.jcraft.jsch.HostKey
Type constant for a DSA key.
start() - Method in class com.jcraft.jsch.Channel
Not to be called externally.
start() - Method in class com.jcraft.jsch.ChannelExec
 
start() - Method in class com.jcraft.jsch.ChannelSftp
 
start() - Method in class com.jcraft.jsch.ChannelShell
 
start() - Method in class com.jcraft.jsch.ChannelSubsystem
 
stat(String) - Method in class com.jcraft.jsch.ChannelSftp
Retrieves the file attributes of a file or directory.
statVFS(String) - Method in class com.jcraft.jsch.ChannelSftp
 
symlink(String, String) - Method in class com.jcraft.jsch.ChannelSftp
Creates a new symbolic link.

T

toString() - Method in class com.jcraft.jsch.ChannelSftp.LsEntry
toString simply returns the longname.
toString() - Method in class com.jcraft.jsch.SftpATTRS
creates a string representation of this object.
toString() - Method in exception com.jcraft.jsch.SftpException
returns a String representation of this exception.
type - Variable in class com.jcraft.jsch.Channel
 
type - Variable in class com.jcraft.jsch.HostKey
the type of this key.

U

UIKeyboardInteractive - Interface in com.jcraft.jsch
Provides a way to prompt the user for keyboard-interactive authentication.
UNAVAILABLE - Static variable in interface com.jcraft.jsch.IdentityRepository
 
UNKNOWN_SIZE - Static variable in interface com.jcraft.jsch.SftpProgressMonitor
 
UserInfo - Interface in com.jcraft.jsch
Allows user interaction.

V

version() - Method in class com.jcraft.jsch.ChannelSftp
returns the protocol version number supported by this client.
VERSION - Static variable in class com.jcraft.jsch.JSch
The version number.

W

WARN - Static variable in interface com.jcraft.jsch.Logger
Log level constant: the middle level, a warning.
write(Packet) - Method in class com.jcraft.jsch.Session
Not to be used from outside - Writes a packet.

_

_put(InputStream, String, SftpProgressMonitor, int) - Method in class com.jcraft.jsch.ChannelSftp
Not for external use.
A B C D E F G H I J K L M N O P Q R S T U V W _ 
Skip navigation links

This is a simplified version of the inofficial Javadoc created by PaĆ­lo Ebermann. Have a look at the official homepage.