diff --git a/index.html b/index.html index 2b41e4ba..38cfa5db 100644 --- a/index.html +++ b/index.html @@ -9,6 +9,7 @@

javadoc

A good entry point is net.schmizz.sshj.SSHClient

diff --git a/javadoc/0.4.1/allclasses-frame.html b/javadoc/0.4.1/allclasses-frame.html new file mode 100644 index 00000000..b4572ba1 --- /dev/null +++ b/javadoc/0.4.1/allclasses-frame.html @@ -0,0 +1,480 @@ + + + + + + + +All Classes (sshj 0.4.1 API) + + + + + + + + + + + +All Classes +
+ + + + + +
AbstractAuthMethod +
+AbstractChannel +
+AbstractDHG +
+AbstractDirectChannel +
+AbstractFileTransfer +
+AbstractForwardedChannel +
+AbstractForwardedChannelOpener +
+AbstractService +
+AbstractSignature +
+AccountResource +
+AES128CBC +
+AES128CBC.Factory +
+AES128CTR +
+AES128CTR.Factory +
+AES192CBC +
+AES192CBC.Factory +
+AES192CTR +
+AES192CTR.Factory +
+AES256CBC +
+AES256CBC.Factory +
+AES256CTR +
+AES256CTR.Factory +
+AndroidConfig +
+AuthHostbased +
+AuthKeyboardInteractive +
+AuthMethod +
+AuthNone +
+AuthParams +
+AuthPassword +
+AuthPublickey +
+Base64 +
+Base64.InputStream +
+Base64.OutputStream +
+BaseCipher +
+BaseDigest +
+BaseMAC +
+BlowfishCBC +
+BlowfishCBC.Factory +
+BouncyCastleRandom +
+BouncyCastleRandom.Factory +
+Buffer +
+Buffer.BufferException +
+Buffer.PlainBuffer +
+ByteArrayUtils +
+ChallengeResponseProvider +
+Channel +
+Channel.Direct +
+Channel.Forwarded +
+ChannelInputStream +
+ChannelOutputStream +
+Cipher +
+Cipher.Mode +
+Compression +
+Compression.Mode +
+Config +
+ConfigImpl +
+Connection +
+ConnectionException +
+ConnectionImpl +
+ConnectListener +
+ConsoleKnownHostsVerifier +
+DefaultConfig +
+DelayedZlibCompression +
+DelayedZlibCompression.Factory +
+DH +
+DHG1 +
+DHG1.Factory +
+DHG14 +
+DHG14.Factory +
+DHGroupData +
+Digest +
+DisconnectListener +
+DisconnectReason +
+ErrorDeliveryUtil +
+ErrorNotifiable +
+ErrorNotifiable.Util +
+Event +
+ExceptionChainer +
+Exec +
+Factory +
+Factory.Named +
+Factory.Named.Util +
+FileAttributes +
+FileAttributes.Builder +
+FileAttributes.Flag +
+FileKeyProvider +
+FileKeyProvider.Format +
+FileMode +
+FileMode.Type +
+FilePermission +
+FileSystemFile +
+FileTransfer +
+ForwardedChannelOpener +
+HMACMD5 +
+HMACMD5.Factory +
+HMACMD596 +
+HMACMD596.Factory +
+HMACSHA1 +
+HMACSHA1.Factory +
+HMACSHA196 +
+HMACSHA196.Factory +
+HostKeyVerifier +
+InMemoryDestFile +
+InMemorySourceFile +
+IOUtils +
+JCERandom +
+JCERandom.Factory +
+KeyedAuthMethod +
+KeyExchange +
+KeyPairWrapper +
+KeyProvider +
+KeyProviderUtil +
+KeyType +
+LocalDestFile +
+LocalFileFilter +
+LocalPF +
+LocalPortForwarder +
+LocalSourceFile +
+LoggingTransferListener +
+MAC +
+MD5 +
+MD5.Factory +
+Message +
+NegotiatedAlgorithms +
+NoneCipher +
+NoneCipher.Factory +
+NoneCompression +
+NoneCompression.Factory +
+OpenFailException +
+OpenFailException.Reason +
+OpenMode +
+OpenSSHKeyFile +
+OpenSSHKeyFile.Factory +
+OpenSSHKnownHosts +
+OpenSSHKnownHosts.Entry +
+OpenSSHKnownHosts.HashedEntry +
+OpenSSHKnownHosts.SimpleEntry +
+PacketReader +
+PacketType +
+PasswordFinder +
+PasswordResponseProvider +
+PasswordUtils +
+PathComponents +
+PathHelper +
+PKCS8KeyFile +
+PKCS8KeyFile.Factory +
+PrivateKeyFileResource +
+PrivateKeyStringResource +
+PromiscuousVerifier +
+Promise +
+PTYMode +
+Random +
+RandomAccessRemoteFile +
+Reader +
+RemoteDirectory +
+RemoteFile +
+RemotePF +
+RemotePortForwarder +
+RemotePortForwarder.Forward +
+RemotePortForwarder.ForwardedTCPIPChannel +
+RemoteResource +
+RemoteResourceFilter +
+RemoteResourceInfo +
+Request +
+Requester +
+Resource +
+Response +
+Response.StatusCode +
+SCPDownload +
+SCPDownloadClient +
+SCPException +
+SCPFileTransfer +
+SCPUpload +
+SCPUploadClient +
+SecurityUtils +
+Service +
+Session +
+Session.Command +
+Session.Shell +
+Session.Subsystem +
+SessionChannel +
+SessionFactory +
+SFTPClient +
+SFTPDownload +
+SFTPEngine +
+SFTPException +
+SFTPFileTransfer +
+SFTPPacket +
+SFTPUpload +
+SHA1 +
+SHA1.Factory +
+Signal +
+Signature +
+SignatureDSA +
+SignatureDSA.Factory +
+SignatureRSA +
+SignatureRSA.Factory +
+SingletonRandomFactory +
+SocketForwardingConnectListener +
+SocketStreamCopyMonitor +
+SSHClient +
+SSHException +
+SSHPacket +
+SSHPacketHandler +
+SSHRuntimeException +
+StatefulSFTPClient +
+StreamCopier +
+StreamCopier.Listener +
+TransferListener +
+Transport +
+TransportException +
+TransportImpl +
+TripleDESCBC +
+TripleDESCBC.Factory +
+UserAuth +
+UserAuthException +
+UserAuthImpl +
+Window +
+Window.Local +
+Window.Remote +
+X11 +
+X11Forwarder +
+X11Forwarder.X11Channel +
+ZlibCompression +
+ZlibCompression.Factory +
+
+ + + diff --git a/javadoc/0.4.1/allclasses-noframe.html b/javadoc/0.4.1/allclasses-noframe.html new file mode 100644 index 00000000..eb800dff --- /dev/null +++ b/javadoc/0.4.1/allclasses-noframe.html @@ -0,0 +1,480 @@ + + + + + + + +All Classes (sshj 0.4.1 API) + + + + + + + + + + + +All Classes +
+ + + + + +
AbstractAuthMethod +
+AbstractChannel +
+AbstractDHG +
+AbstractDirectChannel +
+AbstractFileTransfer +
+AbstractForwardedChannel +
+AbstractForwardedChannelOpener +
+AbstractService +
+AbstractSignature +
+AccountResource +
+AES128CBC +
+AES128CBC.Factory +
+AES128CTR +
+AES128CTR.Factory +
+AES192CBC +
+AES192CBC.Factory +
+AES192CTR +
+AES192CTR.Factory +
+AES256CBC +
+AES256CBC.Factory +
+AES256CTR +
+AES256CTR.Factory +
+AndroidConfig +
+AuthHostbased +
+AuthKeyboardInteractive +
+AuthMethod +
+AuthNone +
+AuthParams +
+AuthPassword +
+AuthPublickey +
+Base64 +
+Base64.InputStream +
+Base64.OutputStream +
+BaseCipher +
+BaseDigest +
+BaseMAC +
+BlowfishCBC +
+BlowfishCBC.Factory +
+BouncyCastleRandom +
+BouncyCastleRandom.Factory +
+Buffer +
+Buffer.BufferException +
+Buffer.PlainBuffer +
+ByteArrayUtils +
+ChallengeResponseProvider +
+Channel +
+Channel.Direct +
+Channel.Forwarded +
+ChannelInputStream +
+ChannelOutputStream +
+Cipher +
+Cipher.Mode +
+Compression +
+Compression.Mode +
+Config +
+ConfigImpl +
+Connection +
+ConnectionException +
+ConnectionImpl +
+ConnectListener +
+ConsoleKnownHostsVerifier +
+DefaultConfig +
+DelayedZlibCompression +
+DelayedZlibCompression.Factory +
+DH +
+DHG1 +
+DHG1.Factory +
+DHG14 +
+DHG14.Factory +
+DHGroupData +
+Digest +
+DisconnectListener +
+DisconnectReason +
+ErrorDeliveryUtil +
+ErrorNotifiable +
+ErrorNotifiable.Util +
+Event +
+ExceptionChainer +
+Exec +
+Factory +
+Factory.Named +
+Factory.Named.Util +
+FileAttributes +
+FileAttributes.Builder +
+FileAttributes.Flag +
+FileKeyProvider +
+FileKeyProvider.Format +
+FileMode +
+FileMode.Type +
+FilePermission +
+FileSystemFile +
+FileTransfer +
+ForwardedChannelOpener +
+HMACMD5 +
+HMACMD5.Factory +
+HMACMD596 +
+HMACMD596.Factory +
+HMACSHA1 +
+HMACSHA1.Factory +
+HMACSHA196 +
+HMACSHA196.Factory +
+HostKeyVerifier +
+InMemoryDestFile +
+InMemorySourceFile +
+IOUtils +
+JCERandom +
+JCERandom.Factory +
+KeyedAuthMethod +
+KeyExchange +
+KeyPairWrapper +
+KeyProvider +
+KeyProviderUtil +
+KeyType +
+LocalDestFile +
+LocalFileFilter +
+LocalPF +
+LocalPortForwarder +
+LocalSourceFile +
+LoggingTransferListener +
+MAC +
+MD5 +
+MD5.Factory +
+Message +
+NegotiatedAlgorithms +
+NoneCipher +
+NoneCipher.Factory +
+NoneCompression +
+NoneCompression.Factory +
+OpenFailException +
+OpenFailException.Reason +
+OpenMode +
+OpenSSHKeyFile +
+OpenSSHKeyFile.Factory +
+OpenSSHKnownHosts +
+OpenSSHKnownHosts.Entry +
+OpenSSHKnownHosts.HashedEntry +
+OpenSSHKnownHosts.SimpleEntry +
+PacketReader +
+PacketType +
+PasswordFinder +
+PasswordResponseProvider +
+PasswordUtils +
+PathComponents +
+PathHelper +
+PKCS8KeyFile +
+PKCS8KeyFile.Factory +
+PrivateKeyFileResource +
+PrivateKeyStringResource +
+PromiscuousVerifier +
+Promise +
+PTYMode +
+Random +
+RandomAccessRemoteFile +
+Reader +
+RemoteDirectory +
+RemoteFile +
+RemotePF +
+RemotePortForwarder +
+RemotePortForwarder.Forward +
+RemotePortForwarder.ForwardedTCPIPChannel +
+RemoteResource +
+RemoteResourceFilter +
+RemoteResourceInfo +
+Request +
+Requester +
+Resource +
+Response +
+Response.StatusCode +
+SCPDownload +
+SCPDownloadClient +
+SCPException +
+SCPFileTransfer +
+SCPUpload +
+SCPUploadClient +
+SecurityUtils +
+Service +
+Session +
+Session.Command +
+Session.Shell +
+Session.Subsystem +
+SessionChannel +
+SessionFactory +
+SFTPClient +
+SFTPDownload +
+SFTPEngine +
+SFTPException +
+SFTPFileTransfer +
+SFTPPacket +
+SFTPUpload +
+SHA1 +
+SHA1.Factory +
+Signal +
+Signature +
+SignatureDSA +
+SignatureDSA.Factory +
+SignatureRSA +
+SignatureRSA.Factory +
+SingletonRandomFactory +
+SocketForwardingConnectListener +
+SocketStreamCopyMonitor +
+SSHClient +
+SSHException +
+SSHPacket +
+SSHPacketHandler +
+SSHRuntimeException +
+StatefulSFTPClient +
+StreamCopier +
+StreamCopier.Listener +
+TransferListener +
+Transport +
+TransportException +
+TransportImpl +
+TripleDESCBC +
+TripleDESCBC.Factory +
+UserAuth +
+UserAuthException +
+UserAuthImpl +
+Window +
+Window.Local +
+Window.Remote +
+X11 +
+X11Forwarder +
+X11Forwarder.X11Channel +
+ZlibCompression +
+ZlibCompression.Factory +
+
+ + + diff --git a/javadoc/0.4.1/constant-values.html b/javadoc/0.4.1/constant-values.html new file mode 100644 index 00000000..7c9f6808 --- /dev/null +++ b/javadoc/0.4.1/constant-values.html @@ -0,0 +1,367 @@ + + + + + + + +Constant Field Values (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + +
+ + + + + + + + + + + +
+ +
+ + + +
+
+

+Constant Field Values

+
+
+Contents + + + + + + +
+net.schmizz.*
+ +

+ + + + + + + + + + + + +
net.schmizz.sshj.SSHClient
+public static final intDEFAULT_PORT22
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
net.schmizz.sshj.common.Base64
+public static final intDECODE0
+public static final intDO_BREAK_LINES8
+public static final intENCODE1
+public static final intGZIP2
+public static final intNO_OPTIONS0
+public static final intORDERED32
+public static final intURL_SAFE16
+ +

+ +

+ + + + + + + + + + + + +
net.schmizz.sshj.common.Buffer<T extends Buffer<T>>
+public static final intDEFAULT_SIZE256
+ +

+ +

+ + + + + + + + + + + + +
net.schmizz.sshj.common.SecurityUtils
+public static final StringBOUNCY_CASTLE"BC"
+ +

+ +

+ + + + + + + + + + + + + + + + + +
net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder
+protected static final StringPF_CANCEL"cancel-tcpip-forward"
+protected static final StringPF_REQ"tcpip-forward"
+ +

+ +

+ + + + + + + + + + + + +
net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder.ForwardedTCPIPChannel
+public static final StringTYPE"forwarded-tcpip"
+ +

+ +

+ + + + + + + + + + + + +
net.schmizz.sshj.connection.channel.forwarded.X11Forwarder.X11Channel
+public static final StringTYPE"x11"
+ +

+ +

+ + + + + + + + + + + + +
net.schmizz.sshj.sftp.PathHelper
+public static final StringDEFAULT_PATH_SEPARATOR"/"
+ +

+ +

+ + + + + + + + + + + + + + + + + +
net.schmizz.sshj.sftp.SFTPEngine
+public static final intDEFAULT_TIMEOUT30
+public static final intMAX_SUPPORTED_VERSION3
+ +

+ +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/deprecated-list.html b/javadoc/0.4.1/deprecated-list.html new file mode 100644 index 00000000..57e654a5 --- /dev/null +++ b/javadoc/0.4.1/deprecated-list.html @@ -0,0 +1,177 @@ + + + + + + + +Deprecated List (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Deprecated API

+
+
+Contents + + + + + + + + + + + + + + + + + + +
+Deprecated Methods
net.schmizz.sshj.connection.channel.direct.SessionChannel.getErrorAsString() +
+           
net.schmizz.sshj.connection.channel.direct.Session.Command.getErrorAsString() +
+           
net.schmizz.sshj.connection.channel.direct.SessionChannel.getOutputAsString() +
+           
net.schmizz.sshj.connection.channel.direct.Session.Command.getOutputAsString() +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/examples/Exec.html b/javadoc/0.4.1/examples/Exec.html new file mode 100644 index 00000000..12007785 --- /dev/null +++ b/javadoc/0.4.1/examples/Exec.html @@ -0,0 +1,260 @@ + + + + + + + +Exec (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +examples +
+Class Exec

+
+java.lang.Object
+  extended by examples.Exec
+
+
+
+
public class Exec
extends Object
+ + +

+This examples demonstrates how a remote command can be executed. +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
Exec() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+static voidmain(String... args) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Exec

+
+public Exec()
+
+
+ + + + + + + + +
+Method Detail
+ +

+main

+
+public static void main(String... args)
+                 throws IOException
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/examples/LocalPF.html b/javadoc/0.4.1/examples/LocalPF.html new file mode 100644 index 00000000..ff260260 --- /dev/null +++ b/javadoc/0.4.1/examples/LocalPF.html @@ -0,0 +1,261 @@ + + + + + + + +LocalPF (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +examples +
+Class LocalPF

+
+java.lang.Object
+  extended by examples.LocalPF
+
+
+
+
public class LocalPF
extends Object
+ + +

+This example demonstrates local port forwarding, i.e. when we listen on a particular address and port; and forward + all incoming connections to SSH server which further forwards them to a specified address and port. +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
LocalPF() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+static voidmain(String... args) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+LocalPF

+
+public LocalPF()
+
+
+ + + + + + + + +
+Method Detail
+ +

+main

+
+public static void main(String... args)
+                 throws IOException
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/examples/RemotePF.html b/javadoc/0.4.1/examples/RemotePF.html new file mode 100644 index 00000000..c18c4670 --- /dev/null +++ b/javadoc/0.4.1/examples/RemotePF.html @@ -0,0 +1,261 @@ + + + + + + + +RemotePF (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +examples +
+Class RemotePF

+
+java.lang.Object
+  extended by examples.RemotePF
+
+
+
+
public class RemotePF
extends Object
+ + +

+This example demonstrates remote port forwarding i.e. when the remote host is made to listen on a specific address + and port; and forwards us incoming connections. +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
RemotePF() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+static voidmain(String... args) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+RemotePF

+
+public RemotePF()
+
+
+ + + + + + + + +
+Method Detail
+ +

+main

+
+public static void main(String... args)
+                 throws IOException
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/examples/SCPDownload.html b/javadoc/0.4.1/examples/SCPDownload.html new file mode 100644 index 00000000..ac32da0d --- /dev/null +++ b/javadoc/0.4.1/examples/SCPDownload.html @@ -0,0 +1,260 @@ + + + + + + + +SCPDownload (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +examples +
+Class SCPDownload

+
+java.lang.Object
+  extended by examples.SCPDownload
+
+
+
+
public class SCPDownload
extends Object
+ + +

+This example demonstrates downloading of a file over SCP from the SSH server. +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
SCPDownload() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+static voidmain(String[] args) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SCPDownload

+
+public SCPDownload()
+
+
+ + + + + + + + +
+Method Detail
+ +

+main

+
+public static void main(String[] args)
+                 throws IOException
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/examples/SCPUpload.html b/javadoc/0.4.1/examples/SCPUpload.html new file mode 100644 index 00000000..5df1169c --- /dev/null +++ b/javadoc/0.4.1/examples/SCPUpload.html @@ -0,0 +1,262 @@ + + + + + + + +SCPUpload (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +examples +
+Class SCPUpload

+
+java.lang.Object
+  extended by examples.SCPUpload
+
+
+
+
public class SCPUpload
extends Object
+ + +

+This example demonstrates uploading of a file over SCP to the SSH server. +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
SCPUpload() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+static voidmain(String[] args) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SCPUpload

+
+public SCPUpload()
+
+
+ + + + + + + + +
+Method Detail
+ +

+main

+
+public static void main(String[] args)
+                 throws IOException,
+                        ClassNotFoundException
+
+
+ +
Throws: +
IOException +
ClassNotFoundException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/examples/SFTPDownload.html b/javadoc/0.4.1/examples/SFTPDownload.html new file mode 100644 index 00000000..198394af --- /dev/null +++ b/javadoc/0.4.1/examples/SFTPDownload.html @@ -0,0 +1,260 @@ + + + + + + + +SFTPDownload (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +examples +
+Class SFTPDownload

+
+java.lang.Object
+  extended by examples.SFTPDownload
+
+
+
+
public class SFTPDownload
extends Object
+ + +

+This example demonstrates downloading of a file over SFTP from the SSH server. +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
SFTPDownload() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+static voidmain(String[] args) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SFTPDownload

+
+public SFTPDownload()
+
+
+ + + + + + + + +
+Method Detail
+ +

+main

+
+public static void main(String[] args)
+                 throws IOException
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/examples/SFTPUpload.html b/javadoc/0.4.1/examples/SFTPUpload.html new file mode 100644 index 00000000..bd74cbe3 --- /dev/null +++ b/javadoc/0.4.1/examples/SFTPUpload.html @@ -0,0 +1,260 @@ + + + + + + + +SFTPUpload (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +examples +
+Class SFTPUpload

+
+java.lang.Object
+  extended by examples.SFTPUpload
+
+
+
+
public class SFTPUpload
extends Object
+ + +

+This example demonstrates uploading of a file over SFTP to the SSH server. +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
SFTPUpload() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+static voidmain(String[] args) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SFTPUpload

+
+public SFTPUpload()
+
+
+ + + + + + + + +
+Method Detail
+ +

+main

+
+public static void main(String[] args)
+                 throws IOException
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/examples/X11.html b/javadoc/0.4.1/examples/X11.html new file mode 100644 index 00000000..1140b261 --- /dev/null +++ b/javadoc/0.4.1/examples/X11.html @@ -0,0 +1,262 @@ + + + + + + + +X11 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +examples +
+Class X11

+
+java.lang.Object
+  extended by examples.X11
+
+
+
+
public class X11
extends Object
+ + +

+This example demonstrates how forwarding X11 connections from a remote host can be accomplished. +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
X11() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+static voidmain(String... args) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+X11

+
+public X11()
+
+
+ + + + + + + + +
+Method Detail
+ +

+main

+
+public static void main(String... args)
+                 throws IOException,
+                        InterruptedException
+
+
+ +
Throws: +
IOException +
InterruptedException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/examples/class-use/Exec.html b/javadoc/0.4.1/examples/class-use/Exec.html new file mode 100644 index 00000000..222cd0a7 --- /dev/null +++ b/javadoc/0.4.1/examples/class-use/Exec.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class examples.Exec (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
examples.Exec

+
+No usage of examples.Exec +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/examples/class-use/LocalPF.html b/javadoc/0.4.1/examples/class-use/LocalPF.html new file mode 100644 index 00000000..36fc9db0 --- /dev/null +++ b/javadoc/0.4.1/examples/class-use/LocalPF.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class examples.LocalPF (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
examples.LocalPF

+
+No usage of examples.LocalPF +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/examples/class-use/RemotePF.html b/javadoc/0.4.1/examples/class-use/RemotePF.html new file mode 100644 index 00000000..eb60a15c --- /dev/null +++ b/javadoc/0.4.1/examples/class-use/RemotePF.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class examples.RemotePF (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
examples.RemotePF

+
+No usage of examples.RemotePF +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/examples/class-use/SCPDownload.html b/javadoc/0.4.1/examples/class-use/SCPDownload.html new file mode 100644 index 00000000..30f02355 --- /dev/null +++ b/javadoc/0.4.1/examples/class-use/SCPDownload.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class examples.SCPDownload (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
examples.SCPDownload

+
+No usage of examples.SCPDownload +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/examples/class-use/SCPUpload.html b/javadoc/0.4.1/examples/class-use/SCPUpload.html new file mode 100644 index 00000000..192e5050 --- /dev/null +++ b/javadoc/0.4.1/examples/class-use/SCPUpload.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class examples.SCPUpload (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
examples.SCPUpload

+
+No usage of examples.SCPUpload +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/examples/class-use/SFTPDownload.html b/javadoc/0.4.1/examples/class-use/SFTPDownload.html new file mode 100644 index 00000000..c92b5679 --- /dev/null +++ b/javadoc/0.4.1/examples/class-use/SFTPDownload.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class examples.SFTPDownload (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
examples.SFTPDownload

+
+No usage of examples.SFTPDownload +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/examples/class-use/SFTPUpload.html b/javadoc/0.4.1/examples/class-use/SFTPUpload.html new file mode 100644 index 00000000..c7963d5c --- /dev/null +++ b/javadoc/0.4.1/examples/class-use/SFTPUpload.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class examples.SFTPUpload (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
examples.SFTPUpload

+
+No usage of examples.SFTPUpload +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/examples/class-use/X11.html b/javadoc/0.4.1/examples/class-use/X11.html new file mode 100644 index 00000000..30962403 --- /dev/null +++ b/javadoc/0.4.1/examples/class-use/X11.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class examples.X11 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
examples.X11

+
+No usage of examples.X11 +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/examples/package-frame.html b/javadoc/0.4.1/examples/package-frame.html new file mode 100644 index 00000000..30f81d08 --- /dev/null +++ b/javadoc/0.4.1/examples/package-frame.html @@ -0,0 +1,47 @@ + + + + + + + +examples (sshj 0.4.1 API) + + + + + + + + + + + +examples + + + + +
+Classes  + +
+Exec +
+LocalPF +
+RemotePF +
+SCPDownload +
+SCPUpload +
+SFTPDownload +
+SFTPUpload +
+X11
+ + + + diff --git a/javadoc/0.4.1/examples/package-summary.html b/javadoc/0.4.1/examples/package-summary.html new file mode 100644 index 00000000..01958d6b --- /dev/null +++ b/javadoc/0.4.1/examples/package-summary.html @@ -0,0 +1,186 @@ + + + + + + + +examples (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package examples +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
ExecThis examples demonstrates how a remote command can be executed.
LocalPFThis example demonstrates local port forwarding, i.e.
RemotePFThis example demonstrates remote port forwarding i.e.
SCPDownloadThis example demonstrates downloading of a file over SCP from the SSH server.
SCPUploadThis example demonstrates uploading of a file over SCP to the SSH server.
SFTPDownloadThis example demonstrates downloading of a file over SFTP from the SSH server.
SFTPUploadThis example demonstrates uploading of a file over SFTP to the SSH server.
X11This example demonstrates how forwarding X11 connections from a remote host can be accomplished.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/examples/package-tree.html b/javadoc/0.4.1/examples/package-tree.html new file mode 100644 index 00000000..ceb64bc6 --- /dev/null +++ b/javadoc/0.4.1/examples/package-tree.html @@ -0,0 +1,154 @@ + + + + + + + +examples Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package examples +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/examples/package-use.html b/javadoc/0.4.1/examples/package-use.html new file mode 100644 index 00000000..549f54f1 --- /dev/null +++ b/javadoc/0.4.1/examples/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package examples (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
examples

+
+No usage of examples +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/help-doc.html b/javadoc/0.4.1/help-doc.html new file mode 100644 index 00000000..df1f9df0 --- /dev/null +++ b/javadoc/0.4.1/help-doc.html @@ -0,0 +1,224 @@ + + + + + + + +API Help (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+How This API Document Is Organized

+
+This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

+Overview

+
+ +

+The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

+

+Package

+
+ +

+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

+
+

+Class/Interface

+
+ +

+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+ +

+Annotation Type

+
+ +

+Each annotation type has its own separate page with the following sections:

+
+ +

+Enum

+
+ +

+Each enum has its own separate page with the following sections:

+
+

+Use

+
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+

+Tree (Class Hierarchy)

+
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object. +
+

+Deprecated API

+
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+

+Index

+
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+

+Prev/Next

+These links take you to the next or previous class, interface, package, or related page.

+Frames/No Frames

+These links show and hide the HTML frames. All pages are available with or without frames. +

+

+Serialized Form

+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

+

+Constant Field Values

+The Constant Field Values page lists the static final fields and their values. +

+ + +This help file applies to API documentation generated using the standard doclet. + +
+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/index-all.html b/javadoc/0.4.1/index-all.html new file mode 100644 index 00000000..5ea1d508 --- /dev/null +++ b/javadoc/0.4.1/index-all.html @@ -0,0 +1,4574 @@ + + + + + + + +Index (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A B C D E F G H I J K L M N O P R S T U V W X Z
+

+A

+
+
AbstractAuthMethod - Class in net.schmizz.sshj.userauth.method
This abstract class for AuthMethod implements common or default functionality.
AbstractAuthMethod(String) - +Constructor for class net.schmizz.sshj.userauth.method.AbstractAuthMethod +
  +
AbstractChannel - Class in net.schmizz.sshj.connection.channel
 
AbstractChannel(Connection, String) - +Constructor for class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
AbstractDHG - Class in net.schmizz.sshj.transport.kex
Base class for DHG key exchange algorithms.
AbstractDHG() - +Constructor for class net.schmizz.sshj.transport.kex.AbstractDHG +
  +
AbstractDirectChannel - Class in net.schmizz.sshj.connection.channel.direct
Base class for direct channels whose open is initated by the client.
AbstractDirectChannel(Connection, String) - +Constructor for class net.schmizz.sshj.connection.channel.direct.AbstractDirectChannel +
  +
AbstractFileTransfer - Class in net.schmizz.sshj.xfer
 
AbstractFileTransfer() - +Constructor for class net.schmizz.sshj.xfer.AbstractFileTransfer +
  +
AbstractForwardedChannel - Class in net.schmizz.sshj.connection.channel.forwarded
Base class for forwarded channels whose open is initiated by the server.
AbstractForwardedChannel(Connection, String, int, int, int, String, int) - +Constructor for class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannel +
  +
AbstractForwardedChannelOpener - Class in net.schmizz.sshj.connection.channel.forwarded
Base class for ForwardedChannelOpener's.
AbstractForwardedChannelOpener(String, Connection) - +Constructor for class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannelOpener +
  +
AbstractService - Class in net.schmizz.sshj
An abstract class for Service that implements common or default functionality.
AbstractService(String, Transport) - +Constructor for class net.schmizz.sshj.AbstractService +
  +
AbstractSignature - Class in net.schmizz.sshj.signature
An abstract class for Signature that implements common functionality.
AbstractSignature(String) - +Constructor for class net.schmizz.sshj.signature.AbstractSignature +
  +
accept(RemoteResourceInfo) - +Method in interface net.schmizz.sshj.sftp.RemoteResourceFilter +
  +
accept(LocalSourceFile) - +Method in interface net.schmizz.sshj.xfer.LocalFileFilter +
  +
AccountResource - Class in net.schmizz.sshj.userauth.password
 
AccountResource(String, String) - +Constructor for class net.schmizz.sshj.userauth.password.AccountResource +
  +
addHostKeyVerifier(HostKeyVerifier) - +Method in class net.schmizz.sshj.SSHClient +
Add a HostKeyVerifier which will be invoked for verifying host key during connection establishment and + future key exchanges. +
addHostKeyVerifier(String) - +Method in class net.schmizz.sshj.SSHClient +
Add a HostKeyVerifier that will verify any host that's able to claim a host key with the given fingerprint, e.g. +
addHostKeyVerifier(HostKeyVerifier) - +Method in interface net.schmizz.sshj.transport.Transport +
Adds the specified verifier. +
addHostKeyVerifier(HostKeyVerifier) - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
addr - +Variable in class net.schmizz.sshj.connection.channel.forwarded.SocketForwardingConnectListener +
  +
adjustForParent(String, String) - +Method in class net.schmizz.sshj.sftp.PathHelper +
  +
AES128CBC - Class in net.schmizz.sshj.transport.cipher
aes128-cbc cipher
AES128CBC() - +Constructor for class net.schmizz.sshj.transport.cipher.AES128CBC +
  +
AES128CBC.Factory - Class in net.schmizz.sshj.transport.cipher
Named factory for AES128CBC Cipher
AES128CBC.Factory() - +Constructor for class net.schmizz.sshj.transport.cipher.AES128CBC.Factory +
  +
AES128CTR - Class in net.schmizz.sshj.transport.cipher
aes128-ctr cipher
AES128CTR() - +Constructor for class net.schmizz.sshj.transport.cipher.AES128CTR +
  +
AES128CTR.Factory - Class in net.schmizz.sshj.transport.cipher
Named factory for AES128CBC Cipher
AES128CTR.Factory() - +Constructor for class net.schmizz.sshj.transport.cipher.AES128CTR.Factory +
  +
AES192CBC - Class in net.schmizz.sshj.transport.cipher
aes192-cbc cipher
AES192CBC() - +Constructor for class net.schmizz.sshj.transport.cipher.AES192CBC +
  +
AES192CBC.Factory - Class in net.schmizz.sshj.transport.cipher
Named factory for AES192CBC Cipher
AES192CBC.Factory() - +Constructor for class net.schmizz.sshj.transport.cipher.AES192CBC.Factory +
  +
AES192CTR - Class in net.schmizz.sshj.transport.cipher
aes192-ctr cipher
AES192CTR() - +Constructor for class net.schmizz.sshj.transport.cipher.AES192CTR +
  +
AES192CTR.Factory - Class in net.schmizz.sshj.transport.cipher
Named factory for AES192CTR Cipher
AES192CTR.Factory() - +Constructor for class net.schmizz.sshj.transport.cipher.AES192CTR.Factory +
  +
AES256CBC - Class in net.schmizz.sshj.transport.cipher
aes256-ctr cipher
AES256CBC() - +Constructor for class net.schmizz.sshj.transport.cipher.AES256CBC +
  +
AES256CBC.Factory - Class in net.schmizz.sshj.transport.cipher
Named factory for AES256CBC Cipher
AES256CBC.Factory() - +Constructor for class net.schmizz.sshj.transport.cipher.AES256CBC.Factory +
  +
AES256CTR - Class in net.schmizz.sshj.transport.cipher
aes256-ctr cipher
AES256CTR() - +Constructor for class net.schmizz.sshj.transport.cipher.AES256CTR +
  +
AES256CTR.Factory - Class in net.schmizz.sshj.transport.cipher
Named factory for AES256CBC Cipher
AES256CTR.Factory() - +Constructor for class net.schmizz.sshj.transport.cipher.AES256CTR.Factory +
  +
alertAll(SSHException, ErrorNotifiable...) - +Static method in class net.schmizz.sshj.common.ErrorNotifiable.Util +
Notify all notifiables of given error. +
alertAll(SSHException, Collection<? extends ErrorNotifiable>) - +Static method in class net.schmizz.sshj.common.ErrorNotifiable.Util +
Notify all notifiables of given error. +
alertEvents(Throwable, Event...) - +Static method in class net.schmizz.concurrent.ErrorDeliveryUtil +
  +
alertEvents(Throwable, Collection<? extends Event>) - +Static method in class net.schmizz.concurrent.ErrorDeliveryUtil +
  +
alertPromises(Throwable, Promise...) - +Static method in class net.schmizz.concurrent.ErrorDeliveryUtil +
  +
alertPromises(Throwable, Collection<? extends Promise>) - +Static method in class net.schmizz.concurrent.ErrorDeliveryUtil +
  +
algorithm - +Variable in class net.schmizz.sshj.signature.AbstractSignature +
  +
allocateDefaultPTY() - +Method in interface net.schmizz.sshj.connection.channel.direct.Session +
Allocates a default PTY. +
allocateDefaultPTY() - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
allocatePTY(String, int, int, int, int, Map<PTYMode, Integer>) - +Method in interface net.schmizz.sshj.connection.channel.direct.Session +
Allocate a psuedo-terminal for this session. +
allocatePTY(String, int, int, int, int, Map<PTYMode, Integer>) - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
AndroidConfig - Class in net.schmizz.sshj
 
AndroidConfig() - +Constructor for class net.schmizz.sshj.AndroidConfig +
  +
appliesTo(String) - +Method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.Entry +
  +
appliesTo(String) - +Method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.HashedEntry +
  +
appliesTo(String) - +Method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.SimpleEntry +
  +
array() - +Method in class net.schmizz.sshj.common.Buffer +
  +
atime(String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
attach(Channel) - +Method in interface net.schmizz.sshj.connection.Connection +
Attach a Channel to this connection. +
attach(ForwardedChannelOpener) - +Method in interface net.schmizz.sshj.connection.Connection +
Attach a ForwardedChannelOpener to this connection, which will be delegated opening of any CHANNEL_OPEN packets for which it is responsible. +
attach(Channel) - +Method in class net.schmizz.sshj.connection.ConnectionImpl +
  +
attach(ForwardedChannelOpener) - +Method in class net.schmizz.sshj.connection.ConnectionImpl +
  +
auth - +Variable in class net.schmizz.sshj.SSHClient +
ssh-userauth service +
auth(String, AuthMethod...) - +Method in class net.schmizz.sshj.SSHClient +
Authenticate username using the supplied methods. +
auth(String, Iterable<AuthMethod>) - +Method in class net.schmizz.sshj.SSHClient +
Authenticate username using the supplied methods. +
authenticate(String, Service, Iterable<AuthMethod>) - +Method in interface net.schmizz.sshj.userauth.UserAuth +
Attempt to authenticate username using each of methods in order. +
authenticate(String, Service, Iterable<AuthMethod>) - +Method in class net.schmizz.sshj.userauth.UserAuthImpl +
  +
AuthHostbased - Class in net.schmizz.sshj.userauth.method
Implements the hostbased SSH authentication method.
AuthHostbased(KeyProvider, String, String) - +Constructor for class net.schmizz.sshj.userauth.method.AuthHostbased +
  +
AuthKeyboardInteractive - Class in net.schmizz.sshj.userauth.method
Implements the keyboard-interactive authentication method.
AuthKeyboardInteractive(ChallengeResponseProvider) - +Constructor for class net.schmizz.sshj.userauth.method.AuthKeyboardInteractive +
  +
AuthMethod - Interface in net.schmizz.sshj.userauth.method
An authentication method of the SSH Authentication Protocol.
AuthNone - Class in net.schmizz.sshj.userauth.method
none auth.
AuthNone() - +Constructor for class net.schmizz.sshj.userauth.method.AuthNone +
  +
AuthParams - Interface in net.schmizz.sshj.userauth
The parameters available to authentication methods.
authPassword(String, String) - +Method in class net.schmizz.sshj.SSHClient +
Authenticate username using the "password" authentication method and as a fallback basic + challenge-response authentication. +
authPassword(String, char[]) - +Method in class net.schmizz.sshj.SSHClient +
Authenticate username using the "password" authentication method and as a fallback basic + challenge-response authentication.. +
authPassword(String, PasswordFinder) - +Method in class net.schmizz.sshj.SSHClient +
Authenticate username using the "password" authentication method and as a fallback basic + challenge-response authentication. +
AuthPassword - Class in net.schmizz.sshj.userauth.method
Implements the password authentication method.
AuthPassword(PasswordFinder) - +Constructor for class net.schmizz.sshj.userauth.method.AuthPassword +
  +
authPublickey(String) - +Method in class net.schmizz.sshj.SSHClient +
Authenticate username using the "publickey" authentication method, with keys from some common + locations on the file system. +
authPublickey(String, Iterable<KeyProvider>) - +Method in class net.schmizz.sshj.SSHClient +
Authenticate username using the "publickey" authentication method. +
authPublickey(String, KeyProvider...) - +Method in class net.schmizz.sshj.SSHClient +
Authenticate username using the "publickey" authentication method. +
authPublickey(String, String...) - +Method in class net.schmizz.sshj.SSHClient +
Authenticate username using the "publickey" authentication method, with keys from one or more + locations in the file system. +
AuthPublickey - Class in net.schmizz.sshj.userauth.method
Implements the "publickey" SSH authentication method.
AuthPublickey(KeyProvider) - +Constructor for class net.schmizz.sshj.userauth.method.AuthPublickey +
Initialize this method with the provider for public and private key. +
available() - +Method in class net.schmizz.sshj.common.Buffer +
  +
available() - +Method in class net.schmizz.sshj.connection.channel.ChannelInputStream +
  +
await() - +Method in class net.schmizz.concurrent.Event +
Await this event to have a definite true or false value. +
await(long, TimeUnit) - +Method in class net.schmizz.concurrent.Event +
Await this event to have a definite true or false value, for timeout duration. +
+
+

+B

+
+
Base64 - Class in net.schmizz.sshj.common
Encodes and decodes to and from Base64 notation.
Base64.InputStream - Class in net.schmizz.sshj.common
A Base64.InputStream will read data from another java.io.InputStream, given in the constructor, + and encode/decode to/from Base64 notation on the fly.
Base64.InputStream(InputStream) - +Constructor for class net.schmizz.sshj.common.Base64.InputStream +
Constructs a Base64.InputStream in DECODE mode. +
Base64.InputStream(InputStream, int) - +Constructor for class net.schmizz.sshj.common.Base64.InputStream +
Constructs a Base64.InputStream in either ENCODE or DECODE mode. +
Base64.OutputStream - Class in net.schmizz.sshj.common
A Base64.OutputStream will write data to another java.io.OutputStream, given in the constructor, + and encode/decode to/from Base64 notation on the fly.
Base64.OutputStream(OutputStream) - +Constructor for class net.schmizz.sshj.common.Base64.OutputStream +
Constructs a Base64.OutputStream in ENCODE mode. +
Base64.OutputStream(OutputStream, int) - +Constructor for class net.schmizz.sshj.common.Base64.OutputStream +
Constructs a Base64.OutputStream in either ENCODE or DECODE mode. +
BaseCipher - Class in net.schmizz.sshj.transport.cipher
Base class for all Cipher implementations delegating to the JCE provider.
BaseCipher(int, int, String, String) - +Constructor for class net.schmizz.sshj.transport.cipher.BaseCipher +
  +
BaseDigest - Class in net.schmizz.sshj.transport.digest
Base class for Digest algorithms based on the JCE provider.
BaseDigest(String, int) - +Constructor for class net.schmizz.sshj.transport.digest.BaseDigest +
Create a new digest using the given algorithm and block size. +
BaseMAC - Class in net.schmizz.sshj.transport.mac
Base class for MAC implementations based on the JCE provider.
BaseMAC(String, int, int) - +Constructor for class net.schmizz.sshj.transport.mac.BaseMAC +
  +
bind(RemotePortForwarder.Forward, ConnectListener) - +Method in class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder +
Request forwarding from the remote host on the specified RemotePortForwarder.Forward. +
blankOut(char[]) - +Static method in class net.schmizz.sshj.userauth.password.PasswordUtils +
Blank out a character array +
BlowfishCBC - Class in net.schmizz.sshj.transport.cipher
blowfish-ctr cipher
BlowfishCBC() - +Constructor for class net.schmizz.sshj.transport.cipher.BlowfishCBC +
  +
BlowfishCBC.Factory - Class in net.schmizz.sshj.transport.cipher
Named factory for BlowfishCBC Cipher
BlowfishCBC.Factory() - +Constructor for class net.schmizz.sshj.transport.cipher.BlowfishCBC.Factory +
  +
BOUNCY_CASTLE - +Static variable in class net.schmizz.sshj.common.SecurityUtils +
Identifier for the BouncyCastle JCE provider +
BouncyCastleRandom - Class in net.schmizz.sshj.transport.random
BouncyCastle Random.
BouncyCastleRandom() - +Constructor for class net.schmizz.sshj.transport.random.BouncyCastleRandom +
  +
BouncyCastleRandom.Factory - Class in net.schmizz.sshj.transport.random
Named factory for the BouncyCastle Random
BouncyCastleRandom.Factory() - +Constructor for class net.schmizz.sshj.transport.random.BouncyCastleRandom.Factory +
  +
Buffer<T extends Buffer<T>> - Class in net.schmizz.sshj.common
 
Buffer() - +Constructor for class net.schmizz.sshj.common.Buffer +
  +
Buffer(Buffer<?>) - +Constructor for class net.schmizz.sshj.common.Buffer +
  +
Buffer(byte[]) - +Constructor for class net.schmizz.sshj.common.Buffer +
  +
Buffer(int) - +Constructor for class net.schmizz.sshj.common.Buffer +
  +
Buffer.BufferException - Exception in net.schmizz.sshj.common
 
Buffer.BufferException(String) - +Constructor for exception net.schmizz.sshj.common.Buffer.BufferException +
  +
Buffer.PlainBuffer - Class in net.schmizz.sshj.common
 
Buffer.PlainBuffer() - +Constructor for class net.schmizz.sshj.common.Buffer.PlainBuffer +
  +
Buffer.PlainBuffer(Buffer<?>) - +Constructor for class net.schmizz.sshj.common.Buffer.PlainBuffer +
  +
Buffer.PlainBuffer(byte[]) - +Constructor for class net.schmizz.sshj.common.Buffer.PlainBuffer +
  +
Buffer.PlainBuffer(int) - +Constructor for class net.schmizz.sshj.common.Buffer.PlainBuffer +
  +
bufSize(int) - +Method in class net.schmizz.sshj.common.StreamCopier +
  +
build() - +Method in class net.schmizz.sshj.sftp.FileAttributes.Builder +
  +
buildOpenReq() - +Method in class net.schmizz.sshj.connection.channel.direct.AbstractDirectChannel +
  +
buildReq() - +Method in class net.schmizz.sshj.userauth.method.AbstractAuthMethod +
Builds a SSHPacket containing the fields common to all authentication method. +
buildReq() - +Method in class net.schmizz.sshj.userauth.method.AuthHostbased +
  +
buildReq() - +Method in class net.schmizz.sshj.userauth.method.AuthKeyboardInteractive +
  +
buildReq() - +Method in class net.schmizz.sshj.userauth.method.AuthPassword +
  +
buildReq() - +Method in class net.schmizz.sshj.userauth.method.AuthPublickey +
Builds a feeler request (sans signature). +
ByteArrayUtils - Class in net.schmizz.sshj.common
Utility functions for byte arrays.
ByteArrayUtils() - +Constructor for class net.schmizz.sshj.common.ByteArrayUtils +
  +
+
+

+C

+
+
callListener(ConnectListener, Channel.Forwarded) - +Method in class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannelOpener +
Calls the listener with the new channel in a separate thread. +
cancel(RemotePortForwarder.Forward) - +Method in class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder +
Request cancellation of some forwarding. +
canDoFlowControl() - +Method in interface net.schmizz.sshj.connection.channel.direct.Session.Shell +
Whether the client can do local flow control using control-S and control-Q. +
canDoFlowControl() - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
canonicalize(String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
canonicalize(String) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
canonicalize(String) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
cd(String) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
chain(Throwable) - +Method in interface net.schmizz.concurrent.ExceptionChainer +
  +
chainer - +Static variable in exception net.schmizz.sshj.common.SSHException +
  +
chainer - +Static variable in exception net.schmizz.sshj.connection.ConnectionException +
  +
chainer - +Static variable in exception net.schmizz.sshj.sftp.SFTPException +
  +
chainer - +Static variable in exception net.schmizz.sshj.transport.TransportException +
  +
chainer - +Static variable in exception net.schmizz.sshj.userauth.UserAuthException +
  +
ChallengeResponseProvider - Interface in net.schmizz.sshj.userauth.method
 
changeWindowDimensions(int, int, int, int) - +Method in interface net.schmizz.sshj.connection.channel.direct.Session.Shell +
Sends a window dimension change message. +
changeWindowDimensions(int, int, int, int) - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
Channel - Interface in net.schmizz.sshj.connection.channel
A channel is the basic medium for application-layer data on top of an SSH transport.
Channel.Direct - Interface in net.schmizz.sshj.connection.channel
Direct channels are those that are initiated by us.
Channel.Forwarded - Interface in net.schmizz.sshj.connection.channel
Forwarded channels are those that are initiated by the server.
ChannelInputStream - Class in net.schmizz.sshj.connection.channel
InputStream for channels.
ChannelInputStream(Channel, Transport, Window.Local) - +Constructor for class net.schmizz.sshj.connection.channel.ChannelInputStream +
  +
ChannelOutputStream - Class in net.schmizz.sshj.connection.channel
OutputStream for channels.
ChannelOutputStream(Channel, Transport, Window.Remote) - +Constructor for class net.schmizz.sshj.connection.channel.ChannelOutputStream +
  +
chanType - +Variable in class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannelOpener +
  +
chgrp(String, int) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
chmod(String, int) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
chown(String, int) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
Cipher - Interface in net.schmizz.sshj.transport.cipher
Wrapper for a cryptographic cipher, used either for encryption or decryption.
Cipher.Mode - Enum in net.schmizz.sshj.transport.cipher
 
clear() - +Method in class net.schmizz.concurrent.Event +
Clear this event. +
clear() - +Method in class net.schmizz.concurrent.Promise +
Clears this promise by setting its value and queued exception to null. +
clear() - +Method in class net.schmizz.sshj.common.Buffer +
Resets this buffer. +
close() - +Method in class net.schmizz.sshj.common.Base64.OutputStream +
Flushes and closes (I think, in the superclass) the stream. +
close - +Variable in class net.schmizz.sshj.connection.channel.AbstractChannel +
Channel close event +
close() - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
close() - +Method in interface net.schmizz.sshj.connection.channel.Channel +
Close this channel. +
close() - +Method in class net.schmizz.sshj.connection.channel.ChannelInputStream +
  +
close() - +Method in class net.schmizz.sshj.connection.channel.ChannelOutputStream +
  +
close() - +Method in class net.schmizz.sshj.sftp.RemoteResource +
  +
close() - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
close() - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
closeAllStreams() - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
Called when all I/O streams should be closed. +
closeAllStreams() - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
closeQuietly(Closeable...) - +Static method in class net.schmizz.sshj.common.IOUtils +
  +
compact() - +Method in class net.schmizz.sshj.common.Buffer +
Compact this SSHPacket +
compress(Buffer) - +Method in interface net.schmizz.sshj.transport.compression.Compression +
Compress the given buffer in place. +
compress(Buffer) - +Method in class net.schmizz.sshj.transport.compression.ZlibCompression +
  +
Compression - Interface in net.schmizz.sshj.transport.compression
Interface used to compress the stream of data between the SSH server and clients.
Compression.Mode - Enum in net.schmizz.sshj.transport.compression
Enum identifying if this object will be used to compress or uncompress data.
computeK(BigInteger) - +Method in class net.schmizz.sshj.transport.kex.DH +
  +
Config - Interface in net.schmizz.sshj
Holds configuration information and factories.
ConfigImpl - Class in net.schmizz.sshj
 
ConfigImpl() - +Constructor for class net.schmizz.sshj.ConfigImpl +
  +
confirm() - +Method in interface net.schmizz.sshj.connection.channel.Channel.Forwarded +
Confirm CHANNEL_OPEN request. +
confirm() - +Method in class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannel +
  +
conn - +Variable in class net.schmizz.sshj.connection.channel.AbstractChannel +
Connection layer +
conn - +Variable in class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannelOpener +
  +
conn - +Variable in class net.schmizz.sshj.SSHClient +
ssh-connection service +
Connection - Interface in net.schmizz.sshj.connection
Connection layer of the SSH protocol.
ConnectionException - Exception in net.schmizz.sshj.connection
Connection-layer exception.
ConnectionException(DisconnectReason) - +Constructor for exception net.schmizz.sshj.connection.ConnectionException +
  +
ConnectionException(DisconnectReason, String) - +Constructor for exception net.schmizz.sshj.connection.ConnectionException +
  +
ConnectionException(DisconnectReason, String, Throwable) - +Constructor for exception net.schmizz.sshj.connection.ConnectionException +
  +
ConnectionException(DisconnectReason, Throwable) - +Constructor for exception net.schmizz.sshj.connection.ConnectionException +
  +
ConnectionException(String) - +Constructor for exception net.schmizz.sshj.connection.ConnectionException +
  +
ConnectionException(String, Throwable) - +Constructor for exception net.schmizz.sshj.connection.ConnectionException +
  +
ConnectionException(Throwable) - +Constructor for exception net.schmizz.sshj.connection.ConnectionException +
  +
ConnectionImpl - Class in net.schmizz.sshj.connection
Connection implementation.
ConnectionImpl(Transport) - +Constructor for class net.schmizz.sshj.connection.ConnectionImpl +
Create with an associated Transport. +
ConnectListener - Interface in net.schmizz.sshj.connection.channel.forwarded
A connect listener is just that: it listens for new forwarded channels and can be delegated charge of them.
ConsoleKnownHostsVerifier - Class in net.schmizz.sshj.transport.verification
 
ConsoleKnownHostsVerifier(File, Console) - +Constructor for class net.schmizz.sshj.transport.verification.ConsoleKnownHostsVerifier +
  +
consume(int) - +Method in class net.schmizz.sshj.connection.channel.Window +
  +
copy() - +Method in class net.schmizz.sshj.common.StreamCopier +
  +
copy(String, LocalDestFile) - +Method in class net.schmizz.sshj.xfer.scp.SCPDownloadClient +
Download a file from sourcePath on the connected host to targetPath locally. +
copy(LocalSourceFile, String) - +Method in class net.schmizz.sshj.xfer.scp.SCPUploadClient +
Upload a local file from localFile to targetPath on the remote host. +
create() - +Method in interface net.schmizz.sshj.common.Factory +
  +
create(List<Factory.Named<T>>, String) - +Static method in class net.schmizz.sshj.common.Factory.Named.Util +
Creates an object by picking a factory from factories that is identified by name from a + list of named factories. +
create() - +Method in class net.schmizz.sshj.signature.SignatureDSA.Factory +
  +
create() - +Method in class net.schmizz.sshj.signature.SignatureRSA.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.cipher.AES128CBC.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.cipher.AES128CTR.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.cipher.AES192CBC.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.cipher.AES192CTR.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.cipher.AES256CBC.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.cipher.AES256CTR.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.cipher.BlowfishCBC.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.cipher.NoneCipher.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.cipher.TripleDESCBC.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.compression.DelayedZlibCompression.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.compression.NoneCompression.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.compression.ZlibCompression.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.digest.MD5.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.digest.SHA1.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.kex.DHG1.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.kex.DHG14.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.mac.HMACMD5.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.mac.HMACMD596.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.mac.HMACSHA1.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.mac.HMACSHA196.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.random.BouncyCastleRandom.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.random.JCERandom.Factory +
  +
create() - +Method in class net.schmizz.sshj.transport.random.SingletonRandomFactory +
  +
create() - +Method in class net.schmizz.sshj.userauth.keyprovider.OpenSSHKeyFile.Factory +
  +
create() - +Method in class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile.Factory +
  +
createOneOff(char[]) - +Static method in class net.schmizz.sshj.userauth.password.PasswordUtils +
  +
+
+

+D

+
+
data - +Variable in class net.schmizz.sshj.common.Buffer +
  +
DECODE - +Static variable in class net.schmizz.sshj.common.Base64 +
Specify decoding in first bit. +
decode(byte[]) - +Static method in class net.schmizz.sshj.common.Base64 +
Low-level access to decoding ASCII characters in the form of a byte array. +
decode(byte[], int, int, int) - +Static method in class net.schmizz.sshj.common.Base64 +
Low-level access to decoding ASCII characters in the form of a byte array. +
decode(String) - +Static method in class net.schmizz.sshj.common.Base64 +
Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it. +
decode(String, int) - +Static method in class net.schmizz.sshj.common.Base64 +
Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it. +
decodeFileToFile(String, String) - +Static method in class net.schmizz.sshj.common.Base64 +
Reads infile and decodes it to outfile. +
decodeFromFile(String) - +Static method in class net.schmizz.sshj.common.Base64 +
Convenience method for reading a base64-encoded file and decoding it. +
decodeToFile(String, String) - +Static method in class net.schmizz.sshj.common.Base64 +
Convenience method for decoding data to a file. +
decodeToObject(String) - +Static method in class net.schmizz.sshj.common.Base64 +
Attempts to decode Base64 data and deserialize a Java Object within. +
DEFAULT_PATH_SEPARATOR - +Static variable in class net.schmizz.sshj.sftp.PathHelper +
  +
DEFAULT_PORT - +Static variable in class net.schmizz.sshj.SSHClient +
Default port for SSH +
DEFAULT_SIZE - +Static variable in class net.schmizz.sshj.common.Buffer +
The default size for a Buffer (256 bytes) +
DEFAULT_TIMEOUT - +Static variable in class net.schmizz.sshj.sftp.SFTPEngine +
  +
DefaultConfig - Class in net.schmizz.sshj
A Config that is initialized as follows.
DefaultConfig() - +Constructor for class net.schmizz.sshj.DefaultConfig +
  +
DelayedZlibCompression - Class in net.schmizz.sshj.transport.compression
ZLib delayed compression.
DelayedZlibCompression() - +Constructor for class net.schmizz.sshj.transport.compression.DelayedZlibCompression +
  +
DelayedZlibCompression.Factory - Class in net.schmizz.sshj.transport.compression
Named factory for the ZLib Delayed Compression.
DelayedZlibCompression.Factory() - +Constructor for class net.schmizz.sshj.transport.compression.DelayedZlibCompression.Factory +
  +
deliver(V) - +Method in class net.schmizz.concurrent.Promise +
Set this promise's value to val. +
deliverError(Throwable) - +Method in class net.schmizz.concurrent.Event +
Deliver the error t (after chaining) to any present or future waiters. +
deliverError(Throwable) - +Method in class net.schmizz.concurrent.Promise +
Queues error that will be thrown in any waiting thread or any thread that attempts to wait on this promise + hereafter. +
detectKeyFileFormat(File) - +Static method in class net.schmizz.sshj.userauth.keyprovider.KeyProviderUtil +
Attempts to detect how a key file is encoded. +
detectKeyFileFormat(String, boolean) - +Static method in class net.schmizz.sshj.userauth.keyprovider.KeyProviderUtil +
Attempts to detect how a key file is encoded. +
detectSSHDir() - +Static method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts +
  +
DH - Class in net.schmizz.sshj.transport.kex
Diffie-Hellman key generator.
DH() - +Constructor for class net.schmizz.sshj.transport.kex.DH +
  +
DHG1 - Class in net.schmizz.sshj.transport.kex
Diffie-Hellman key exchange with SHA-1 and Oakley Group 2 [RFC2409] (1024-bit MODP Group).
DHG1() - +Constructor for class net.schmizz.sshj.transport.kex.DHG1 +
  +
DHG1.Factory - Class in net.schmizz.sshj.transport.kex
Named factory for DHG1 key exchange
DHG1.Factory() - +Constructor for class net.schmizz.sshj.transport.kex.DHG1.Factory +
  +
DHG14 - Class in net.schmizz.sshj.transport.kex
Diffie-Hellman key exchange with SHA-1 and Oakley Group 14 [RFC3526] (2048-bit MODP Group).
DHG14() - +Constructor for class net.schmizz.sshj.transport.kex.DHG14 +
  +
DHG14.Factory - Class in net.schmizz.sshj.transport.kex
Named factory for DHG14 key exchange
DHG14.Factory() - +Constructor for class net.schmizz.sshj.transport.kex.DHG14.Factory +
  +
DHGroupData - Class in net.schmizz.sshj.transport.kex
Simple class holding the data for DH group key exchanges.
DHGroupData() - +Constructor for class net.schmizz.sshj.transport.kex.DHGroupData +
  +
digest() - +Method in class net.schmizz.sshj.transport.digest.BaseDigest +
  +
Digest - Interface in net.schmizz.sshj.transport.digest
Interface used to compute digests, based on algorithms such as MD5 or SHA1.
digest() - +Method in interface net.schmizz.sshj.transport.digest.Digest +
  +
disconnect() - +Method in class net.schmizz.sshj.SSHClient +
Disconnects from the connected SSH server. +
disconnect() - +Method in interface net.schmizz.sshj.transport.Transport +
Send a disconnection packet with reason as DisconnectReason.BY_APPLICATION, and closes this transport. +
disconnect(DisconnectReason) - +Method in interface net.schmizz.sshj.transport.Transport +
Send a disconnect packet with the given reason, and closes this transport. +
disconnect(DisconnectReason, String) - +Method in interface net.schmizz.sshj.transport.Transport +
Send a disconnect packet with the given reason and message, and closes this + transport. +
disconnect() - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
disconnect(DisconnectReason) - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
disconnect(DisconnectReason, String) - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
DisconnectListener - Interface in net.schmizz.sshj.transport
 
DisconnectReason - Enum in net.schmizz.sshj.common
Disconnect error codes
DO_BREAK_LINES - +Static variable in class net.schmizz.sshj.common.Base64 +
Do break lines when encoding. +
doFinal() - +Method in class net.schmizz.sshj.transport.mac.BaseMAC +
  +
doFinal(byte[]) - +Method in class net.schmizz.sshj.transport.mac.BaseMAC +
  +
doFinal(byte[], int) - +Method in class net.schmizz.sshj.transport.mac.BaseMAC +
  +
doFinal() - +Method in interface net.schmizz.sshj.transport.mac.MAC +
  +
doFinal(byte[]) - +Method in interface net.schmizz.sshj.transport.mac.MAC +
  +
doFinal(byte[], int) - +Method in interface net.schmizz.sshj.transport.mac.MAC +
  +
doKex() - +Method in class net.schmizz.sshj.SSHClient +
Do key exchange. +
doKex() - +Method in interface net.schmizz.sshj.transport.Transport +
Do key exchange and algorithm negotiation. +
doKex() - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
doRequest(Request) - +Method in interface net.schmizz.sshj.sftp.Requester +
  +
doRequest(Request) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
download(String, String) - +Method in class net.schmizz.sshj.sftp.SFTPFileTransfer +
  +
download(String, LocalDestFile) - +Method in class net.schmizz.sshj.sftp.SFTPFileTransfer +
  +
download(String, String) - +Method in interface net.schmizz.sshj.xfer.FileTransfer +
  +
download(String, LocalDestFile) - +Method in interface net.schmizz.sshj.xfer.FileTransfer +
  +
download(String, String) - +Method in class net.schmizz.sshj.xfer.scp.SCPFileTransfer +
  +
download(String, LocalDestFile) - +Method in class net.schmizz.sshj.xfer.scp.SCPFileTransfer +
  +
+
+

+E

+
+
EMPTY - +Static variable in class net.schmizz.sshj.sftp.FileAttributes +
  +
ENCODE - +Static variable in class net.schmizz.sshj.common.Base64 +
Specify encoding in first bit. +
encode(ByteBuffer, ByteBuffer) - +Static method in class net.schmizz.sshj.common.Base64 +
Performs Base64 encoding on the raw ByteBuffer, writing it to the encoded ByteBuffer. +
encode(ByteBuffer, CharBuffer) - +Static method in class net.schmizz.sshj.common.Base64 +
Performs Base64 encoding on the raw ByteBuffer, writing it to the encoded CharBuffer. +
encode(Map<PTYMode, Integer>) - +Static method in enum net.schmizz.sshj.connection.channel.direct.PTYMode +
  +
encodeBytes(byte[]) - +Static method in class net.schmizz.sshj.common.Base64 +
Encodes a byte array into Base64 notation. +
encodeBytes(byte[], int) - +Static method in class net.schmizz.sshj.common.Base64 +
Encodes a byte array into Base64 notation. +
encodeBytes(byte[], int, int) - +Static method in class net.schmizz.sshj.common.Base64 +
Encodes a byte array into Base64 notation. +
encodeBytes(byte[], int, int, int) - +Static method in class net.schmizz.sshj.common.Base64 +
Encodes a byte array into Base64 notation. +
encodeBytesToBytes(byte[]) - +Static method in class net.schmizz.sshj.common.Base64 +
Similar to Base64.encodeBytes(byte[]) but returns a byte array instead of instantiating a String. +
encodeBytesToBytes(byte[], int, int, int) - +Static method in class net.schmizz.sshj.common.Base64 +
Similar to Base64.encodeBytes(byte[], int, int, int) but returns a byte array instead of instantiating a + String. +
encodeFileToFile(String, String) - +Static method in class net.schmizz.sshj.common.Base64 +
Reads infile and encodes it to outfile. +
encodeFromFile(String) - +Static method in class net.schmizz.sshj.common.Base64 +
Convenience method for reading a binary file and base64-encoding it. +
encodeObject(Serializable) - +Static method in class net.schmizz.sshj.common.Base64 +
Serializes an object and returns the Base64-encoded version of that serialized object. +
encodeObject(Serializable, int) - +Static method in class net.schmizz.sshj.common.Base64 +
Serializes an object and returns the Base64-encoded version of that serialized object. +
encodeToFile(byte[], String) - +Static method in class net.schmizz.sshj.common.Base64 +
Convenience method for encoding data to a file. +
engine - +Variable in class net.schmizz.sshj.sftp.SFTPClient +
  +
ensureAvailable(int) - +Method in class net.schmizz.sshj.common.Buffer +
  +
ensureCapacity(int) - +Method in class net.schmizz.sshj.common.Buffer +
  +
ensurePacketTypeIs(PacketType) - +Method in class net.schmizz.sshj.sftp.Response +
  +
ensureStatusIs(Response.StatusCode) - +Method in class net.schmizz.sshj.sftp.Response +
  +
ensureStatusPacketIsOK() - +Method in class net.schmizz.sshj.sftp.Response +
  +
entries - +Variable in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts +
  +
entries() - +Method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts +
  +
eof() - +Method in class net.schmizz.sshj.connection.channel.ChannelInputStream +
  +
eofInputStreams() - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
Called when EOF has been received. +
eofInputStreams() - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
equals(byte[], int, byte[], int, int) - +Static method in class net.schmizz.sshj.common.ByteArrayUtils +
Check whether some part or whole of two byte arrays is equal, for length bytes starting at some + offset. +
equals(Object) - +Method in class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder.Forward +
  +
equals(Object) - +Method in class net.schmizz.sshj.sftp.PathComponents +
  +
equals(Object) - +Method in class net.schmizz.sshj.sftp.RemoteResourceInfo +
  +
equals(Object) - +Method in class net.schmizz.sshj.userauth.password.Resource +
  +
equals(Object) - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
error(Response.StatusCode) - +Method in class net.schmizz.sshj.sftp.Response +
  +
ErrorDeliveryUtil - Class in net.schmizz.concurrent
 
ErrorDeliveryUtil() - +Constructor for class net.schmizz.concurrent.ErrorDeliveryUtil +
  +
ErrorNotifiable - Interface in net.schmizz.sshj.common
API for classes that are capable of being notified on an error so they can cleanup.
ErrorNotifiable.Util - Class in net.schmizz.sshj.common
Utility functions.
ErrorNotifiable.Util() - +Constructor for class net.schmizz.sshj.common.ErrorNotifiable.Util +
  +
Event<T extends Throwable> - Class in net.schmizz.concurrent
An event can be set, cleared, or awaited, similar to Python's threading.event.
Event(String, ExceptionChainer<T>) - +Constructor for class net.schmizz.concurrent.Event +
Creates this event with given name and exception chainer. +
Event(String, ExceptionChainer<T>, ReentrantLock) - +Constructor for class net.schmizz.concurrent.Event +
Creates this event with given name, exception chainer, and associated lock. +
examples - package examples
 
ExceptionChainer<Z extends Throwable> - Interface in net.schmizz.concurrent
Chains an exception to desired type.
Exec - Class in examples
This examples demonstrates how a remote command can be executed.
Exec() - +Constructor for class examples.Exec +
  +
exec(String) - +Method in interface net.schmizz.sshj.connection.channel.direct.Session +
Execute a remote command. +
exec(String) - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
expand(int) - +Method in class net.schmizz.sshj.connection.channel.Window +
  +
expectResponseTo(Request) - +Method in class net.schmizz.sshj.sftp.PacketReader +
  +
extractSig(byte[]) - +Method in class net.schmizz.sshj.signature.AbstractSignature +
  +
+
+

+F

+
+
Factory<T> - Interface in net.schmizz.sshj.common
A basic factory interface.
Factory.Named<T> - Interface in net.schmizz.sshj.common
Inteface for a named factory.
Factory.Named.Util - Class in net.schmizz.sshj.common
Utility functions
Factory.Named.Util() - +Constructor for class net.schmizz.sshj.common.Factory.Named.Util +
  +
fetchAttributes() - +Method in class net.schmizz.sshj.sftp.RemoteFile +
  +
FileAttributes - Class in net.schmizz.sshj.sftp
 
FileAttributes(int, long, int, int, FileMode, long, long, Map<String, String>) - +Constructor for class net.schmizz.sshj.sftp.FileAttributes +
  +
FileAttributes.Builder - Class in net.schmizz.sshj.sftp
 
FileAttributes.Builder() - +Constructor for class net.schmizz.sshj.sftp.FileAttributes.Builder +
  +
FileAttributes.Flag - Enum in net.schmizz.sshj.sftp
 
FileKeyProvider - Interface in net.schmizz.sshj.userauth.keyprovider
A file key provider is initialized with a location of
FileKeyProvider.Format - Enum in net.schmizz.sshj.userauth.keyprovider
 
FileMode - Class in net.schmizz.sshj.sftp
 
FileMode(int) - +Constructor for class net.schmizz.sshj.sftp.FileMode +
  +
FileMode.Type - Enum in net.schmizz.sshj.sftp
 
FilePermission - Enum in net.schmizz.sshj.xfer
 
FileSystemFile - Class in net.schmizz.sshj.xfer
 
FileSystemFile(String) - +Constructor for class net.schmizz.sshj.xfer.FileSystemFile +
  +
FileSystemFile(File) - +Constructor for class net.schmizz.sshj.xfer.FileSystemFile +
  +
FileTransfer - Interface in net.schmizz.sshj.xfer
 
fill(byte[], int, int) - +Method in class net.schmizz.sshj.transport.random.BouncyCastleRandom +
  +
fill(byte[], int, int) - +Method in class net.schmizz.sshj.transport.random.JCERandom +
Fill the given byte-array with random bytes from this PRNG. +
fill(byte[], int, int) - +Method in interface net.schmizz.sshj.transport.random.Random +
Fill part of bytes with random values. +
fill(byte[], int, int) - +Method in class net.schmizz.sshj.transport.random.SingletonRandomFactory +
  +
finishedDir() - +Method in class net.schmizz.sshj.xfer.LoggingTransferListener +
  +
finishedDir() - +Method in interface net.schmizz.sshj.xfer.TransferListener +
  +
finishedFile() - +Method in class net.schmizz.sshj.xfer.LoggingTransferListener +
  +
finishedFile() - +Method in interface net.schmizz.sshj.xfer.TransferListener +
  +
finishOff() - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
flush() - +Method in class net.schmizz.sshj.common.Base64.OutputStream +
Flushes the stream (and the enclosing streams). +
flush() - +Method in class net.schmizz.sshj.connection.channel.ChannelOutputStream +
  +
flushBase64() - +Method in class net.schmizz.sshj.common.Base64.OutputStream +
Method added by PHIL. +
forget(Channel) - +Method in interface net.schmizz.sshj.connection.Connection +
Forget an attached Channel. +
forget(ForwardedChannelOpener) - +Method in interface net.schmizz.sshj.connection.Connection +
Forget an attached ForwardedChannelOpener. +
forget(Channel) - +Method in class net.schmizz.sshj.connection.ConnectionImpl +
  +
forget(ForwardedChannelOpener) - +Method in class net.schmizz.sshj.connection.ConnectionImpl +
  +
ForwardedChannelOpener - Interface in net.schmizz.sshj.connection.channel.forwarded
Takes care of handling SSH_MSG_CHANNEL_OPEN requests for forwarded channels of a specific type.
fromByte(byte) - +Static method in enum net.schmizz.sshj.common.Message +
  +
fromByte(byte) - +Static method in enum net.schmizz.sshj.sftp.PacketType +
  +
fromInt(int) - +Static method in enum net.schmizz.sshj.common.DisconnectReason +
  +
fromInt(int) - +Static method in enum net.schmizz.sshj.connection.channel.OpenFailException.Reason +
  +
fromInt(int) - +Static method in enum net.schmizz.sshj.sftp.Response.StatusCode +
  +
fromKey(Key) - +Static method in enum net.schmizz.sshj.common.KeyType +
  +
fromMask(int) - +Static method in enum net.schmizz.sshj.sftp.FileMode.Type +
  +
fromMask(int) - +Static method in enum net.schmizz.sshj.xfer.FilePermission +
  +
fromString(String) - +Static method in enum net.schmizz.sshj.common.KeyType +
  +
fromString(String) - +Static method in enum net.schmizz.sshj.connection.channel.direct.Signal +
Create from the string representation used when the signal is received as part of an SSH packet. +
+
+

+G

+
+
G - +Static variable in class net.schmizz.sshj.transport.kex.DHGroupData +
  +
geq(int) - +Method in enum net.schmizz.sshj.common.Message +
  +
get(List<Factory.Named<T>>, String) - +Static method in class net.schmizz.sshj.common.Factory.Named.Util +
Retrieve a particular factory as identified by name from a list of named factories. +
get(int) - +Method in interface net.schmizz.sshj.connection.Connection +
  +
get(String) - +Method in interface net.schmizz.sshj.connection.Connection +
  +
get(int) - +Method in class net.schmizz.sshj.connection.ConnectionImpl +
  +
get(String) - +Method in class net.schmizz.sshj.connection.ConnectionImpl +
  +
get() - +Method in enum net.schmizz.sshj.sftp.FileAttributes.Flag +
  +
get(String, String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
get(String, LocalDestFile) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
get(String, String) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
getActiveForwards() - +Method in class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder +
  +
getAddress() - +Method in class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder.Forward +
  +
getAtime() - +Method in class net.schmizz.sshj.sftp.FileAttributes +
  +
getAttributes() - +Method in class net.schmizz.sshj.sftp.RemoteResourceInfo +
  +
getAutoExpand() - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
getAutoExpand() - +Method in interface net.schmizz.sshj.connection.channel.Channel +
  +
getBanner() - +Method in interface net.schmizz.sshj.userauth.UserAuth +
Returns the authentication banner (if any). +
getBanner() - +Method in class net.schmizz.sshj.userauth.UserAuthImpl +
  +
getBlockSize() - +Method in class net.schmizz.sshj.transport.cipher.BaseCipher +
  +
getBlockSize() - +Method in interface net.schmizz.sshj.transport.cipher.Cipher +
  +
getBlockSize() - +Method in class net.schmizz.sshj.transport.cipher.NoneCipher +
  +
getBlockSize() - +Method in class net.schmizz.sshj.transport.digest.BaseDigest +
  +
getBlockSize() - +Method in interface net.schmizz.sshj.transport.digest.Digest +
  +
getBlockSize() - +Method in class net.schmizz.sshj.transport.mac.BaseMAC +
  +
getBlockSize() - +Method in interface net.schmizz.sshj.transport.mac.MAC +
  +
getChannelType() - +Method in class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannelOpener +
  +
getChannelType() - +Method in interface net.schmizz.sshj.connection.channel.forwarded.ForwardedChannelOpener +
Returns the name of the channel type this opener can next. +
getChannelType() - +Method in exception net.schmizz.sshj.connection.channel.OpenFailException +
  +
getChild(String) - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
getChild(String) - +Method in class net.schmizz.sshj.xfer.InMemoryDestFile +
  +
getChild(String) - +Method in interface net.schmizz.sshj.xfer.LocalDestFile +
  +
getChildren(LocalFileFilter) - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
getChildren(LocalFileFilter) - +Method in class net.schmizz.sshj.xfer.InMemorySourceFile +
  +
getChildren(LocalFileFilter) - +Method in interface net.schmizz.sshj.xfer.LocalSourceFile +
  +
getCipher(String) - +Static method in class net.schmizz.sshj.common.SecurityUtils +
  +
getCipherFactories() - +Method in interface net.schmizz.sshj.Config +
Retrieve the list of named factories for Cipher. +
getCipherFactories() - +Method in class net.schmizz.sshj.ConfigImpl +
  +
getClient2ServerCipherAlgorithm() - +Method in class net.schmizz.sshj.transport.NegotiatedAlgorithms +
  +
getClient2ServerCompressionAlgorithm() - +Method in class net.schmizz.sshj.transport.NegotiatedAlgorithms +
  +
getClient2ServerMACAlgorithm() - +Method in class net.schmizz.sshj.transport.NegotiatedAlgorithms +
  +
getClientVersion() - +Method in interface net.schmizz.sshj.transport.Transport +
  +
getClientVersion() - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
getCode() - +Method in enum net.schmizz.sshj.connection.channel.OpenFailException.Reason +
  +
getCompactData() - +Method in class net.schmizz.sshj.common.Buffer +
  +
getComponents(String, String) - +Method in class net.schmizz.sshj.sftp.PathHelper +
  +
getComponents(String) - +Method in class net.schmizz.sshj.sftp.PathHelper +
  +
getCompressionFactories() - +Method in interface net.schmizz.sshj.Config +
Retrieve the list of named factories for Compression. +
getCompressionFactories() - +Method in class net.schmizz.sshj.ConfigImpl +
  +
getConfig() - +Method in interface net.schmizz.sshj.transport.Transport +
  +
getConfig() - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
getConnection() - +Method in class net.schmizz.sshj.SSHClient +
  +
getDetail() - +Method in class net.schmizz.sshj.userauth.password.Resource +
  +
getDisconnectListener() - +Method in interface net.schmizz.sshj.transport.Transport +
  +
getDisconnectListener() - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
getDisconnectReason() - +Method in exception net.schmizz.sshj.common.SSHException +
  +
getDownloadFilter() - +Method in class net.schmizz.sshj.sftp.SFTPFileTransfer +
  +
getE() - +Method in class net.schmizz.sshj.transport.kex.DH +
  +
getErrorAsString() - +Method in interface net.schmizz.sshj.connection.channel.direct.Session.Command +
Deprecated.  +
getErrorAsString() - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
Deprecated.  +
getErrorStream() - +Method in interface net.schmizz.sshj.connection.channel.direct.Session.Command +
Returns the command's stderr stream. +
getErrorStream() - +Method in interface net.schmizz.sshj.connection.channel.direct.Session.Shell +
Returns the shell's stderr stream. +
getErrorStream() - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
getExitErrorMessage() - +Method in interface net.schmizz.sshj.connection.channel.direct.Session.Command +
If the command exit violently with a signal, an error message would have been + received and can be retrieved via this method. +
getExitErrorMessage() - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
getExitSignal() - +Method in interface net.schmizz.sshj.connection.channel.direct.Session.Command +
Returns the signal if the command exit violently, or null if this information was not + received. +
getExitSignal() - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
getExitStatus() - +Method in interface net.schmizz.sshj.connection.channel.direct.Session.Command +
Returns the exit status of the command if it was received, or null if this information was not + received. +
getExitStatus() - +Method in interface net.schmizz.sshj.connection.channel.direct.Session.Subsystem +
  +
getExitStatus() - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
getExitWasCoreDumped() - +Method in interface net.schmizz.sshj.connection.channel.direct.Session.Command +
If the command exit violently with a signal, information about whether a core dump + took place would have been received and can be retrieved via this method. +
getExitWasCoreDumped() - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
getExtended(String) - +Method in class net.schmizz.sshj.sftp.FileAttributes +
  +
getFile() - +Method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts +
  +
getFile() - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
getFileKeyProviderFactories() - +Method in interface net.schmizz.sshj.Config +
Retrieve the list of named factories for FileKeyProvider. +
getFileKeyProviderFactories() - +Method in class net.schmizz.sshj.ConfigImpl +
  +
getFilePointer() - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
getFileTansfer() - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
getFingerprint(PublicKey) - +Static method in class net.schmizz.sshj.common.SecurityUtils +
Computes the fingerprint for a public key, in the standard SSH format, e.g. +
getGID() - +Method in class net.schmizz.sshj.sftp.FileAttributes +
  +
getH() - +Method in class net.schmizz.sshj.transport.kex.AbstractDHG +
  +
getH() - +Method in interface net.schmizz.sshj.transport.kex.KeyExchange +
  +
getHash() - +Method in class net.schmizz.sshj.transport.kex.AbstractDHG +
  +
getHash() - +Method in interface net.schmizz.sshj.transport.kex.KeyExchange +
The message digest used by this key exchange algorithm. +
getHeartbeatInterval() - +Method in interface net.schmizz.sshj.transport.Transport +
  +
getHeartbeatInterval() - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
getHostKey() - +Method in class net.schmizz.sshj.transport.kex.AbstractDHG +
  +
getHostKey() - +Method in interface net.schmizz.sshj.transport.kex.KeyExchange +
  +
getHostPart() - +Method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.Entry +
  +
getHostPart() - +Method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.HashedEntry +
  +
getHostPart() - +Method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.SimpleEntry +
  +
getID() - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
getID() - +Method in interface net.schmizz.sshj.connection.channel.Channel +
  +
getInputStream() - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
getInputStream() - +Method in interface net.schmizz.sshj.connection.channel.Channel +
  +
getInputStream() - +Method in class net.schmizz.sshj.sftp.RemoteFile +
  +
getInputStream() - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
getInputStream() - +Method in interface net.schmizz.sshj.xfer.LocalSourceFile +
  +
getIVSize() - +Method in class net.schmizz.sshj.transport.cipher.BaseCipher +
  +
getIVSize() - +Method in interface net.schmizz.sshj.transport.cipher.Cipher +
  +
getIVSize() - +Method in class net.schmizz.sshj.transport.cipher.NoneCipher +
  +
getK() - +Method in class net.schmizz.sshj.transport.kex.AbstractDHG +
  +
getK() - +Method in class net.schmizz.sshj.transport.kex.DH +
  +
getK() - +Method in interface net.schmizz.sshj.transport.kex.KeyExchange +
  +
getKey() - +Method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.Entry +
  +
getKeyAgreement(String) - +Static method in class net.schmizz.sshj.common.SecurityUtils +
Creates a new instance of KeyAgreement with the given algorithm. +
getKeyExchangeAlgorithm() - +Method in class net.schmizz.sshj.transport.NegotiatedAlgorithms +
  +
getKeyExchangeFactories() - +Method in interface net.schmizz.sshj.Config +
Retrieve the list of named factories for KeyExchange. +
getKeyExchangeFactories() - +Method in class net.schmizz.sshj.ConfigImpl +
  +
getKeyFactory(String) - +Static method in class net.schmizz.sshj.common.SecurityUtils +
Creates a new instance of KeyFactory with the given algorithm. +
getKeyPairGenerator(String) - +Static method in class net.schmizz.sshj.common.SecurityUtils +
Creates a new instance of KeyPairGenerator with the given algorithm. +
getKeyString() - +Method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.Entry +
  +
getLastAccessTime() - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
getLastAccessTime() - +Method in class net.schmizz.sshj.xfer.InMemorySourceFile +
  +
getLastAccessTime() - +Method in interface net.schmizz.sshj.xfer.LocalSourceFile +
Returns last access time for the underlying file. +
getLastModifiedTime() - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
getLastModifiedTime() - +Method in class net.schmizz.sshj.xfer.InMemorySourceFile +
  +
getLastModifiedTime() - +Method in interface net.schmizz.sshj.xfer.LocalSourceFile +
Returns last access time for the underlying file. +
getLength() - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
getLength() - +Method in interface net.schmizz.sshj.xfer.LocalSourceFile +
  +
getLine() - +Method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.Entry +
  +
getListeningAddress() - +Method in class net.schmizz.sshj.connection.channel.direct.LocalPortForwarder +
  +
getLocalMaxPacketSize() - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
getLocalMaxPacketSize() - +Method in interface net.schmizz.sshj.connection.channel.Channel +
  +
getLocalWinSize() - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
getLocalWinSize() - +Method in interface net.schmizz.sshj.connection.channel.Channel +
  +
getMAC(String) - +Static method in class net.schmizz.sshj.common.SecurityUtils +
Create a new instance of Mac with the given algorithm. +
getMACFactories() - +Method in interface net.schmizz.sshj.Config +
Retrieve the list of named factories for MAC. +
getMACFactories() - +Method in class net.schmizz.sshj.ConfigImpl +
  +
getMask() - +Method in class net.schmizz.sshj.sftp.FileMode +
  +
getMaxPacketSize() - +Method in class net.schmizz.sshj.connection.channel.Window +
  +
getMaxPacketSize() - +Method in interface net.schmizz.sshj.connection.Connection +
  +
getMaxPacketSize() - +Method in class net.schmizz.sshj.connection.ConnectionImpl +
  +
getMessage() - +Method in exception net.schmizz.sshj.common.SSHException +
  +
getMessage() - +Method in exception net.schmizz.sshj.connection.channel.OpenFailException +
  +
getMessageDigest(String) - +Static method in class net.schmizz.sshj.common.SecurityUtils +
Create a new instance of MessageDigest with the given algorithm. +
getMode() - +Method in class net.schmizz.sshj.sftp.FileAttributes +
  +
getMtime() - +Method in class net.schmizz.sshj.sftp.FileAttributes +
  +
getName() - +Method in class net.schmizz.sshj.AbstractService +
  +
getName() - +Method in interface net.schmizz.sshj.common.Factory.Named +
  +
getName() - +Method in interface net.schmizz.sshj.Service +
  +
getName() - +Method in class net.schmizz.sshj.sftp.PathComponents +
  +
getName() - +Method in class net.schmizz.sshj.sftp.RemoteResourceInfo +
  +
getName() - +Method in class net.schmizz.sshj.signature.SignatureDSA.Factory +
  +
getName() - +Method in class net.schmizz.sshj.signature.SignatureRSA.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.cipher.AES128CBC.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.cipher.AES128CTR.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.cipher.AES192CBC.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.cipher.AES192CTR.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.cipher.AES256CBC.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.cipher.AES256CTR.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.cipher.BlowfishCBC.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.cipher.NoneCipher.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.cipher.TripleDESCBC.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.compression.DelayedZlibCompression.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.compression.NoneCompression.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.compression.ZlibCompression.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.digest.MD5.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.digest.SHA1.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.kex.DHG1.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.kex.DHG14.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.mac.HMACMD5.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.mac.HMACMD596.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.mac.HMACSHA1.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.mac.HMACSHA196.Factory +
  +
getName() - +Method in class net.schmizz.sshj.transport.random.JCERandom.Factory +
  +
getName() - +Method in class net.schmizz.sshj.userauth.keyprovider.OpenSSHKeyFile.Factory +
  +
getName() - +Method in class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile.Factory +
  +
getName() - +Method in class net.schmizz.sshj.userauth.method.AbstractAuthMethod +
  +
getName() - +Method in interface net.schmizz.sshj.userauth.method.AuthMethod +
  +
getName() - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
getName() - +Method in interface net.schmizz.sshj.xfer.LocalSourceFile +
  +
getNames(List<Factory.Named<T>>) - +Static method in class net.schmizz.sshj.common.Factory.Named.Util +
Get a comma-delimited string containing the factory names from the given list of factories. +
getNextPowerOf2(int) - +Static method in class net.schmizz.sshj.common.Buffer +
  +
getNextServiceName() - +Method in interface net.schmizz.sshj.userauth.AuthParams +
  +
getOpcode() - +Method in enum net.schmizz.sshj.connection.channel.direct.PTYMode +
  +
getOperativeProtocolVersion() - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
getOriginatorIP() - +Method in interface net.schmizz.sshj.connection.channel.Channel.Forwarded +
  +
getOriginatorIP() - +Method in class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannel +
  +
getOriginatorPort() - +Method in interface net.schmizz.sshj.connection.channel.Channel.Forwarded +
  +
getOriginatorPort() - +Method in class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannel +
  +
getOutgoingPacketOverhead() - +Method in class net.schmizz.sshj.sftp.RemoteFile +
  +
getOutputAsString() - +Method in interface net.schmizz.sshj.connection.channel.direct.Session.Command +
Deprecated.  +
getOutputAsString() - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
Deprecated.  +
getOutputStream() - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
getOutputStream() - +Method in interface net.schmizz.sshj.connection.channel.Channel +
  +
getOutputStream() - +Method in class net.schmizz.sshj.sftp.RemoteFile +
  +
getOutputStream() - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
getOutputStream() - +Method in interface net.schmizz.sshj.xfer.LocalDestFile +
  +
getParent() - +Method in class net.schmizz.sshj.sftp.PathComponents +
  +
getParent() - +Method in class net.schmizz.sshj.sftp.RemoteResourceInfo +
  +
getParentForward() - +Method in class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder.ForwardedTCPIPChannel +
  +
getPath() - +Method in class net.schmizz.sshj.sftp.PathComponents +
  +
getPath() - +Method in class net.schmizz.sshj.sftp.RemoteResource +
  +
getPath() - +Method in class net.schmizz.sshj.sftp.RemoteResourceInfo +
  +
getPathHelper() - +Method in interface net.schmizz.sshj.sftp.Requester +
  +
getPathHelper() - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
getPathSeparator() - +Method in class net.schmizz.sshj.sftp.PathHelper +
  +
getPermissions() - +Method in class net.schmizz.sshj.sftp.FileAttributes +
  +
getPermissions() - +Method in class net.schmizz.sshj.sftp.FileMode +
  +
getPermissions() - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
getPermissions() - +Method in class net.schmizz.sshj.xfer.InMemorySourceFile +
  +
getPermissions() - +Method in interface net.schmizz.sshj.xfer.LocalSourceFile +
Returns the permissions for the underlying file +
getPermissionsMask() - +Method in class net.schmizz.sshj.sftp.FileMode +
  +
getPort() - +Method in class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder.Forward +
  +
getPrivate() - +Method in class net.schmizz.sshj.userauth.keyprovider.KeyPairWrapper +
  +
getPrivate() - +Method in interface net.schmizz.sshj.userauth.keyprovider.KeyProvider +
  +
getPrivate() - +Method in class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile +
  +
getProtocolVersion() - +Method in class net.schmizz.sshj.sftp.Response +
  +
getPublic() - +Method in class net.schmizz.sshj.userauth.keyprovider.KeyPairWrapper +
  +
getPublic() - +Method in interface net.schmizz.sshj.userauth.keyprovider.KeyProvider +
  +
getPublic() - +Method in class net.schmizz.sshj.userauth.keyprovider.OpenSSHKeyFile +
  +
getPublic() - +Method in class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile +
  +
getRandomFactory() - +Method in interface net.schmizz.sshj.Config +
Retrieve the Random factory. +
getRandomFactory() - +Method in class net.schmizz.sshj.ConfigImpl +
  +
getReader() - +Method in class net.schmizz.sshj.userauth.password.AccountResource +
  +
getReader() - +Method in class net.schmizz.sshj.userauth.password.PrivateKeyFileResource +
  +
getReader() - +Method in class net.schmizz.sshj.userauth.password.PrivateKeyStringResource +
  +
getReader() - +Method in class net.schmizz.sshj.userauth.password.Resource +
  +
getReason() - +Method in exception net.schmizz.sshj.connection.channel.OpenFailException +
  +
getRecipient() - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
getRecipient() - +Method in interface net.schmizz.sshj.connection.channel.Channel +
  +
getRecursiveMode() - +Method in class net.schmizz.sshj.xfer.scp.SCPDownloadClient +
  +
getRemoteHost() - +Method in interface net.schmizz.sshj.transport.Transport +
  +
getRemoteHost() - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
getRemoteMaxPacketSize() - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
getRemoteMaxPacketSize() - +Method in interface net.schmizz.sshj.connection.channel.Channel +
  +
getRemotePort() - +Method in interface net.schmizz.sshj.transport.Transport +
  +
getRemotePort() - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
getRemotePortForwarder() - +Method in class net.schmizz.sshj.SSHClient +
  +
getRemoteWinSize() - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
getRemoteWinSize() - +Method in interface net.schmizz.sshj.connection.channel.Channel +
  +
getRequestID() - +Method in class net.schmizz.sshj.sftp.Request +
  +
getRequestID() - +Method in class net.schmizz.sshj.sftp.Response +
  +
getResponse(String, boolean) - +Method in interface net.schmizz.sshj.userauth.method.ChallengeResponseProvider +
  +
getResponse(String, boolean) - +Method in class net.schmizz.sshj.userauth.method.PasswordResponseProvider +
  +
getResponsePromise() - +Method in class net.schmizz.sshj.sftp.Request +
  +
getSavedExceptions() - +Method in interface net.schmizz.sshj.userauth.UserAuth +
  +
getSavedExceptions() - +Method in class net.schmizz.sshj.userauth.UserAuthImpl +
  +
getSecurityProvider() - +Static method in class net.schmizz.sshj.common.SecurityUtils +
Get the identifier for the registered security provider. +
getServer2ClientCipherAlgorithm() - +Method in class net.schmizz.sshj.transport.NegotiatedAlgorithms +
  +
getServer2ClientCompressionAlgorithm() - +Method in class net.schmizz.sshj.transport.NegotiatedAlgorithms +
  +
getServer2ClientMACAlgorithm() - +Method in class net.schmizz.sshj.transport.NegotiatedAlgorithms +
  +
getServerVersion() - +Method in interface net.schmizz.sshj.transport.Transport +
Returns the version string as sent by the SSH server for identification purposes, e.g. +
getServerVersion() - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
getService() - +Method in interface net.schmizz.sshj.transport.Transport +
  +
getService() - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
getSessionID() - +Method in interface net.schmizz.sshj.transport.Transport +
  +
getSessionID() - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
getSFTPEngine() - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
getSignature(String) - +Static method in class net.schmizz.sshj.common.SecurityUtils +
  +
getSignatureAlgorithm() - +Method in class net.schmizz.sshj.transport.NegotiatedAlgorithms +
  +
getSignatureFactories() - +Method in interface net.schmizz.sshj.Config +
Retrieve the list of named factories for Signature +
getSignatureFactories() - +Method in class net.schmizz.sshj.ConfigImpl +
  +
getSize() - +Method in class net.schmizz.sshj.connection.channel.Window +
  +
getSize() - +Method in class net.schmizz.sshj.sftp.FileAttributes +
  +
getStatusCode() - +Method in exception net.schmizz.sshj.sftp.SFTPException +
  +
getSubmethods() - +Method in interface net.schmizz.sshj.userauth.method.ChallengeResponseProvider +
  +
getSubmethods() - +Method in class net.schmizz.sshj.userauth.method.PasswordResponseProvider +
  +
getSubsystem() - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
getTargetDirectory(String) - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
getTargetDirectory(String) - +Method in class net.schmizz.sshj.xfer.InMemoryDestFile +
  +
getTargetDirectory(String) - +Method in interface net.schmizz.sshj.xfer.LocalDestFile +
Allows caller to express intent that caller expects to write to directory with dirname. +
getTargetFile(String) - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
getTargetFile(String) - +Method in class net.schmizz.sshj.xfer.InMemoryDestFile +
  +
getTargetFile(String) - +Method in interface net.schmizz.sshj.xfer.LocalDestFile +
Allows caller to express intent that caller expects to write to file with filename. +
getTimeout() - +Method in class net.schmizz.sshj.AbstractService +
  +
getTimeout() - +Method in interface net.schmizz.sshj.connection.Connection +
  +
getTimeout() - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
getTimeout() - +Method in interface net.schmizz.sshj.transport.Transport +
  +
getTimeout() - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
getTimeout() - +Method in interface net.schmizz.sshj.userauth.UserAuth +
  +
getTransferListener() - +Method in class net.schmizz.sshj.xfer.AbstractFileTransfer +
  +
getTransferListener() - +Method in interface net.schmizz.sshj.xfer.FileTransfer +
  +
getTransport() - +Method in interface net.schmizz.sshj.connection.Connection +
  +
getTransport() - +Method in class net.schmizz.sshj.connection.ConnectionImpl +
  +
getTransport() - +Method in class net.schmizz.sshj.SSHClient +
  +
getTransport() - +Method in interface net.schmizz.sshj.userauth.AuthParams +
  +
getType() - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
getType() - +Method in interface net.schmizz.sshj.connection.channel.Channel +
  +
getType() - +Method in class net.schmizz.sshj.sftp.FileAttributes +
  +
getType() - +Method in class net.schmizz.sshj.sftp.FileMode +
  +
getType() - +Method in class net.schmizz.sshj.sftp.Request +
  +
getType() - +Method in class net.schmizz.sshj.sftp.Response +
  +
getType() - +Method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.Entry +
  +
getType() - +Method in class net.schmizz.sshj.userauth.keyprovider.KeyPairWrapper +
  +
getType() - +Method in interface net.schmizz.sshj.userauth.keyprovider.KeyProvider +
  +
getType() - +Method in class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile +
  +
getTypeMask() - +Method in class net.schmizz.sshj.sftp.FileMode +
  +
getUID() - +Method in class net.schmizz.sshj.sftp.FileAttributes +
  +
getUploadFilter() - +Method in class net.schmizz.sshj.sftp.SFTPFileTransfer +
  +
getUserAuth() - +Method in class net.schmizz.sshj.SSHClient +
  +
getUsername() - +Method in interface net.schmizz.sshj.userauth.AuthParams +
  +
getVersion() - +Method in interface net.schmizz.sshj.Config +
Returns the software version information for identification during SSH connection initialization. +
getVersion() - +Method in class net.schmizz.sshj.ConfigImpl +
  +
getWindowSize() - +Method in interface net.schmizz.sshj.connection.Connection +
  +
getWindowSize() - +Method in class net.schmizz.sshj.connection.ConnectionImpl +
  +
gid(String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
gotConnect(Channel.Forwarded) - +Method in interface net.schmizz.sshj.connection.channel.forwarded.ConnectListener +
Notify this listener of a new forwarded channel. +
gotConnect(Channel.Forwarded) - +Method in class net.schmizz.sshj.connection.channel.forwarded.SocketForwardingConnectListener +
On connect, confirm the channel and start forwarding. +
gotExtendedData(SSHPacket) - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
gotExtendedData(SSHPacket) - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
gotUnknown(Message, SSHPacket) - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
gotUnknown(Message, SSHPacket) - +Method in class net.schmizz.sshj.connection.channel.direct.AbstractDirectChannel +
  +
gt(int) - +Method in enum net.schmizz.sshj.common.Message +
  +
GZIP - +Static variable in class net.schmizz.sshj.common.Base64 +
Specify that data should be gzip-compressed in second bit. +
+
+

+H

+
+
hadPartialSuccess() - +Method in interface net.schmizz.sshj.userauth.UserAuth +
  +
hadPartialSuccess() - +Method in class net.schmizz.sshj.userauth.UserAuthImpl +
  +
handle(Message, SSHPacket) - +Method in class net.schmizz.sshj.AbstractService +
  +
handle(Message, SSHPacket) - +Method in interface net.schmizz.sshj.common.SSHPacketHandler +
Delegate handling of some SSH packet to this object. +
handle(Message, SSHPacket) - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
handle(Message, SSHPacket) - +Method in class net.schmizz.sshj.connection.ConnectionImpl +
  +
handle() - +Method in class net.schmizz.sshj.sftp.PacketReader +
  +
handle - +Variable in class net.schmizz.sshj.sftp.RemoteResource +
  +
handle(Message, SSHPacket) - +Method in class net.schmizz.sshj.transport.TransportImpl +
This is where all incoming packets are handled. +
handle(Message, SSHPacket) - +Method in class net.schmizz.sshj.userauth.method.AbstractAuthMethod +
  +
handle(Message, SSHPacket) - +Method in class net.schmizz.sshj.userauth.method.AuthKeyboardInteractive +
  +
handle(Message, SSHPacket) - +Method in class net.schmizz.sshj.userauth.method.AuthPassword +
  +
handle(Message, SSHPacket) - +Method in class net.schmizz.sshj.userauth.method.AuthPublickey +
Internal use. +
handle(Message, SSHPacket) - +Method in class net.schmizz.sshj.userauth.UserAuthImpl +
  +
handleOpen(SSHPacket) - +Method in interface net.schmizz.sshj.connection.channel.forwarded.ForwardedChannelOpener +
Delegates a SSH_MSG_CHANNEL_OPEN request for the channel type claimed by this opener. +
handleOpen(SSHPacket) - +Method in class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder +
Internal API. +
handleOpen(SSHPacket) - +Method in class net.schmizz.sshj.connection.channel.forwarded.X11Forwarder +
Internal API +
handleRequest(String, SSHPacket) - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
handleRequest(String, SSHPacket) - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
has(FileAttributes.Flag) - +Method in class net.schmizz.sshj.sftp.FileAttributes +
  +
hashCode() - +Method in class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder.Forward +
  +
hashCode() - +Method in class net.schmizz.sshj.sftp.PathComponents +
  +
hashCode() - +Method in class net.schmizz.sshj.sftp.RemoteResourceInfo +
  +
hashCode() - +Method in class net.schmizz.sshj.userauth.password.Resource +
  +
hashCode() - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
hasWaiters() - +Method in class net.schmizz.concurrent.Event +
  +
hasWaiters() - +Method in class net.schmizz.concurrent.Promise +
  +
HMACMD5 - Class in net.schmizz.sshj.transport.mac
HMAC-MD5 MAC.
HMACMD5() - +Constructor for class net.schmizz.sshj.transport.mac.HMACMD5 +
  +
HMACMD5.Factory - Class in net.schmizz.sshj.transport.mac
Named factory for the HMACMD5 MAC
HMACMD5.Factory() - +Constructor for class net.schmizz.sshj.transport.mac.HMACMD5.Factory +
  +
HMACMD596 - Class in net.schmizz.sshj.transport.mac
HMAC-MD5-96 MAC
HMACMD596() - +Constructor for class net.schmizz.sshj.transport.mac.HMACMD596 +
  +
HMACMD596.Factory - Class in net.schmizz.sshj.transport.mac
Named factory for the HMAC-MD5-96 MAC
HMACMD596.Factory() - +Constructor for class net.schmizz.sshj.transport.mac.HMACMD596.Factory +
  +
HMACSHA1 - Class in net.schmizz.sshj.transport.mac
HMAC-SHA1 MAC
HMACSHA1() - +Constructor for class net.schmizz.sshj.transport.mac.HMACSHA1 +
  +
HMACSHA1.Factory - Class in net.schmizz.sshj.transport.mac
Named factory for the HMAC-SHA1 MAC
HMACSHA1.Factory() - +Constructor for class net.schmizz.sshj.transport.mac.HMACSHA1.Factory +
  +
HMACSHA196 - Class in net.schmizz.sshj.transport.mac
HMAC-SHA1-96 MAC
HMACSHA196() - +Constructor for class net.schmizz.sshj.transport.mac.HMACSHA196 +
  +
HMACSHA196.Factory - Class in net.schmizz.sshj.transport.mac
Named factory for the HMAC-SHA1-96 MAC
HMACSHA196.Factory() - +Constructor for class net.schmizz.sshj.transport.mac.HMACSHA196.Factory +
  +
hostKeyChangedAction(OpenSSHKnownHosts.Entry, String, PublicKey) - +Method in class net.schmizz.sshj.transport.verification.ConsoleKnownHostsVerifier +
  +
hostKeyChangedAction(OpenSSHKnownHosts.Entry, String, PublicKey) - +Method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts +
  +
hostKeyUnverifiableAction(String, PublicKey) - +Method in class net.schmizz.sshj.transport.verification.ConsoleKnownHostsVerifier +
  +
hostKeyUnverifiableAction(String, PublicKey) - +Method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts +
  +
HostKeyVerifier - Interface in net.schmizz.sshj.transport.verification
Host key verification interface.
hostname - +Variable in class net.schmizz.sshj.userauth.method.AuthHostbased +
  +
hostuser - +Variable in class net.schmizz.sshj.userauth.method.AuthHostbased +
  +
+
+

+I

+
+
in(int, int) - +Method in enum net.schmizz.sshj.common.Message +
  +
inError() - +Method in class net.schmizz.concurrent.Event +
  +
inError() - +Method in class net.schmizz.concurrent.Promise +
  +
init(int, int, int) - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
init() - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
init(PublicKey, PrivateKey) - +Method in class net.schmizz.sshj.signature.AbstractSignature +
  +
init(PublicKey, PrivateKey) - +Method in interface net.schmizz.sshj.signature.Signature +
Initialize this signature with the given public key and private key. +
init(Cipher.Mode, byte[], byte[]) - +Method in class net.schmizz.sshj.transport.cipher.BaseCipher +
  +
init(Cipher.Mode, byte[], byte[]) - +Method in interface net.schmizz.sshj.transport.cipher.Cipher +
Initialize the cipher for encryption or decryption with the given private key and initialization vector +
init(Cipher.Mode, byte[], byte[]) - +Method in class net.schmizz.sshj.transport.cipher.NoneCipher +
  +
init(Compression.Mode) - +Method in interface net.schmizz.sshj.transport.compression.Compression +
Initialize this object to either compress or uncompress data. +
init(Compression.Mode) - +Method in class net.schmizz.sshj.transport.compression.ZlibCompression +
  +
init() - +Method in class net.schmizz.sshj.transport.digest.BaseDigest +
  +
init() - +Method in interface net.schmizz.sshj.transport.digest.Digest +
  +
init(Transport, String, String, byte[], byte[]) - +Method in class net.schmizz.sshj.transport.kex.AbstractDHG +
  +
init(BigInteger, BigInteger) - +Method in class net.schmizz.sshj.transport.kex.DH +
  +
init(Transport, String, String, byte[], byte[]) - +Method in interface net.schmizz.sshj.transport.kex.KeyExchange +
Initialize the key exchange algorithm. +
init(byte[]) - +Method in class net.schmizz.sshj.transport.mac.BaseMAC +
  +
init(byte[]) - +Method in interface net.schmizz.sshj.transport.mac.MAC +
  +
init(String, int, InputStream, OutputStream) - +Method in interface net.schmizz.sshj.transport.Transport +
Sets the host information and the streams to be used by this transport. +
init(String, int, InputStream, OutputStream) - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
init(PublicKey) - +Method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.Entry +
  +
init(String, String) - +Method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.Entry +
  +
init(File) - +Method in interface net.schmizz.sshj.userauth.keyprovider.FileKeyProvider +
  +
init(File, PasswordFinder) - +Method in interface net.schmizz.sshj.userauth.keyprovider.FileKeyProvider +
  +
init(String, String) - +Method in interface net.schmizz.sshj.userauth.keyprovider.FileKeyProvider +
  +
init(String, String, PasswordFinder) - +Method in interface net.schmizz.sshj.userauth.keyprovider.FileKeyProvider +
  +
init(File) - +Method in class net.schmizz.sshj.userauth.keyprovider.OpenSSHKeyFile +
  +
init(String, String) - +Method in class net.schmizz.sshj.userauth.keyprovider.OpenSSHKeyFile +
  +
init(File) - +Method in class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile +
  +
init(File, PasswordFinder) - +Method in class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile +
  +
init(String, String) - +Method in class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile +
  +
init(String, String, PasswordFinder) - +Method in class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile +
  +
init(AuthParams) - +Method in class net.schmizz.sshj.userauth.method.AbstractAuthMethod +
  +
init(AuthParams) - +Method in interface net.schmizz.sshj.userauth.method.AuthMethod +
This method must be called before requesting authentication with this method. +
init(Resource, String, String) - +Method in interface net.schmizz.sshj.userauth.method.ChallengeResponseProvider +
  +
init(Resource, String, String) - +Method in class net.schmizz.sshj.userauth.method.PasswordResponseProvider +
  +
initCipherFactories() - +Method in class net.schmizz.sshj.DefaultConfig +
  +
initCompressionFactories() - +Method in class net.schmizz.sshj.DefaultConfig +
  +
initDH(DH) - +Method in class net.schmizz.sshj.transport.kex.AbstractDHG +
  +
initDH(DH) - +Method in class net.schmizz.sshj.transport.kex.DHG1 +
  +
initDH(DH) - +Method in class net.schmizz.sshj.transport.kex.DHG14 +
  +
initFileKeyProviderFactories(boolean) - +Method in class net.schmizz.sshj.DefaultConfig +
  +
initKeyExchangeFactories(boolean) - +Method in class net.schmizz.sshj.DefaultConfig +
  +
initMACFactories() - +Method in class net.schmizz.sshj.DefaultConfig +
  +
initRandomFactory(boolean) - +Method in class net.schmizz.sshj.AndroidConfig +
  +
initRandomFactory(boolean) - +Method in class net.schmizz.sshj.DefaultConfig +
  +
initSignatureFactories() - +Method in class net.schmizz.sshj.DefaultConfig +
  +
InMemoryDestFile - Class in net.schmizz.sshj.xfer
 
InMemoryDestFile() - +Constructor for class net.schmizz.sshj.xfer.InMemoryDestFile +
  +
InMemorySourceFile - Class in net.schmizz.sshj.xfer
 
InMemorySourceFile() - +Constructor for class net.schmizz.sshj.xfer.InMemorySourceFile +
  +
IOUtils - Class in net.schmizz.sshj.common
 
IOUtils() - +Constructor for class net.schmizz.sshj.common.IOUtils +
  +
isAuthenticated() - +Method in class net.schmizz.sshj.SSHClient +
  +
isAuthenticated() - +Method in interface net.schmizz.sshj.transport.Transport +
  +
isAuthenticated() - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
isBouncyCastleRegistered() - +Static method in class net.schmizz.sshj.common.SecurityUtils +
Attempts registering BouncyCastle as security provider if it has not been previously attempted and returns + whether the registration succeeded. +
isConnected() - +Method in class net.schmizz.sshj.SSHClient +
  +
isDelayed() - +Method in interface net.schmizz.sshj.transport.compression.Compression +
Delayed compression is an Open-SSH specific feature which informs both the client and server to not compress data + before the session has been authenticated. +
isDelayed() - +Method in class net.schmizz.sshj.transport.compression.DelayedZlibCompression +
  +
isDelayed() - +Method in class net.schmizz.sshj.transport.compression.ZlibCompression +
  +
isDelivered() - +Method in class net.schmizz.concurrent.Promise +
  +
isDirectory() - +Method in class net.schmizz.sshj.sftp.RemoteResourceInfo +
  +
isDirectory() - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
isDirectory() - +Method in class net.schmizz.sshj.xfer.InMemorySourceFile +
  +
isDirectory() - +Method in interface net.schmizz.sshj.xfer.LocalSourceFile +
  +
isFile() - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
isFile() - +Method in class net.schmizz.sshj.xfer.InMemorySourceFile +
  +
isFile() - +Method in interface net.schmizz.sshj.xfer.LocalSourceFile +
  +
isHashed(String) - +Static method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts +
  +
isIn(int) - +Method in enum net.schmizz.sshj.xfer.FilePermission +
  +
isKexDone() - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
isMyType(Key) - +Method in enum net.schmizz.sshj.common.KeyType +
  +
isOpen() - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
isOpen() - +Method in interface net.schmizz.sshj.connection.channel.Channel +
  +
isRegularFile() - +Method in class net.schmizz.sshj.sftp.RemoteResourceInfo +
  +
isRunning() - +Method in interface net.schmizz.sshj.transport.Transport +
  +
isRunning() - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
isSet() - +Method in class net.schmizz.concurrent.Event +
  +
isSet(int) - +Method in enum net.schmizz.sshj.sftp.FileAttributes.Flag +
  +
+
+

+J

+
+
JCERandom - Class in net.schmizz.sshj.transport.random
A Random implementation using the built-in SecureRandom PRNG.
JCERandom() - +Constructor for class net.schmizz.sshj.transport.random.JCERandom +
  +
JCERandom.Factory - Class in net.schmizz.sshj.transport.random
Named factory for the JCE Random
JCERandom.Factory() - +Constructor for class net.schmizz.sshj.transport.random.JCERandom.Factory +
  +
join() - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
join(int, TimeUnit) - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
join() - +Method in interface net.schmizz.sshj.connection.channel.Channel +
  +
join(int, TimeUnit) - +Method in interface net.schmizz.sshj.connection.channel.Channel +
  +
join() - +Method in interface net.schmizz.sshj.connection.Connection +
Wait for the situation that no channels are attached (e.g., got closed). +
join() - +Method in class net.schmizz.sshj.connection.ConnectionImpl +
  +
join() - +Method in interface net.schmizz.sshj.transport.Transport +
Joins the thread calling this method to the transport's death. +
join(int, TimeUnit) - +Method in interface net.schmizz.sshj.transport.Transport +
Joins the thread calling this method to the transport's death. +
join() - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
join(int, TimeUnit) - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
+
+

+K

+
+
keepFlushing(boolean) - +Method in class net.schmizz.sshj.common.StreamCopier +
  +
KeyedAuthMethod - Class in net.schmizz.sshj.userauth.method
 
KeyedAuthMethod(String, KeyProvider) - +Constructor for class net.schmizz.sshj.userauth.method.KeyedAuthMethod +
  +
KeyExchange - Interface in net.schmizz.sshj.transport.kex
Key exchange algorithm.
KeyPairWrapper - Class in net.schmizz.sshj.userauth.keyprovider
A KeyProvider wrapper around KeyPair
KeyPairWrapper(KeyPair) - +Constructor for class net.schmizz.sshj.userauth.keyprovider.KeyPairWrapper +
  +
KeyPairWrapper(PublicKey, PrivateKey) - +Constructor for class net.schmizz.sshj.userauth.keyprovider.KeyPairWrapper +
  +
KeyProvider - Interface in net.schmizz.sshj.userauth.keyprovider
A KeyProvider is a container for a public-private keypair.
KeyProviderUtil - Class in net.schmizz.sshj.userauth.keyprovider
 
KeyProviderUtil() - +Constructor for class net.schmizz.sshj.userauth.keyprovider.KeyProviderUtil +
  +
KeyType - Enum in net.schmizz.sshj.common
Type of key e.g.
khFile - +Variable in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts +
  +
kp - +Variable in class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile +
  +
kProv - +Variable in class net.schmizz.sshj.userauth.method.KeyedAuthMethod +
  +
+
+

+L

+
+
length(long) - +Method in class net.schmizz.sshj.common.StreamCopier +
  +
length() - +Method in class net.schmizz.sshj.sftp.RemoteFile +
  +
leq(int) - +Method in enum net.schmizz.sshj.common.Message +
  +
listen() - +Method in class net.schmizz.sshj.connection.channel.direct.LocalPortForwarder +
Start listening for incoming connections and forward to remote host as a channel. +
listener(StreamCopier.Listener) - +Method in class net.schmizz.sshj.common.StreamCopier +
  +
listeners - +Variable in class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder +
  +
loadKeys(KeyPair) - +Method in class net.schmizz.sshj.SSHClient +
Creates a KeyProvider from supplied KeyPair. +
loadKeys(String) - +Method in class net.schmizz.sshj.SSHClient +
Returns a KeyProvider instance created from a location on the file system where an unencrypted + private key file (does not require a passphrase) can be found. +
loadKeys(String, char[]) - +Method in class net.schmizz.sshj.SSHClient +
Utility function for createing a KeyProvider instance from given location on the file system. +
loadKeys(String, PasswordFinder) - +Method in class net.schmizz.sshj.SSHClient +
Creates a KeyProvider instance from given location on the file system. +
loadKeys(String, String) - +Method in class net.schmizz.sshj.SSHClient +
Convenience method for creating a KeyProvider instance from a location where an encrypted + key file is located. +
loadKeys(String, String, PasswordFinder) - +Method in class net.schmizz.sshj.SSHClient +
Creates a KeyProvider instance from passed strings. +
loadKnownHosts() - +Method in class net.schmizz.sshj.SSHClient +
Attempts loading the user's known_hosts file from the default locations, i.e. +
loadKnownHosts(File) - +Method in class net.schmizz.sshj.SSHClient +
Adds a OpenSSHKnownHosts object created from the specified location as a host key verifier. +
LocalDestFile - Interface in net.schmizz.sshj.xfer
 
LocalFileFilter - Interface in net.schmizz.sshj.xfer
 
LocalPF - Class in examples
This example demonstrates local port forwarding, i.e.
LocalPF() - +Constructor for class examples.LocalPF +
  +
LocalPortForwarder - Class in net.schmizz.sshj.connection.channel.direct
 
LocalPortForwarder(Connection, SocketAddress, String, int) - +Constructor for class net.schmizz.sshj.connection.channel.direct.LocalPortForwarder +
Create a local port forwarder with specified binding (listeningAddr. +
LocalPortForwarder(ServerSocketFactory, Connection, SocketAddress, String, int) - +Constructor for class net.schmizz.sshj.connection.channel.direct.LocalPortForwarder +
Create a local port forwarder with specified binding (listeningAddr. +
LocalSourceFile - Interface in net.schmizz.sshj.xfer
 
lock() - +Method in class net.schmizz.concurrent.Event +
Acquire the lock associated with this event. +
lock() - +Method in class net.schmizz.concurrent.Promise +
Acquire the lock associated with this promise. +
lock - +Variable in class net.schmizz.sshj.connection.channel.Window +
  +
log - +Variable in class net.schmizz.sshj.AbstractService +
Logger +
log - +Variable in class net.schmizz.sshj.connection.channel.AbstractChannel +
Logger +
log - +Variable in class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannelOpener +
  +
log - +Variable in class net.schmizz.sshj.connection.channel.forwarded.SocketForwardingConnectListener +
  +
log - +Variable in class net.schmizz.sshj.connection.channel.Window +
  +
log - +Variable in class net.schmizz.sshj.sftp.RemoteResource +
Logger +
log - +Variable in class net.schmizz.sshj.sftp.SFTPClient +
Logger +
log - +Variable in class net.schmizz.sshj.sftp.SFTPEngine +
Logger +
log - +Variable in class net.schmizz.sshj.SSHClient +
Logger +
log - +Variable in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts +
  +
log - +Variable in class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile +
  +
log - +Variable in class net.schmizz.sshj.userauth.method.AbstractAuthMethod +
Logger +
log - +Variable in class net.schmizz.sshj.xfer.AbstractFileTransfer +
  +
log - +Variable in class net.schmizz.sshj.xfer.FileSystemFile +
  +
log - +Variable in class net.schmizz.sshj.xfer.InMemoryDestFile +
  +
log - +Variable in class net.schmizz.sshj.xfer.InMemorySourceFile +
  +
LOGGING_TRANSFER_LISTENER - +Static variable in class net.schmizz.sshj.xfer.AbstractFileTransfer +
  +
LoggingTransferListener - Class in net.schmizz.sshj.xfer
 
LoggingTransferListener() - +Constructor for class net.schmizz.sshj.xfer.LoggingTransferListener +
  +
ls(String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
ls(String, RemoteResourceFilter) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
ls() - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
ls(RemoteResourceFilter) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
ls(String) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
ls(String, RemoteResourceFilter) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
lstat(String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
lstat(String) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
lstat(String) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
lt(int) - +Method in enum net.schmizz.sshj.common.Message +
  +
lwin - +Variable in class net.schmizz.sshj.connection.channel.AbstractChannel +
Local window +
+
+

+M

+
+
MAC - Interface in net.schmizz.sshj.transport.mac
Message Authentication Code for use in SSH.
main(String...) - +Static method in class examples.Exec +
  +
main(String...) - +Static method in class examples.LocalPF +
  +
main(String...) - +Static method in class examples.RemotePF +
  +
main(String[]) - +Static method in class examples.SCPDownload +
  +
main(String[]) - +Static method in class examples.SCPUpload +
  +
main(String[]) - +Static method in class examples.SFTPDownload +
  +
main(String[]) - +Static method in class examples.SFTPUpload +
  +
main(String...) - +Static method in class examples.X11 +
  +
makeAccountResource() - +Method in class net.schmizz.sshj.userauth.method.AbstractAuthMethod +
  +
makeBouncyPasswordFinder() - +Method in class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile +
  +
makeDir(String, FileAttributes) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
makeDir(String) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
mark(int) - +Method in class net.schmizz.sshj.sftp.RemoteFile.RemoteFileInputStream +
  +
markSupported() - +Method in class net.schmizz.sshj.sftp.RemoteFile.RemoteFileInputStream +
  +
MAX_SUPPORTED_VERSION - +Static variable in class net.schmizz.sshj.sftp.SFTPEngine +
  +
maxPacketSize - +Variable in class net.schmizz.sshj.connection.channel.Window +
  +
MD5 - Class in net.schmizz.sshj.transport.digest
MD5 Digest.
MD5() - +Constructor for class net.schmizz.sshj.transport.digest.MD5 +
Create a new instance of a MD5 digest +
MD5.Factory - Class in net.schmizz.sshj.transport.digest
Named factory for MD5 digest
MD5.Factory() - +Constructor for class net.schmizz.sshj.transport.digest.MD5.Factory +
  +
Message - Enum in net.schmizz.sshj.common
SSH message identifiers
mkdir(String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
mkdir(String) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
mkdirs(String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
mkdirs(String) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
mode(String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
monitor(int, TimeUnit, Event<IOException>, Event<IOException>, Channel, Socket) - +Static method in class net.schmizz.sshj.connection.channel.SocketStreamCopyMonitor +
  +
mtime(String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
+
+

+N

+
+
name - +Variable in class net.schmizz.sshj.AbstractService +
Assigned name of this service +
neededAdjustment() - +Method in class net.schmizz.sshj.connection.channel.Window.Local +
  +
NegotiatedAlgorithms - Class in net.schmizz.sshj.transport
 
net.schmizz.concurrent - package net.schmizz.concurrent
 
net.schmizz.sshj - package net.schmizz.sshj
 
net.schmizz.sshj.common - package net.schmizz.sshj.common
 
net.schmizz.sshj.connection - package net.schmizz.sshj.connection
 
net.schmizz.sshj.connection.channel - package net.schmizz.sshj.connection.channel
 
net.schmizz.sshj.connection.channel.direct - package net.schmizz.sshj.connection.channel.direct
 
net.schmizz.sshj.connection.channel.forwarded - package net.schmizz.sshj.connection.channel.forwarded
 
net.schmizz.sshj.sftp - package net.schmizz.sshj.sftp
 
net.schmizz.sshj.signature - package net.schmizz.sshj.signature
 
net.schmizz.sshj.transport - package net.schmizz.sshj.transport
 
net.schmizz.sshj.transport.cipher - package net.schmizz.sshj.transport.cipher
 
net.schmizz.sshj.transport.compression - package net.schmizz.sshj.transport.compression
 
net.schmizz.sshj.transport.digest - package net.schmizz.sshj.transport.digest
 
net.schmizz.sshj.transport.kex - package net.schmizz.sshj.transport.kex
 
net.schmizz.sshj.transport.mac - package net.schmizz.sshj.transport.mac
 
net.schmizz.sshj.transport.random - package net.schmizz.sshj.transport.random
 
net.schmizz.sshj.transport.verification - package net.schmizz.sshj.transport.verification
 
net.schmizz.sshj.userauth - package net.schmizz.sshj.userauth
 
net.schmizz.sshj.userauth.keyprovider - package net.schmizz.sshj.userauth.keyprovider
 
net.schmizz.sshj.userauth.method - package net.schmizz.sshj.userauth.method
 
net.schmizz.sshj.userauth.password - package net.schmizz.sshj.userauth.password
 
net.schmizz.sshj.xfer - package net.schmizz.sshj.xfer
 
net.schmizz.sshj.xfer.scp - package net.schmizz.sshj.xfer.scp
 
newBuffer(Message) - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
newExtendedRequest(String) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
newLocalPortForwarder(SocketAddress, String, int) - +Method in class net.schmizz.sshj.SSHClient +
Create a LocalPortForwarder that will listen on address and forward incoming connections to the + server; which will further forward them to host:port. +
newRequest(PacketType) - +Method in class net.schmizz.sshj.sftp.RemoteResource +
  +
newRequest(PacketType) - +Method in interface net.schmizz.sshj.sftp.Requester +
  +
newRequest(PacketType) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
newSCPDownloadClient() - +Method in class net.schmizz.sshj.xfer.scp.SCPFileTransfer +
  +
newSCPFileTransfer() - +Method in class net.schmizz.sshj.SSHClient +
  +
newSCPUploadClient() - +Method in class net.schmizz.sshj.xfer.scp.SCPFileTransfer +
  +
newSFTPClient() - +Method in class net.schmizz.sshj.SSHClient +
  +
next(Message, SSHPacket) - +Method in class net.schmizz.sshj.transport.kex.AbstractDHG +
  +
next(Message, SSHPacket) - +Method in interface net.schmizz.sshj.transport.kex.KeyExchange +
Process the next packet +
nextID() - +Method in interface net.schmizz.sshj.connection.Connection +
  +
nextID() - +Method in class net.schmizz.sshj.connection.ConnectionImpl +
  +
NO_OPTIONS - +Static variable in class net.schmizz.sshj.common.Base64 +
No options specified. +
NoneCipher - Class in net.schmizz.sshj.transport.cipher
Represents a no-op cipher.
NoneCipher() - +Constructor for class net.schmizz.sshj.transport.cipher.NoneCipher +
  +
NoneCipher.Factory - Class in net.schmizz.sshj.transport.cipher
Named factory for the no-op Cipher
NoneCipher.Factory() - +Constructor for class net.schmizz.sshj.transport.cipher.NoneCipher.Factory +
  +
NoneCompression - Class in net.schmizz.sshj.transport.compression
No-op Compression.
NoneCompression() - +Constructor for class net.schmizz.sshj.transport.compression.NoneCompression +
  +
NoneCompression.Factory - Class in net.schmizz.sshj.transport.compression
Named factory for the no-op Compression
NoneCompression.Factory() - +Constructor for class net.schmizz.sshj.transport.compression.NoneCompression.Factory +
  +
notifyDisconnect(DisconnectReason) - +Method in interface net.schmizz.sshj.transport.DisconnectListener +
  +
notifyError(SSHException) - +Method in class net.schmizz.sshj.AbstractService +
  +
notifyError(SSHException) - +Method in interface net.schmizz.sshj.common.ErrorNotifiable +
Notifies this object of an error. +
notifyError(SSHException) - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
notifyError(SSHException) - +Method in class net.schmizz.sshj.connection.channel.ChannelInputStream +
  +
notifyError(SSHException) - +Method in class net.schmizz.sshj.connection.channel.ChannelOutputStream +
  +
notifyError(SSHException) - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
notifyError(SSHException) - +Method in class net.schmizz.sshj.connection.ConnectionImpl +
  +
notifyError(SSHException) - +Method in class net.schmizz.sshj.userauth.UserAuthImpl +
  +
notifyUnimplemented(long) - +Method in class net.schmizz.sshj.AbstractService +
  +
notifyUnimplemented(long) - +Method in interface net.schmizz.sshj.Service +
Notifies this service that a SSH_MSG_UNIMPLEMENTED was received for packet with given sequence number. +
+
+

+O

+
+
onConnect() - +Method in class net.schmizz.sshj.SSHClient +
On connection establishment, also initializes the SSH transport via Transport.init(java.lang.String, int, java.io.InputStream, java.io.OutputStream) and SSHClient.doKex(). +
open - +Variable in class net.schmizz.sshj.connection.channel.AbstractChannel +
Channel open event +
open() - +Method in interface net.schmizz.sshj.connection.channel.Channel.Direct +
Request opening this channel from remote end. +
open() - +Method in class net.schmizz.sshj.connection.channel.direct.AbstractDirectChannel +
  +
open(String, Set<OpenMode>, FileAttributes) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
open(String, Set<OpenMode>) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
open(String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
open(String, Set<OpenMode>, FileAttributes) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
open(String, Set<OpenMode>) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
open(String) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
open(String, Set<OpenMode>, FileAttributes) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
open(String, Set<OpenMode>) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
open(String) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
openDir(String) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
OpenFailException - Exception in net.schmizz.sshj.connection.channel
 
OpenFailException(String, int, String) - +Constructor for exception net.schmizz.sshj.connection.channel.OpenFailException +
  +
OpenFailException(String, OpenFailException.Reason, String) - +Constructor for exception net.schmizz.sshj.connection.channel.OpenFailException +
  +
OpenFailException.Reason - Enum in net.schmizz.sshj.connection.channel
 
OpenMode - Enum in net.schmizz.sshj.sftp
 
OpenSSHKeyFile - Class in net.schmizz.sshj.userauth.keyprovider
Represents an OpenSSH identity that consists of a PKCS8-encoded private key file and an unencrypted public key file + of the same name with the ".pub" extension.
OpenSSHKeyFile() - +Constructor for class net.schmizz.sshj.userauth.keyprovider.OpenSSHKeyFile +
  +
OpenSSHKeyFile.Factory - Class in net.schmizz.sshj.userauth.keyprovider
 
OpenSSHKeyFile.Factory() - +Constructor for class net.schmizz.sshj.userauth.keyprovider.OpenSSHKeyFile.Factory +
  +
OpenSSHKnownHosts - Class in net.schmizz.sshj.transport.verification
A HostKeyVerifier implementation for a known_hosts file i.e.
OpenSSHKnownHosts(File) - +Constructor for class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts +
  +
OpenSSHKnownHosts.Entry - Class in net.schmizz.sshj.transport.verification
 
OpenSSHKnownHosts.Entry() - +Constructor for class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.Entry +
  +
OpenSSHKnownHosts.HashedEntry - Class in net.schmizz.sshj.transport.verification
 
OpenSSHKnownHosts.HashedEntry(String, PublicKey) - +Constructor for class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.HashedEntry +
  +
OpenSSHKnownHosts.HashedEntry(String) - +Constructor for class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.HashedEntry +
  +
OpenSSHKnownHosts.SimpleEntry - Class in net.schmizz.sshj.transport.verification
 
OpenSSHKnownHosts.SimpleEntry(String, PublicKey) - +Constructor for class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.SimpleEntry +
  +
OpenSSHKnownHosts.SimpleEntry(List<String>, PublicKey) - +Constructor for class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.SimpleEntry +
  +
OpenSSHKnownHosts.SimpleEntry(String) - +Constructor for class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.SimpleEntry +
  +
operativeVersion - +Variable in class net.schmizz.sshj.sftp.SFTPEngine +
  +
ORDERED - +Static variable in class net.schmizz.sshj.common.Base64 +
Encode using the special "ordered" dialect of Base64 described here: http://www.faqs.org/qa/rfcc-1940.html. +
origIP - +Variable in class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannel +
  +
origPort - +Variable in class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannel +
  +
out - +Variable in class net.schmizz.sshj.sftp.SFTPEngine +
  +
+
+

+P

+
+
P1 - +Static variable in class net.schmizz.sshj.transport.kex.DHGroupData +
  +
P14 - +Static variable in class net.schmizz.sshj.transport.kex.DHGroupData +
  +
PacketReader - Class in net.schmizz.sshj.sftp
 
PacketReader(SFTPEngine) - +Constructor for class net.schmizz.sshj.sftp.PacketReader +
  +
PacketType - Enum in net.schmizz.sshj.sftp
 
params - +Variable in class net.schmizz.sshj.userauth.method.AbstractAuthMethod +
AuthParams useful for building request. +
passphrase - +Variable in class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile +
  +
PasswordFinder - Interface in net.schmizz.sshj.userauth.password
Services requests for plaintext passwords.
PasswordResponseProvider - Class in net.schmizz.sshj.userauth.method
 
PasswordResponseProvider(PasswordFinder) - +Constructor for class net.schmizz.sshj.userauth.method.PasswordResponseProvider +
  +
PasswordResponseProvider(PasswordFinder, Collection<String>) - +Constructor for class net.schmizz.sshj.userauth.method.PasswordResponseProvider +
  +
PasswordUtils - Class in net.schmizz.sshj.userauth.password
Static utility method and factories
PasswordUtils() - +Constructor for class net.schmizz.sshj.userauth.password.PasswordUtils +
  +
path - +Variable in class net.schmizz.sshj.sftp.RemoteResource +
  +
PathComponents - Class in net.schmizz.sshj.sftp
 
PathComponents(String, String, String) - +Constructor for class net.schmizz.sshj.sftp.PathComponents +
  +
PathHelper - Class in net.schmizz.sshj.sftp
 
PathHelper(SFTPEngine, String) - +Constructor for class net.schmizz.sshj.sftp.PathHelper +
  +
pathHelper - +Variable in class net.schmizz.sshj.sftp.SFTPEngine +
  +
perms(String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
PF_CANCEL - +Static variable in class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder +
  +
PF_REQ - +Static variable in class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder +
  +
PKCS8KeyFile - Class in net.schmizz.sshj.userauth.keyprovider
Represents a PKCS8-encoded key file.
PKCS8KeyFile() - +Constructor for class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile +
  +
PKCS8KeyFile.Factory - Class in net.schmizz.sshj.userauth.keyprovider
 
PKCS8KeyFile.Factory() - +Constructor for class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile.Factory +
  +
printHex() - +Method in class net.schmizz.sshj.common.Buffer +
Gives a readable snapshot of the buffer in hex. +
printHex(byte[], int, int) - +Static method in class net.schmizz.sshj.common.ByteArrayUtils +
Get a hexadecimal representation of a byte array starting at offset index for len + bytes, with each octet separated by a space. +
PrivateKeyFileResource - Class in net.schmizz.sshj.userauth.password
 
PrivateKeyFileResource(File) - +Constructor for class net.schmizz.sshj.userauth.password.PrivateKeyFileResource +
  +
PrivateKeyStringResource - Class in net.schmizz.sshj.userauth.password
 
PrivateKeyStringResource(String) - +Constructor for class net.schmizz.sshj.userauth.password.PrivateKeyStringResource +
  +
PromiscuousVerifier - Class in net.schmizz.sshj.transport.verification
 
PromiscuousVerifier() - +Constructor for class net.schmizz.sshj.transport.verification.PromiscuousVerifier +
  +
Promise<V,T extends Throwable> - Class in net.schmizz.concurrent
Represents promised data of the parameterized type V and allows waiting on it.
Promise(String, ExceptionChainer<T>) - +Constructor for class net.schmizz.concurrent.Promise +
Creates this promise with given name and exception chainer. +
Promise(String, ExceptionChainer<T>, ReentrantLock) - +Constructor for class net.schmizz.concurrent.Promise +
Creates this promise with given name, exception chainer, and associated lock. +
providesAtimeMtime() - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
providesAtimeMtime() - +Method in class net.schmizz.sshj.xfer.InMemorySourceFile +
  +
providesAtimeMtime() - +Method in interface net.schmizz.sshj.xfer.LocalSourceFile +
  +
PTYMode - Enum in net.schmizz.sshj.connection.channel.direct
Various modes for a psuedo-terminal.
put(String, String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
put(LocalSourceFile, String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
put(String, String) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
putBoolean(boolean) - +Method in class net.schmizz.sshj.common.Buffer +
Puts an SSH boolean value +
putBuffer(Buffer<? extends Buffer<?>>) - +Method in class net.schmizz.sshj.common.Buffer +
Copies the contents of provided buffer into this buffer +
putByte(byte) - +Method in class net.schmizz.sshj.common.Buffer +
Writes a single byte into this buffer +
putBytes(byte[]) - +Method in class net.schmizz.sshj.common.Buffer +
Writes Java byte-array as an SSH byte-array +
putBytes(byte[], int, int) - +Method in class net.schmizz.sshj.common.Buffer +
Writes Java byte-array as an SSH byte-array +
putFileAttributes(FileAttributes) - +Method in class net.schmizz.sshj.sftp.SFTPPacket +
  +
putMessageID(Message) - +Method in class net.schmizz.sshj.common.SSHPacket +
Writes a byte indicating the SSH message identifier +
putMPInt(BigInteger) - +Method in class net.schmizz.sshj.common.Buffer +
  +
putPubKey(SSHPacket) - +Method in class net.schmizz.sshj.userauth.method.KeyedAuthMethod +
  +
putPubKeyIntoBuffer(PublicKey, Buffer<?>) - +Method in enum net.schmizz.sshj.common.KeyType +
  +
putPublicKey(PublicKey) - +Method in class net.schmizz.sshj.common.Buffer +
  +
putRawBytes(byte[]) - +Method in class net.schmizz.sshj.common.Buffer +
  +
putRawBytes(byte[], int, int) - +Method in class net.schmizz.sshj.common.Buffer +
  +
putSensitiveString(char[]) - +Method in class net.schmizz.sshj.common.Buffer +
Writes a char-array as an SSH string and then blanks it out. +
putSig(SSHPacket) - +Method in class net.schmizz.sshj.userauth.method.KeyedAuthMethod +
  +
putSignature(String, byte[]) - +Method in class net.schmizz.sshj.common.Buffer +
  +
putString(byte[]) - +Method in class net.schmizz.sshj.common.Buffer +
  +
putString(byte[], int, int) - +Method in class net.schmizz.sshj.common.Buffer +
  +
putString(String) - +Method in class net.schmizz.sshj.common.Buffer +
  +
putType(PacketType) - +Method in class net.schmizz.sshj.sftp.SFTPPacket +
  +
putUInt32(long) - +Method in class net.schmizz.sshj.common.Buffer +
Writes a uint32 integer +
putUInt64(long) - +Method in class net.schmizz.sshj.common.Buffer +
  +
pwd() - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
pwdf - +Variable in class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile +
  +
+
+

+R

+
+
Random - Interface in net.schmizz.sshj.transport.random
A pseudo random number generator.
RandomAccessRemoteFile - Class in net.schmizz.sshj.sftp
 
RandomAccessRemoteFile(RemoteFile) - +Constructor for class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
read() - +Method in class net.schmizz.sshj.common.Base64.InputStream +
Reads enough of the input stream to convert to/from Base64 and returns the next byte. +
read(byte[], int, int) - +Method in class net.schmizz.sshj.common.Base64.InputStream +
Calls Base64.InputStream.read() repeatedly until the end of stream is reached or len bytes are read. +
read() - +Method in class net.schmizz.sshj.connection.channel.ChannelInputStream +
  +
read(byte[], int, int) - +Method in class net.schmizz.sshj.connection.channel.ChannelInputStream +
  +
read() - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
read(byte[]) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
read(byte[], int, int) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
read(long, byte[], int, int) - +Method in class net.schmizz.sshj.sftp.RemoteFile +
  +
read() - +Method in class net.schmizz.sshj.sftp.RemoteFile.RemoteFileInputStream +
  +
read(byte[], int, int) - +Method in class net.schmizz.sshj.sftp.RemoteFile.RemoteFileInputStream +
  +
readBoolean() - +Method in class net.schmizz.sshj.common.Buffer +
Read an SSH boolean byte +
readBoolean() - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
readByte() - +Method in class net.schmizz.sshj.common.Buffer +
Read a byte from the buffer +
readByte() - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
readBytes() - +Method in class net.schmizz.sshj.common.Buffer +
Read an SSH byte-array +
readChar() - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
readDouble() - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
reader - +Variable in class net.schmizz.sshj.sftp.SFTPEngine +
  +
Reader - Class in net.schmizz.sshj.transport
 
Reader(TransportImpl) - +Constructor for class net.schmizz.sshj.transport.Reader +
  +
readFileAttributes() - +Method in class net.schmizz.sshj.sftp.SFTPPacket +
  +
readFloat() - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
readFully(InputStream) - +Static method in class net.schmizz.sshj.common.IOUtils +
  +
readFully(byte[]) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
readFully(byte[], int, int) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
readInt() - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
readKeyPair() - +Method in class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile +
  +
readLine() - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
readlink(String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
readLink(String) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
readlink(String) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
readLong() - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
readMessageID() - +Method in class net.schmizz.sshj.common.SSHPacket +
Reads an SSH byte and returns it as Message +
readMPInt() - +Method in class net.schmizz.sshj.common.Buffer +
Read an SSH multiple-precision integer +
readPacket() - +Method in class net.schmizz.sshj.sftp.PacketReader +
  +
readPubKeyFromBuffer(String, Buffer<?>) - +Method in enum net.schmizz.sshj.common.KeyType +
  +
readPublicKey() - +Method in class net.schmizz.sshj.common.Buffer +
  +
readRawBytes(byte[]) - +Method in class net.schmizz.sshj.common.Buffer +
  +
readRawBytes(byte[], int, int) - +Method in class net.schmizz.sshj.common.Buffer +
  +
readShort() - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
readSingleName(Response) - +Static method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
readStatusCode() - +Method in class net.schmizz.sshj.sftp.Response +
  +
readString() - +Method in class net.schmizz.sshj.common.Buffer +
Reads an SSH string +
readStringAsBytes() - +Method in class net.schmizz.sshj.common.Buffer +
Reads an SSH string +
readType() - +Method in class net.schmizz.sshj.sftp.SFTPPacket +
  +
readUInt32() - +Method in class net.schmizz.sshj.common.Buffer +
  +
readUInt32AsInt() - +Method in class net.schmizz.sshj.common.Buffer +
  +
readUInt64() - +Method in class net.schmizz.sshj.common.Buffer +
  +
readUnsignedByte() - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
readUnsignedShort() - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
readUTF() - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
receive(byte[], int, int) - +Method in class net.schmizz.sshj.connection.channel.ChannelInputStream +
  +
receiveInto(ChannelInputStream, SSHPacket) - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
registerX11Forwarder(ConnectListener) - +Method in class net.schmizz.sshj.SSHClient +
Register a listener for handling forwarded X11 channels. +
reject(OpenFailException.Reason, String) - +Method in interface net.schmizz.sshj.connection.channel.Channel.Forwarded +
Indicate rejection to remote end. +
reject(OpenFailException.Reason, String) - +Method in class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannel +
  +
rekey() - +Method in class net.schmizz.sshj.SSHClient +
Does key re-exchange. +
RemoteDirectory - Class in net.schmizz.sshj.sftp
 
RemoteDirectory(Requester, String, String) - +Constructor for class net.schmizz.sshj.sftp.RemoteDirectory +
  +
RemoteFile - Class in net.schmizz.sshj.sftp
 
RemoteFile(Requester, String, String) - +Constructor for class net.schmizz.sshj.sftp.RemoteFile +
  +
RemoteFile.RemoteFileInputStream - Class in net.schmizz.sshj.sftp
 
RemoteFile.RemoteFileInputStream() - +Constructor for class net.schmizz.sshj.sftp.RemoteFile.RemoteFileInputStream +
  +
RemoteFile.RemoteFileInputStream(int) - +Constructor for class net.schmizz.sshj.sftp.RemoteFile.RemoteFileInputStream +
  +
RemoteFile.RemoteFileOutputStream - Class in net.schmizz.sshj.sftp
 
RemoteFile.RemoteFileOutputStream() - +Constructor for class net.schmizz.sshj.sftp.RemoteFile.RemoteFileOutputStream +
  +
RemoteFile.RemoteFileOutputStream(long) - +Constructor for class net.schmizz.sshj.sftp.RemoteFile.RemoteFileOutputStream +
  +
RemotePF - Class in examples
This example demonstrates remote port forwarding i.e.
RemotePF() - +Constructor for class examples.RemotePF +
  +
RemotePortForwarder - Class in net.schmizz.sshj.connection.channel.forwarded
Handles remote port forwarding.
RemotePortForwarder(Connection) - +Constructor for class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder +
  +
RemotePortForwarder.Forward - Class in net.schmizz.sshj.connection.channel.forwarded
Represents a particular forwarding.
RemotePortForwarder.Forward(int) - +Constructor for class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder.Forward +
Creates this forward with address as "" and specified port. +
RemotePortForwarder.Forward(String) - +Constructor for class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder.Forward +
Creates this forward with specified address and port as 0. +
RemotePortForwarder.Forward(String, int) - +Constructor for class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder.Forward +
Creates this forward with specified address and port number. +
RemotePortForwarder.ForwardedTCPIPChannel - Class in net.schmizz.sshj.connection.channel.forwarded
A forwarded-tcpip channel.
RemotePortForwarder.ForwardedTCPIPChannel(Connection, int, int, int, RemotePortForwarder.Forward, String, int) - +Constructor for class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder.ForwardedTCPIPChannel +
  +
RemoteResource - Class in net.schmizz.sshj.sftp
 
RemoteResource(Requester, String, String) - +Constructor for class net.schmizz.sshj.sftp.RemoteResource +
  +
RemoteResourceFilter - Interface in net.schmizz.sshj.sftp
 
RemoteResourceInfo - Class in net.schmizz.sshj.sftp
 
RemoteResourceInfo(PathComponents, FileAttributes) - +Constructor for class net.schmizz.sshj.sftp.RemoteResourceInfo +
  +
remove(String) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
removeDir(String) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
rename(String, String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
rename(String, String) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
rename(String, String) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
reportProgress(long) - +Method in interface net.schmizz.sshj.common.StreamCopier.Listener +
  +
reportProgress(long) - +Method in class net.schmizz.sshj.xfer.LoggingTransferListener +
  +
req(String, RemotePortForwarder.Forward) - +Method in class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder +
  +
reqID - +Variable in class net.schmizz.sshj.sftp.SFTPEngine +
  +
reqPassword(Resource<?>) - +Method in interface net.schmizz.sshj.userauth.password.PasswordFinder +
Request password for specified resource. +
reqService(Service) - +Method in interface net.schmizz.sshj.transport.Transport +
Request a SSH service represented by a Service instance. +
reqService(Service) - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
request() - +Method in class net.schmizz.sshj.AbstractService +
  +
request() - +Method in interface net.schmizz.sshj.Service +
Request and install this service with the associated transport. +
Request - Class in net.schmizz.sshj.sftp
 
Request(PacketType, long) - +Constructor for class net.schmizz.sshj.sftp.Request +
  +
request() - +Method in class net.schmizz.sshj.userauth.method.AbstractAuthMethod +
  +
request() - +Method in interface net.schmizz.sshj.userauth.method.AuthMethod +
  +
requester - +Variable in class net.schmizz.sshj.sftp.RemoteResource +
  +
Requester - Interface in net.schmizz.sshj.sftp
 
reqX11Forwarding(String, String, int) - +Method in interface net.schmizz.sshj.connection.channel.direct.Session +
Request X11 forwarding. +
reqX11Forwarding(String, String, int) - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
reset() - +Method in class net.schmizz.sshj.sftp.RemoteFile.RemoteFileInputStream +
  +
resource - +Variable in class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile +
  +
Resource<H> - Class in net.schmizz.sshj.userauth.password
A password-protected resource
Resource(H) - +Constructor for class net.schmizz.sshj.userauth.password.Resource +
  +
Response - Class in net.schmizz.sshj.sftp
 
Response(Buffer<Response>, int) - +Constructor for class net.schmizz.sshj.sftp.Response +
  +
Response.StatusCode - Enum in net.schmizz.sshj.sftp
 
resumeEncoding() - +Method in class net.schmizz.sshj.common.Base64.OutputStream +
Resumes encoding of the stream. +
retrieve() - +Method in class net.schmizz.concurrent.Promise +
Wait indefinitely for this promise's value to be deliver. +
retrieve(long, TimeUnit) - +Method in class net.schmizz.concurrent.Promise +
Wait for timeout duration for this promise's value to be deliver. +
rm(String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
rm(String) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
rmdir(String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
rmdir(String) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
rpos - +Variable in class net.schmizz.sshj.common.Buffer +
  +
rpos() - +Method in class net.schmizz.sshj.common.Buffer +
  +
rpos(int) - +Method in class net.schmizz.sshj.common.Buffer +
  +
run() - +Method in class net.schmizz.sshj.sftp.PacketReader +
  +
run() - +Method in class net.schmizz.sshj.transport.Reader +
  +
rwin - +Variable in class net.schmizz.sshj.connection.channel.AbstractChannel +
Remote window +
+
+

+S

+
+
scan(RemoteResourceFilter) - +Method in class net.schmizz.sshj.sftp.RemoteDirectory +
  +
SCPDownload - Class in examples
This example demonstrates downloading of a file over SCP from the SSH server.
SCPDownload() - +Constructor for class examples.SCPDownload +
  +
SCPDownloadClient - Class in net.schmizz.sshj.xfer.scp
Support for uploading files over a connected link using SCP.
SCPException - Exception in net.schmizz.sshj.xfer.scp
 
SCPException(String) - +Constructor for exception net.schmizz.sshj.xfer.scp.SCPException +
  +
SCPException(String, Throwable) - +Constructor for exception net.schmizz.sshj.xfer.scp.SCPException +
  +
SCPFileTransfer - Class in net.schmizz.sshj.xfer.scp
 
SCPFileTransfer(SessionFactory) - +Constructor for class net.schmizz.sshj.xfer.scp.SCPFileTransfer +
  +
SCPUpload - Class in examples
This example demonstrates uploading of a file over SCP to the SSH server.
SCPUpload() - +Constructor for class examples.SCPUpload +
  +
SCPUploadClient - Class in net.schmizz.sshj.xfer.scp
Support for uploading files over a connected link using SCP.
SecurityUtils - Class in net.schmizz.sshj.common
Static utility method relating to security facilities.
SecurityUtils() - +Constructor for class net.schmizz.sshj.common.SecurityUtils +
  +
seek(long) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
sendChannelRequest(String, boolean, Buffer.PlainBuffer) - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
sendClose() - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
sendEOF() - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
sendEOF() - +Method in interface net.schmizz.sshj.connection.channel.Channel +
Sends an EOF message to the server for this channel; indicating that no more data will be sent by us. +
sendGlobalRequest(String, boolean, byte[]) - +Method in interface net.schmizz.sshj.connection.Connection +
Send an SSH global request. +
sendGlobalRequest(String, boolean, byte[]) - +Method in class net.schmizz.sshj.connection.ConnectionImpl +
  +
sendOpenFailure(int, OpenFailException.Reason, String) - +Method in interface net.schmizz.sshj.connection.Connection +
Send a SSH_MSG_OPEN_FAILURE for specified Reason and message. +
sendOpenFailure(int, OpenFailException.Reason, String) - +Method in class net.schmizz.sshj.connection.ConnectionImpl +
  +
sendUnimplemented() - +Method in interface net.schmizz.sshj.transport.Transport +
Sends SSH_MSG_UNIMPLEMENTED in response to the last packet received. +
sendUnimplemented() - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
serverExtensions - +Variable in class net.schmizz.sshj.sftp.SFTPEngine +
  +
Service - Interface in net.schmizz.sshj
Represents a service running on top of the SSH transport layer.
Session - Interface in net.schmizz.sshj.connection.channel.direct
A session channel provides for execution of a remote command, shell or subsystem.
Session.Command - Interface in net.schmizz.sshj.connection.channel.direct
Command API.
Session.Shell - Interface in net.schmizz.sshj.connection.channel.direct
Shell API.
Session.Subsystem - Interface in net.schmizz.sshj.connection.channel.direct
Subsystem API.
SessionChannel - Class in net.schmizz.sshj.connection.channel.direct
Session implementation.
SessionChannel(Connection) - +Constructor for class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
SessionFactory - Interface in net.schmizz.sshj.connection.channel.direct
A factory interface for creating SSH session channels.
set() - +Method in class net.schmizz.concurrent.Event +
Sets this event to be true. +
setattr(String, FileAttributes) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
setattr(String, FileAttributes) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
setAttributes(FileAttributes) - +Method in class net.schmizz.sshj.sftp.RemoteFile +
  +
setAttributes(String, FileAttributes) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
setAuthenticated() - +Method in interface net.schmizz.sshj.transport.Transport +
Informs this transport that authentication has been completed. +
setAuthenticated() - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
setAutoExpand(boolean) - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
setAutoExpand(boolean) - +Method in interface net.schmizz.sshj.connection.channel.Channel +
Set whether local window should automatically expand when data is received, irrespective of whether data has been + read from that stream. +
setCipherFactories(List<Factory.Named<Cipher>>) - +Method in interface net.schmizz.sshj.Config +
Set the named factories for Cipher. +
setCipherFactories(Factory.Named<Cipher>...) - +Method in class net.schmizz.sshj.ConfigImpl +
  +
setCipherFactories(List<Factory.Named<Cipher>>) - +Method in class net.schmizz.sshj.ConfigImpl +
  +
setClosed() - +Method in class net.schmizz.sshj.connection.channel.ChannelOutputStream +
  +
setCompressionFactories(List<Factory.Named<Compression>>) - +Method in interface net.schmizz.sshj.Config +
Set the named factories for Compression. +
setCompressionFactories(Factory.Named<Compression>...) - +Method in class net.schmizz.sshj.ConfigImpl +
  +
setCompressionFactories(List<Factory.Named<Compression>>) - +Method in class net.schmizz.sshj.ConfigImpl +
  +
setDisconnectListener(DisconnectListener) - +Method in interface net.schmizz.sshj.transport.Transport +
Specify a listener that will be notified upon disconnection. +
setDisconnectListener(DisconnectListener) - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
setDownloadFilter(RemoteResourceFilter) - +Method in class net.schmizz.sshj.sftp.SFTPFileTransfer +
  +
setEnvVar(String, String) - +Method in interface net.schmizz.sshj.connection.channel.direct.Session +
Set an enviornment variable. +
setEnvVar(String, String) - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
setFileKeyProviderFactories(List<Factory.Named<FileKeyProvider>>) - +Method in interface net.schmizz.sshj.Config +
Set the named factories for FileKeyProvider. +
setFileKeyProviderFactories(Factory.Named<FileKeyProvider>...) - +Method in class net.schmizz.sshj.ConfigImpl +
  +
setFileKeyProviderFactories(List<Factory.Named<FileKeyProvider>>) - +Method in class net.schmizz.sshj.ConfigImpl +
  +
setHeartbeatInterval(int) - +Method in interface net.schmizz.sshj.transport.Transport +
  +
setHeartbeatInterval(int) - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
setKeyExchangeFactories(List<Factory.Named<KeyExchange>>) - +Method in interface net.schmizz.sshj.Config +
Set the named factories for KeyExchange. +
setKeyExchangeFactories(Factory.Named<KeyExchange>...) - +Method in class net.schmizz.sshj.ConfigImpl +
  +
setKeyExchangeFactories(List<Factory.Named<KeyExchange>>) - +Method in class net.schmizz.sshj.ConfigImpl +
  +
setLastAccessedTime(long) - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
setLastAccessedTime(long) - +Method in class net.schmizz.sshj.xfer.InMemoryDestFile +
  +
setLastAccessedTime(long) - +Method in interface net.schmizz.sshj.xfer.LocalDestFile +
Set the last access time for the underlying file. +
setLastModifiedTime(long) - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
setLastModifiedTime(long) - +Method in class net.schmizz.sshj.xfer.InMemoryDestFile +
  +
setLastModifiedTime(long) - +Method in interface net.schmizz.sshj.xfer.LocalDestFile +
Set the last modified time for the underlying file. +
setLength(long) - +Method in class net.schmizz.sshj.sftp.RemoteFile +
  +
setMACFactories(List<Factory.Named<MAC>>) - +Method in interface net.schmizz.sshj.Config +
Set the named factories for MAC. +
setMACFactories(Factory.Named<MAC>...) - +Method in class net.schmizz.sshj.ConfigImpl +
  +
setMACFactories(List<Factory.Named<MAC>>) - +Method in class net.schmizz.sshj.ConfigImpl +
  +
setMaxPacketSize(int) - +Method in interface net.schmizz.sshj.connection.Connection +
Set the maximum packet size for the local window this connection recommends to any Channel's that ask for + it. +
setMaxPacketSize(int) - +Method in class net.schmizz.sshj.connection.ConnectionImpl +
  +
setPermissions(int) - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
setPermissions(int) - +Method in class net.schmizz.sshj.xfer.InMemoryDestFile +
  +
setPermissions(int) - +Method in interface net.schmizz.sshj.xfer.LocalDestFile +
Set the permissions for the underlying file. +
setRandomFactory(Factory<Random>) - +Method in interface net.schmizz.sshj.Config +
Set the factory for Random. +
setRandomFactory(Factory<Random>) - +Method in class net.schmizz.sshj.ConfigImpl +
  +
setRecursiveMode(boolean) - +Method in class net.schmizz.sshj.xfer.scp.SCPDownloadClient +
  +
setRegisterBouncyCastle(boolean) - +Static method in class net.schmizz.sshj.common.SecurityUtils +
  +
setSecurityProvider(String) - +Static method in class net.schmizz.sshj.common.SecurityUtils +
Specifies the JCE security provider that should be used. +
setService(Service) - +Method in interface net.schmizz.sshj.transport.Transport +
Sets the currently active Service. +
setService(Service) - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
setSignatureFactories(List<Factory.Named<Signature>>) - +Method in interface net.schmizz.sshj.Config +
Set the named factories for Signature. +
setSignatureFactories(Factory.Named<Signature>...) - +Method in class net.schmizz.sshj.ConfigImpl +
  +
setSignatureFactories(List<Factory.Named<Signature>>) - +Method in class net.schmizz.sshj.ConfigImpl +
  +
setTimeout(int) - +Method in class net.schmizz.sshj.AbstractService +
  +
setTimeout(int) - +Method in interface net.schmizz.sshj.connection.Connection +
Set the timeout this connection uses for blocking operations and recommends to any other + classes that ask for it. +
setTimeout(int) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
setTimeout(int) - +Method in interface net.schmizz.sshj.transport.Transport +
Set a timeout for methods that may block. +
setTimeout(int) - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
setTimeout(int) - +Method in interface net.schmizz.sshj.userauth.UserAuth +
Set the timeout for any method to successfully authenticate before it is abandoned. +
setTransferListener(TransferListener) - +Method in class net.schmizz.sshj.xfer.AbstractFileTransfer +
  +
setTransferListener(TransferListener) - +Method in interface net.schmizz.sshj.xfer.FileTransfer +
  +
setUploadFilter(LocalFileFilter) - +Method in class net.schmizz.sshj.sftp.SFTPFileTransfer +
  +
setVersion(String) - +Method in interface net.schmizz.sshj.Config +
Set the software version information for identification during SSH connection initialization. +
setVersion(String) - +Method in class net.schmizz.sshj.ConfigImpl +
  +
setWindowSize(int) - +Method in interface net.schmizz.sshj.connection.Connection +
Set the size for the local window this connection recommends to any Channel's that ask for it. +
setWindowSize(int) - +Method in class net.schmizz.sshj.connection.ConnectionImpl +
  +
SFTPClient - Class in net.schmizz.sshj.sftp
 
SFTPClient(SFTPEngine) - +Constructor for class net.schmizz.sshj.sftp.SFTPClient +
  +
SFTPDownload - Class in examples
This example demonstrates downloading of a file over SFTP from the SSH server.
SFTPDownload() - +Constructor for class examples.SFTPDownload +
  +
SFTPEngine - Class in net.schmizz.sshj.sftp
 
SFTPEngine(SessionFactory) - +Constructor for class net.schmizz.sshj.sftp.SFTPEngine +
  +
SFTPEngine(SessionFactory, String) - +Constructor for class net.schmizz.sshj.sftp.SFTPEngine +
  +
SFTPException - Exception in net.schmizz.sshj.sftp
 
SFTPException(DisconnectReason) - +Constructor for exception net.schmizz.sshj.sftp.SFTPException +
  +
SFTPException(DisconnectReason, String) - +Constructor for exception net.schmizz.sshj.sftp.SFTPException +
  +
SFTPException(DisconnectReason, String, Throwable) - +Constructor for exception net.schmizz.sshj.sftp.SFTPException +
  +
SFTPException(DisconnectReason, Throwable) - +Constructor for exception net.schmizz.sshj.sftp.SFTPException +
  +
SFTPException(String) - +Constructor for exception net.schmizz.sshj.sftp.SFTPException +
  +
SFTPException(String, Throwable) - +Constructor for exception net.schmizz.sshj.sftp.SFTPException +
  +
SFTPException(Throwable) - +Constructor for exception net.schmizz.sshj.sftp.SFTPException +
  +
SFTPException(Response.StatusCode, String) - +Constructor for exception net.schmizz.sshj.sftp.SFTPException +
  +
SFTPFileTransfer - Class in net.schmizz.sshj.sftp
 
SFTPFileTransfer(SFTPEngine) - +Constructor for class net.schmizz.sshj.sftp.SFTPFileTransfer +
  +
SFTPPacket<T extends SFTPPacket<T>> - Class in net.schmizz.sshj.sftp
 
SFTPPacket() - +Constructor for class net.schmizz.sshj.sftp.SFTPPacket +
  +
SFTPPacket(Buffer<T>) - +Constructor for class net.schmizz.sshj.sftp.SFTPPacket +
  +
SFTPPacket(PacketType) - +Constructor for class net.schmizz.sshj.sftp.SFTPPacket +
  +
SFTPUpload - Class in examples
This example demonstrates uploading of a file over SFTP to the SSH server.
SFTPUpload() - +Constructor for class examples.SFTPUpload +
  +
SHA1 - Class in net.schmizz.sshj.transport.digest
SHA1 Digest.
SHA1() - +Constructor for class net.schmizz.sshj.transport.digest.SHA1 +
Create a new instance of a SHA1 digest +
SHA1.Factory - Class in net.schmizz.sshj.transport.digest
Named factory for SHA1 digest
SHA1.Factory() - +Constructor for class net.schmizz.sshj.transport.digest.SHA1.Factory +
  +
shouldRetry() - +Method in class net.schmizz.sshj.userauth.method.AbstractAuthMethod +
  +
shouldRetry() - +Method in class net.schmizz.sshj.userauth.method.AuthKeyboardInteractive +
  +
shouldRetry() - +Method in interface net.schmizz.sshj.userauth.method.AuthMethod +
  +
shouldRetry() - +Method in class net.schmizz.sshj.userauth.method.AuthPassword +
Returns true if the associated PasswordFinder tells that we should retry with a new password that + it will supply. +
shouldRetry() - +Method in interface net.schmizz.sshj.userauth.method.ChallengeResponseProvider +
  +
shouldRetry() - +Method in class net.schmizz.sshj.userauth.method.PasswordResponseProvider +
  +
shouldRetry(Resource<?>) - +Method in interface net.schmizz.sshj.userauth.password.PasswordFinder +
If password turns out to be incorrect, indicates whether another call to PasswordFinder.reqPassword(Resource) should be + made. +
sign() - +Method in interface net.schmizz.sshj.signature.Signature +
Compute the signature. +
sign() - +Method in class net.schmizz.sshj.signature.SignatureDSA +
  +
sign() - +Method in class net.schmizz.sshj.signature.SignatureRSA +
  +
signal(Signal) - +Method in interface net.schmizz.sshj.connection.channel.direct.Session.Command +
Send a signal to the remote command. +
signal(Signal) - +Method in interface net.schmizz.sshj.connection.channel.direct.Session.Shell +
Send a signal. +
signal(Signal) - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
Signal - Enum in net.schmizz.sshj.connection.channel.direct
Various signals that may be sent or received.
signature - +Variable in class net.schmizz.sshj.signature.AbstractSignature +
  +
Signature - Interface in net.schmizz.sshj.signature
Signature interface for SSH used to sign or verify data.
SignatureDSA - Class in net.schmizz.sshj.signature
DSA Signature
SignatureDSA() - +Constructor for class net.schmizz.sshj.signature.SignatureDSA +
  +
SignatureDSA.Factory - Class in net.schmizz.sshj.signature
A named factory for DSA signature
SignatureDSA.Factory() - +Constructor for class net.schmizz.sshj.signature.SignatureDSA.Factory +
  +
SignatureRSA - Class in net.schmizz.sshj.signature
RSA Signature
SignatureRSA() - +Constructor for class net.schmizz.sshj.signature.SignatureRSA +
  +
SignatureRSA.Factory - Class in net.schmizz.sshj.signature
A named factory for RSA Signature
SignatureRSA.Factory() - +Constructor for class net.schmizz.sshj.signature.SignatureRSA.Factory +
  +
SingletonRandomFactory - Class in net.schmizz.sshj.transport.random
A random factory wrapper that uses a single random instance.
SingletonRandomFactory(Factory<Random>) - +Constructor for class net.schmizz.sshj.transport.random.SingletonRandomFactory +
  +
size - +Variable in class net.schmizz.sshj.connection.channel.Window +
  +
size(String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
skip(long) - +Method in class net.schmizz.sshj.sftp.RemoteFile.RemoteFileInputStream +
  +
skipBytes(int) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
SocketForwardingConnectListener - Class in net.schmizz.sshj.connection.channel.forwarded
A ConnectListener that forwards what is received over the channel to a socket and vice-versa.
SocketForwardingConnectListener(SocketAddress) - +Constructor for class net.schmizz.sshj.connection.channel.forwarded.SocketForwardingConnectListener +
Create with a SocketAddress this listener will forward to. +
SocketStreamCopyMonitor - Class in net.schmizz.sshj.connection.channel
 
spawn(String) - +Method in class net.schmizz.sshj.common.StreamCopier +
  +
spawnDaemon(String) - +Method in class net.schmizz.sshj.common.StreamCopier +
  +
SSHClient - Class in net.schmizz.sshj
Secure SHell client API.
SSHClient() - +Constructor for class net.schmizz.sshj.SSHClient +
Default constructor. +
SSHClient(Config) - +Constructor for class net.schmizz.sshj.SSHClient +
Constructor that allows specifying a config to be used. +
SSHException - Exception in net.schmizz.sshj.common
Most exceptions in the net.schmizz.sshj package are instances of this class.
SSHException(DisconnectReason) - +Constructor for exception net.schmizz.sshj.common.SSHException +
  +
SSHException(DisconnectReason, String) - +Constructor for exception net.schmizz.sshj.common.SSHException +
  +
SSHException(DisconnectReason, String, Throwable) - +Constructor for exception net.schmizz.sshj.common.SSHException +
  +
SSHException(DisconnectReason, Throwable) - +Constructor for exception net.schmizz.sshj.common.SSHException +
  +
SSHException(String) - +Constructor for exception net.schmizz.sshj.common.SSHException +
  +
SSHException(String, Throwable) - +Constructor for exception net.schmizz.sshj.common.SSHException +
  +
SSHException(Throwable) - +Constructor for exception net.schmizz.sshj.common.SSHException +
  +
SSHPacket - Class in net.schmizz.sshj.common
 
SSHPacket() - +Constructor for class net.schmizz.sshj.common.SSHPacket +
  +
SSHPacket(int) - +Constructor for class net.schmizz.sshj.common.SSHPacket +
  +
SSHPacket(byte[]) - +Constructor for class net.schmizz.sshj.common.SSHPacket +
  +
SSHPacket(Message) - +Constructor for class net.schmizz.sshj.common.SSHPacket +
Constructs new buffer for the specified SSH packet and reserves the needed space (5 bytes) for the packet + header. +
SSHPacket(SSHPacket) - +Constructor for class net.schmizz.sshj.common.SSHPacket +
  +
SSHPacketHandler - Interface in net.schmizz.sshj.common
An interface for classes to which packet handling may be delegated.
SSHRuntimeException - Exception in net.schmizz.sshj.common
Represents unrecoverable exceptions in the net.schmizz.sshj package.
SSHRuntimeException() - +Constructor for exception net.schmizz.sshj.common.SSHRuntimeException +
  +
SSHRuntimeException(String) - +Constructor for exception net.schmizz.sshj.common.SSHRuntimeException +
  +
SSHRuntimeException(String, Throwable) - +Constructor for exception net.schmizz.sshj.common.SSHRuntimeException +
  +
SSHRuntimeException(Throwable) - +Constructor for exception net.schmizz.sshj.common.SSHRuntimeException +
  +
startedDir(String) - +Method in class net.schmizz.sshj.xfer.LoggingTransferListener +
  +
startedDir(String) - +Method in interface net.schmizz.sshj.xfer.TransferListener +
  +
startedFile(String, long) - +Method in class net.schmizz.sshj.xfer.LoggingTransferListener +
  +
startedFile(String, long) - +Method in interface net.schmizz.sshj.xfer.TransferListener +
  +
startSession() - +Method in interface net.schmizz.sshj.connection.channel.direct.SessionFactory +
Opens a session channel. +
startSession() - +Method in class net.schmizz.sshj.SSHClient +
  +
startShell() - +Method in interface net.schmizz.sshj.connection.channel.direct.Session +
Request a shell. +
startShell() - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
startSubsystem(String) - +Method in interface net.schmizz.sshj.connection.channel.direct.Session +
Request a subsystem. +
startSubsystem(String) - +Method in class net.schmizz.sshj.connection.channel.direct.SessionChannel +
  +
stat(String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
stat(String) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
stat(PacketType, String) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
stat(String) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
StatefulSFTPClient - Class in net.schmizz.sshj.sftp
 
StatefulSFTPClient(SFTPEngine) - +Constructor for class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
statExistence(String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
statExistence(String) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
stop() - +Method in class net.schmizz.sshj.connection.channel.forwarded.X11Forwarder +
Stop handling x11 channel open requests. +
StreamCopier - Class in net.schmizz.sshj.common
 
StreamCopier(InputStream, OutputStream) - +Constructor for class net.schmizz.sshj.common.StreamCopier +
  +
StreamCopier.Listener - Interface in net.schmizz.sshj.common
 
sType - +Variable in enum net.schmizz.sshj.common.KeyType +
  +
sub - +Variable in class net.schmizz.sshj.sftp.SFTPEngine +
  +
suspendEncoding() - +Method in class net.schmizz.sshj.common.Base64.OutputStream +
Suspends encoding of the stream. +
symlink(String, String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
symlink(String, String) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
symlink(String, String) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
+
+

+T

+
+
timeout - +Variable in class net.schmizz.sshj.AbstractService +
Timeout for blocking operations +
timeout - +Variable in class net.schmizz.sshj.sftp.SFTPEngine +
  +
toByte() - +Method in enum net.schmizz.sshj.common.Message +
  +
toByte() - +Method in enum net.schmizz.sshj.sftp.PacketType +
  +
toBytes() - +Method in class net.schmizz.sshj.sftp.FileAttributes +
  +
toHex(byte[]) - +Static method in class net.schmizz.sshj.common.ByteArrayUtils +
Get the hexadecimal representation of a byte array. +
toHex(byte[], int, int) - +Static method in class net.schmizz.sshj.common.ByteArrayUtils +
Get the hexadecimal representation of a byte array starting at offset index for len + bytes. +
toInt() - +Method in enum net.schmizz.sshj.common.DisconnectReason +
  +
toMask() - +Method in enum net.schmizz.sshj.sftp.FileMode.Type +
  +
toMask(Set<OpenMode>) - +Static method in enum net.schmizz.sshj.sftp.OpenMode +
  +
toMask(Set<FilePermission>) - +Static method in enum net.schmizz.sshj.xfer.FilePermission +
  +
toString() - +Method in class net.schmizz.concurrent.Event +
  +
toString() - +Method in class net.schmizz.concurrent.Promise +
  +
toString() - +Method in class net.schmizz.sshj.common.Buffer +
  +
toString() - +Method in enum net.schmizz.sshj.common.KeyType +
  +
toString() - +Method in exception net.schmizz.sshj.common.SSHException +
  +
toString() - +Method in class net.schmizz.sshj.connection.channel.AbstractChannel +
  +
toString() - +Method in class net.schmizz.sshj.connection.channel.ChannelInputStream +
  +
toString() - +Method in class net.schmizz.sshj.connection.channel.ChannelOutputStream +
  +
toString() - +Method in class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder.Forward +
  +
toString() - +Method in exception net.schmizz.sshj.connection.channel.OpenFailException +
  +
toString() - +Method in class net.schmizz.sshj.connection.channel.Window +
  +
toString() - +Method in class net.schmizz.sshj.sftp.FileAttributes +
  +
toString() - +Method in class net.schmizz.sshj.sftp.FileMode +
  +
toString() - +Method in class net.schmizz.sshj.sftp.PathComponents +
  +
toString() - +Method in class net.schmizz.sshj.sftp.RemoteResource +
  +
toString() - +Method in class net.schmizz.sshj.sftp.RemoteResourceInfo +
  +
toString() - +Method in class net.schmizz.sshj.sftp.Request +
  +
toString() - +Method in class net.schmizz.sshj.transport.NegotiatedAlgorithms +
  +
toString() - +Method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.Entry +
  +
toString() - +Method in class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile +
  +
toString() - +Method in class net.schmizz.sshj.userauth.password.Resource +
  +
toString() - +Method in class net.schmizz.sshj.xfer.FileSystemFile +
  +
trans - +Variable in class net.schmizz.sshj.AbstractService +
Transport layer +
trans - +Variable in class net.schmizz.sshj.connection.channel.AbstractChannel +
Transport layer +
trans - +Variable in class net.schmizz.sshj.SSHClient +
Transport layer +
TransferListener - Interface in net.schmizz.sshj.xfer
 
transmit(SFTPPacket<Request>) - +Method in class net.schmizz.sshj.sftp.SFTPEngine +
  +
Transport - Interface in net.schmizz.sshj.transport
Transport layer of the SSH protocol.
TransportException - Exception in net.schmizz.sshj.transport
Transport-layer exception
TransportException(DisconnectReason) - +Constructor for exception net.schmizz.sshj.transport.TransportException +
  +
TransportException(DisconnectReason, String) - +Constructor for exception net.schmizz.sshj.transport.TransportException +
  +
TransportException(DisconnectReason, String, Throwable) - +Constructor for exception net.schmizz.sshj.transport.TransportException +
  +
TransportException(DisconnectReason, Throwable) - +Constructor for exception net.schmizz.sshj.transport.TransportException +
  +
TransportException(String) - +Constructor for exception net.schmizz.sshj.transport.TransportException +
  +
TransportException(String, Throwable) - +Constructor for exception net.schmizz.sshj.transport.TransportException +
  +
TransportException(Throwable) - +Constructor for exception net.schmizz.sshj.transport.TransportException +
  +
TransportImpl - Class in net.schmizz.sshj.transport
A thread-safe Transport implementation.
TransportImpl(Config) - +Constructor for class net.schmizz.sshj.transport.TransportImpl +
  +
trimTrailingSeparator(String) - +Method in class net.schmizz.sshj.sftp.PathHelper +
  +
TripleDESCBC - Class in net.schmizz.sshj.transport.cipher
3des-cbc cipher
TripleDESCBC() - +Constructor for class net.schmizz.sshj.transport.cipher.TripleDESCBC +
  +
TripleDESCBC.Factory - Class in net.schmizz.sshj.transport.cipher
Named factory for TripleDESCBC Cipher
TripleDESCBC.Factory() - +Constructor for class net.schmizz.sshj.transport.cipher.TripleDESCBC.Factory +
  +
truncate(String, long) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
truncate(String, long) - +Method in class net.schmizz.sshj.sftp.StatefulSFTPClient +
  +
tryAwait(long, TimeUnit) - +Method in class net.schmizz.concurrent.Event +
Await this event to have a definite true or false value, for timeout duration. +
tryRetrieve(long, TimeUnit) - +Method in class net.schmizz.concurrent.Promise +
Wait for timeout duration for this promise's value to be deliver. +
TYPE - +Static variable in class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder.ForwardedTCPIPChannel +
  +
TYPE - +Static variable in class net.schmizz.sshj.connection.channel.forwarded.X11Forwarder.X11Channel +
  +
type(String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
type - +Variable in class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile +
  +
+
+

+U

+
+
uid(String) - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
uncompress(Buffer, Buffer) - +Method in interface net.schmizz.sshj.transport.compression.Compression +
Uncompress the data in a buffer into another buffer. +
uncompress(Buffer, Buffer) - +Method in class net.schmizz.sshj.transport.compression.ZlibCompression +
  +
unlock() - +Method in class net.schmizz.concurrent.Event +
Release the lock associated with this event. +
unlock() - +Method in class net.schmizz.concurrent.Promise +
Release the lock associated with this promise. +
update(byte[]) - +Method in class net.schmizz.sshj.signature.AbstractSignature +
  +
update(byte[], int, int) - +Method in class net.schmizz.sshj.signature.AbstractSignature +
  +
update(byte[]) - +Method in interface net.schmizz.sshj.signature.Signature +
Convenience method, same as calling Signature.update(byte[], int, int) with offset as 0 and H.length. +
update(byte[], int, int) - +Method in interface net.schmizz.sshj.signature.Signature +
Update the computed signature with the given data. +
update(byte[], int, int) - +Method in class net.schmizz.sshj.transport.cipher.BaseCipher +
  +
update(byte[], int, int) - +Method in interface net.schmizz.sshj.transport.cipher.Cipher +
Performs in-place encryption or decryption on the given data. +
update(byte[], int, int) - +Method in class net.schmizz.sshj.transport.cipher.NoneCipher +
  +
update(byte[]) - +Method in class net.schmizz.sshj.transport.digest.BaseDigest +
  +
update(byte[], int, int) - +Method in class net.schmizz.sshj.transport.digest.BaseDigest +
  +
update(byte[]) - +Method in interface net.schmizz.sshj.transport.digest.Digest +
  +
update(byte[], int, int) - +Method in interface net.schmizz.sshj.transport.digest.Digest +
  +
update(byte[], int, int) - +Method in class net.schmizz.sshj.transport.mac.BaseMAC +
  +
update(byte[]) - +Method in class net.schmizz.sshj.transport.mac.BaseMAC +
  +
update(long) - +Method in class net.schmizz.sshj.transport.mac.BaseMAC +
  +
update(byte[]) - +Method in interface net.schmizz.sshj.transport.mac.MAC +
  +
update(byte[], int, int) - +Method in interface net.schmizz.sshj.transport.mac.MAC +
  +
update(long) - +Method in interface net.schmizz.sshj.transport.mac.MAC +
  +
upload(String, String) - +Method in class net.schmizz.sshj.sftp.SFTPFileTransfer +
  +
upload(LocalSourceFile, String) - +Method in class net.schmizz.sshj.sftp.SFTPFileTransfer +
  +
upload(String, String) - +Method in interface net.schmizz.sshj.xfer.FileTransfer +
  +
upload(LocalSourceFile, String) - +Method in interface net.schmizz.sshj.xfer.FileTransfer +
  +
upload(String, String) - +Method in class net.schmizz.sshj.xfer.scp.SCPFileTransfer +
  +
upload(LocalSourceFile, String) - +Method in class net.schmizz.sshj.xfer.scp.SCPFileTransfer +
  +
URL_SAFE - +Static variable in class net.schmizz.sshj.common.Base64 +
Encode using Base64-like encoding that is URL- and Filename-safe as described in Section 4 of RFC3548: http://www.faqs.org/rfcs/rfc3548.html. +
useCompression() - +Method in class net.schmizz.sshj.SSHClient +
Adds zlib compression to preferred compression algorithms. +
UserAuth - Interface in net.schmizz.sshj.userauth
User authentication API.
UserAuthException - Exception in net.schmizz.sshj.userauth
User authentication exception
UserAuthException(DisconnectReason) - +Constructor for exception net.schmizz.sshj.userauth.UserAuthException +
  +
UserAuthException(DisconnectReason, String) - +Constructor for exception net.schmizz.sshj.userauth.UserAuthException +
  +
UserAuthException(DisconnectReason, String, Throwable) - +Constructor for exception net.schmizz.sshj.userauth.UserAuthException +
  +
UserAuthException(DisconnectReason, Throwable) - +Constructor for exception net.schmizz.sshj.userauth.UserAuthException +
  +
UserAuthException(String) - +Constructor for exception net.schmizz.sshj.userauth.UserAuthException +
  +
UserAuthException(String, Throwable) - +Constructor for exception net.schmizz.sshj.userauth.UserAuthException +
  +
UserAuthException(Throwable) - +Constructor for exception net.schmizz.sshj.userauth.UserAuthException +
  +
UserAuthImpl - Class in net.schmizz.sshj.userauth
UserAuth implementation.
UserAuthImpl(Transport) - +Constructor for class net.schmizz.sshj.userauth.UserAuthImpl +
  +
UTF8 - +Static variable in class net.schmizz.sshj.common.IOUtils +
  +
+
+

+V

+
+
valueOf(String) - +Static method in enum net.schmizz.sshj.common.DisconnectReason +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum net.schmizz.sshj.common.KeyType +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum net.schmizz.sshj.common.Message +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum net.schmizz.sshj.connection.channel.direct.PTYMode +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum net.schmizz.sshj.connection.channel.direct.Signal +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum net.schmizz.sshj.connection.channel.OpenFailException.Reason +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum net.schmizz.sshj.sftp.FileAttributes.Flag +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum net.schmizz.sshj.sftp.FileMode.Type +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum net.schmizz.sshj.sftp.OpenMode +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum net.schmizz.sshj.sftp.PacketType +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum net.schmizz.sshj.sftp.Response.StatusCode +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum net.schmizz.sshj.transport.cipher.Cipher.Mode +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum net.schmizz.sshj.transport.compression.Compression.Mode +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum net.schmizz.sshj.userauth.keyprovider.FileKeyProvider.Format +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum net.schmizz.sshj.xfer.FilePermission +
Returns the enum constant of this type with the specified name. +
values() - +Static method in enum net.schmizz.sshj.common.DisconnectReason +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum net.schmizz.sshj.common.KeyType +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum net.schmizz.sshj.common.Message +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum net.schmizz.sshj.connection.channel.direct.PTYMode +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum net.schmizz.sshj.connection.channel.direct.Signal +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum net.schmizz.sshj.connection.channel.OpenFailException.Reason +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum net.schmizz.sshj.sftp.FileAttributes.Flag +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum net.schmizz.sshj.sftp.FileMode.Type +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum net.schmizz.sshj.sftp.OpenMode +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum net.schmizz.sshj.sftp.PacketType +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum net.schmizz.sshj.sftp.Response.StatusCode +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum net.schmizz.sshj.transport.cipher.Cipher.Mode +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum net.schmizz.sshj.transport.compression.Compression.Mode +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum net.schmizz.sshj.userauth.keyprovider.FileKeyProvider.Format +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum net.schmizz.sshj.xfer.FilePermission +
Returns an array containing the constants of this enum type, in +the order they are declared. +
verify(byte[]) - +Method in interface net.schmizz.sshj.signature.Signature +
Verify against the given signature. +
verify(byte[]) - +Method in class net.schmizz.sshj.signature.SignatureDSA +
  +
verify(byte[]) - +Method in class net.schmizz.sshj.signature.SignatureRSA +
  +
verify(String, int, PublicKey) - +Method in interface net.schmizz.sshj.transport.verification.HostKeyVerifier +
This callback is invoked when the server's host key needs to be verified. +
verify(String, int, PublicKey) - +Method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts +
  +
verify(String, int, PublicKey) - +Method in class net.schmizz.sshj.transport.verification.PromiscuousVerifier +
  +
version() - +Method in class net.schmizz.sshj.sftp.SFTPClient +
  +
+
+

+W

+
+
waitAndConsume(int) - +Method in class net.schmizz.sshj.connection.channel.Window.Remote +
  +
Window - Class in net.schmizz.sshj.connection.channel
 
Window(int, int) - +Constructor for class net.schmizz.sshj.connection.channel.Window +
  +
Window.Local - Class in net.schmizz.sshj.connection.channel
Controls how much data remote end can send before an adjustment notification from us is required.
Window.Local(int, int) - +Constructor for class net.schmizz.sshj.connection.channel.Window.Local +
  +
Window.Remote - Class in net.schmizz.sshj.connection.channel
Controls how much data we can send before an adjustment notification from remote end is required.
Window.Remote(int, int) - +Constructor for class net.schmizz.sshj.connection.channel.Window.Remote +
  +
withAtimeMtime(long, long) - +Method in class net.schmizz.sshj.sftp.FileAttributes.Builder +
  +
withExtended(String, String) - +Method in class net.schmizz.sshj.sftp.FileAttributes.Builder +
  +
withExtended(Map<String, String>) - +Method in class net.schmizz.sshj.sftp.FileAttributes.Builder +
  +
withPermissions(Set<FilePermission>) - +Method in class net.schmizz.sshj.sftp.FileAttributes.Builder +
  +
withPermissions(int) - +Method in class net.schmizz.sshj.sftp.FileAttributes.Builder +
  +
withSize(long) - +Method in class net.schmizz.sshj.sftp.FileAttributes.Builder +
  +
withType(FileMode.Type) - +Method in class net.schmizz.sshj.sftp.FileAttributes.Builder +
  +
withUIDGID(int, int) - +Method in class net.schmizz.sshj.sftp.FileAttributes.Builder +
  +
wpos - +Variable in class net.schmizz.sshj.common.Buffer +
  +
wpos() - +Method in class net.schmizz.sshj.common.Buffer +
  +
wpos(int) - +Method in class net.schmizz.sshj.common.Buffer +
  +
write(byte[], int, int) - +Method in class net.schmizz.sshj.common.Base64.OutputStream +
Calls Base64.OutputStream.write(int) repeatedly until len bytes are written. +
write(int) - +Method in class net.schmizz.sshj.common.Base64.OutputStream +
Writes the byte to the output stream after converting to/from Base64 notation. +
write(int) - +Method in class net.schmizz.sshj.connection.channel.ChannelOutputStream +
  +
write(byte[], int, int) - +Method in class net.schmizz.sshj.connection.channel.ChannelOutputStream +
  +
write(int) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
write(byte[]) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
write(byte[], int, int) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
write(int) - +Method in class net.schmizz.sshj.sftp.RemoteFile.RemoteFileOutputStream +
  +
write(byte[], int, int) - +Method in class net.schmizz.sshj.sftp.RemoteFile.RemoteFileOutputStream +
  +
write(long, byte[], int, int) - +Method in class net.schmizz.sshj.sftp.RemoteFile +
  +
write(SSHPacket) - +Method in interface net.schmizz.sshj.transport.Transport +
Write a packet over this transport. +
write(SSHPacket) - +Method in class net.schmizz.sshj.transport.TransportImpl +
  +
write() - +Method in class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts +
  +
writeBoolean(boolean) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
writeByte(int) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
writeBytes(String) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
writeChar(int) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
writeChars(String) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
writeDouble(double) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
writeFloat(float) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
writeInt(int) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
writeLong(long) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
writeShort(int) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
writeUTF(String) - +Method in class net.schmizz.sshj.sftp.RandomAccessRemoteFile +
  +
+
+

+X

+
+
X11 - Class in examples
This example demonstrates how forwarding X11 connections from a remote host can be accomplished.
X11() - +Constructor for class examples.X11 +
  +
X11Forwarder - Class in net.schmizz.sshj.connection.channel.forwarded
Handles forwarded x11 channels.
X11Forwarder(Connection, ConnectListener) - +Constructor for class net.schmizz.sshj.connection.channel.forwarded.X11Forwarder +
  +
X11Forwarder.X11Channel - Class in net.schmizz.sshj.connection.channel.forwarded
An x11 forwarded channel.
X11Forwarder.X11Channel(Connection, int, int, int, String, int) - +Constructor for class net.schmizz.sshj.connection.channel.forwarded.X11Forwarder.X11Channel +
  +
xfer - +Variable in class net.schmizz.sshj.sftp.SFTPClient +
  +
+
+

+Z

+
+
ZlibCompression - Class in net.schmizz.sshj.transport.compression
ZLib based Compression.
ZlibCompression() - +Constructor for class net.schmizz.sshj.transport.compression.ZlibCompression +
  +
ZlibCompression.Factory - Class in net.schmizz.sshj.transport.compression
Named factory for the ZLib Compression.
ZlibCompression.Factory() - +Constructor for class net.schmizz.sshj.transport.compression.ZlibCompression.Factory +
  +
+
+A B C D E F G H I J K L M N O P R S T U V W X Z + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/index.html b/javadoc/0.4.1/index.html new file mode 100644 index 00000000..fe8d933a --- /dev/null +++ b/javadoc/0.4.1/index.html @@ -0,0 +1,40 @@ + + + + + + + +sshj 0.4.1 API + + + + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="overview-summary.html">Non-frame version.</A> + + + diff --git a/javadoc/0.4.1/net/schmizz/concurrent/ErrorDeliveryUtil.html b/javadoc/0.4.1/net/schmizz/concurrent/ErrorDeliveryUtil.html new file mode 100644 index 00000000..1088ce7f --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/concurrent/ErrorDeliveryUtil.html @@ -0,0 +1,318 @@ + + + + + + + +ErrorDeliveryUtil (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.concurrent +
+Class ErrorDeliveryUtil

+
+java.lang.Object
+  extended by net.schmizz.concurrent.ErrorDeliveryUtil
+
+
+
+
public class ErrorDeliveryUtil
extends Object
+ + +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
ErrorDeliveryUtil() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static voidalertEvents(Throwable x, + Collection<? extends Event> events) + +
+           
+static voidalertEvents(Throwable x, + Event... events) + +
+           
+static voidalertPromises(Throwable x, + Collection<? extends Promise> promises) + +
+           
+static voidalertPromises(Throwable x, + Promise... promises) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ErrorDeliveryUtil

+
+public ErrorDeliveryUtil()
+
+
+ + + + + + + + +
+Method Detail
+ +

+alertPromises

+
+public static void alertPromises(Throwable x,
+                                 Promise... promises)
+
+
+
+
+
+
+ +

+alertPromises

+
+public static void alertPromises(Throwable x,
+                                 Collection<? extends Promise> promises)
+
+
+
+
+
+
+ +

+alertEvents

+
+public static void alertEvents(Throwable x,
+                               Event... events)
+
+
+
+
+
+
+ +

+alertEvents

+
+public static void alertEvents(Throwable x,
+                               Collection<? extends Event> events)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/concurrent/Event.html b/javadoc/0.4.1/net/schmizz/concurrent/Event.html new file mode 100644 index 00000000..cf05cfe3 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/concurrent/Event.html @@ -0,0 +1,537 @@ + + + + + + + +Event (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.concurrent +
+Class Event<T extends Throwable>

+
+java.lang.Object
+  extended by net.schmizz.concurrent.Event<T>
+
+
+
+
public class Event<T extends Throwable>
extends Object
+ + +

+An event can be set, cleared, or awaited, similar to Python's threading.event. The key difference is that a + waiter may be delivered an exception of parameterized type T. +

+ Uses Promise under the hood. +

+ +

+


+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
Event(String name, + ExceptionChainer<T> chainer) + +
+          Creates this event with given name and exception chainer.
Event(String name, + ExceptionChainer<T> chainer, + ReentrantLock lock) + +
+          Creates this event with given name, exception chainer, and associated lock.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidawait() + +
+          Await this event to have a definite true or false value.
+ voidawait(long timeout, + TimeUnit unit) + +
+          Await this event to have a definite true or false value, for timeout duration.
+ voidclear() + +
+          Clear this event.
+ voiddeliverError(Throwable t) + +
+          Deliver the error t (after chaining) to any present or future waiters.
+ booleanhasWaiters() + +
+           
+ booleaninError() + +
+           
+ booleanisSet() + +
+           
+ voidlock() + +
+          Acquire the lock associated with this event.
+ voidset() + +
+          Sets this event to be true.
+ StringtoString() + +
+           
+ booleantryAwait(long timeout, + TimeUnit unit) + +
+          Await this event to have a definite true or false value, for timeout duration.
+ voidunlock() + +
+          Release the lock associated with this event.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Event

+
+public Event(String name,
+             ExceptionChainer<T> chainer)
+
+
Creates this event with given name and exception chainer. Allocates a new Lock object for this event. +

+

+
Parameters:
name - name of this event
chainer - ExceptionChainer that will be used for chaining exceptions
+
+
+ +

+Event

+
+public Event(String name,
+             ExceptionChainer<T> chainer,
+             ReentrantLock lock)
+
+
Creates this event with given name, exception chainer, and associated lock. +

+

+
Parameters:
name - name of this event
chainer - ExceptionChainer that will be used for chaining exceptions
lock - lock to use
+
+ + + + + + + + +
+Method Detail
+ +

+set

+
+public void set()
+
+
Sets this event to be true. Short for set(true). +

+

+
+
+
+
+ +

+clear

+
+public void clear()
+
+
Clear this event. A cleared event !isSet(). +

+

+
+
+
+
+ +

+deliverError

+
+public void deliverError(Throwable t)
+
+
Deliver the error t (after chaining) to any present or future waiters. +

+

+
+
+
+
+ +

+isSet

+
+public boolean isSet()
+
+
+ +
Returns:
whether this event is in a 'set' state. An event is set by a call to set() or deliverError(java.lang.Throwable)
+
+
+
+ +

+await

+
+public void await()
+           throws T extends Throwable
+
+
Await this event to have a definite true or false value. +

+

+ +
Throws: +
T - if another thread meanwhile informs this event of an error +
T extends Throwable
+
+
+
+ +

+await

+
+public void await(long timeout,
+                  TimeUnit unit)
+           throws T extends Throwable
+
+
Await this event to have a definite true or false value, for timeout duration. +

+

+
Parameters:
timeout - timeout
unit - the time unit for the timeout +
Throws: +
T - if another thread meanwhile informs this event of an error, or timeout expires +
T extends Throwable
+
+
+
+ +

+tryAwait

+
+public boolean tryAwait(long timeout,
+                        TimeUnit unit)
+                 throws T extends Throwable
+
+
Await this event to have a definite true or false value, for timeout duration. +

+ If the definite value is not available when the timeout expires, returns false. +

+

+
Parameters:
timeout - timeout
unit - the time unit for the timeout +
Throws: +
T - if another thread meanwhile informs this event of an error +
T extends Throwable
+
+
+
+ +

+hasWaiters

+
+public boolean hasWaiters()
+
+
+ +
Returns:
whether there are any threads waiting on this event to be set.
+
+
+
+ +

+inError

+
+public boolean inError()
+
+
+ +
Returns:
whether this event is in an error state i.e. has been delivered an error.
+
+
+
+ +

+lock

+
+public void lock()
+
+
Acquire the lock associated with this event. +

+

+
+
+
+
+ +

+unlock

+
+public void unlock()
+
+
Release the lock associated with this event. +

+

+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/concurrent/ExceptionChainer.html b/javadoc/0.4.1/net/schmizz/concurrent/ExceptionChainer.html new file mode 100644 index 00000000..fa0f7d20 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/concurrent/ExceptionChainer.html @@ -0,0 +1,226 @@ + + + + + + + +ExceptionChainer (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.concurrent +
+Interface ExceptionChainer<Z extends Throwable>

+
+
Type Parameters:
Z - Throwable type
+
+
+
public interface ExceptionChainer<Z extends Throwable>
+ + +

+Chains an exception to desired type. For example:

+

+

+ ExceptionChainer<SomeException> chainer = new ExceptionChainer<SomeException>()
+ {
+     public SomeException chain(Throwable t)
+     {
+         if (t instanceof SomeException)
+             return (SomeException) t;
+         else
+             return new SomeExcepion(t);
+     }
+ };
+ 
+

+ +

+


+ +

+ + + + + + + + + + + + +
+Method Summary
+ Zchain(Throwable t) + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+chain

+
+Z chain(Throwable t)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/concurrent/Promise.html b/javadoc/0.4.1/net/schmizz/concurrent/Promise.html new file mode 100644 index 00000000..2c46ce46 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/concurrent/Promise.html @@ -0,0 +1,543 @@ + + + + + + + +Promise (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.concurrent +
+Class Promise<V,T extends Throwable>

+
+java.lang.Object
+  extended by net.schmizz.concurrent.Promise<V,T>
+
+
+
+
public class Promise<V,T extends Throwable>
extends Object
+ + +

+Represents promised data of the parameterized type V and allows waiting on it. An exception may also be + delivered to a waiter, and will be of the parameterized type T. +

+ For atomic operations on a promise, e.g. checking if a value is delivered and if it is not then setting it, the + associated lock for the promise should be acquired while doing so. +

+ +

+


+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
Promise(String name, + ExceptionChainer<T> chainer) + +
+          Creates this promise with given name and exception chainer.
Promise(String name, + ExceptionChainer<T> chainer, + ReentrantLock lock) + +
+          Creates this promise with given name, exception chainer, and associated lock.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclear() + +
+          Clears this promise by setting its value and queued exception to null.
+ voiddeliver(V val) + +
+          Set this promise's value to val.
+ voiddeliverError(Throwable e) + +
+          Queues error that will be thrown in any waiting thread or any thread that attempts to wait on this promise + hereafter.
+ booleanhasWaiters() + +
+           
+ booleaninError() + +
+           
+ booleanisDelivered() + +
+           
+ voidlock() + +
+          Acquire the lock associated with this promise.
+ Vretrieve() + +
+          Wait indefinitely for this promise's value to be deliver.
+ Vretrieve(long timeout, + TimeUnit unit) + +
+          Wait for timeout duration for this promise's value to be deliver.
+ StringtoString() + +
+           
+ VtryRetrieve(long timeout, + TimeUnit unit) + +
+          Wait for timeout duration for this promise's value to be deliver.
+ voidunlock() + +
+          Release the lock associated with this promise.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Promise

+
+public Promise(String name,
+               ExceptionChainer<T> chainer)
+
+
Creates this promise with given name and exception chainer. Allocates a new lock object for this promise. +

+

+
Parameters:
name - name of this promise
chainer - ExceptionChainer that will be used for chaining exceptions
+
+
+ +

+Promise

+
+public Promise(String name,
+               ExceptionChainer<T> chainer,
+               ReentrantLock lock)
+
+
Creates this promise with given name, exception chainer, and associated lock. +

+

+
Parameters:
name - name of this promise
chainer - ExceptionChainer that will be used for chaining exceptions
lock - lock to use
+
+ + + + + + + + +
+Method Detail
+ +

+deliver

+
+public void deliver(V val)
+
+
Set this promise's value to val. Any waiters will be delivered this value. +

+

+
Parameters:
val - the value
+
+
+
+ +

+deliverError

+
+public void deliverError(Throwable e)
+
+
Queues error that will be thrown in any waiting thread or any thread that attempts to wait on this promise + hereafter. +

+

+
Parameters:
e - the error
+
+
+
+ +

+clear

+
+public void clear()
+
+
Clears this promise by setting its value and queued exception to null. +

+

+
+
+
+
+ +

+retrieve

+
+public V retrieve()
+           throws T extends Throwable
+
+
Wait indefinitely for this promise's value to be deliver. +

+

+ +
Returns:
the value +
Throws: +
T - in case another thread informs the promise of an error meanwhile +
T extends Throwable
+
+
+
+ +

+retrieve

+
+public V retrieve(long timeout,
+                  TimeUnit unit)
+           throws T extends Throwable
+
+
Wait for timeout duration for this promise's value to be deliver. +

+

+
Parameters:
timeout - the timeout
unit - time unit for the timeout +
Returns:
the value +
Throws: +
T - in case another thread informs the promise of an error meanwhile, or the timeout expires +
T extends Throwable
+
+
+
+ +

+tryRetrieve

+
+public V tryRetrieve(long timeout,
+                     TimeUnit unit)
+              throws T extends Throwable
+
+
Wait for timeout duration for this promise's value to be deliver. +

+ If the value is not deliver by the time the timeout expires, returns null. +

+

+
Parameters:
timeout - the timeout
unit - time unit for the timeout +
Returns:
the value or null +
Throws: +
T - in case another thread informs the promise of an error meanwhile +
T extends Throwable
+
+
+
+ +

+isDelivered

+
+public boolean isDelivered()
+
+
+ +
Returns:
whether this promise has a value delivered, and no error waiting to pop.
+
+
+
+ +

+inError

+
+public boolean inError()
+
+
+ +
Returns:
whether this promise has been delivered an error.
+
+
+
+ +

+hasWaiters

+
+public boolean hasWaiters()
+
+
+ +
Returns:
whether this promise has threads waiting on it.
+
+
+
+ +

+lock

+
+public void lock()
+
+
Acquire the lock associated with this promise. +

+

+
+
+
+
+ +

+unlock

+
+public void unlock()
+
+
Release the lock associated with this promise. +

+

+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/concurrent/class-use/ErrorDeliveryUtil.html b/javadoc/0.4.1/net/schmizz/concurrent/class-use/ErrorDeliveryUtil.html new file mode 100644 index 00000000..898c40d5 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/concurrent/class-use/ErrorDeliveryUtil.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.concurrent.ErrorDeliveryUtil (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.concurrent.ErrorDeliveryUtil

+
+No usage of net.schmizz.concurrent.ErrorDeliveryUtil +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/concurrent/class-use/Event.html b/javadoc/0.4.1/net/schmizz/concurrent/class-use/Event.html new file mode 100644 index 00000000..a3733434 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/concurrent/class-use/Event.html @@ -0,0 +1,325 @@ + + + + + + + +Uses of Class net.schmizz.concurrent.Event (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.concurrent.Event

+
+ + + + + + + + + + + + + + + + + +
+Packages that use Event
net.schmizz.concurrent  
net.schmizz.sshj.common  
net.schmizz.sshj.connection.channel  
+  +

+ + + + + +
+Uses of Event in net.schmizz.concurrent
+  +

+ + + + + + + + + +
Methods in net.schmizz.concurrent with parameters of type Event
+static voidErrorDeliveryUtil.alertEvents(Throwable x, + Event... events) + +
+           
+  +

+ + + + + + + + + +
Method parameters in net.schmizz.concurrent with type arguments of type Event
+static voidErrorDeliveryUtil.alertEvents(Throwable x, + Collection<? extends Event> events) + +
+           
+  +

+ + + + + +
+Uses of Event in net.schmizz.sshj.common
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.common that return Event
+ Event<IOException>StreamCopier.spawn(String name) + +
+           
+ Event<IOException>StreamCopier.spawnDaemon(String name) + +
+           
+  +

+ + + + + +
+Uses of Event in net.schmizz.sshj.connection.channel
+  +

+ + + + + + + + + + + + + +
Fields in net.schmizz.sshj.connection.channel declared as Event
+protected  Event<ConnectionException>AbstractChannel.close + +
+          Channel close event
+protected  Event<ConnectionException>AbstractChannel.open + +
+          Channel open event
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel that return Event
+protected  Event<ConnectionException>AbstractChannel.sendChannelRequest(String reqType, + boolean wantReply, + Buffer.PlainBuffer reqSpecific) + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel with parameters of type Event
+static voidSocketStreamCopyMonitor.monitor(int frequency, + TimeUnit unit, + Event<IOException> x, + Event<IOException> y, + Channel channel, + Socket socket) + +
+           
+static voidSocketStreamCopyMonitor.monitor(int frequency, + TimeUnit unit, + Event<IOException> x, + Event<IOException> y, + Channel channel, + Socket socket) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/concurrent/class-use/ExceptionChainer.html b/javadoc/0.4.1/net/schmizz/concurrent/class-use/ExceptionChainer.html new file mode 100644 index 00000000..3c5e44f2 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/concurrent/class-use/ExceptionChainer.html @@ -0,0 +1,348 @@ + + + + + + + +Uses of Interface net.schmizz.concurrent.ExceptionChainer (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.concurrent.ExceptionChainer

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use ExceptionChainer
net.schmizz.concurrent  
net.schmizz.sshj.common  
net.schmizz.sshj.connection  
net.schmizz.sshj.sftp  
net.schmizz.sshj.transport  
net.schmizz.sshj.userauth  
+  +

+ + + + + +
+Uses of ExceptionChainer in net.schmizz.concurrent
+  +

+ + + + + + + + + + + + + + + + + +
Constructors in net.schmizz.concurrent with parameters of type ExceptionChainer
Event(String name, + ExceptionChainer<T> chainer) + +
+          Creates this event with given name and exception chainer.
Event(String name, + ExceptionChainer<T> chainer, + ReentrantLock lock) + +
+          Creates this event with given name, exception chainer, and associated lock.
Promise(String name, + ExceptionChainer<T> chainer) + +
+          Creates this promise with given name and exception chainer.
Promise(String name, + ExceptionChainer<T> chainer, + ReentrantLock lock) + +
+          Creates this promise with given name, exception chainer, and associated lock.
+  +

+ + + + + +
+Uses of ExceptionChainer in net.schmizz.sshj.common
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.common declared as ExceptionChainer
+static ExceptionChainer<SSHException>SSHException.chainer + +
+           
+  +

+ + + + + +
+Uses of ExceptionChainer in net.schmizz.sshj.connection
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.connection declared as ExceptionChainer
+static ExceptionChainer<ConnectionException>ConnectionException.chainer + +
+           
+  +

+ + + + + +
+Uses of ExceptionChainer in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.sftp declared as ExceptionChainer
+static ExceptionChainer<SFTPException>SFTPException.chainer + +
+           
+  +

+ + + + + +
+Uses of ExceptionChainer in net.schmizz.sshj.transport
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.transport declared as ExceptionChainer
+static ExceptionChainer<TransportException>TransportException.chainer + +
+           
+  +

+ + + + + +
+Uses of ExceptionChainer in net.schmizz.sshj.userauth
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.userauth declared as ExceptionChainer
+static ExceptionChainer<UserAuthException>UserAuthException.chainer + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/concurrent/class-use/Promise.html b/javadoc/0.4.1/net/schmizz/concurrent/class-use/Promise.html new file mode 100644 index 00000000..490e1b1a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/concurrent/class-use/Promise.html @@ -0,0 +1,269 @@ + + + + + + + +Uses of Class net.schmizz.concurrent.Promise (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.concurrent.Promise

+
+ + + + + + + + + + + + + + + + + +
+Packages that use Promise
net.schmizz.concurrent  
net.schmizz.sshj.connection  
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of Promise in net.schmizz.concurrent
+  +

+ + + + + + + + + +
Methods in net.schmizz.concurrent with parameters of type Promise
+static voidErrorDeliveryUtil.alertPromises(Throwable x, + Promise... promises) + +
+           
+  +

+ + + + + + + + + +
Method parameters in net.schmizz.concurrent with type arguments of type Promise
+static voidErrorDeliveryUtil.alertPromises(Throwable x, + Collection<? extends Promise> promises) + +
+           
+  +

+ + + + + +
+Uses of Promise in net.schmizz.sshj.connection
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection that return Promise
+ Promise<SSHPacket,ConnectionException>ConnectionImpl.sendGlobalRequest(String name, + boolean wantReply, + byte[] specifics) + +
+           
+ Promise<SSHPacket,ConnectionException>Connection.sendGlobalRequest(String name, + boolean wantReply, + byte[] specifics) + +
+          Send an SSH global request.
+  +

+ + + + + +
+Uses of Promise in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return Promise
+ Promise<Response,SFTPException>Request.getResponsePromise() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/concurrent/package-frame.html b/javadoc/0.4.1/net/schmizz/concurrent/package-frame.html new file mode 100644 index 00000000..63c6822e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/concurrent/package-frame.html @@ -0,0 +1,48 @@ + + + + + + + +net.schmizz.concurrent (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.concurrent + + + + +
+Interfaces  + +
+ExceptionChainer
+ + + + + + +
+Classes  + +
+ErrorDeliveryUtil +
+Event +
+Promise
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/concurrent/package-summary.html b/javadoc/0.4.1/net/schmizz/concurrent/package-summary.html new file mode 100644 index 00000000..2d838d85 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/concurrent/package-summary.html @@ -0,0 +1,180 @@ + + + + + + + +net.schmizz.concurrent (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.concurrent +

+ + + + + + + + + +
+Interface Summary
ExceptionChainer<Z extends Throwable>Chains an exception to desired type.
+  + +

+ + + + + + + + + + + + + + + + + +
+Class Summary
ErrorDeliveryUtil 
Event<T extends Throwable>An event can be set, cleared, or awaited, similar to Python's threading.event.
Promise<V,T extends Throwable>Represents promised data of the parameterized type V and allows waiting on it.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/concurrent/package-tree.html b/javadoc/0.4.1/net/schmizz/concurrent/package-tree.html new file mode 100644 index 00000000..65797824 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/concurrent/package-tree.html @@ -0,0 +1,159 @@ + + + + + + + +net.schmizz.concurrent Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.concurrent +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/concurrent/package-use.html b/javadoc/0.4.1/net/schmizz/concurrent/package-use.html new file mode 100644 index 00000000..4c0ae93e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/concurrent/package-use.html @@ -0,0 +1,315 @@ + + + + + + + +Uses of Package net.schmizz.concurrent (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.concurrent

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use net.schmizz.concurrent
net.schmizz.concurrent  
net.schmizz.sshj.common  
net.schmizz.sshj.connection  
net.schmizz.sshj.connection.channel  
net.schmizz.sshj.sftp  
net.schmizz.sshj.transport  
net.schmizz.sshj.userauth  
+  +

+ + + + + + + + + + + + + + +
+Classes in net.schmizz.concurrent used by net.schmizz.concurrent
Event + +
+          An event can be set, cleared, or awaited, similar to Python's threading.event.
ExceptionChainer + +
+          Chains an exception to desired type.
Promise + +
+          Represents promised data of the parameterized type V and allows waiting on it.
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.concurrent used by net.schmizz.sshj.common
Event + +
+          An event can be set, cleared, or awaited, similar to Python's threading.event.
ExceptionChainer + +
+          Chains an exception to desired type.
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.concurrent used by net.schmizz.sshj.connection
ExceptionChainer + +
+          Chains an exception to desired type.
Promise + +
+          Represents promised data of the parameterized type V and allows waiting on it.
+  +

+ + + + + + + + +
+Classes in net.schmizz.concurrent used by net.schmizz.sshj.connection.channel
Event + +
+          An event can be set, cleared, or awaited, similar to Python's threading.event.
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.concurrent used by net.schmizz.sshj.sftp
ExceptionChainer + +
+          Chains an exception to desired type.
Promise + +
+          Represents promised data of the parameterized type V and allows waiting on it.
+  +

+ + + + + + + + +
+Classes in net.schmizz.concurrent used by net.schmizz.sshj.transport
ExceptionChainer + +
+          Chains an exception to desired type.
+  +

+ + + + + + + + +
+Classes in net.schmizz.concurrent used by net.schmizz.sshj.userauth
ExceptionChainer + +
+          Chains an exception to desired type.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/AbstractService.html b/javadoc/0.4.1/net/schmizz/sshj/AbstractService.html new file mode 100644 index 00000000..f8485564 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/AbstractService.html @@ -0,0 +1,544 @@ + + + + + + + +AbstractService (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj +
+Class AbstractService

+
+java.lang.Object
+  extended by net.schmizz.sshj.AbstractService
+
+
+
All Implemented Interfaces:
ErrorNotifiable, SSHPacketHandler, Service
+
+
+
Direct Known Subclasses:
ConnectionImpl, UserAuthImpl
+
+
+
+
public abstract class AbstractService
extends Object
implements Service
+ + +

+An abstract class for Service that implements common or default functionality. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable
ErrorNotifiable.Util
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+protected  org.slf4j.Loggerlog + +
+          Logger
+protected  Stringname + +
+          Assigned name of this service
+protected  inttimeout + +
+          Timeout for blocking operations
+protected  Transporttrans + +
+          Transport layer
+  + + + + + + + + + + +
+Constructor Summary
AbstractService(String name, + Transport trans) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StringgetName() + +
+           
+ intgetTimeout() + +
+           
+ voidhandle(Message msg, + SSHPacket buf) + +
+          Delegate handling of some SSH packet to this object.
+ voidnotifyError(SSHException error) + +
+          Notifies this object of an error.
+ voidnotifyUnimplemented(long seqNum) + +
+          Notifies this service that a SSH_MSG_UNIMPLEMENTED was received for packet with given sequence number.
+ voidrequest() + +
+          Request and install this service with the associated transport.
+ voidsetTimeout(int timeout) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+protected final org.slf4j.Logger log
+
+
Logger +

+

+
+
+
+ +

+name

+
+protected final String name
+
+
Assigned name of this service +

+

+
+
+
+ +

+trans

+
+protected final Transport trans
+
+
Transport layer +

+

+
+
+
+ +

+timeout

+
+protected int timeout
+
+
Timeout for blocking operations +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+AbstractService

+
+public AbstractService(String name,
+                       Transport trans)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Service
+
+
+ +
Returns:
the assigned name for this SSH service.
+
+
+
+ +

+handle

+
+public void handle(Message msg,
+                   SSHPacket buf)
+            throws SSHException
+
+
Description copied from interface: SSHPacketHandler
+
Delegate handling of some SSH packet to this object. +

+

+
Specified by:
handle in interface SSHPacketHandler
+
+
+
Parameters:
msg - the SSH message identifier
buf - SSHPacket containing rest of the request +
Throws: +
SSHException - if there is a non-recoverable error
+
+
+
+ +

+notifyError

+
+public void notifyError(SSHException error)
+
+
Description copied from interface: ErrorNotifiable
+
Notifies this object of an error. +

+

+
Specified by:
notifyError in interface ErrorNotifiable
+
+
+
+
+
+
+ +

+notifyUnimplemented

+
+public void notifyUnimplemented(long seqNum)
+                         throws SSHException
+
+
Description copied from interface: Service
+
Notifies this service that a SSH_MSG_UNIMPLEMENTED was received for packet with given sequence number. + Meant to be invoked as a callback by the transport layer. +

+

+
Specified by:
notifyUnimplemented in interface Service
+
+
+
Parameters:
seqNum - sequence number of the packet which the server claims is unimplemented +
Throws: +
SSHException - if the packet is unexpected and may represent a disruption
+
+
+
+ +

+request

+
+public void request()
+             throws TransportException
+
+
Description copied from interface: Service
+
Request and install this service with the associated transport. Implementations should aim to make this method + idempotent by first checking the Transport.getService() currently active + service}. +

+

+
Specified by:
request in interface Service
+
+
+ +
Throws: +
TransportException - if there is an error sending the service request
+
+
+
+ +

+getTimeout

+
+public int getTimeout()
+
+
+
+
+
+
+
+
+
+ +

+setTimeout

+
+public void setTimeout(int timeout)
+
+
+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/AndroidConfig.html b/javadoc/0.4.1/net/schmizz/sshj/AndroidConfig.html new file mode 100644 index 00000000..db32dbc8 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/AndroidConfig.html @@ -0,0 +1,279 @@ + + + + + + + +AndroidConfig (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj +
+Class AndroidConfig

+
+java.lang.Object
+  extended by net.schmizz.sshj.ConfigImpl
+      extended by net.schmizz.sshj.DefaultConfig
+          extended by net.schmizz.sshj.AndroidConfig
+
+
+
All Implemented Interfaces:
Config
+
+
+
+
public class AndroidConfig
extends DefaultConfig
+ + +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
AndroidConfig() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+protected  voidinitRandomFactory(boolean ignored) + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.DefaultConfig
initCipherFactories, initCompressionFactories, initFileKeyProviderFactories, initKeyExchangeFactories, initMACFactories, initSignatureFactories
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.ConfigImpl
getCipherFactories, getCompressionFactories, getFileKeyProviderFactories, getKeyExchangeFactories, getMACFactories, getRandomFactory, getSignatureFactories, getVersion, setCipherFactories, setCipherFactories, setCompressionFactories, setCompressionFactories, setFileKeyProviderFactories, setFileKeyProviderFactories, setKeyExchangeFactories, setKeyExchangeFactories, setMACFactories, setMACFactories, setRandomFactory, setSignatureFactories, setSignatureFactories, setVersion
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AndroidConfig

+
+public AndroidConfig()
+
+
+ + + + + + + + +
+Method Detail
+ +

+initRandomFactory

+
+protected void initRandomFactory(boolean ignored)
+
+
+
Overrides:
initRandomFactory in class DefaultConfig
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/Config.html b/javadoc/0.4.1/net/schmizz/sshj/Config.html new file mode 100644 index 00000000..a5937ea7 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/Config.html @@ -0,0 +1,540 @@ + + + + + + + +Config (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj +
+Interface Config

+
+
All Known Implementing Classes:
AndroidConfig, ConfigImpl, DefaultConfig
+
+
+
+
public interface Config
+ + +

+Holds configuration information and factories. Acts a container for factories of KeyExchange, Cipher, + Compression, MAC, Signature, Random, and FileKeyProvider. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ List<Factory.Named<Cipher>>getCipherFactories() + +
+          Retrieve the list of named factories for Cipher.
+ List<Factory.Named<Compression>>getCompressionFactories() + +
+          Retrieve the list of named factories for Compression.
+ List<Factory.Named<FileKeyProvider>>getFileKeyProviderFactories() + +
+          Retrieve the list of named factories for FileKeyProvider.
+ List<Factory.Named<KeyExchange>>getKeyExchangeFactories() + +
+          Retrieve the list of named factories for KeyExchange.
+ List<Factory.Named<MAC>>getMACFactories() + +
+          Retrieve the list of named factories for MAC.
+ Factory<Random>getRandomFactory() + +
+          Retrieve the Random factory.
+ List<Factory.Named<Signature>>getSignatureFactories() + +
+          Retrieve the list of named factories for Signature
+ StringgetVersion() + +
+          Returns the software version information for identification during SSH connection initialization.
+ voidsetCipherFactories(List<Factory.Named<Cipher>> cipherFactories) + +
+          Set the named factories for Cipher.
+ voidsetCompressionFactories(List<Factory.Named<Compression>> compressionFactories) + +
+          Set the named factories for Compression.
+ voidsetFileKeyProviderFactories(List<Factory.Named<FileKeyProvider>> fileKeyProviderFactories) + +
+          Set the named factories for FileKeyProvider.
+ voidsetKeyExchangeFactories(List<Factory.Named<KeyExchange>> kexFactories) + +
+          Set the named factories for KeyExchange.
+ voidsetMACFactories(List<Factory.Named<MAC>> macFactories) + +
+          Set the named factories for MAC.
+ voidsetRandomFactory(Factory<Random> randomFactory) + +
+          Set the factory for Random.
+ voidsetSignatureFactories(List<Factory.Named<Signature>> signatureFactories) + +
+          Set the named factories for Signature.
+ voidsetVersion(String version) + +
+          Set the software version information for identification during SSH connection initialization.
+  +

+ + + + + + + + +
+Method Detail
+ +

+getCipherFactories

+
+List<Factory.Named<Cipher>> getCipherFactories()
+
+
Retrieve the list of named factories for Cipher. +

+

+ +
Returns:
a list of named Cipher factories
+
+
+
+ +

+getCompressionFactories

+
+List<Factory.Named<Compression>> getCompressionFactories()
+
+
Retrieve the list of named factories for Compression. +

+

+ +
Returns:
a list of named Compression factories
+
+
+
+ +

+getFileKeyProviderFactories

+
+List<Factory.Named<FileKeyProvider>> getFileKeyProviderFactories()
+
+
Retrieve the list of named factories for FileKeyProvider. +

+

+ +
Returns:
a list of named FileKeyProvider factories
+
+
+
+ +

+getKeyExchangeFactories

+
+List<Factory.Named<KeyExchange>> getKeyExchangeFactories()
+
+
Retrieve the list of named factories for KeyExchange. +

+

+ +
Returns:
a list of named KeyExchange factories
+
+
+
+ +

+getMACFactories

+
+List<Factory.Named<MAC>> getMACFactories()
+
+
Retrieve the list of named factories for MAC. +

+

+ +
Returns:
a list of named MAC factories
+
+
+
+ +

+getRandomFactory

+
+Factory<Random> getRandomFactory()
+
+
Retrieve the Random factory. +

+

+ +
Returns:
the Random factory
+
+
+
+ +

+getSignatureFactories

+
+List<Factory.Named<Signature>> getSignatureFactories()
+
+
Retrieve the list of named factories for Signature +

+

+ +
Returns:
a list of named Signature factories
+
+
+
+ +

+getVersion

+
+String getVersion()
+
+
Returns the software version information for identification during SSH connection initialization. For example, + "NET_3_0". +

+

+
+
+
+
+ +

+setCipherFactories

+
+void setCipherFactories(List<Factory.Named<Cipher>> cipherFactories)
+
+
Set the named factories for Cipher. +

+

+
Parameters:
cipherFactories - a list of named factories
+
+
+
+ +

+setCompressionFactories

+
+void setCompressionFactories(List<Factory.Named<Compression>> compressionFactories)
+
+
Set the named factories for Compression. +

+

+
Parameters:
compressionFactories - a list of named factories
+
+
+
+ +

+setFileKeyProviderFactories

+
+void setFileKeyProviderFactories(List<Factory.Named<FileKeyProvider>> fileKeyProviderFactories)
+
+
Set the named factories for FileKeyProvider. +

+

+
Parameters:
fileKeyProviderFactories - a list of named factories
+
+
+
+ +

+setKeyExchangeFactories

+
+void setKeyExchangeFactories(List<Factory.Named<KeyExchange>> kexFactories)
+
+
Set the named factories for KeyExchange. +

+

+
Parameters:
kexFactories - a list of named factories
+
+
+
+ +

+setMACFactories

+
+void setMACFactories(List<Factory.Named<MAC>> macFactories)
+
+
Set the named factories for MAC. +

+

+
Parameters:
macFactories - a list of named factories
+
+
+
+ +

+setRandomFactory

+
+void setRandomFactory(Factory<Random> randomFactory)
+
+
Set the factory for Random. +

+

+
Parameters:
randomFactory - the factory
+
+
+
+ +

+setSignatureFactories

+
+void setSignatureFactories(List<Factory.Named<Signature>> signatureFactories)
+
+
Set the named factories for Signature. +

+

+
Parameters:
signatureFactories - a list of named factories
+
+
+
+ +

+setVersion

+
+void setVersion(String version)
+
+
Set the software version information for identification during SSH connection initialization. For example, "SSHJ_0_1". +

+

+
Parameters:
version - software version info
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/ConfigImpl.html b/javadoc/0.4.1/net/schmizz/sshj/ConfigImpl.html new file mode 100644 index 00000000..aa6bfd47 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/ConfigImpl.html @@ -0,0 +1,780 @@ + + + + + + + +ConfigImpl (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj +
+Class ConfigImpl

+
+java.lang.Object
+  extended by net.schmizz.sshj.ConfigImpl
+
+
+
All Implemented Interfaces:
Config
+
+
+
Direct Known Subclasses:
DefaultConfig
+
+
+
+
public class ConfigImpl
extends Object
implements Config
+ + +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
ConfigImpl() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ List<Factory.Named<Cipher>>getCipherFactories() + +
+          Retrieve the list of named factories for Cipher.
+ List<Factory.Named<Compression>>getCompressionFactories() + +
+          Retrieve the list of named factories for Compression.
+ List<Factory.Named<FileKeyProvider>>getFileKeyProviderFactories() + +
+          Retrieve the list of named factories for FileKeyProvider.
+ List<Factory.Named<KeyExchange>>getKeyExchangeFactories() + +
+          Retrieve the list of named factories for KeyExchange.
+ List<Factory.Named<MAC>>getMACFactories() + +
+          Retrieve the list of named factories for MAC.
+ Factory<Random>getRandomFactory() + +
+          Retrieve the Random factory.
+ List<Factory.Named<Signature>>getSignatureFactories() + +
+          Retrieve the list of named factories for Signature
+ StringgetVersion() + +
+          Returns the software version information for identification during SSH connection initialization.
+ voidsetCipherFactories(Factory.Named<Cipher>... cipherFactories) + +
+           
+ voidsetCipherFactories(List<Factory.Named<Cipher>> cipherFactories) + +
+          Set the named factories for Cipher.
+ voidsetCompressionFactories(Factory.Named<Compression>... compressionFactories) + +
+           
+ voidsetCompressionFactories(List<Factory.Named<Compression>> compressionFactories) + +
+          Set the named factories for Compression.
+ voidsetFileKeyProviderFactories(Factory.Named<FileKeyProvider>... fileKeyProviderFactories) + +
+           
+ voidsetFileKeyProviderFactories(List<Factory.Named<FileKeyProvider>> fileKeyProviderFactories) + +
+          Set the named factories for FileKeyProvider.
+ voidsetKeyExchangeFactories(Factory.Named<KeyExchange>... kexFactories) + +
+           
+ voidsetKeyExchangeFactories(List<Factory.Named<KeyExchange>> kexFactories) + +
+          Set the named factories for KeyExchange.
+ voidsetMACFactories(Factory.Named<MAC>... macFactories) + +
+           
+ voidsetMACFactories(List<Factory.Named<MAC>> macFactories) + +
+          Set the named factories for MAC.
+ voidsetRandomFactory(Factory<Random> randomFactory) + +
+          Set the factory for Random.
+ voidsetSignatureFactories(Factory.Named<Signature>... signatureFactories) + +
+           
+ voidsetSignatureFactories(List<Factory.Named<Signature>> signatureFactories) + +
+          Set the named factories for Signature.
+ voidsetVersion(String version) + +
+          Set the software version information for identification during SSH connection initialization.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ConfigImpl

+
+public ConfigImpl()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getCipherFactories

+
+public List<Factory.Named<Cipher>> getCipherFactories()
+
+
Description copied from interface: Config
+
Retrieve the list of named factories for Cipher. +

+

+
Specified by:
getCipherFactories in interface Config
+
+
+ +
Returns:
a list of named Cipher factories
+
+
+
+ +

+getCompressionFactories

+
+public List<Factory.Named<Compression>> getCompressionFactories()
+
+
Description copied from interface: Config
+
Retrieve the list of named factories for Compression. +

+

+
Specified by:
getCompressionFactories in interface Config
+
+
+ +
Returns:
a list of named Compression factories
+
+
+
+ +

+getFileKeyProviderFactories

+
+public List<Factory.Named<FileKeyProvider>> getFileKeyProviderFactories()
+
+
Description copied from interface: Config
+
Retrieve the list of named factories for FileKeyProvider. +

+

+
Specified by:
getFileKeyProviderFactories in interface Config
+
+
+ +
Returns:
a list of named FileKeyProvider factories
+
+
+
+ +

+getKeyExchangeFactories

+
+public List<Factory.Named<KeyExchange>> getKeyExchangeFactories()
+
+
Description copied from interface: Config
+
Retrieve the list of named factories for KeyExchange. +

+

+
Specified by:
getKeyExchangeFactories in interface Config
+
+
+ +
Returns:
a list of named KeyExchange factories
+
+
+
+ +

+getMACFactories

+
+public List<Factory.Named<MAC>> getMACFactories()
+
+
Description copied from interface: Config
+
Retrieve the list of named factories for MAC. +

+

+
Specified by:
getMACFactories in interface Config
+
+
+ +
Returns:
a list of named MAC factories
+
+
+
+ +

+getRandomFactory

+
+public Factory<Random> getRandomFactory()
+
+
Description copied from interface: Config
+
Retrieve the Random factory. +

+

+
Specified by:
getRandomFactory in interface Config
+
+
+ +
Returns:
the Random factory
+
+
+
+ +

+getSignatureFactories

+
+public List<Factory.Named<Signature>> getSignatureFactories()
+
+
Description copied from interface: Config
+
Retrieve the list of named factories for Signature +

+

+
Specified by:
getSignatureFactories in interface Config
+
+
+ +
Returns:
a list of named Signature factories
+
+
+
+ +

+getVersion

+
+public String getVersion()
+
+
Description copied from interface: Config
+
Returns the software version information for identification during SSH connection initialization. For example, + "NET_3_0". +

+

+
Specified by:
getVersion in interface Config
+
+
+
+
+
+
+ +

+setCipherFactories

+
+public void setCipherFactories(Factory.Named<Cipher>... cipherFactories)
+
+
+
+
+
+
+
+
+
+ +

+setCipherFactories

+
+public void setCipherFactories(List<Factory.Named<Cipher>> cipherFactories)
+
+
Description copied from interface: Config
+
Set the named factories for Cipher. +

+

+
Specified by:
setCipherFactories in interface Config
+
+
+
Parameters:
cipherFactories - a list of named factories
+
+
+
+ +

+setCompressionFactories

+
+public void setCompressionFactories(Factory.Named<Compression>... compressionFactories)
+
+
+
+
+
+
+
+
+
+ +

+setCompressionFactories

+
+public void setCompressionFactories(List<Factory.Named<Compression>> compressionFactories)
+
+
Description copied from interface: Config
+
Set the named factories for Compression. +

+

+
Specified by:
setCompressionFactories in interface Config
+
+
+
Parameters:
compressionFactories - a list of named factories
+
+
+
+ +

+setFileKeyProviderFactories

+
+public void setFileKeyProviderFactories(Factory.Named<FileKeyProvider>... fileKeyProviderFactories)
+
+
+
+
+
+
+
+
+
+ +

+setFileKeyProviderFactories

+
+public void setFileKeyProviderFactories(List<Factory.Named<FileKeyProvider>> fileKeyProviderFactories)
+
+
Description copied from interface: Config
+
Set the named factories for FileKeyProvider. +

+

+
Specified by:
setFileKeyProviderFactories in interface Config
+
+
+
Parameters:
fileKeyProviderFactories - a list of named factories
+
+
+
+ +

+setKeyExchangeFactories

+
+public void setKeyExchangeFactories(Factory.Named<KeyExchange>... kexFactories)
+
+
+
+
+
+
+
+
+
+ +

+setKeyExchangeFactories

+
+public void setKeyExchangeFactories(List<Factory.Named<KeyExchange>> kexFactories)
+
+
Description copied from interface: Config
+
Set the named factories for KeyExchange. +

+

+
Specified by:
setKeyExchangeFactories in interface Config
+
+
+
Parameters:
kexFactories - a list of named factories
+
+
+
+ +

+setMACFactories

+
+public void setMACFactories(Factory.Named<MAC>... macFactories)
+
+
+
+
+
+
+
+
+
+ +

+setMACFactories

+
+public void setMACFactories(List<Factory.Named<MAC>> macFactories)
+
+
Description copied from interface: Config
+
Set the named factories for MAC. +

+

+
Specified by:
setMACFactories in interface Config
+
+
+
Parameters:
macFactories - a list of named factories
+
+
+
+ +

+setRandomFactory

+
+public void setRandomFactory(Factory<Random> randomFactory)
+
+
Description copied from interface: Config
+
Set the factory for Random. +

+

+
Specified by:
setRandomFactory in interface Config
+
+
+
Parameters:
randomFactory - the factory
+
+
+
+ +

+setSignatureFactories

+
+public void setSignatureFactories(Factory.Named<Signature>... signatureFactories)
+
+
+
+
+
+
+
+
+
+ +

+setSignatureFactories

+
+public void setSignatureFactories(List<Factory.Named<Signature>> signatureFactories)
+
+
Description copied from interface: Config
+
Set the named factories for Signature. +

+

+
Specified by:
setSignatureFactories in interface Config
+
+
+
Parameters:
signatureFactories - a list of named factories
+
+
+
+ +

+setVersion

+
+public void setVersion(String version)
+
+
Description copied from interface: Config
+
Set the software version information for identification during SSH connection initialization. For example, "SSHJ_0_1". +

+

+
Specified by:
setVersion in interface Config
+
+
+
Parameters:
version - software version info
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/DefaultConfig.html b/javadoc/0.4.1/net/schmizz/sshj/DefaultConfig.html new file mode 100644 index 00000000..98a4c0cf --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/DefaultConfig.html @@ -0,0 +1,395 @@ + + + + + + + +DefaultConfig (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj +
+Class DefaultConfig

+
+java.lang.Object
+  extended by net.schmizz.sshj.ConfigImpl
+      extended by net.schmizz.sshj.DefaultConfig
+
+
+
All Implemented Interfaces:
Config
+
+
+
Direct Known Subclasses:
AndroidConfig
+
+
+
+
public class DefaultConfig
extends ConfigImpl
+ + +

+A Config that is initialized as follows. Items marked with an asterisk are added to the config only if + BouncyCastle is in the classpath. +

+

+

+ [1] It is worth noting that Sun's JRE does not have the unlimited cryptography extension enabled by default. This + prevents using ciphers with strength greater than 128. +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
DefaultConfig() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+protected  voidinitCipherFactories() + +
+           
+protected  voidinitCompressionFactories() + +
+           
+protected  voidinitFileKeyProviderFactories(boolean bouncyCastleRegistered) + +
+           
+protected  voidinitKeyExchangeFactories(boolean bouncyCastleRegistered) + +
+           
+protected  voidinitMACFactories() + +
+           
+protected  voidinitRandomFactory(boolean bouncyCastleRegistered) + +
+           
+protected  voidinitSignatureFactories() + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.ConfigImpl
getCipherFactories, getCompressionFactories, getFileKeyProviderFactories, getKeyExchangeFactories, getMACFactories, getRandomFactory, getSignatureFactories, getVersion, setCipherFactories, setCipherFactories, setCompressionFactories, setCompressionFactories, setFileKeyProviderFactories, setFileKeyProviderFactories, setKeyExchangeFactories, setKeyExchangeFactories, setMACFactories, setMACFactories, setRandomFactory, setSignatureFactories, setSignatureFactories, setVersion
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DefaultConfig

+
+public DefaultConfig()
+
+
+ + + + + + + + +
+Method Detail
+ +

+initKeyExchangeFactories

+
+protected void initKeyExchangeFactories(boolean bouncyCastleRegistered)
+
+
+
+
+
+
+ +

+initRandomFactory

+
+protected void initRandomFactory(boolean bouncyCastleRegistered)
+
+
+
+
+
+
+ +

+initFileKeyProviderFactories

+
+protected void initFileKeyProviderFactories(boolean bouncyCastleRegistered)
+
+
+
+
+
+
+ +

+initCipherFactories

+
+protected void initCipherFactories()
+
+
+
+
+
+
+ +

+initSignatureFactories

+
+protected void initSignatureFactories()
+
+
+
+
+
+
+ +

+initMACFactories

+
+protected void initMACFactories()
+
+
+
+
+
+
+ +

+initCompressionFactories

+
+protected void initCompressionFactories()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/SSHClient.html b/javadoc/0.4.1/net/schmizz/sshj/SSHClient.html new file mode 100644 index 00000000..eb83b9af --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/SSHClient.html @@ -0,0 +1,1861 @@ + + + + + + + +SSHClient (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj +
+Class SSHClient

+
+java.lang.Object
+  extended by net.schmizz.sshj.SSHClient
+
+
+
All Implemented Interfaces:
SessionFactory
+
+
+
+
public class SSHClient
extends Object
implements SessionFactory
+ + +

+Secure SHell client API. +

+ Before connection is established, host key verification needs to be accounted for. This is done by specifying one or more HostKeyVerifier objects. Database of known + hostname-key pairs in the OpenSSH "known_hosts" format can be loaded for host + key verification. +

+ User authentication can be performed by any of the auth*() method. +

+ startSession() caters to the most typical use case of starting a session channel and executing a + remote command, starting a subsystem, etc. If you wish to request X11 forwarding for some session, first register a ConnectListener for x11 channels. +

+ Local and remote port forwarding is possible. There + are also utility method for easily creating SCP and SFTP + implementations. +

+ A simple example: +

+

+ client = new SSHClient();
+ client.initUserKnownHosts();
+ client.connect("hostname");
+ try {
+     client.authPassword("username", "password");
+     final Session session = client.startSession();
+     try {
+          final Command cmd = session.exec("true");
+          cmd.join(1, TimeUnit.SECONDS);
+     } finally {
+          session.close();
+    } finally {
+     client.disconnect();
+ }
+ 
+

+ Where a password or passphrase is required, if you're extra-paranoid use the char[] based method. The char[] will be blanked out after use. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+protected  UserAuthauth + +
+          ssh-userauth service
+protected  Connectionconn + +
+          ssh-connection service
+static intDEFAULT_PORT + +
+          Default port for SSH
+protected  org.slf4j.Loggerlog + +
+          Logger
+protected  Transporttrans + +
+          Transport layer
+  + + + + + + + + + + + + + +
+Constructor Summary
SSHClient() + +
+          Default constructor.
SSHClient(Config config) + +
+          Constructor that allows specifying a config to be used.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddHostKeyVerifier(HostKeyVerifier hostKeyVerifier) + +
+          Add a HostKeyVerifier which will be invoked for verifying host key during connection establishment and + future key exchanges.
+ voidaddHostKeyVerifier(String fingerprint) + +
+          Add a HostKeyVerifier that will verify any host that's able to claim a host key with the given fingerprint, e.g.
+ voidauth(String username, + AuthMethod... methods) + +
+          Authenticate username using the supplied methods.
+ voidauth(String username, + Iterable<AuthMethod> methods) + +
+          Authenticate username using the supplied methods.
+ voidauthPassword(String username, + char[] password) + +
+          Authenticate username using the "password" authentication method and as a fallback basic + challenge-response authentication..
+ voidauthPassword(String username, + PasswordFinder pfinder) + +
+          Authenticate username using the "password" authentication method and as a fallback basic + challenge-response authentication.
+ voidauthPassword(String username, + String password) + +
+          Authenticate username using the "password" authentication method and as a fallback basic + challenge-response authentication.
+ voidauthPublickey(String username) + +
+          Authenticate username using the "publickey" authentication method, with keys from some common + locations on the file system.
+ voidauthPublickey(String username, + Iterable<KeyProvider> keyProviders) + +
+          Authenticate username using the "publickey" authentication method.
+ voidauthPublickey(String username, + KeyProvider... keyProviders) + +
+          Authenticate username using the "publickey" authentication method.
+ voidauthPublickey(String username, + String... locations) + +
+          Authenticate username using the "publickey" authentication method, with keys from one or more + locations in the file system.
+ voidconnect(InetAddress host) + +
+           
+ voidconnect(InetAddress host, + int port) + +
+           
+ voidconnect(InetAddress host, + int port, + InetAddress localAddr, + int localPort) + +
+           
+ voidconnect(String hostname) + +
+           
+ voidconnect(String hostname, + int port) + +
+           
+ voidconnect(String hostname, + int port, + InetAddress localAddr, + int localPort) + +
+           
+ voiddisconnect() + +
+          Disconnects from the connected SSH server.
+protected  voiddoKex() + +
+          Do key exchange.
+ ConnectiongetConnection() + +
+           
+ intgetConnectTimeout() + +
+           
+ InetAddressgetLocalAddress() + +
+           
+ intgetLocalPort() + +
+           
+ InetAddressgetRemoteAddress() + +
+           
+ StringgetRemoteHostname() + +
+           
+ intgetRemotePort() + +
+           
+ RemotePortForwardergetRemotePortForwarder() + +
+           
+ ServerSocketFactorygetServerSocketFactory() + +
+           
+ SocketgetSocket() + +
+           
+ SocketFactorygetSocketFactory() + +
+           
+ intgetTimeout() + +
+           
+ TransportgetTransport() + +
+           
+ UserAuthgetUserAuth() + +
+           
+ booleanisAuthenticated() + +
+           
+ booleanisConnected() + +
+           
+ KeyProviderloadKeys(KeyPair kp) + +
+          Creates a KeyProvider from supplied KeyPair.
+ KeyProviderloadKeys(String location) + +
+          Returns a KeyProvider instance created from a location on the file system where an unencrypted + private key file (does not require a passphrase) can be found.
+ KeyProviderloadKeys(String location, + char[] passphrase) + +
+          Utility function for createing a KeyProvider instance from given location on the file system.
+ KeyProviderloadKeys(String location, + PasswordFinder passwordFinder) + +
+          Creates a KeyProvider instance from given location on the file system.
+ KeyProviderloadKeys(String location, + String passphrase) + +
+          Convenience method for creating a KeyProvider instance from a location where an encrypted + key file is located.
+ KeyProviderloadKeys(String privateKey, + String publicKey, + PasswordFinder passwordFinder) + +
+          Creates a KeyProvider instance from passed strings.
+ voidloadKnownHosts() + +
+          Attempts loading the user's known_hosts file from the default locations, i.e.
+ voidloadKnownHosts(File location) + +
+          Adds a OpenSSHKnownHosts object created from the specified location as a host key verifier.
+ LocalPortForwardernewLocalPortForwarder(SocketAddress address, + String host, + int port) + +
+          Create a LocalPortForwarder that will listen on address and forward incoming connections to the + server; which will further forward them to host:port.
+ SCPFileTransfernewSCPFileTransfer() + +
+           
+ SFTPClientnewSFTPClient() + +
+           
+protected  voidonConnect() + +
+          On connection establishment, also initializes the SSH transport via Transport.init(java.lang.String, int, java.io.InputStream, java.io.OutputStream) and doKex().
+ X11ForwarderregisterX11Forwarder(ConnectListener listener) + +
+          Register a listener for handling forwarded X11 channels.
+ voidrekey() + +
+          Does key re-exchange.
+ voidsetConnectTimeout(int connectTimeout) + +
+           
+ voidsetServerSocketFactory(ServerSocketFactory factory) + +
+           
+ voidsetSocketFactory(SocketFactory factory) + +
+           
+ voidsetTimeout(int timeout) + +
+           
+ SessionstartSession() + +
+          Opens a session channel.
+ voiduseCompression() + +
+          Adds zlib compression to preferred compression algorithms.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+DEFAULT_PORT

+
+public static final int DEFAULT_PORT
+
+
Default port for SSH +

+

+
See Also:
Constant Field Values
+
+
+ +

+log

+
+protected final org.slf4j.Logger log
+
+
Logger +

+

+
+
+
+ +

+trans

+
+protected final Transport trans
+
+
Transport layer +

+

+
+
+
+ +

+auth

+
+protected final UserAuth auth
+
+
ssh-userauth service +

+

+
+
+
+ +

+conn

+
+protected final Connection conn
+
+
ssh-connection service +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+SSHClient

+
+public SSHClient()
+
+
Default constructor. Initializes this object using DefaultConfig. +

+

+
+ +

+SSHClient

+
+public SSHClient(Config config)
+
+
Constructor that allows specifying a config to be used. +

+

+
Parameters:
config - Config instance
+
+ + + + + + + + +
+Method Detail
+ +

+addHostKeyVerifier

+
+public void addHostKeyVerifier(HostKeyVerifier hostKeyVerifier)
+
+
Add a HostKeyVerifier which will be invoked for verifying host key during connection establishment and + future key exchanges. +

+

+
+
+
+
Parameters:
hostKeyVerifier - HostKeyVerifier instance
+
+
+
+ +

+addHostKeyVerifier

+
+public void addHostKeyVerifier(String fingerprint)
+
+
Add a HostKeyVerifier that will verify any host that's able to claim a host key with the given fingerprint, e.g. "4b:69:6c:72:6f:79:20:77:61:73:20:68:65:72:65:21" +

+

+
+
+
+
Parameters:
fingerprint - expected fingerprint in colon-delimited format (16 octets in hex delimited by a colon)
See Also:
SecurityUtils.getFingerprint(java.security.PublicKey)
+
+
+
+ +

+auth

+
+public void auth(String username,
+                 AuthMethod... methods)
+          throws UserAuthException,
+                 TransportException
+
+
Authenticate username using the supplied methods. +

+

+
+
+
+
Parameters:
username - user to authenticate
methods - one or more authentication method +
Throws: +
UserAuthException - in case of authentication failure +
TransportException - if there was a transport-layer error
+
+
+
+ +

+auth

+
+public void auth(String username,
+                 Iterable<AuthMethod> methods)
+          throws UserAuthException,
+                 TransportException
+
+
Authenticate username using the supplied methods. +

+

+
+
+
+
Parameters:
username - user to authenticate
methods - one or more authentication method +
Throws: +
UserAuthException - in case of authentication failure +
TransportException - if there was a transport-layer error
+
+
+
+ +

+authPassword

+
+public void authPassword(String username,
+                         String password)
+                  throws UserAuthException,
+                         TransportException
+
+
Authenticate username using the "password" authentication method and as a fallback basic + challenge-response authentication. +

+

+
+
+
+
Parameters:
username - user to authenticate
password - the password to use for authentication +
Throws: +
UserAuthException - in case of authentication failure +
TransportException - if there was a transport-layer error
+
+
+
+ +

+authPassword

+
+public void authPassword(String username,
+                         char[] password)
+                  throws UserAuthException,
+                         TransportException
+
+
Authenticate username using the "password" authentication method and as a fallback basic + challenge-response authentication.. The password array is blanked out after use. +

+

+
+
+
+
Parameters:
username - user to authenticate
password - the password to use for authentication +
Throws: +
UserAuthException - in case of authentication failure +
TransportException - if there was a transport-layer error
+
+
+
+ +

+authPassword

+
+public void authPassword(String username,
+                         PasswordFinder pfinder)
+                  throws UserAuthException,
+                         TransportException
+
+
Authenticate username using the "password" authentication method and as a fallback basic + challenge-response authentication. +

+

+
+
+
+
Parameters:
username - user to authenticate
pfinder - the PasswordFinder to use for authentication +
Throws: +
UserAuthException - in case of authentication failure +
TransportException - if there was a transport-layer error
+
+
+
+ +

+authPublickey

+
+public void authPublickey(String username)
+                   throws UserAuthException,
+                          TransportException
+
+
Authenticate username using the "publickey" authentication method, with keys from some common + locations on the file system. This method relies on ~/.ssh/id_rsa and ~/.ssh/id_dsa. +

+ This method does not provide a way to specify a passphrase. +

+

+
+
+
+
Parameters:
username - user to authenticate +
Throws: +
UserAuthException - in case of authentication failure +
TransportException - if there was a transport-layer error
+
+
+
+ +

+authPublickey

+
+public void authPublickey(String username,
+                          Iterable<KeyProvider> keyProviders)
+                   throws UserAuthException,
+                          TransportException
+
+
Authenticate username using the "publickey" authentication method. +

+ KeyProvider instances can be created using any of the of the loadKeys() method provided in this + class. In case multiple keyProviders are specified; authentication is attempted in order as long as the + "publickey" authentication method is available. +

+

+
+
+
+
Parameters:
username - user to authenticate
keyProviders - one or more KeyProvider instances +
Throws: +
UserAuthException - in case of authentication failure +
TransportException - if there was a transport-layer error
+
+
+
+ +

+authPublickey

+
+public void authPublickey(String username,
+                          KeyProvider... keyProviders)
+                   throws UserAuthException,
+                          TransportException
+
+
Authenticate username using the "publickey" authentication method. +

+ KeyProvider instances can be created using any of the loadKeys() method provided in this class. + In case multiple keyProviders are specified; authentication is attempted in order as long as the "publickey" authentication method is available. +

+

+
+
+
+
Parameters:
username - user to authenticate
keyProviders - one or more KeyProvider instances +
Throws: +
UserAuthException - in case of authentication failure +
TransportException - if there was a transport-layer error
+
+
+
+ +

+authPublickey

+
+public void authPublickey(String username,
+                          String... locations)
+                   throws UserAuthException,
+                          TransportException
+
+
Authenticate username using the "publickey" authentication method, with keys from one or more + locations in the file system. +

+ In case multiple locations are specified; authentication is attempted in order as long as the "publickey" authentication method is available. If there is an error loading keys from any of them (e.g. file + could not be read, file format not recognized) that key file it is ignored. +

+ This method does not provide a way to specify a passphrase. +

+

+
+
+
+
Parameters:
username - user to authenticate
locations - one or more locations in the file system containing the private key +
Throws: +
UserAuthException - in case of authentication failure +
TransportException - if there was a transport-layer error
+
+
+
+ +

+disconnect

+
+public void disconnect()
+                throws IOException
+
+
Disconnects from the connected SSH server. SSHClient objects are not reusable therefore it is incorrect + to attempt connection after this method has been called. +

+ This method should be called from a finally construct after connection is established; so that proper + cleanup is done and the thread spawned by the transport layer for dealing with incoming packets is stopped. +

+

+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+getConnection

+
+public Connection getConnection()
+
+
+
+
+
+ +
Returns:
the associated Connection instance.
+
+
+
+ +

+getRemotePortForwarder

+
+public RemotePortForwarder getRemotePortForwarder()
+
+
+
+
+
+ +
Returns:
a RemotePortForwarder that allows requesting remote forwarding over this connection.
+
+
+
+ +

+getTransport

+
+public Transport getTransport()
+
+
+
+
+
+ +
Returns:
the associated Transport instance.
+
+
+
+ +

+getUserAuth

+
+public UserAuth getUserAuth()
+
+
+
+
+
+ +
Returns:
the associated UserAuth instance. This allows access to information like the authentication banner, whether authentication was at least partially successful, and any saved + exceptions that were ignored because there were more authentication method that could be tried.
+
+
+
+ +

+isAuthenticated

+
+public boolean isAuthenticated()
+
+
+
+
+
+ +
Returns:
whether authenticated.
+
+
+
+ +

+isConnected

+
+public boolean isConnected()
+
+
+
+
+
+ +
Returns:
whether connected.
+
+
+
+ +

+loadKeys

+
+public KeyProvider loadKeys(KeyPair kp)
+
+
Creates a KeyProvider from supplied KeyPair. +

+

+
+
+
+
Parameters:
kp - the key pair +
Returns:
the key provider ready for use in authentication
+
+
+
+ +

+loadKeys

+
+public KeyProvider loadKeys(String location)
+                     throws IOException
+
+
Returns a KeyProvider instance created from a location on the file system where an unencrypted + private key file (does not require a passphrase) can be found. Simply calls loadKeys(String, + PasswordFinder) with the PasswordFinder argument as null. +

+

+
+
+
+
Parameters:
location - the location for the key file +
Returns:
the key provider ready for use in authentication +
Throws: +
SSHException - if there was no suitable key provider available for the file format; typically because + BouncyCastle is not in the classpath +
IOException - if the key file format is not known, if the file could not be read, etc.
+
+
+
+ +

+loadKeys

+
+public KeyProvider loadKeys(String location,
+                            char[] passphrase)
+                     throws IOException
+
+
Utility function for createing a KeyProvider instance from given location on the file system. Creates a + one-off PasswordFinder using PasswordUtils.createOneOff(char[]), and calls loadKeys(String,PasswordFinder). +

+

+
+
+
+
Parameters:
location - location of the key file
passphrase - passphrase as a char-array +
Returns:
the key provider ready for use in authentication +
Throws: +
SSHException - if there was no suitable key provider available for the file format; typically because + BouncyCastle is not in the classpath +
IOException - if the key file format is not known, if the file could not be read, etc.
+
+
+
+ +

+loadKeys

+
+public KeyProvider loadKeys(String location,
+                            PasswordFinder passwordFinder)
+                     throws IOException
+
+
Creates a KeyProvider instance from given location on the file system. Currently only PKCS8 format + private key files are supported (OpenSSH uses this format). +

+

+

+
+
+
+
Parameters:
location - the location of the key file
passwordFinder - the PasswordFinder that can supply the passphrase for decryption (may be null in case keyfile is not encrypted) +
Returns:
the key provider ready for use in authentication +
Throws: +
SSHException - if there was no suitable key provider available for the file format; typically because + BouncyCastle is not in the classpath +
IOException - if the key file format is not known, if the file could not be read, etc.
+
+
+
+ +

+loadKeys

+
+public KeyProvider loadKeys(String location,
+                            String passphrase)
+                     throws IOException
+
+
Convenience method for creating a KeyProvider instance from a location where an encrypted + key file is located. Calls loadKeys(String, char[]) with a character array created from the supplied + passphrase string. +

+

+
+
+
+
Parameters:
location - location of the key file
passphrase - passphrase as a string +
Returns:
the key provider for use in authentication +
Throws: +
IOException - if the key file format is not known, if the file could not be read etc.
+
+
+
+ +

+loadKeys

+
+public KeyProvider loadKeys(String privateKey,
+                            String publicKey,
+                            PasswordFinder passwordFinder)
+                     throws IOException
+
+
Creates a KeyProvider instance from passed strings. Currently only PKCS8 format + private key files are supported (OpenSSH uses this format). +

+

+

+
+
+
+
Parameters:
privateKey - the private key as a string
publicKey - the public key as a string if it's not included with the private key
passwordFinder - the PasswordFinder that can supply the passphrase for decryption (may be null in case keyfile is not encrypted) +
Returns:
the key provider ready for use in authentication +
Throws: +
SSHException - if there was no suitable key provider available for the file format; typically because + BouncyCastle is not in the classpath +
IOException - if the key file format is not known, etc.
+
+
+
+ +

+loadKnownHosts

+
+public void loadKnownHosts()
+                    throws IOException
+
+
Attempts loading the user's known_hosts file from the default locations, i.e. ~/.ssh/known_hosts + and ~/.ssh/known_hosts2 on most platforms. Adds the resulting OpenSSHKnownHosts object as a host + key verifier. +

+ For finer control over which file is used, see loadKnownHosts(File). +

+

+
+
+
+ +
Throws: +
IOException - if there is an error loading from both locations
+
+
+
+ +

+loadKnownHosts

+
+public void loadKnownHosts(File location)
+                    throws IOException
+
+
Adds a OpenSSHKnownHosts object created from the specified location as a host key verifier. +

+

+
+
+
+
Parameters:
location - location for known_hosts file +
Throws: +
IOException - if there is an error loading from any of these locations
+
+
+
+ +

+newLocalPortForwarder

+
+public LocalPortForwarder newLocalPortForwarder(SocketAddress address,
+                                                String host,
+                                                int port)
+                                         throws IOException
+
+
Create a LocalPortForwarder that will listen on address and forward incoming connections to the + server; which will further forward them to host:port. +

+ The returned forwarder's listen() method should be called to actually start + listening, this method just creates an instance. +

+

+
+
+
+
Parameters:
address - defines where the LocalPortForwarder listens
host - hostname to which the server will forward
port - the port at hostname to which the server wil forward +
Returns:
a LocalPortForwarder +
Throws: +
IOException - if there is an error opening a local server socket
+
+
+
+ +

+registerX11Forwarder

+
+public X11Forwarder registerX11Forwarder(ConnectListener listener)
+
+
Register a listener for handling forwarded X11 channels. Without having done this, an incoming X11 + forwarding will be summarily rejected. +

+ It should be clarified that multiple listeners for X11 forwarding over a single SSH connection are not supported + (and don't make much sense). So a subsequent call to this method is only going to replace the registered listener. +

+

+
+
+
+
Parameters:
listener - the ConnectListener that should be delegated the responsibility of handling forwarded + X11Forwarder.X11Channel 's +
Returns:
an X11Forwarder that allows to stop acting on X11 requests from + server
+
+
+
+ +

+newSCPFileTransfer

+
+public SCPFileTransfer newSCPFileTransfer()
+
+
+
+
+
+ +
Returns:
Instantiated SCPFileTransfer implementation.
+
+
+
+ +

+newSFTPClient

+
+public SFTPClient newSFTPClient()
+                         throws IOException
+
+
+
+
+
+ +
Returns:
Instantiated SFTPClient implementation. +
Throws: +
IOException - if there is an error starting the sftp subsystem
See Also:
StatefulSFTPClient
+
+
+
+ +

+rekey

+
+public void rekey()
+           throws TransportException
+
+
Does key re-exchange. +

+

+
+
+
+ +
Throws: +
TransportException - if an error occurs during key exchange
+
+
+
+ +

+startSession

+
+public Session startSession()
+                     throws ConnectionException,
+                            TransportException
+
+
Description copied from interface: SessionFactory
+
Opens a session channel. The returned Session instance allows executing a remote command, starting a subsystem, or starting a shell. +

+

+
Specified by:
startSession in interface SessionFactory
+
+
+ +
Returns:
the opened session channel +
Throws: +
ConnectionException +
TransportException
See Also:
Session
+
+
+
+ +

+useCompression

+
+public void useCompression()
+                    throws TransportException
+
+
Adds zlib compression to preferred compression algorithms. There is no guarantee that it will be + successfully negotiatied. +

+ If the client is already connected renegotiation is done; otherwise this method simply returns (and compression + will be negotiated during connection establishment). +

+

+
+
+
+ +
Throws: +
ClassNotFoundException - if JZlib is not in classpath +
TransportException - if an error occurs during renegotiation
+
+
+
+ +

+onConnect

+
+protected void onConnect()
+                  throws IOException
+
+
On connection establishment, also initializes the SSH transport via Transport.init(java.lang.String, int, java.io.InputStream, java.io.OutputStream) and doKex(). +

+

+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+doKex

+
+protected void doKex()
+              throws TransportException
+
+
Do key exchange. +

+

+
+
+
+ +
Throws: +
TransportException - if error during kex
+
+
+
+ +

+connect

+
+public void connect(InetAddress host,
+                    int port)
+             throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+connect

+
+public void connect(String hostname,
+                    int port)
+             throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+connect

+
+public void connect(InetAddress host,
+                    int port,
+                    InetAddress localAddr,
+                    int localPort)
+             throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+connect

+
+public void connect(String hostname,
+                    int port,
+                    InetAddress localAddr,
+                    int localPort)
+             throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+connect

+
+public void connect(InetAddress host)
+             throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+connect

+
+public void connect(String hostname)
+             throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+getLocalPort

+
+public int getLocalPort()
+
+
+
+
+
+
+ +

+getLocalAddress

+
+public InetAddress getLocalAddress()
+
+
+
+
+
+
+ +

+getRemoteHostname

+
+public String getRemoteHostname()
+
+
+
+
+
+
+ +

+getRemotePort

+
+public int getRemotePort()
+
+
+
+
+
+
+ +

+getRemoteAddress

+
+public InetAddress getRemoteAddress()
+
+
+
+
+
+
+ +

+setSocketFactory

+
+public void setSocketFactory(SocketFactory factory)
+
+
+
+
+
+
+ +

+getSocketFactory

+
+public SocketFactory getSocketFactory()
+
+
+
+
+
+
+ +

+setServerSocketFactory

+
+public void setServerSocketFactory(ServerSocketFactory factory)
+
+
+
+
+
+
+ +

+getServerSocketFactory

+
+public ServerSocketFactory getServerSocketFactory()
+
+
+
+
+
+
+ +

+getConnectTimeout

+
+public int getConnectTimeout()
+
+
+
+
+
+
+ +

+setConnectTimeout

+
+public void setConnectTimeout(int connectTimeout)
+
+
+
+
+
+
+ +

+getTimeout

+
+public int getTimeout()
+
+
+
+
+
+
+ +

+setTimeout

+
+public void setTimeout(int timeout)
+
+
+
+
+
+
+ +

+getSocket

+
+public Socket getSocket()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/Service.html b/javadoc/0.4.1/net/schmizz/sshj/Service.html new file mode 100644 index 00000000..9d9f2fc4 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/Service.html @@ -0,0 +1,315 @@ + + + + + + + +Service (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj +
+Interface Service

+
+
All Superinterfaces:
ErrorNotifiable, SSHPacketHandler
+
+
+
All Known Implementing Classes:
AbstractService, ConnectionImpl, UserAuthImpl
+
+
+
+
public interface Service
extends SSHPacketHandler, ErrorNotifiable
+ + +

+Represents a service running on top of the SSH transport layer. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable
ErrorNotifiable.Util
+  + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StringgetName() + +
+           
+ voidnotifyUnimplemented(long seqNum) + +
+          Notifies this service that a SSH_MSG_UNIMPLEMENTED was received for packet with given sequence number.
+ voidrequest() + +
+          Request and install this service with the associated transport.
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.SSHPacketHandler
handle
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.ErrorNotifiable
notifyError
+  +

+ + + + + + + + +
+Method Detail
+ +

+getName

+
+String getName()
+
+
+
+
+
+ +
Returns:
the assigned name for this SSH service.
+
+
+
+ +

+notifyUnimplemented

+
+void notifyUnimplemented(long seqNum)
+                         throws SSHException
+
+
Notifies this service that a SSH_MSG_UNIMPLEMENTED was received for packet with given sequence number. + Meant to be invoked as a callback by the transport layer. +

+

+
+
+
+
Parameters:
seqNum - sequence number of the packet which the server claims is unimplemented +
Throws: +
SSHException - if the packet is unexpected and may represent a disruption
+
+
+
+ +

+request

+
+void request()
+             throws TransportException
+
+
Request and install this service with the associated transport. Implementations should aim to make this method + idempotent by first checking the Transport.getService() currently active + service}. +

+

+
+
+
+ +
Throws: +
TransportException - if there is an error sending the service request
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/class-use/AbstractService.html b/javadoc/0.4.1/net/schmizz/sshj/class-use/AbstractService.html new file mode 100644 index 00000000..5c8aac56 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/class-use/AbstractService.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Class net.schmizz.sshj.AbstractService (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.AbstractService

+
+ + + + + + + + + + + + + +
+Packages that use AbstractService
net.schmizz.sshj.connection  
net.schmizz.sshj.userauth  
+  +

+ + + + + +
+Uses of AbstractService in net.schmizz.sshj.connection
+  +

+ + + + + + + + + +
Subclasses of AbstractService in net.schmizz.sshj.connection
+ classConnectionImpl + +
+          Connection implementation.
+  +

+ + + + + +
+Uses of AbstractService in net.schmizz.sshj.userauth
+  +

+ + + + + + + + + +
Subclasses of AbstractService in net.schmizz.sshj.userauth
+ classUserAuthImpl + +
+          UserAuth implementation.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/class-use/AndroidConfig.html b/javadoc/0.4.1/net/schmizz/sshj/class-use/AndroidConfig.html new file mode 100644 index 00000000..9c58f8cd --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/class-use/AndroidConfig.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.AndroidConfig (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.AndroidConfig

+
+No usage of net.schmizz.sshj.AndroidConfig +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/class-use/Config.html b/javadoc/0.4.1/net/schmizz/sshj/class-use/Config.html new file mode 100644 index 00000000..4b266f22 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/class-use/Config.html @@ -0,0 +1,262 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.Config (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.Config

+
+ + + + + + + + + + + + + +
+Packages that use Config
net.schmizz.sshj  
net.schmizz.sshj.transport  
+  +

+ + + + + +
+Uses of Config in net.schmizz.sshj
+  +

+ + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj that implement Config
+ classAndroidConfig + +
+           
+ classConfigImpl + +
+           
+ classDefaultConfig + +
+          A Config that is initialized as follows.
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj with parameters of type Config
SSHClient(Config config) + +
+          Constructor that allows specifying a config to be used.
+  +

+ + + + + +
+Uses of Config in net.schmizz.sshj.transport
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport that return Config
+ ConfigTransportImpl.getConfig() + +
+           
+ ConfigTransport.getConfig() + +
+           
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.transport with parameters of type Config
TransportImpl(Config config) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/class-use/ConfigImpl.html b/javadoc/0.4.1/net/schmizz/sshj/class-use/ConfigImpl.html new file mode 100644 index 00000000..19f725f8 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/class-use/ConfigImpl.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class net.schmizz.sshj.ConfigImpl (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.ConfigImpl

+
+ + + + + + + + + +
+Packages that use ConfigImpl
net.schmizz.sshj  
+  +

+ + + + + +
+Uses of ConfigImpl in net.schmizz.sshj
+  +

+ + + + + + + + + + + + + +
Subclasses of ConfigImpl in net.schmizz.sshj
+ classAndroidConfig + +
+           
+ classDefaultConfig + +
+          A Config that is initialized as follows.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/class-use/DefaultConfig.html b/javadoc/0.4.1/net/schmizz/sshj/class-use/DefaultConfig.html new file mode 100644 index 00000000..45d72408 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/class-use/DefaultConfig.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class net.schmizz.sshj.DefaultConfig (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.DefaultConfig

+
+ + + + + + + + + +
+Packages that use DefaultConfig
net.schmizz.sshj  
+  +

+ + + + + +
+Uses of DefaultConfig in net.schmizz.sshj
+  +

+ + + + + + + + + +
Subclasses of DefaultConfig in net.schmizz.sshj
+ classAndroidConfig + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/class-use/SSHClient.html b/javadoc/0.4.1/net/schmizz/sshj/class-use/SSHClient.html new file mode 100644 index 00000000..5afb6f1a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/class-use/SSHClient.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.SSHClient (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.SSHClient

+
+No usage of net.schmizz.sshj.SSHClient +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/class-use/Service.html b/javadoc/0.4.1/net/schmizz/sshj/class-use/Service.html new file mode 100644 index 00000000..d0b38b06 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/class-use/Service.html @@ -0,0 +1,344 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.Service (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.Service

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use Service
net.schmizz.sshj  
net.schmizz.sshj.connection  
net.schmizz.sshj.transport  
net.schmizz.sshj.userauth  
+  +

+ + + + + +
+Uses of Service in net.schmizz.sshj
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj that implement Service
+ classAbstractService + +
+          An abstract class for Service that implements common or default functionality.
+  +

+ + + + + +
+Uses of Service in net.schmizz.sshj.connection
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.connection that implement Service
+ classConnectionImpl + +
+          Connection implementation.
+  +

+ + + + + +
+Uses of Service in net.schmizz.sshj.transport
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport that return Service
+ ServiceTransportImpl.getService() + +
+           
+ ServiceTransport.getService() + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport with parameters of type Service
+ voidTransportImpl.reqService(Service service) + +
+           
+ voidTransport.reqService(Service service) + +
+          Request a SSH service represented by a Service instance.
+ voidTransportImpl.setService(Service service) + +
+           
+ voidTransport.setService(Service service) + +
+          Sets the currently active Service.
+  +

+ + + + + +
+Uses of Service in net.schmizz.sshj.userauth
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.userauth that implement Service
+ classUserAuthImpl + +
+          UserAuth implementation.
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.userauth with parameters of type Service
+ voidUserAuthImpl.authenticate(String username, + Service nextService, + Iterable<AuthMethod> methods) + +
+           
+ voidUserAuth.authenticate(String username, + Service nextService, + Iterable<AuthMethod> methods) + +
+          Attempt to authenticate username using each of methods in order.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/Base64.InputStream.html b/javadoc/0.4.1/net/schmizz/sshj/common/Base64.InputStream.html new file mode 100644 index 00000000..04a13423 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/Base64.InputStream.html @@ -0,0 +1,383 @@ + + + + + + + +Base64.InputStream (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Class Base64.InputStream

+
+java.lang.Object
+  extended by java.io.InputStream
+      extended by java.io.FilterInputStream
+          extended by net.schmizz.sshj.common.Base64.InputStream
+
+
+
All Implemented Interfaces:
Closeable
+
+
+
Enclosing class:
Base64
+
+
+
+
public static class Base64.InputStream
extends FilterInputStream
+ + +

+A Base64.InputStream will read data from another java.io.InputStream, given in the constructor, + and encode/decode to/from Base64 notation on the fly. +

+ +

+

+
Since:
+
1.3
+
See Also:
Base64
+
+ +

+ + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class java.io.FilterInputStream
in
+  + + + + + + + + + + + + + +
+Constructor Summary
Base64.InputStream(InputStream in) + +
+          Constructs a Base64.InputStream in DECODE mode.
Base64.InputStream(InputStream in, + int options) + +
+          Constructs a Base64.InputStream in either ENCODE or DECODE mode.
+  + + + + + + + + + + + + + + + +
+Method Summary
+ intread() + +
+          Reads enough of the input stream to convert to/from Base64 and returns the next byte.
+ intread(byte[] dest, + int off, + int len) + +
+          Calls read() repeatedly until the end of stream is reached or len bytes are read.
+ + + + + + + +
Methods inherited from class java.io.FilterInputStream
available, close, mark, markSupported, read, reset, skip
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Base64.InputStream

+
+public Base64.InputStream(InputStream in)
+
+
Constructs a Base64.InputStream in DECODE mode. +

+

+
Parameters:
in - the java.io.InputStream from which to read data.
Since:
+
1.3
+
+
+
+ +

+Base64.InputStream

+
+public Base64.InputStream(InputStream in,
+                          int options)
+
+
Constructs a Base64.InputStream in either ENCODE or DECODE mode. +

+ Valid options: +

+

+   ENCODE or DECODE: Encode or Decode as data is read.
+   DO_BREAK_LINES: break lines at 76 characters
+     (only meaningful when encoding)</i>
+ 
+

+ Example: new Base64.InputStream( in, Base64.DECODE ) +

+

+
Parameters:
in - the java.io.InputStream from which to read data.
options - Specified options
Since:
+
2.0
+
See Also:
Base64.ENCODE, +Base64.DECODE, +Base64.DO_BREAK_LINES
+
+ + + + + + + + +
+Method Detail
+ +

+read

+
+public int read()
+         throws IOException
+
+
Reads enough of the input stream to convert to/from Base64 and returns the next byte. +

+

+
Overrides:
read in class FilterInputStream
+
+
+ +
Returns:
next byte +
Throws: +
IOException
Since:
+
1.3
+
+
+
+
+ +

+read

+
+public int read(byte[] dest,
+                int off,
+                int len)
+         throws IOException
+
+
Calls read() repeatedly until the end of stream is reached or len bytes are read. Returns + number of bytes read into array or -1 if end of stream is encountered. +

+

+
Overrides:
read in class FilterInputStream
+
+
+
Parameters:
dest - array to hold values
off - offset for array
len - max number of bytes to read into array +
Returns:
bytes read into array or -1 if end of stream is encountered. +
Throws: +
IOException
Since:
+
1.3
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/Base64.OutputStream.html b/javadoc/0.4.1/net/schmizz/sshj/common/Base64.OutputStream.html new file mode 100644 index 00000000..f1f98316 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/Base64.OutputStream.html @@ -0,0 +1,515 @@ + + + + + + + +Base64.OutputStream (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Class Base64.OutputStream

+
+java.lang.Object
+  extended by java.io.OutputStream
+      extended by java.io.FilterOutputStream
+          extended by net.schmizz.sshj.common.Base64.OutputStream
+
+
+
All Implemented Interfaces:
Closeable, Flushable
+
+
+
Enclosing class:
Base64
+
+
+
+
public static class Base64.OutputStream
extends FilterOutputStream
+ + +

+A Base64.OutputStream will write data to another java.io.OutputStream, given in the constructor, + and encode/decode to/from Base64 notation on the fly. +

+ +

+

+
Since:
+
1.3
+
See Also:
Base64
+
+ +

+ + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class java.io.FilterOutputStream
out
+  + + + + + + + + + + + + + +
+Constructor Summary
Base64.OutputStream(OutputStream out) + +
+          Constructs a Base64.OutputStream in ENCODE mode.
Base64.OutputStream(OutputStream out, + int options) + +
+          Constructs a Base64.OutputStream in either ENCODE or DECODE mode.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclose() + +
+          Flushes and closes (I think, in the superclass) the stream.
+ voidflush() + +
+          Flushes the stream (and the enclosing streams).
+ voidflushBase64() + +
+          Method added by PHIL.
+ voidresumeEncoding() + +
+          Resumes encoding of the stream.
+ voidsuspendEncoding() + +
+          Suspends encoding of the stream.
+ voidwrite(byte[] theBytes, + int off, + int len) + +
+          Calls write(int) repeatedly until len bytes are written.
+ voidwrite(int theByte) + +
+          Writes the byte to the output stream after converting to/from Base64 notation.
+ + + + + + + +
Methods inherited from class java.io.FilterOutputStream
write
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Base64.OutputStream

+
+public Base64.OutputStream(OutputStream out)
+
+
Constructs a Base64.OutputStream in ENCODE mode. +

+

+
Parameters:
out - the java.io.OutputStream to which data will be written.
Since:
+
1.3
+
+
+
+ +

+Base64.OutputStream

+
+public Base64.OutputStream(OutputStream out,
+                           int options)
+
+
Constructs a Base64.OutputStream in either ENCODE or DECODE mode. +

+ Valid options: +

+

+   ENCODE or DECODE: Encode or Decode as data is read.
+   DO_BREAK_LINES: don't break lines at 76 characters
+     (only meaningful when encoding)</i>
+ 
+

+ Example: new Base64.OutputStream( out, Base64.ENCODE ) +

+

+
Parameters:
out - the java.io.OutputStream to which data will be written.
options - Specified options.
Since:
+
1.3
+
See Also:
Base64.ENCODE, +Base64.DECODE, +Base64.DO_BREAK_LINES
+
+ + + + + + + + +
+Method Detail
+ +

+close

+
+public void close()
+           throws IOException
+
+
Flushes and closes (I think, in the superclass) the stream. +

+

+
Specified by:
close in interface Closeable
Overrides:
close in class FilterOutputStream
+
+
+ +
Throws: +
IOException
Since:
+
1.3
+
+
+
+
+ +

+flush

+
+public void flush()
+           throws IOException
+
+
Flushes the stream (and the enclosing streams). +

+

+
Specified by:
flush in interface Flushable
Overrides:
flush in class FilterOutputStream
+
+
+ +
Throws: +
IOException
Since:
+
2.3
+
+
+
+
+ +

+flushBase64

+
+public void flushBase64()
+                 throws IOException
+
+
Method added by PHIL. [Thanks, PHIL. -Rob] This pads the buffer without closing the stream. +

+

+ +
Throws: +
IOException - if there's an error.
+
+
+
+ +

+resumeEncoding

+
+public void resumeEncoding()
+
+
Resumes encoding of the stream. May be helpful if you need to embed a piece of base64-encoded data in a + stream. +

+

+
Since:
+
1.5.1
+
+
+
+
+ +

+suspendEncoding

+
+public void suspendEncoding()
+                     throws IOException
+
+
Suspends encoding of the stream. May be helpful if you need to embed a piece of base64-encoded data in a + stream. +

+

+ +
Throws: +
IOException - if there's an error flushing
Since:
+
1.5.1
+
+
+
+
+ +

+write

+
+public void write(byte[] theBytes,
+                  int off,
+                  int len)
+           throws IOException
+
+
Calls write(int) repeatedly until len bytes are written. +

+

+
Overrides:
write in class FilterOutputStream
+
+
+
Parameters:
theBytes - array from which to read bytes
off - offset for array
len - max number of bytes to read into array +
Throws: +
IOException
Since:
+
1.3
+
+
+
+
+ +

+write

+
+public void write(int theByte)
+           throws IOException
+
+
Writes the byte to the output stream after converting to/from Base64 notation. When encoding, bytes are + buffered three at a time before the output stream actually gets a write() call. When decoding, bytes are + buffered four at a time. +

+

+
Overrides:
write in class FilterOutputStream
+
+
+
Parameters:
theByte - the byte to write +
Throws: +
IOException
Since:
+
1.3
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/Base64.html b/javadoc/0.4.1/net/schmizz/sshj/common/Base64.html new file mode 100644 index 00000000..e9446a0b --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/Base64.html @@ -0,0 +1,1083 @@ + + + + + + + +Base64 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Class Base64

+
+java.lang.Object
+  extended by net.schmizz.sshj.common.Base64
+
+
+
+
public class Base64
extends Object
+ + +

+

Encodes and decodes to and from Base64 notation.

Homepage: http://iharder.net/base64. +

Example:

String encoded = Base64.encode( myByteArray );
byte[] + myByteArray = Base64.decode( encoded );

The options parameter, which appears in a few + places, is used to pass several pieces of information to the encoder. In the "higher level" method such as + encodeBytes( bytes, options ) the options parameter can be used to indicate such things as first gzipping the bytes + before encoding them, not inserting linefeeds, and encoding using the URL-safe and Ordered dialects.

+ Note, according to RFC3548, Section 2.1, implementations should + not add line feeds unless explicitly told to do so. I've got Base64 set to this behavior now, although earlier + versions broke lines by default.

The constants defined in Base64 can be OR-ed together to combine + options, so you might make a call like this:

String encoded = Base64.encodeBytes( mybytes, + Base64.GZIP | Base64.DO_BREAK_LINES );

to compress the data before encoding it and then making the output + have newline characters.

Also...

String encoded = Base64.encodeBytes( crazyString.getBytes() + );

I am placing this code in the Public Domain. Do with it as you will. This software comes with no + guarantees or warranties but with plenty of well-wishing instead! Please visit http://iharder.net/base64 periodically to check for updates or to contribute + improvements.

+

+ +

+

+
Version:
+
2.3.3
+
Author:
+
Robert Harder, rob@iharder.net
+
+
+ +

+ + + + + + + + + + + + + + + +
+Nested Class Summary
+static classBase64.InputStream + +
+          A Base64.InputStream will read data from another java.io.InputStream, given in the constructor, + and encode/decode to/from Base64 notation on the fly.
+static classBase64.OutputStream + +
+          A Base64.OutputStream will write data to another java.io.OutputStream, given in the constructor, + and encode/decode to/from Base64 notation on the fly.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intDECODE + +
+          Specify decoding in first bit.
+static intDO_BREAK_LINES + +
+          Do break lines when encoding.
+static intENCODE + +
+          Specify encoding in first bit.
+static intGZIP + +
+          Specify that data should be gzip-compressed in second bit.
+static intNO_OPTIONS + +
+          No options specified.
+static intORDERED + +
+          Encode using the special "ordered" dialect of Base64 described here: http://www.faqs.org/qa/rfcc-1940.html.
+static intURL_SAFE + +
+          Encode using Base64-like encoding that is URL- and Filename-safe as described in Section 4 of RFC3548: http://www.faqs.org/rfcs/rfc3548.html.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static byte[]decode(byte[] source) + +
+          Low-level access to decoding ASCII characters in the form of a byte array.
+static byte[]decode(byte[] source, + int off, + int len, + int options) + +
+          Low-level access to decoding ASCII characters in the form of a byte array.
+static byte[]decode(String s) + +
+          Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
+static byte[]decode(String s, + int options) + +
+          Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
+static voiddecodeFileToFile(String infile, + String outfile) + +
+          Reads infile and decodes it to outfile.
+static byte[]decodeFromFile(String filename) + +
+          Convenience method for reading a base64-encoded file and decoding it.
+static voiddecodeToFile(String dataToDecode, + String filename) + +
+          Convenience method for decoding data to a file.
+static ObjectdecodeToObject(String encodedObject) + +
+          Attempts to decode Base64 data and deserialize a Java Object within.
+static voidencode(ByteBuffer raw, + ByteBuffer encoded) + +
+          Performs Base64 encoding on the raw ByteBuffer, writing it to the encoded ByteBuffer.
+static voidencode(ByteBuffer raw, + CharBuffer encoded) + +
+          Performs Base64 encoding on the raw ByteBuffer, writing it to the encoded CharBuffer.
+static StringencodeBytes(byte[] source) + +
+          Encodes a byte array into Base64 notation.
+static StringencodeBytes(byte[] source, + int options) + +
+          Encodes a byte array into Base64 notation.
+static StringencodeBytes(byte[] source, + int off, + int len) + +
+          Encodes a byte array into Base64 notation.
+static StringencodeBytes(byte[] source, + int off, + int len, + int options) + +
+          Encodes a byte array into Base64 notation.
+static byte[]encodeBytesToBytes(byte[] source) + +
+          Similar to encodeBytes(byte[]) but returns a byte array instead of instantiating a String.
+static byte[]encodeBytesToBytes(byte[] source, + int off, + int len, + int options) + +
+          Similar to encodeBytes(byte[], int, int, int) but returns a byte array instead of instantiating a + String.
+static voidencodeFileToFile(String infile, + String outfile) + +
+          Reads infile and encodes it to outfile.
+static StringencodeFromFile(String filename) + +
+          Convenience method for reading a binary file and base64-encoding it.
+static StringencodeObject(Serializable serializableObject) + +
+          Serializes an object and returns the Base64-encoded version of that serialized object.
+static StringencodeObject(Serializable serializableObject, + int options) + +
+          Serializes an object and returns the Base64-encoded version of that serialized object.
+static voidencodeToFile(byte[] dataToEncode, + String filename) + +
+          Convenience method for encoding data to a file.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+NO_OPTIONS

+
+public static final int NO_OPTIONS
+
+
No options specified. Value is zero. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ENCODE

+
+public static final int ENCODE
+
+
Specify encoding in first bit. Value is one. +

+

+
See Also:
Constant Field Values
+
+
+ +

+DECODE

+
+public static final int DECODE
+
+
Specify decoding in first bit. Value is zero. +

+

+
See Also:
Constant Field Values
+
+
+ +

+GZIP

+
+public static final int GZIP
+
+
Specify that data should be gzip-compressed in second bit. Value is two. +

+

+
See Also:
Constant Field Values
+
+
+ +

+DO_BREAK_LINES

+
+public static final int DO_BREAK_LINES
+
+
Do break lines when encoding. Value is 8. +

+

+
See Also:
Constant Field Values
+
+
+ +

+URL_SAFE

+
+public static final int URL_SAFE
+
+
Encode using Base64-like encoding that is URL- and Filename-safe as described in Section 4 of RFC3548: http://www.faqs.org/rfcs/rfc3548.html. It is important to note + that data encoded this way is not officially valid Base64, or at the very least should not be called + Base64 without also specifying that is was encoded using the URL- and Filename-safe dialect. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ORDERED

+
+public static final int ORDERED
+
+
Encode using the special "ordered" dialect of Base64 described here: http://www.faqs.org/qa/rfcc-1940.html. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Method Detail
+ +

+decode

+
+public static byte[] decode(byte[] source)
+
+
Low-level access to decoding ASCII characters in the form of a byte array. Ignores GUNZIP option, if it's + set. This is not generally a recommended method, although it is used internally as part of the decoding + process. Special case: if len = 0, an empty array is returned. Still, if you need more speed and reduced memory + footprint (and aren't gzipping), consider this method. +

+

+
Parameters:
source - The Base64 encoded data +
Returns:
decoded data
Since:
+
2.3.1
+
+
+
+
+ +

+decode

+
+public static byte[] decode(byte[] source,
+                            int off,
+                            int len,
+                            int options)
+                     throws IOException
+
+
Low-level access to decoding ASCII characters in the form of a byte array. Ignores GUNZIP option, if it's + set. This is not generally a recommended method, although it is used internally as part of the decoding + process. Special case: if len = 0, an empty array is returned. Still, if you need more speed and reduced memory + footprint (and aren't gzipping), consider this method. +

+

+
Parameters:
source - The Base64 encoded data
off - The offset of where to begin decoding
len - The length of characters to decode
options - Can specify options such as alphabet type to use +
Returns:
decoded data +
Throws: +
IOException - If bogus characters exist in source data
Since:
+
1.3
+
+
+
+
+ +

+decode

+
+public static byte[] decode(String s)
+                     throws IOException
+
+
Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it. +

+

+
Parameters:
s - the string to decode +
Returns:
the decoded data +
Throws: +
IOException - If there is a problem
Since:
+
1.4
+
+
+
+
+ +

+decode

+
+public static byte[] decode(String s,
+                            int options)
+                     throws IOException
+
+
Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it. +

+

+
Parameters:
s - the string to decode
options - encode options such as URL_SAFE +
Returns:
the decoded data +
Throws: +
IOException - if there is an error +
NullPointerException - if s is null
Since:
+
1.4
+
+
+
+
+ +

+decodeFileToFile

+
+public static void decodeFileToFile(String infile,
+                                    String outfile)
+                             throws IOException
+
+
Reads infile and decodes it to outfile. +

+

+
Parameters:
infile - Input file
outfile - Output file +
Throws: +
IOException - if there is an error
Since:
+
2.2
+
+
+
+
+ +

+decodeFromFile

+
+public static byte[] decodeFromFile(String filename)
+                             throws IOException
+
+
Convenience method for reading a base64-encoded file and decoding it.

As of v 2.3, if there is a error, + the method will throw an java.io.IOException. This is new to v2.3! In earlier versions, it just returned + false, but in retrospect that's a pretty poor way to next it.

+

+

+
Parameters:
filename - Filename for reading encoded data +
Returns:
decoded byte array +
Throws: +
IOException - if there is an error
Since:
+
2.1
+
+
+
+
+ +

+decodeToFile

+
+public static void decodeToFile(String dataToDecode,
+                                String filename)
+                         throws IOException
+
+
Convenience method for decoding data to a file.

As of v 2.3, if there is a error, the method will throw + an java.io.IOException. This is new to v2.3! In earlier versions, it just returned false, but in + retrospect that's a pretty poor way to next it.

+

+

+
Parameters:
dataToDecode - Base64-encoded data as a string
filename - Filename for saving decoded data +
Throws: +
IOException - if there is an error
Since:
+
2.1
+
+
+
+
+ +

+decodeToObject

+
+public static Object decodeToObject(String encodedObject)
+                             throws IOException,
+                                    ClassNotFoundException
+
+
Attempts to decode Base64 data and deserialize a Java Object within. Returns null if there was an + error. +

+

+
Parameters:
encodedObject - The Base64 data to decode +
Returns:
The decoded and deserialized object +
Throws: +
NullPointerException - if encodedObject is null +
IOException - if there is a general error +
ClassNotFoundException - if the decoded object is of a class that cannot be found by the JVM
Since:
+
1.5
+
+
+
+
+ +

+encode

+
+public static void encode(ByteBuffer raw,
+                          ByteBuffer encoded)
+
+
Performs Base64 encoding on the raw ByteBuffer, writing it to the encoded ByteBuffer. + This is an experimental feature. Currently it does not pass along any options (such as DO_BREAK_LINES or + GZIP. +

+

+
Parameters:
raw - input buffer
encoded - output buffer
Since:
+
2.3
+
+
+
+
+ +

+encode

+
+public static void encode(ByteBuffer raw,
+                          CharBuffer encoded)
+
+
Performs Base64 encoding on the raw ByteBuffer, writing it to the encoded CharBuffer. + This is an experimental feature. Currently it does not pass along any options (such as DO_BREAK_LINES or + GZIP. +

+

+
Parameters:
raw - input buffer
encoded - output buffer
Since:
+
2.3
+
+
+
+
+ +

+encodeBytes

+
+public static String encodeBytes(byte[] source)
+
+
Encodes a byte array into Base64 notation. Does not GZip-compress data. +

+

+
Parameters:
source - The data to convert +
Returns:
The data in Base64-encoded form +
Throws: +
NullPointerException - if source array is null
Since:
+
1.4
+
+
+
+
+ +

+encodeBytes

+
+public static String encodeBytes(byte[] source,
+                                 int options)
+                          throws IOException
+
+
Encodes a byte array into Base64 notation.

Example options:

+

+   GZIP: gzip-compresses object before encoding it.
+   DO_BREAK_LINES: break lines at 76 characters
+     <i>Note: Technically, this makes your encoding non-compliant.</i>
+ 
+

Example: encodeBytes( myData, Base64.GZIP ) or

Example: encodeBytes( myData, + Base64.GZIP | Base64.DO_BREAK_LINES )

As of v 2.3, if there is an error with the GZIP + stream, the method will throw an java.io.IOException. This is new to v2.3! In earlier versions, it just + returned a null value, but in retrospect that's a pretty poor way to next it.

+

+

+
Parameters:
source - The data to convert
options - Specified options +
Returns:
The Base64-encoded data as a String +
Throws: +
IOException - if there is an error +
NullPointerException - if source array is null
Since:
+
2.0
+
See Also:
GZIP, +DO_BREAK_LINES
+
+
+
+ +

+encodeBytes

+
+public static String encodeBytes(byte[] source,
+                                 int off,
+                                 int len)
+
+
Encodes a byte array into Base64 notation. Does not GZip-compress data.

As of v 2.3, if there is an + error, the method will throw an java.io.IOException. This is new to v2.3! In earlier versions, it just + returned a null value, but in retrospect that's a pretty poor way to next it.

+

+

+
Parameters:
source - The data to convert
off - Offset in array where conversion should begin
len - Length of data to convert +
Returns:
The Base64-encoded data as a String +
Throws: +
NullPointerException - if source array is null +
IllegalArgumentException - if source array, offset, or length are invalid
Since:
+
1.4
+
+
+
+
+ +

+encodeBytes

+
+public static String encodeBytes(byte[] source,
+                                 int off,
+                                 int len,
+                                 int options)
+                          throws IOException
+
+
Encodes a byte array into Base64 notation.

Example options:

+

+   GZIP: gzip-compresses object before encoding it.
+   DO_BREAK_LINES: break lines at 76 characters
+     <i>Note: Technically, this makes your encoding non-compliant.</i>
+ 
+

Example: encodeBytes( myData, Base64.GZIP ) or

Example: encodeBytes( myData, + Base64.GZIP | Base64.DO_BREAK_LINES )

As of v 2.3, if there is an error with the GZIP + stream, the method will throw an java.io.IOException. This is new to v2.3! In earlier versions, it just + returned a null value, but in retrospect that's a pretty poor way to next it.

+

+

+
Parameters:
source - The data to convert
off - Offset in array where conversion should begin
len - Length of data to convert
options - Specified options +
Returns:
The Base64-encoded data as a String +
Throws: +
IOException - if there is an error +
NullPointerException - if source array is null +
IllegalArgumentException - if source array, offset, or length are invalid
Since:
+
2.0
+
See Also:
GZIP, +DO_BREAK_LINES
+
+
+
+ +

+encodeBytesToBytes

+
+public static byte[] encodeBytesToBytes(byte[] source)
+
+
Similar to encodeBytes(byte[]) but returns a byte array instead of instantiating a String. This is more + efficient if you're working with I/O streams and have large data sets to encode. +

+

+
Parameters:
source - The data to convert +
Returns:
The Base64-encoded data as a byte[] (of ASCII characters) +
Throws: +
NullPointerException - if source array is null
Since:
+
2.3.1
+
+
+
+
+ +

+encodeBytesToBytes

+
+public static byte[] encodeBytesToBytes(byte[] source,
+                                        int off,
+                                        int len,
+                                        int options)
+                                 throws IOException
+
+
Similar to encodeBytes(byte[], int, int, int) but returns a byte array instead of instantiating a + String. This is more efficient if you're working with I/O streams and have large data sets to encode. +

+

+
Parameters:
source - The data to convert
off - Offset in array where conversion should begin
len - Length of data to convert
options - Specified options +
Returns:
The Base64-encoded data as a String +
Throws: +
IOException - if there is an error +
NullPointerException - if source array is null +
IllegalArgumentException - if source array, offset, or length are invalid
Since:
+
2.3.1
+
See Also:
GZIP, +DO_BREAK_LINES
+
+
+
+ +

+encodeFileToFile

+
+public static void encodeFileToFile(String infile,
+                                    String outfile)
+                             throws IOException
+
+
Reads infile and encodes it to outfile. +

+

+
Parameters:
infile - Input file
outfile - Output file +
Throws: +
IOException - if there is an error
Since:
+
2.2
+
+
+
+
+ +

+encodeFromFile

+
+public static String encodeFromFile(String filename)
+                             throws IOException
+
+
Convenience method for reading a binary file and base64-encoding it.

As of v 2.3, if there is a error, + the method will throw an java.io.IOException. This is new to v2.3! In earlier versions, it just returned + false, but in retrospect that's a pretty poor way to next it.

+

+

+
Parameters:
filename - Filename for reading binary data +
Returns:
base64-encoded string +
Throws: +
IOException - if there is an error
Since:
+
2.1
+
+
+
+
+ +

+encodeObject

+
+public static String encodeObject(Serializable serializableObject)
+                           throws IOException
+
+
Serializes an object and returns the Base64-encoded version of that serialized object.

As of v 2.3, if + the object cannot be serialized or there is another error, the method will throw an java.io.IOException. This + is new to v2.3! In earlier versions, it just returned a null value, but in retrospect that's a pretty poor + way to next it.

+

+ The object is not GZip-compressed before being encoded. +

+

+
Parameters:
serializableObject - The object to encode +
Returns:
The Base64-encoded object +
Throws: +
IOException - if there is an error +
NullPointerException - if serializedObject is null
Since:
+
1.4
+
+
+
+
+ +

+encodeObject

+
+public static String encodeObject(Serializable serializableObject,
+                                  int options)
+                           throws IOException
+
+
Serializes an object and returns the Base64-encoded version of that serialized object.

As of v 2.3, if + the object cannot be serialized or there is another error, the method will throw an java.io.IOException. This + is new to v2.3! In earlier versions, it just returned a null value, but in retrospect that's a pretty poor + way to next it.

+

+ The object is not GZip-compressed before being encoded. +

+ Example options: +

+

+   GZIP: gzip-compresses object before encoding it.
+   DO_BREAK_LINES: break lines at 76 characters
+ 
+

+ Example: encodeObject( myObj, Base64.GZIP ) or +

+ Example: encodeObject( myObj, Base64.GZIP | Base64.DO_BREAK_LINES ) +

+

+
Parameters:
serializableObject - The object to encode
options - Specified options +
Returns:
The Base64-encoded object +
Throws: +
IOException - if there is an error
Since:
+
2.0
+
See Also:
GZIP, +DO_BREAK_LINES
+
+
+
+ +

+encodeToFile

+
+public static void encodeToFile(byte[] dataToEncode,
+                                String filename)
+                         throws IOException
+
+
Convenience method for encoding data to a file.

As of v 2.3, if there is a error, the method will throw + an java.io.IOException. This is new to v2.3! In earlier versions, it just returned false, but in + retrospect that's a pretty poor way to next it.

+

+

+
Parameters:
dataToEncode - byte array of data to encode in base64 form
filename - Filename for saving encoded data +
Throws: +
IOException - if there is an error +
NullPointerException - if dataToEncode is null
Since:
+
2.1
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/Buffer.BufferException.html b/javadoc/0.4.1/net/schmizz/sshj/common/Buffer.BufferException.html new file mode 100644 index 00000000..15503ab5 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/Buffer.BufferException.html @@ -0,0 +1,273 @@ + + + + + + + +Buffer.BufferException (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Class Buffer.BufferException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by net.schmizz.sshj.common.SSHException
+                  extended by net.schmizz.sshj.common.Buffer.BufferException
+
+
+
All Implemented Interfaces:
Serializable
+
+
+
Enclosing class:
Buffer<T extends Buffer<T>>
+
+
+
+
public static class Buffer.BufferException
extends SSHException
+ + +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.common.SSHException
chainer
+  + + + + + + + + + + +
+Constructor Summary
Buffer.BufferException(String message) + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.common.SSHException
getDisconnectReason, getMessage, toString
+ + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Buffer.BufferException

+
+public Buffer.BufferException(String message)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/Buffer.PlainBuffer.html b/javadoc/0.4.1/net/schmizz/sshj/common/Buffer.PlainBuffer.html new file mode 100644 index 00000000..3a895d3b --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/Buffer.PlainBuffer.html @@ -0,0 +1,317 @@ + + + + + + + +Buffer.PlainBuffer (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Class Buffer.PlainBuffer

+
+java.lang.Object
+  extended by net.schmizz.sshj.common.Buffer<Buffer.PlainBuffer>
+      extended by net.schmizz.sshj.common.Buffer.PlainBuffer
+
+
+
Enclosing class:
Buffer<T extends Buffer<T>>
+
+
+
+
public static class Buffer.PlainBuffer
extends Buffer<Buffer.PlainBuffer>
+ + +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class net.schmizz.sshj.common.Buffer
Buffer.BufferException, Buffer.PlainBuffer
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.common.Buffer
data, DEFAULT_SIZE, rpos, wpos
+  + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
Buffer.PlainBuffer() + +
+           
Buffer.PlainBuffer(Buffer<?> from) + +
+           
Buffer.PlainBuffer(byte[] b) + +
+           
Buffer.PlainBuffer(int size) + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.common.Buffer
array, available, clear, compact, ensureAvailable, ensureCapacity, getCompactData, getNextPowerOf2, printHex, putBoolean, putBuffer, putByte, putBytes, putBytes, putMPInt, putPublicKey, putRawBytes, putRawBytes, putSensitiveString, putSignature, putString, putString, putString, putUInt32, putUInt64, readBoolean, readByte, readBytes, readMPInt, readPublicKey, readRawBytes, readRawBytes, readString, readStringAsBytes, readUInt32, readUInt32AsInt, readUInt64, rpos, rpos, toString, wpos, wpos
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Buffer.PlainBuffer

+
+public Buffer.PlainBuffer()
+
+
+
+ +

+Buffer.PlainBuffer

+
+public Buffer.PlainBuffer(Buffer<?> from)
+
+
+
+ +

+Buffer.PlainBuffer

+
+public Buffer.PlainBuffer(byte[] b)
+
+
+
+ +

+Buffer.PlainBuffer

+
+public Buffer.PlainBuffer(int size)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/Buffer.html b/javadoc/0.4.1/net/schmizz/sshj/common/Buffer.html new file mode 100644 index 00000000..8ec9497a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/Buffer.html @@ -0,0 +1,1305 @@ + + + + + + + +Buffer (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Class Buffer<T extends Buffer<T>>

+
+java.lang.Object
+  extended by net.schmizz.sshj.common.Buffer<T>
+
+
+
Direct Known Subclasses:
Buffer.PlainBuffer, SFTPPacket, SSHPacket
+
+
+
+
public class Buffer<T extends Buffer<T>>
extends Object
+ + +

+


+ +

+ + + + + + + + + + + + + + + +
+Nested Class Summary
+static classBuffer.BufferException + +
+           
+static classBuffer.PlainBuffer + +
+           
+ + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+protected  byte[]data + +
+           
+static intDEFAULT_SIZE + +
+          The default size for a Buffer (256 bytes)
+protected  intrpos + +
+           
+protected  intwpos + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
Buffer() + +
+           
Buffer(Buffer<?> from) + +
+           
Buffer(byte[] data) + +
+           
Buffer(int size) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ byte[]array() + +
+           
+ intavailable() + +
+           
+ voidclear() + +
+          Resets this buffer.
+ voidcompact() + +
+          Compact this SSHPacket
+protected  voidensureAvailable(int a) + +
+           
+ voidensureCapacity(int capacity) + +
+           
+ byte[]getCompactData() + +
+           
+protected static intgetNextPowerOf2(int i) + +
+           
+ StringprintHex() + +
+          Gives a readable snapshot of the buffer in hex.
+ TputBoolean(boolean b) + +
+          Puts an SSH boolean value
+ TputBuffer(Buffer<? extends Buffer<?>> buffer) + +
+          Copies the contents of provided buffer into this buffer
+ TputByte(byte b) + +
+          Writes a single byte into this buffer
+ TputBytes(byte[] b) + +
+          Writes Java byte-array as an SSH byte-array
+ TputBytes(byte[] b, + int off, + int len) + +
+          Writes Java byte-array as an SSH byte-array
+ TputMPInt(BigInteger bi) + +
+           
+ TputPublicKey(PublicKey key) + +
+           
+ TputRawBytes(byte[] d) + +
+           
+ TputRawBytes(byte[] d, + int off, + int len) + +
+           
+ TputSensitiveString(char[] str) + +
+          Writes a char-array as an SSH string and then blanks it out.
+ TputSignature(String sigFormat, + byte[] sigData) + +
+           
+ TputString(byte[] str) + +
+           
+ TputString(byte[] str, + int offset, + int len) + +
+           
+ TputString(String string) + +
+           
+ TputUInt32(long uint32) + +
+          Writes a uint32 integer
+ TputUInt64(long uint64) + +
+           
+ booleanreadBoolean() + +
+          Read an SSH boolean byte
+ bytereadByte() + +
+          Read a byte from the buffer
+ byte[]readBytes() + +
+          Read an SSH byte-array
+ BigIntegerreadMPInt() + +
+          Read an SSH multiple-precision integer
+ PublicKeyreadPublicKey() + +
+           
+ voidreadRawBytes(byte[] buf) + +
+           
+ voidreadRawBytes(byte[] buf, + int off, + int len) + +
+           
+ StringreadString() + +
+          Reads an SSH string
+ byte[]readStringAsBytes() + +
+          Reads an SSH string
+ longreadUInt32() + +
+           
+ intreadUInt32AsInt() + +
+           
+ longreadUInt64() + +
+           
+ intrpos() + +
+           
+ voidrpos(int rpos) + +
+           
+ StringtoString() + +
+           
+ intwpos() + +
+           
+ voidwpos(int wpos) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+DEFAULT_SIZE

+
+public static final int DEFAULT_SIZE
+
+
The default size for a Buffer (256 bytes) +

+

+
See Also:
Constant Field Values
+
+
+ +

+data

+
+protected byte[] data
+
+
+
+
+
+ +

+rpos

+
+protected int rpos
+
+
+
+
+
+ +

+wpos

+
+protected int wpos
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Buffer

+
+public Buffer()
+
+
+
See Also:
DEFAULT_SIZE
+
+
+ +

+Buffer

+
+public Buffer(Buffer<?> from)
+
+
+
+ +

+Buffer

+
+public Buffer(byte[] data)
+
+
+
+ +

+Buffer

+
+public Buffer(int size)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getNextPowerOf2

+
+protected static int getNextPowerOf2(int i)
+
+
+
+
+
+
+ +

+array

+
+public byte[] array()
+
+
+
+
+
+
+ +

+available

+
+public int available()
+
+
+
+
+
+
+ +

+clear

+
+public void clear()
+
+
Resets this buffer. The object becomes ready for reuse. +

+

+
+
+
+
+ +

+rpos

+
+public int rpos()
+
+
+
+
+
+
+ +

+rpos

+
+public void rpos(int rpos)
+
+
+
+
+
+
+ +

+wpos

+
+public int wpos()
+
+
+
+
+
+
+ +

+wpos

+
+public void wpos(int wpos)
+
+
+
+
+
+
+ +

+ensureAvailable

+
+protected void ensureAvailable(int a)
+                        throws Buffer.BufferException
+
+
+ +
Throws: +
Buffer.BufferException
+
+
+
+ +

+ensureCapacity

+
+public void ensureCapacity(int capacity)
+
+
+
+
+
+
+ +

+compact

+
+public void compact()
+
+
Compact this SSHPacket +

+

+
+
+
+
+ +

+getCompactData

+
+public byte[] getCompactData()
+
+
+
+
+
+
+ +

+readBoolean

+
+public boolean readBoolean()
+                    throws Buffer.BufferException
+
+
Read an SSH boolean byte +

+

+ +
Returns:
the true or false value read +
Throws: +
Buffer.BufferException
+
+
+
+ +

+putBoolean

+
+public T putBoolean(boolean b)
+
+
Puts an SSH boolean value +

+

+
Parameters:
b - the value +
Returns:
this
+
+
+
+ +

+readByte

+
+public byte readByte()
+              throws Buffer.BufferException
+
+
Read a byte from the buffer +

+

+ +
Returns:
the byte read +
Throws: +
Buffer.BufferException
+
+
+
+ +

+putByte

+
+public T putByte(byte b)
+
+
Writes a single byte into this buffer +

+

+
Parameters:
b - +
Returns:
this
+
+
+
+ +

+readBytes

+
+public byte[] readBytes()
+                 throws Buffer.BufferException
+
+
Read an SSH byte-array +

+

+ +
Returns:
the byte-array read +
Throws: +
Buffer.BufferException
+
+
+
+ +

+putBytes

+
+public T putBytes(byte[] b)
+
+
Writes Java byte-array as an SSH byte-array +

+

+
Parameters:
b - Java byte-array +
Returns:
this
+
+
+
+ +

+putBytes

+
+public T putBytes(byte[] b,
+                  int off,
+                  int len)
+
+
Writes Java byte-array as an SSH byte-array +

+

+
Parameters:
b - Java byte-array
off - offset
len - length +
Returns:
this
+
+
+
+ +

+readRawBytes

+
+public void readRawBytes(byte[] buf)
+                  throws Buffer.BufferException
+
+
+ +
Throws: +
Buffer.BufferException
+
+
+
+ +

+readRawBytes

+
+public void readRawBytes(byte[] buf,
+                         int off,
+                         int len)
+                  throws Buffer.BufferException
+
+
+ +
Throws: +
Buffer.BufferException
+
+
+
+ +

+putRawBytes

+
+public T putRawBytes(byte[] d)
+
+
+
+
+
+
+ +

+putRawBytes

+
+public T putRawBytes(byte[] d,
+                     int off,
+                     int len)
+
+
+
+
+
+
+ +

+putBuffer

+
+public T putBuffer(Buffer<? extends Buffer<?>> buffer)
+
+
Copies the contents of provided buffer into this buffer +

+

+
Parameters:
buffer - the Buffer to copy +
Returns:
this
+
+
+
+ +

+readUInt32AsInt

+
+public int readUInt32AsInt()
+                    throws Buffer.BufferException
+
+
+ +
Throws: +
Buffer.BufferException
+
+
+
+ +

+readUInt32

+
+public long readUInt32()
+                throws Buffer.BufferException
+
+
+ +
Throws: +
Buffer.BufferException
+
+
+
+ +

+putUInt32

+
+public T putUInt32(long uint32)
+
+
Writes a uint32 integer +

+

+
Parameters:
uint32 - +
Returns:
this
+
+
+
+ +

+readMPInt

+
+public BigInteger readMPInt()
+                     throws Buffer.BufferException
+
+
Read an SSH multiple-precision integer +

+

+ +
Returns:
the MP integer as a BigInteger +
Throws: +
Buffer.BufferException
+
+
+
+ +

+putMPInt

+
+public T putMPInt(BigInteger bi)
+
+
+
+
+
+
+ +

+readUInt64

+
+public long readUInt64()
+                throws Buffer.BufferException
+
+
+ +
Throws: +
Buffer.BufferException
+
+
+
+ +

+putUInt64

+
+public T putUInt64(long uint64)
+
+
+
+
+
+
+ +

+readString

+
+public String readString()
+                  throws Buffer.BufferException
+
+
Reads an SSH string +

+

+ +
Returns:
the string as a Java String +
Throws: +
Buffer.BufferException
+
+
+
+ +

+readStringAsBytes

+
+public byte[] readStringAsBytes()
+                         throws Buffer.BufferException
+
+
Reads an SSH string +

+

+ +
Returns:
the string as a byte-array +
Throws: +
Buffer.BufferException
+
+
+
+ +

+putString

+
+public T putString(byte[] str)
+
+
+
+
+
+
+ +

+putString

+
+public T putString(byte[] str,
+                   int offset,
+                   int len)
+
+
+
+
+
+
+ +

+putString

+
+public T putString(String string)
+
+
+
+
+
+
+ +

+putSensitiveString

+
+public T putSensitiveString(char[] str)
+
+
Writes a char-array as an SSH string and then blanks it out. +

+ This is useful when a plaintext password needs to be sent. If str is null, an empty string is + written. +

+

+
Parameters:
str - (null-ok) the string as a character array +
Returns:
this
+
+
+
+ +

+readPublicKey

+
+public PublicKey readPublicKey()
+                        throws Buffer.BufferException
+
+
+ +
Throws: +
Buffer.BufferException
+
+
+
+ +

+putPublicKey

+
+public T putPublicKey(PublicKey key)
+
+
+
+
+
+
+ +

+putSignature

+
+public T putSignature(String sigFormat,
+                      byte[] sigData)
+
+
+
+
+
+
+ +

+printHex

+
+public String printHex()
+
+
Gives a readable snapshot of the buffer in hex. This is useful for debugging. +

+

+ +
Returns:
snapshot of the buffer as a hex string with each octet delimited by a space
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/ByteArrayUtils.html b/javadoc/0.4.1/net/schmizz/sshj/common/ByteArrayUtils.html new file mode 100644 index 00000000..277fcb4e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/ByteArrayUtils.html @@ -0,0 +1,348 @@ + + + + + + + +ByteArrayUtils (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Class ByteArrayUtils

+
+java.lang.Object
+  extended by net.schmizz.sshj.common.ByteArrayUtils
+
+
+
+
public class ByteArrayUtils
extends Object
+ + +

+Utility functions for byte arrays. +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
ByteArrayUtils() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static booleanequals(byte[] a1, + int a1Offset, + byte[] a2, + int a2Offset, + int length) + +
+          Check whether some part or whole of two byte arrays is equal, for length bytes starting at some + offset.
+static StringprintHex(byte[] array, + int offset, + int len) + +
+          Get a hexadecimal representation of a byte array starting at offset index for len + bytes, with each octet separated by a space.
+static StringtoHex(byte[] array) + +
+          Get the hexadecimal representation of a byte array.
+static StringtoHex(byte[] array, + int offset, + int len) + +
+          Get the hexadecimal representation of a byte array starting at offset index for len + bytes.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ByteArrayUtils

+
+public ByteArrayUtils()
+
+
+ + + + + + + + +
+Method Detail
+ +

+equals

+
+public static boolean equals(byte[] a1,
+                             int a1Offset,
+                             byte[] a2,
+                             int a2Offset,
+                             int length)
+
+
Check whether some part or whole of two byte arrays is equal, for length bytes starting at some + offset. +

+

+
Parameters:
a1 -
a1Offset -
a2 -
a2Offset -
length - +
Returns:
true or false
+
+
+
+ +

+printHex

+
+public static String printHex(byte[] array,
+                              int offset,
+                              int len)
+
+
Get a hexadecimal representation of a byte array starting at offset index for len + bytes, with each octet separated by a space. +

+

+
Parameters:
array -
offset -
len - +
Returns:
hex string, each octet delimited by a space
+
+
+
+ +

+toHex

+
+public static String toHex(byte[] array)
+
+
Get the hexadecimal representation of a byte array. +

+

+
Parameters:
array - +
Returns:
hex string
+
+
+
+ +

+toHex

+
+public static String toHex(byte[] array,
+                           int offset,
+                           int len)
+
+
Get the hexadecimal representation of a byte array starting at offset index for len + bytes. +

+

+
Parameters:
array -
offset -
len - +
Returns:
hex string
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/DisconnectReason.html b/javadoc/0.4.1/net/schmizz/sshj/common/DisconnectReason.html new file mode 100644 index 00000000..ab202085 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/DisconnectReason.html @@ -0,0 +1,589 @@ + + + + + + + +DisconnectReason (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Enum DisconnectReason

+
+java.lang.Object
+  extended by java.lang.Enum<DisconnectReason>
+      extended by net.schmizz.sshj.common.DisconnectReason
+
+
+
All Implemented Interfaces:
Serializable, Comparable<DisconnectReason>
+
+
+
+
public enum DisconnectReason
extends Enum<DisconnectReason>
+ + +

+Disconnect error codes +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
AUTH_CANCELLED_BY_USER + +
+           
BY_APPLICATION + +
+           
COMPRESSION_ERROR + +
+           
CONNECTION_LOST + +
+           
HOST_KEY_NOT_VERIFIABLE + +
+           
HOST_NOT_ALLOWED_TO_CONNECT + +
+           
ILLEGAL_USER_NAME + +
+           
KEY_EXCHANGE_FAILED + +
+           
MAC_ERROR + +
+           
NO_MORE_AUTH_METHODS_AVAILABLE + +
+           
PROTOCOL_ERROR + +
+           
PROTOCOL_VERSION_NOT_SUPPORTED + +
+           
RESERVED + +
+           
SERVICE_NOT_AVAILABLE + +
+           
TOO_MANY_CONNECTIONS + +
+           
UNKNOWN + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static DisconnectReasonfromInt(int code) + +
+           
+ inttoInt() + +
+           
+static DisconnectReasonvalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static DisconnectReason[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+UNKNOWN

+
+public static final DisconnectReason UNKNOWN
+
+
+
+
+
+ +

+HOST_NOT_ALLOWED_TO_CONNECT

+
+public static final DisconnectReason HOST_NOT_ALLOWED_TO_CONNECT
+
+
+
+
+
+ +

+PROTOCOL_ERROR

+
+public static final DisconnectReason PROTOCOL_ERROR
+
+
+
+
+
+ +

+KEY_EXCHANGE_FAILED

+
+public static final DisconnectReason KEY_EXCHANGE_FAILED
+
+
+
+
+
+ +

+RESERVED

+
+public static final DisconnectReason RESERVED
+
+
+
+
+
+ +

+MAC_ERROR

+
+public static final DisconnectReason MAC_ERROR
+
+
+
+
+
+ +

+COMPRESSION_ERROR

+
+public static final DisconnectReason COMPRESSION_ERROR
+
+
+
+
+
+ +

+SERVICE_NOT_AVAILABLE

+
+public static final DisconnectReason SERVICE_NOT_AVAILABLE
+
+
+
+
+
+ +

+PROTOCOL_VERSION_NOT_SUPPORTED

+
+public static final DisconnectReason PROTOCOL_VERSION_NOT_SUPPORTED
+
+
+
+
+
+ +

+HOST_KEY_NOT_VERIFIABLE

+
+public static final DisconnectReason HOST_KEY_NOT_VERIFIABLE
+
+
+
+
+
+ +

+CONNECTION_LOST

+
+public static final DisconnectReason CONNECTION_LOST
+
+
+
+
+
+ +

+BY_APPLICATION

+
+public static final DisconnectReason BY_APPLICATION
+
+
+
+
+
+ +

+TOO_MANY_CONNECTIONS

+
+public static final DisconnectReason TOO_MANY_CONNECTIONS
+
+
+
+
+
+ +

+AUTH_CANCELLED_BY_USER

+
+public static final DisconnectReason AUTH_CANCELLED_BY_USER
+
+
+
+
+
+ +

+NO_MORE_AUTH_METHODS_AVAILABLE

+
+public static final DisconnectReason NO_MORE_AUTH_METHODS_AVAILABLE
+
+
+
+
+
+ +

+ILLEGAL_USER_NAME

+
+public static final DisconnectReason ILLEGAL_USER_NAME
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static DisconnectReason[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (DisconnectReason c : DisconnectReason.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static DisconnectReason valueOf(String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+
+
+ +

+fromInt

+
+public static DisconnectReason fromInt(int code)
+
+
+
+
+
+
+ +

+toInt

+
+public int toInt()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/ErrorNotifiable.Util.html b/javadoc/0.4.1/net/schmizz/sshj/common/ErrorNotifiable.Util.html new file mode 100644 index 00000000..0147a653 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/ErrorNotifiable.Util.html @@ -0,0 +1,287 @@ + + + + + + + +ErrorNotifiable.Util (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Class ErrorNotifiable.Util

+
+java.lang.Object
+  extended by net.schmizz.sshj.common.ErrorNotifiable.Util
+
+
+
Enclosing interface:
ErrorNotifiable
+
+
+
+
public static class ErrorNotifiable.Util
extends Object
+ + +

+Utility functions. +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
ErrorNotifiable.Util() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static voidalertAll(SSHException error, + Collection<? extends ErrorNotifiable> notifiables) + +
+          Notify all notifiables of given error.
+static voidalertAll(SSHException error, + ErrorNotifiable... notifiables) + +
+          Notify all notifiables of given error.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ErrorNotifiable.Util

+
+public ErrorNotifiable.Util()
+
+
+ + + + + + + + +
+Method Detail
+ +

+alertAll

+
+public static void alertAll(SSHException error,
+                            ErrorNotifiable... notifiables)
+
+
Notify all notifiables of given error. +

+

+
+
+
+
+ +

+alertAll

+
+public static void alertAll(SSHException error,
+                            Collection<? extends ErrorNotifiable> notifiables)
+
+
Notify all notifiables of given error. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/ErrorNotifiable.html b/javadoc/0.4.1/net/schmizz/sshj/common/ErrorNotifiable.html new file mode 100644 index 00000000..f4992a95 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/ErrorNotifiable.html @@ -0,0 +1,236 @@ + + + + + + + +ErrorNotifiable (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Interface ErrorNotifiable

+
+
All Known Subinterfaces:
Channel, Channel.Direct, Channel.Forwarded, Service, Session, Session.Command, Session.Shell, Session.Subsystem
+
+
+
All Known Implementing Classes:
AbstractChannel, AbstractDirectChannel, AbstractForwardedChannel, AbstractService, ChannelInputStream, ChannelOutputStream, ConnectionImpl, RemotePortForwarder.ForwardedTCPIPChannel, SessionChannel, UserAuthImpl, X11Forwarder.X11Channel
+
+
+
+
public interface ErrorNotifiable
+ + +

+API for classes that are capable of being notified on an error so they can cleanup. +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classErrorNotifiable.Util + +
+          Utility functions.
+  + + + + + + + + + + + +
+Method Summary
+ voidnotifyError(SSHException error) + +
+          Notifies this object of an error.
+  +

+ + + + + + + + +
+Method Detail
+ +

+notifyError

+
+void notifyError(SSHException error)
+
+
Notifies this object of an error. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/Factory.Named.Util.html b/javadoc/0.4.1/net/schmizz/sshj/common/Factory.Named.Util.html new file mode 100644 index 00000000..8c535b37 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/Factory.Named.Util.html @@ -0,0 +1,335 @@ + + + + + + + +Factory.Named.Util (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Class Factory.Named.Util

+
+java.lang.Object
+  extended by net.schmizz.sshj.common.Factory.Named.Util
+
+
+
Enclosing interface:
Factory.Named<T>
+
+
+
+
public static class Factory.Named.Util
extends Object
+ + +

+Utility functions +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
Factory.Named.Util() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static + + + + +
+<T> T
+
create(List<Factory.Named<T>> factories, + String name) + +
+          Creates an object by picking a factory from factories that is identified by name from a + list of named factories.
+static + + + + +
+<T> Factory.Named<T>
+
get(List<Factory.Named<T>> factories, + String name) + +
+          Retrieve a particular factory as identified by name from a list of named factories.
+static + + + + +
+<T> List<String>
+
getNames(List<Factory.Named<T>> factories) + +
+          Get a comma-delimited string containing the factory names from the given list of factories.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Factory.Named.Util

+
+public Factory.Named.Util()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public static <T> T create(List<Factory.Named<T>> factories,
+                           String name)
+
+
Creates an object by picking a factory from factories that is identified by name from a + list of named factories. Uses the first match. +

+

+
Type Parameters:
T - type of the factories
Parameters:
factories - list of available factories
name - name of the desired factory +
Returns:
a newly created instance of T or null if there was no match
+
+
+
+ +

+get

+
+public static <T> Factory.Named<T> get(List<Factory.Named<T>> factories,
+                                       String name)
+
+
Retrieve a particular factory as identified by name from a list of named factories. + Returns the first match. +

+

+
Type Parameters:
T - type of the factories
Parameters:
factories - list of factories
name - the name of the factory to retrieve +
Returns:
a factory or null if there was no match
+
+
+
+ +

+getNames

+
+public static <T> List<String> getNames(List<Factory.Named<T>> factories)
+
+
Get a comma-delimited string containing the factory names from the given list of factories. +

+

+
Type Parameters:
T - type of the factories
Parameters:
factories - list of available factories +
Returns:
a comma separated list of factory names
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/Factory.Named.html b/javadoc/0.4.1/net/schmizz/sshj/common/Factory.Named.html new file mode 100644 index 00000000..1dece8ce --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/Factory.Named.html @@ -0,0 +1,263 @@ + + + + + + + +Factory.Named (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Interface Factory.Named<T>

+
+
Type Parameters:
T - type of object created by this factory
+
+
All Superinterfaces:
Factory<T>
+
+
+
All Known Implementing Classes:
AES128CBC.Factory, AES128CTR.Factory, AES192CBC.Factory, AES192CTR.Factory, AES256CBC.Factory, AES256CTR.Factory, BlowfishCBC.Factory, DelayedZlibCompression.Factory, DHG1.Factory, DHG14.Factory, HMACMD5.Factory, HMACMD596.Factory, HMACSHA1.Factory, HMACSHA196.Factory, JCERandom.Factory, MD5.Factory, NoneCipher.Factory, NoneCompression.Factory, OpenSSHKeyFile.Factory, PKCS8KeyFile.Factory, SHA1.Factory, SignatureDSA.Factory, SignatureRSA.Factory, TripleDESCBC.Factory, ZlibCompression.Factory
+
+
+
Enclosing interface:
Factory<T>
+
+
+
+
public static interface Factory.Named<T>
extends Factory<T>
+ + +

+Inteface for a named factory. Named factories are simply factories that are identified by a name. Such names are + used mainly in SSH algorithm negotiation. +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classFactory.Named.Util + +
+          Utility functions
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + + +
+Method Summary
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.Factory
create
+  +

+ + + + + + + + +
+Method Detail
+ +

+getName

+
+String getName()
+
+
+
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/Factory.html b/javadoc/0.4.1/net/schmizz/sshj/common/Factory.html new file mode 100644 index 00000000..cf61af16 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/Factory.html @@ -0,0 +1,237 @@ + + + + + + + +Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Interface Factory<T>

+
+
Type Parameters:
T - the type of object created by this factory
+
+
All Known Subinterfaces:
Factory.Named<T>
+
+
+
All Known Implementing Classes:
AES128CBC.Factory, AES128CTR.Factory, AES192CBC.Factory, AES192CTR.Factory, AES256CBC.Factory, AES256CTR.Factory, BlowfishCBC.Factory, BouncyCastleRandom.Factory, DelayedZlibCompression.Factory, DHG1.Factory, DHG14.Factory, HMACMD5.Factory, HMACMD596.Factory, HMACSHA1.Factory, HMACSHA196.Factory, JCERandom.Factory, MD5.Factory, NoneCipher.Factory, NoneCompression.Factory, OpenSSHKeyFile.Factory, PKCS8KeyFile.Factory, SHA1.Factory, SignatureDSA.Factory, SignatureRSA.Factory, SingletonRandomFactory, TripleDESCBC.Factory, ZlibCompression.Factory
+
+
+
+
public interface Factory<T>
+ + +

+A basic factory interface. +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static interfaceFactory.Named<T> + +
+          Inteface for a named factory.
+  + + + + + + + + + + + +
+Method Summary
+ Tcreate() + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+create

+
+T create()
+
+
+ +
Returns:
a new object created using this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/IOUtils.html b/javadoc/0.4.1/net/schmizz/sshj/common/IOUtils.html new file mode 100644 index 00000000..e524e50c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/IOUtils.html @@ -0,0 +1,311 @@ + + + + + + + +IOUtils (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Class IOUtils

+
+java.lang.Object
+  extended by net.schmizz.sshj.common.IOUtils
+
+
+
+
public class IOUtils
extends Object
+ + +

+


+ +

+ + + + + + + + + + + +
+Field Summary
+static CharsetUTF8 + +
+           
+  + + + + + + + + + + +
+Constructor Summary
IOUtils() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static voidcloseQuietly(Closeable... closeables) + +
+           
+static ByteArrayOutputStreamreadFully(InputStream stream) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+UTF8

+
+public static final Charset UTF8
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+IOUtils

+
+public IOUtils()
+
+
+ + + + + + + + +
+Method Detail
+ +

+closeQuietly

+
+public static void closeQuietly(Closeable... closeables)
+
+
+
+
+
+
+ +

+readFully

+
+public static ByteArrayOutputStream readFully(InputStream stream)
+                                       throws IOException
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/KeyType.html b/javadoc/0.4.1/net/schmizz/sshj/common/KeyType.html new file mode 100644 index 00000000..358c7597 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/KeyType.html @@ -0,0 +1,509 @@ + + + + + + + +KeyType (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Enum KeyType

+
+java.lang.Object
+  extended by java.lang.Enum<KeyType>
+      extended by net.schmizz.sshj.common.KeyType
+
+
+
All Implemented Interfaces:
Serializable, Comparable<KeyType>
+
+
+
+
public enum KeyType
extends Enum<KeyType>
+ + +

+Type of key e.g. rsa, dsa +

+ +

+


+ +

+ + + + + + + + + + + + + + + + +
+Enum Constant Summary
DSA + +
+          SSH identifier for DSA keys
RSA + +
+          SSH identifier for RSA keys
UNKNOWN + +
+          Unrecognized
+ + + + + + + + + + +
+Field Summary
+protected  StringsType + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static KeyTypefromKey(Key key) + +
+           
+static KeyTypefromString(String sType) + +
+           
+protected abstract  booleanisMyType(Key key) + +
+           
+abstract  voidputPubKeyIntoBuffer(PublicKey pk, + Buffer<?> buf) + +
+           
+abstract  PublicKeyreadPubKeyFromBuffer(String type, + Buffer<?> buf) + +
+           
+ StringtoString() + +
+           
+static KeyTypevalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static KeyType[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+RSA

+
+public static final KeyType RSA
+
+
SSH identifier for RSA keys +

+

+
+
+
+ +

+DSA

+
+public static final KeyType DSA
+
+
SSH identifier for DSA keys +

+

+
+
+
+ +

+UNKNOWN

+
+public static final KeyType UNKNOWN
+
+
Unrecognized +

+

+
+
+ + + + + + + + +
+Field Detail
+ +

+sType

+
+protected final String sType
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static KeyType[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (KeyType c : KeyType.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static KeyType valueOf(String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+
+
+ +

+readPubKeyFromBuffer

+
+public abstract PublicKey readPubKeyFromBuffer(String type,
+                                               Buffer<?> buf)
+                                        throws GeneralSecurityException
+
+
+ +
Throws: +
GeneralSecurityException
+
+
+
+ +

+putPubKeyIntoBuffer

+
+public abstract void putPubKeyIntoBuffer(PublicKey pk,
+                                         Buffer<?> buf)
+
+
+
+
+
+
+ +

+isMyType

+
+protected abstract boolean isMyType(Key key)
+
+
+
+
+
+
+ +

+fromKey

+
+public static KeyType fromKey(Key key)
+
+
+
+
+
+
+ +

+fromString

+
+public static KeyType fromString(String sType)
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Enum<KeyType>
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/Message.html b/javadoc/0.4.1/net/schmizz/sshj/common/Message.html new file mode 100644 index 00000000..875485ac --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/Message.html @@ -0,0 +1,978 @@ + + + + + + + +Message (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Enum Message

+
+java.lang.Object
+  extended by java.lang.Enum<Message>
+      extended by net.schmizz.sshj.common.Message
+
+
+
All Implemented Interfaces:
Serializable, Comparable<Message>
+
+
+
+
public enum Message
extends Enum<Message>
+ + +

+SSH message identifiers +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
CHANNEL_CLOSE + +
+           
CHANNEL_DATA + +
+           
CHANNEL_EOF + +
+           
CHANNEL_EXTENDED_DATA + +
+           
CHANNEL_FAILURE + +
+           
CHANNEL_OPEN + +
+           
CHANNEL_OPEN_CONFIRMATION + +
+           
CHANNEL_OPEN_FAILURE + +
+           
CHANNEL_REQUEST + +
+           
CHANNEL_SUCCESS + +
+           
CHANNEL_WINDOW_ADJUST + +
+           
DEBUG + +
+           
DISCONNECT + +
+           
GLOBAL_REQUEST + +
+           
IGNORE + +
+           
KEX_DH_GEX_INIT + +
+           
KEX_DH_GEX_REPLY + +
+           
KEX_DH_GEX_REQUEST + +
+           
KEXDH_31 + +
+          { KEXDH_REPLY, KEXDH_GEX_GROUP }
KEXDH_INIT + +
+           
KEXINIT + +
+           
NEWKEYS + +
+           
REQUEST_FAILURE + +
+           
REQUEST_SUCCESS + +
+           
SERVICE_ACCEPT + +
+           
SERVICE_REQUEST + +
+           
UNIMPLEMENTED + +
+           
UNKNOWN + +
+           
USERAUTH_60 + +
+          { USERAUTH_PASSWD_CHANGREQ, USERAUTH_PK_OK, USERAUTH_INFO_REQUEST }
USERAUTH_BANNER + +
+           
USERAUTH_FAILURE + +
+           
USERAUTH_INFO_RESPONSE + +
+           
USERAUTH_REQUEST + +
+           
USERAUTH_SUCCESS + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static MessagefromByte(byte b) + +
+           
+ booleangeq(int num) + +
+           
+ booleangt(int num) + +
+           
+ booleanin(int x, + int y) + +
+           
+ booleanleq(int num) + +
+           
+ booleanlt(int num) + +
+           
+ bytetoByte() + +
+           
+static MessagevalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static Message[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+UNKNOWN

+
+public static final Message UNKNOWN
+
+
+
+
+
+ +

+DISCONNECT

+
+public static final Message DISCONNECT
+
+
+
+
+
+ +

+IGNORE

+
+public static final Message IGNORE
+
+
+
+
+
+ +

+UNIMPLEMENTED

+
+public static final Message UNIMPLEMENTED
+
+
+
+
+
+ +

+DEBUG

+
+public static final Message DEBUG
+
+
+
+
+
+ +

+SERVICE_REQUEST

+
+public static final Message SERVICE_REQUEST
+
+
+
+
+
+ +

+SERVICE_ACCEPT

+
+public static final Message SERVICE_ACCEPT
+
+
+
+
+
+ +

+KEXINIT

+
+public static final Message KEXINIT
+
+
+
+
+
+ +

+NEWKEYS

+
+public static final Message NEWKEYS
+
+
+
+
+
+ +

+KEXDH_INIT

+
+public static final Message KEXDH_INIT
+
+
+
+
+
+ +

+KEXDH_31

+
+public static final Message KEXDH_31
+
+
{ KEXDH_REPLY, KEXDH_GEX_GROUP } +

+

+
+
+
+ +

+KEX_DH_GEX_INIT

+
+public static final Message KEX_DH_GEX_INIT
+
+
+
+
+
+ +

+KEX_DH_GEX_REPLY

+
+public static final Message KEX_DH_GEX_REPLY
+
+
+
+
+
+ +

+KEX_DH_GEX_REQUEST

+
+public static final Message KEX_DH_GEX_REQUEST
+
+
+
+
+
+ +

+USERAUTH_REQUEST

+
+public static final Message USERAUTH_REQUEST
+
+
+
+
+
+ +

+USERAUTH_FAILURE

+
+public static final Message USERAUTH_FAILURE
+
+
+
+
+
+ +

+USERAUTH_SUCCESS

+
+public static final Message USERAUTH_SUCCESS
+
+
+
+
+
+ +

+USERAUTH_BANNER

+
+public static final Message USERAUTH_BANNER
+
+
+
+
+
+ +

+USERAUTH_60

+
+public static final Message USERAUTH_60
+
+
{ USERAUTH_PASSWD_CHANGREQ, USERAUTH_PK_OK, USERAUTH_INFO_REQUEST } +

+

+
+
+
+ +

+USERAUTH_INFO_RESPONSE

+
+public static final Message USERAUTH_INFO_RESPONSE
+
+
+
+
+
+ +

+GLOBAL_REQUEST

+
+public static final Message GLOBAL_REQUEST
+
+
+
+
+
+ +

+REQUEST_SUCCESS

+
+public static final Message REQUEST_SUCCESS
+
+
+
+
+
+ +

+REQUEST_FAILURE

+
+public static final Message REQUEST_FAILURE
+
+
+
+
+
+ +

+CHANNEL_OPEN

+
+public static final Message CHANNEL_OPEN
+
+
+
+
+
+ +

+CHANNEL_OPEN_CONFIRMATION

+
+public static final Message CHANNEL_OPEN_CONFIRMATION
+
+
+
+
+
+ +

+CHANNEL_OPEN_FAILURE

+
+public static final Message CHANNEL_OPEN_FAILURE
+
+
+
+
+
+ +

+CHANNEL_WINDOW_ADJUST

+
+public static final Message CHANNEL_WINDOW_ADJUST
+
+
+
+
+
+ +

+CHANNEL_DATA

+
+public static final Message CHANNEL_DATA
+
+
+
+
+
+ +

+CHANNEL_EXTENDED_DATA

+
+public static final Message CHANNEL_EXTENDED_DATA
+
+
+
+
+
+ +

+CHANNEL_EOF

+
+public static final Message CHANNEL_EOF
+
+
+
+
+
+ +

+CHANNEL_CLOSE

+
+public static final Message CHANNEL_CLOSE
+
+
+
+
+
+ +

+CHANNEL_REQUEST

+
+public static final Message CHANNEL_REQUEST
+
+
+
+
+
+ +

+CHANNEL_SUCCESS

+
+public static final Message CHANNEL_SUCCESS
+
+
+
+
+
+ +

+CHANNEL_FAILURE

+
+public static final Message CHANNEL_FAILURE
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static Message[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (Message c : Message.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static Message valueOf(String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+
+
+ +

+fromByte

+
+public static Message fromByte(byte b)
+
+
+
+
+
+
+ +

+geq

+
+public boolean geq(int num)
+
+
+
+
+
+
+ +

+gt

+
+public boolean gt(int num)
+
+
+
+
+
+
+ +

+in

+
+public boolean in(int x,
+                  int y)
+
+
+
+
+
+
+ +

+leq

+
+public boolean leq(int num)
+
+
+
+
+
+
+ +

+lt

+
+public boolean lt(int num)
+
+
+
+
+
+
+ +

+toByte

+
+public byte toByte()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/SSHException.html b/javadoc/0.4.1/net/schmizz/sshj/common/SSHException.html new file mode 100644 index 00000000..7be315f9 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/SSHException.html @@ -0,0 +1,452 @@ + + + + + + + +SSHException (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Class SSHException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by net.schmizz.sshj.common.SSHException
+
+
+
All Implemented Interfaces:
Serializable
+
+
+
Direct Known Subclasses:
Buffer.BufferException, ConnectionException, SCPException, SFTPException, TransportException, UserAuthException
+
+
+
+
public class SSHException
extends IOException
+ + +

+Most exceptions in the net.schmizz.sshj package are instances of this class. An SSHException is + itself an IOException and can be caught like that if this level of granularity is not desired. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Field Summary
+static ExceptionChainer<SSHException>chainer + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
SSHException(DisconnectReason code) + +
+           
SSHException(DisconnectReason code, + String message) + +
+           
SSHException(DisconnectReason code, + String message, + Throwable cause) + +
+           
SSHException(DisconnectReason code, + Throwable cause) + +
+           
SSHException(String message) + +
+           
SSHException(String message, + Throwable cause) + +
+           
SSHException(Throwable cause) + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ DisconnectReasongetDisconnectReason() + +
+           
+ StringgetMessage() + +
+           
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+chainer

+
+public static final ExceptionChainer<SSHException> chainer
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+SSHException

+
+public SSHException(DisconnectReason code)
+
+
+
+ +

+SSHException

+
+public SSHException(DisconnectReason code,
+                    String message)
+
+
+
+ +

+SSHException

+
+public SSHException(DisconnectReason code,
+                    String message,
+                    Throwable cause)
+
+
+
+ +

+SSHException

+
+public SSHException(DisconnectReason code,
+                    Throwable cause)
+
+
+
+ +

+SSHException

+
+public SSHException(String message)
+
+
+
+ +

+SSHException

+
+public SSHException(String message,
+                    Throwable cause)
+
+
+
+ +

+SSHException

+
+public SSHException(Throwable cause)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getDisconnectReason

+
+public DisconnectReason getDisconnectReason()
+
+
+
+
+
+
+ +

+getMessage

+
+public String getMessage()
+
+
+
Overrides:
getMessage in class Throwable
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Throwable
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/SSHPacket.html b/javadoc/0.4.1/net/schmizz/sshj/common/SSHPacket.html new file mode 100644 index 00000000..36b9e2df --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/SSHPacket.html @@ -0,0 +1,390 @@ + + + + + + + +SSHPacket (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Class SSHPacket

+
+java.lang.Object
+  extended by net.schmizz.sshj.common.Buffer<SSHPacket>
+      extended by net.schmizz.sshj.common.SSHPacket
+
+
+
+
public class SSHPacket
extends Buffer<SSHPacket>
+ + +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class net.schmizz.sshj.common.Buffer
Buffer.BufferException, Buffer.PlainBuffer
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.common.Buffer
data, DEFAULT_SIZE, rpos, wpos
+  + + + + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
SSHPacket() + +
+           
SSHPacket(byte[] data) + +
+           
SSHPacket(int size) + +
+           
SSHPacket(Message msg) + +
+          Constructs new buffer for the specified SSH packet and reserves the needed space (5 bytes) for the packet + header.
SSHPacket(SSHPacket p) + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ SSHPacketputMessageID(Message msg) + +
+          Writes a byte indicating the SSH message identifier
+ MessagereadMessageID() + +
+          Reads an SSH byte and returns it as Message
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.common.Buffer
array, available, clear, compact, ensureAvailable, ensureCapacity, getCompactData, getNextPowerOf2, printHex, putBoolean, putBuffer, putByte, putBytes, putBytes, putMPInt, putPublicKey, putRawBytes, putRawBytes, putSensitiveString, putSignature, putString, putString, putString, putUInt32, putUInt64, readBoolean, readByte, readBytes, readMPInt, readPublicKey, readRawBytes, readRawBytes, readString, readStringAsBytes, readUInt32, readUInt32AsInt, readUInt64, rpos, rpos, toString, wpos, wpos
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SSHPacket

+
+public SSHPacket()
+
+
+
+ +

+SSHPacket

+
+public SSHPacket(int size)
+
+
+
+ +

+SSHPacket

+
+public SSHPacket(byte[] data)
+
+
+
+ +

+SSHPacket

+
+public SSHPacket(Message msg)
+
+
Constructs new buffer for the specified SSH packet and reserves the needed space (5 bytes) for the packet + header. +

+

+
Parameters:
msg - the SSH command
+
+
+ +

+SSHPacket

+
+public SSHPacket(SSHPacket p)
+
+
+ + + + + + + + +
+Method Detail
+ +

+readMessageID

+
+public Message readMessageID()
+                      throws Buffer.BufferException
+
+
Reads an SSH byte and returns it as Message +

+

+ +
Returns:
the message identifier +
Throws: +
Buffer.BufferException
+
+
+
+ +

+putMessageID

+
+public SSHPacket putMessageID(Message msg)
+
+
Writes a byte indicating the SSH message identifier +

+

+
Parameters:
msg - the identifier as a Message type +
Returns:
this
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/SSHPacketHandler.html b/javadoc/0.4.1/net/schmizz/sshj/common/SSHPacketHandler.html new file mode 100644 index 00000000..e77fed8f --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/SSHPacketHandler.html @@ -0,0 +1,226 @@ + + + + + + + +SSHPacketHandler (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Interface SSHPacketHandler

+
+
All Known Subinterfaces:
AuthMethod, Channel, Channel.Direct, Channel.Forwarded, Service, Session, Session.Command, Session.Shell, Session.Subsystem, Transport
+
+
+
All Known Implementing Classes:
AbstractAuthMethod, AbstractChannel, AbstractDirectChannel, AbstractForwardedChannel, AbstractService, AuthHostbased, AuthKeyboardInteractive, AuthNone, AuthPassword, AuthPublickey, ConnectionImpl, KeyedAuthMethod, RemotePortForwarder.ForwardedTCPIPChannel, SessionChannel, TransportImpl, UserAuthImpl, X11Forwarder.X11Channel
+
+
+
+
public interface SSHPacketHandler
+ + +

+An interface for classes to which packet handling may be delegated. Chains of such delegations may be used, e.g. + packet decoder -> (SSHPacketHandler) transport layer -> (SSHPacketHandler) connection layer -> + (SSHPacketHandler) channel. +

+ +

+


+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidhandle(Message msg, + SSHPacket buf) + +
+          Delegate handling of some SSH packet to this object.
+  +

+ + + + + + + + +
+Method Detail
+ +

+handle

+
+void handle(Message msg,
+            SSHPacket buf)
+            throws SSHException
+
+
Delegate handling of some SSH packet to this object. +

+

+
Parameters:
msg - the SSH message identifier
buf - SSHPacket containing rest of the request +
Throws: +
SSHException - if there is a non-recoverable error
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/SSHRuntimeException.html b/javadoc/0.4.1/net/schmizz/sshj/common/SSHRuntimeException.html new file mode 100644 index 00000000..456d4188 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/SSHRuntimeException.html @@ -0,0 +1,290 @@ + + + + + + + +SSHRuntimeException (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Class SSHRuntimeException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by net.schmizz.sshj.common.SSHRuntimeException
+
+
+
All Implemented Interfaces:
Serializable
+
+
+
+
public class SSHRuntimeException
extends RuntimeException
+ + +

+Represents unrecoverable exceptions in the net.schmizz.sshj package. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
SSHRuntimeException() + +
+           
SSHRuntimeException(String message) + +
+           
SSHRuntimeException(String message, + Throwable cause) + +
+           
SSHRuntimeException(Throwable cause) + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SSHRuntimeException

+
+public SSHRuntimeException()
+
+
+
+ +

+SSHRuntimeException

+
+public SSHRuntimeException(String message)
+
+
+
+ +

+SSHRuntimeException

+
+public SSHRuntimeException(String message,
+                           Throwable cause)
+
+
+
+ +

+SSHRuntimeException

+
+public SSHRuntimeException(Throwable cause)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/SecurityUtils.html b/javadoc/0.4.1/net/schmizz/sshj/common/SecurityUtils.html new file mode 100644 index 00000000..11ffe1e5 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/SecurityUtils.html @@ -0,0 +1,569 @@ + + + + + + + +SecurityUtils (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Class SecurityUtils

+
+java.lang.Object
+  extended by net.schmizz.sshj.common.SecurityUtils
+
+
+
+
public class SecurityUtils
extends Object
+ + +

+Static utility method relating to security facilities. +

+ +

+


+ +

+ + + + + + + + + + + +
+Field Summary
+static StringBOUNCY_CASTLE + +
+          Identifier for the BouncyCastle JCE provider
+  + + + + + + + + + + +
+Constructor Summary
SecurityUtils() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static CiphergetCipher(String transformation) + +
+           
+static StringgetFingerprint(PublicKey key) + +
+          Computes the fingerprint for a public key, in the standard SSH format, e.g.
+static KeyAgreementgetKeyAgreement(String algorithm) + +
+          Creates a new instance of KeyAgreement with the given algorithm.
+static KeyFactorygetKeyFactory(String algorithm) + +
+          Creates a new instance of KeyFactory with the given algorithm.
+static KeyPairGeneratorgetKeyPairGenerator(String algorithm) + +
+          Creates a new instance of KeyPairGenerator with the given algorithm.
+static MacgetMAC(String algorithm) + +
+          Create a new instance of Mac with the given algorithm.
+static MessageDigestgetMessageDigest(String algorithm) + +
+          Create a new instance of MessageDigest with the given algorithm.
+static StringgetSecurityProvider() + +
+          Get the identifier for the registered security provider.
+static SignaturegetSignature(String algorithm) + +
+           
+static booleanisBouncyCastleRegistered() + +
+          Attempts registering BouncyCastle as security provider if it has not been previously attempted and returns + whether the registration succeeded.
+static voidsetRegisterBouncyCastle(boolean registerBouncyCastle) + +
+           
+static voidsetSecurityProvider(String securityProvider) + +
+          Specifies the JCE security provider that should be used.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+BOUNCY_CASTLE

+
+public static final String BOUNCY_CASTLE
+
+
Identifier for the BouncyCastle JCE provider +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+SecurityUtils

+
+public SecurityUtils()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getCipher

+
+public static Cipher getCipher(String transformation)
+                        throws NoSuchAlgorithmException,
+                               NoSuchPaddingException,
+                               NoSuchProviderException
+
+
+ +
Throws: +
NoSuchAlgorithmException +
NoSuchPaddingException +
NoSuchProviderException
+
+
+
+ +

+getFingerprint

+
+public static String getFingerprint(PublicKey key)
+
+
Computes the fingerprint for a public key, in the standard SSH format, e.g. "4b:69:6c:72:6f:79:20:77:61:73:20:68:65:72:65:21" +

+

+
Parameters:
key - the public key +
Returns:
the fingerprint
See Also:
specification
+
+
+
+ +

+getKeyAgreement

+
+public static KeyAgreement getKeyAgreement(String algorithm)
+                                    throws NoSuchAlgorithmException,
+                                           NoSuchProviderException
+
+
Creates a new instance of KeyAgreement with the given algorithm. +

+

+
Parameters:
algorithm - key agreement algorithm +
Returns:
new instance +
Throws: +
NoSuchAlgorithmException +
NoSuchProviderException
+
+
+
+ +

+getKeyFactory

+
+public static KeyFactory getKeyFactory(String algorithm)
+                                throws NoSuchAlgorithmException,
+                                       NoSuchProviderException
+
+
Creates a new instance of KeyFactory with the given algorithm. +

+

+
Parameters:
algorithm - key factory algorithm e.g. RSA, DSA +
Returns:
new instance +
Throws: +
NoSuchAlgorithmException +
NoSuchProviderException
+
+
+
+ +

+getKeyPairGenerator

+
+public static KeyPairGenerator getKeyPairGenerator(String algorithm)
+                                            throws NoSuchAlgorithmException,
+                                                   NoSuchProviderException
+
+
Creates a new instance of KeyPairGenerator with the given algorithm. +

+

+
Parameters:
algorithm - key pair generator algorithm +
Returns:
new instance +
Throws: +
NoSuchAlgorithmException +
NoSuchProviderException
+
+
+
+ +

+getMAC

+
+public static Mac getMAC(String algorithm)
+                  throws NoSuchAlgorithmException,
+                         NoSuchProviderException
+
+
Create a new instance of Mac with the given algorithm. +

+

+
Parameters:
algorithm - MAC algorithm +
Returns:
new instance +
Throws: +
NoSuchAlgorithmException +
NoSuchProviderException
+
+
+
+ +

+getMessageDigest

+
+public static MessageDigest getMessageDigest(String algorithm)
+                                      throws NoSuchAlgorithmException,
+                                             NoSuchProviderException
+
+
Create a new instance of MessageDigest with the given algorithm. +

+

+
Parameters:
algorithm - MessageDigest algorithm name +
Returns:
new instance +
Throws: +
NoSuchAlgorithmException +
NoSuchProviderException
+
+
+
+ +

+getSecurityProvider

+
+public static String getSecurityProvider()
+
+
Get the identifier for the registered security provider. +

+

+ +
Returns:
JCE provider identifier
+
+
+
+ +

+getSignature

+
+public static Signature getSignature(String algorithm)
+                              throws NoSuchAlgorithmException,
+                                     NoSuchProviderException
+
+
+ +
Throws: +
NoSuchAlgorithmException +
NoSuchProviderException
+
+
+
+ +

+isBouncyCastleRegistered

+
+public static boolean isBouncyCastleRegistered()
+
+
Attempts registering BouncyCastle as security provider if it has not been previously attempted and returns + whether the registration succeeded. +

+

+ +
Returns:
whether BC registered
+
+
+
+ +

+setRegisterBouncyCastle

+
+public static void setRegisterBouncyCastle(boolean registerBouncyCastle)
+
+
+
+
+
+
+ +

+setSecurityProvider

+
+public static void setSecurityProvider(String securityProvider)
+
+
Specifies the JCE security provider that should be used. +

+

+
Parameters:
securityProvider - identifier for the security provider
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/StreamCopier.Listener.html b/javadoc/0.4.1/net/schmizz/sshj/common/StreamCopier.Listener.html new file mode 100644 index 00000000..8d18c3c6 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/StreamCopier.Listener.html @@ -0,0 +1,219 @@ + + + + + + + +StreamCopier.Listener (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Interface StreamCopier.Listener

+
+
All Known Subinterfaces:
TransferListener
+
+
+
All Known Implementing Classes:
LoggingTransferListener
+
+
+
Enclosing class:
StreamCopier
+
+
+
+
public static interface StreamCopier.Listener
+ + +

+


+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidreportProgress(long transferred) + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+reportProgress

+
+void reportProgress(long transferred)
+                    throws IOException
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/StreamCopier.html b/javadoc/0.4.1/net/schmizz/sshj/common/StreamCopier.html new file mode 100644 index 00000000..36fe726d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/StreamCopier.html @@ -0,0 +1,389 @@ + + + + + + + +StreamCopier (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.common +
+Class StreamCopier

+
+java.lang.Object
+  extended by net.schmizz.sshj.common.StreamCopier
+
+
+
+
public class StreamCopier
extends Object
+ + +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static interfaceStreamCopier.Listener + +
+           
+  + + + + + + + + + + +
+Constructor Summary
StreamCopier(InputStream in, + OutputStream out) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StreamCopierbufSize(int bufSize) + +
+           
+ longcopy() + +
+           
+ StreamCopierkeepFlushing(boolean keepFlushing) + +
+           
+ StreamCopierlength(long length) + +
+           
+ StreamCopierlistener(StreamCopier.Listener listener) + +
+           
+ Event<IOException>spawn(String name) + +
+           
+ Event<IOException>spawnDaemon(String name) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StreamCopier

+
+public StreamCopier(InputStream in,
+                    OutputStream out)
+
+
+ + + + + + + + +
+Method Detail
+ +

+bufSize

+
+public StreamCopier bufSize(int bufSize)
+
+
+
+
+
+
+ +

+keepFlushing

+
+public StreamCopier keepFlushing(boolean keepFlushing)
+
+
+
+
+
+
+ +

+listener

+
+public StreamCopier listener(StreamCopier.Listener listener)
+
+
+
+
+
+
+ +

+length

+
+public StreamCopier length(long length)
+
+
+
+
+
+
+ +

+spawn

+
+public Event<IOException> spawn(String name)
+
+
+
+
+
+
+ +

+spawnDaemon

+
+public Event<IOException> spawnDaemon(String name)
+
+
+
+
+
+
+ +

+copy

+
+public long copy()
+          throws IOException
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Base64.InputStream.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Base64.InputStream.html new file mode 100644 index 00000000..9b4f9335 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Base64.InputStream.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.common.Base64.InputStream (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.common.Base64.InputStream

+
+No usage of net.schmizz.sshj.common.Base64.InputStream +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Base64.OutputStream.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Base64.OutputStream.html new file mode 100644 index 00000000..953d6362 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Base64.OutputStream.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.common.Base64.OutputStream (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.common.Base64.OutputStream

+
+No usage of net.schmizz.sshj.common.Base64.OutputStream +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Base64.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Base64.html new file mode 100644 index 00000000..6b24ac4c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Base64.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.common.Base64 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.common.Base64

+
+No usage of net.schmizz.sshj.common.Base64 +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Buffer.BufferException.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Buffer.BufferException.html new file mode 100644 index 00000000..3926312f --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Buffer.BufferException.html @@ -0,0 +1,287 @@ + + + + + + + +Uses of Class net.schmizz.sshj.common.Buffer.BufferException (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.common.Buffer.BufferException

+
+ + + + + + + + + +
+Packages that use Buffer.BufferException
net.schmizz.sshj.common  
+  +

+ + + + + +
+Uses of Buffer.BufferException in net.schmizz.sshj.common
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.common that throw Buffer.BufferException
+protected  voidBuffer.ensureAvailable(int a) + +
+           
+ booleanBuffer.readBoolean() + +
+          Read an SSH boolean byte
+ byteBuffer.readByte() + +
+          Read a byte from the buffer
+ byte[]Buffer.readBytes() + +
+          Read an SSH byte-array
+ MessageSSHPacket.readMessageID() + +
+          Reads an SSH byte and returns it as Message
+ BigIntegerBuffer.readMPInt() + +
+          Read an SSH multiple-precision integer
+ PublicKeyBuffer.readPublicKey() + +
+           
+ voidBuffer.readRawBytes(byte[] buf) + +
+           
+ voidBuffer.readRawBytes(byte[] buf, + int off, + int len) + +
+           
+ StringBuffer.readString() + +
+          Reads an SSH string
+ byte[]Buffer.readStringAsBytes() + +
+          Reads an SSH string
+ longBuffer.readUInt32() + +
+           
+ intBuffer.readUInt32AsInt() + +
+           
+ longBuffer.readUInt64() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Buffer.PlainBuffer.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Buffer.PlainBuffer.html new file mode 100644 index 00000000..a155434a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Buffer.PlainBuffer.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Class net.schmizz.sshj.common.Buffer.PlainBuffer (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.common.Buffer.PlainBuffer

+
+ + + + + + + + + +
+Packages that use Buffer.PlainBuffer
net.schmizz.sshj.connection.channel  
+  +

+ + + + + +
+Uses of Buffer.PlainBuffer in net.schmizz.sshj.connection.channel
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel with parameters of type Buffer.PlainBuffer
+protected  Event<ConnectionException>AbstractChannel.sendChannelRequest(String reqType, + boolean wantReply, + Buffer.PlainBuffer reqSpecific) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Buffer.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Buffer.html new file mode 100644 index 00000000..dbe335af --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Buffer.html @@ -0,0 +1,414 @@ + + + + + + + +Uses of Class net.schmizz.sshj.common.Buffer (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.common.Buffer

+
+ + + + + + + + + + + + + + + + + +
+Packages that use Buffer
net.schmizz.sshj.common  
net.schmizz.sshj.sftp  
net.schmizz.sshj.transport.compression  
+  +

+ + + + + +
+Uses of Buffer in net.schmizz.sshj.common
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.common with type parameters of type Buffer
+ classBuffer<T extends Buffer<T>> + +
+           
+  +

+ + + + + + + + + + + + + +
Subclasses of Buffer in net.schmizz.sshj.common
+static classBuffer.PlainBuffer + +
+           
+ classSSHPacket + +
+           
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.common with parameters of type Buffer
+ TBuffer.putBuffer(Buffer<? extends Buffer<?>> buffer) + +
+          Copies the contents of provided buffer into this buffer
+abstract  voidKeyType.putPubKeyIntoBuffer(PublicKey pk, + Buffer<?> buf) + +
+           
+abstract  PublicKeyKeyType.readPubKeyFromBuffer(String type, + Buffer<?> buf) + +
+           
+  +

+ + + + + + + + + +
Method parameters in net.schmizz.sshj.common with type arguments of type Buffer
+ TBuffer.putBuffer(Buffer<? extends Buffer<?>> buffer) + +
+          Copies the contents of provided buffer into this buffer
+  +

+ + + + + + + + + + + +
Constructors in net.schmizz.sshj.common with parameters of type Buffer
Buffer.PlainBuffer(Buffer<?> from) + +
+           
Buffer(Buffer<?> from) + +
+           
+  +

+ + + + + +
+Uses of Buffer in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + + + + + + + + + +
Subclasses of Buffer in net.schmizz.sshj.sftp
+ classRequest + +
+           
+ classResponse + +
+           
+ classSFTPPacket<T extends SFTPPacket<T>> + +
+           
+  +

+ + + + + + + + + + + +
Constructors in net.schmizz.sshj.sftp with parameters of type Buffer
Response(Buffer<Response> pk, + int protocolVersion) + +
+           
SFTPPacket(Buffer<T> buf) + +
+           
+  +

+ + + + + +
+Uses of Buffer in net.schmizz.sshj.transport.compression
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.compression with parameters of type Buffer
+ voidZlibCompression.compress(Buffer buffer) + +
+           
+ voidCompression.compress(Buffer buffer) + +
+          Compress the given buffer in place.
+ voidZlibCompression.uncompress(Buffer from, + Buffer to) + +
+           
+ voidZlibCompression.uncompress(Buffer from, + Buffer to) + +
+           
+ voidCompression.uncompress(Buffer from, + Buffer to) + +
+          Uncompress the data in a buffer into another buffer.
+ voidCompression.uncompress(Buffer from, + Buffer to) + +
+          Uncompress the data in a buffer into another buffer.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/ByteArrayUtils.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/ByteArrayUtils.html new file mode 100644 index 00000000..34185e8b --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/ByteArrayUtils.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.common.ByteArrayUtils (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.common.ByteArrayUtils

+
+No usage of net.schmizz.sshj.common.ByteArrayUtils +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/DisconnectReason.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/DisconnectReason.html new file mode 100644 index 00000000..dc7b45c6 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/DisconnectReason.html @@ -0,0 +1,489 @@ + + + + + + + +Uses of Class net.schmizz.sshj.common.DisconnectReason (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.common.DisconnectReason

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use DisconnectReason
net.schmizz.sshj.common  
net.schmizz.sshj.connection  
net.schmizz.sshj.sftp  
net.schmizz.sshj.transport  
net.schmizz.sshj.userauth  
+  +

+ + + + + +
+Uses of DisconnectReason in net.schmizz.sshj.common
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.common that return DisconnectReason
+static DisconnectReasonDisconnectReason.fromInt(int code) + +
+           
+ DisconnectReasonSSHException.getDisconnectReason() + +
+           
+static DisconnectReasonDisconnectReason.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static DisconnectReason[]DisconnectReason.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + + + + + + + + + +
Constructors in net.schmizz.sshj.common with parameters of type DisconnectReason
SSHException(DisconnectReason code) + +
+           
SSHException(DisconnectReason code, + String message) + +
+           
SSHException(DisconnectReason code, + String message, + Throwable cause) + +
+           
SSHException(DisconnectReason code, + Throwable cause) + +
+           
+  +

+ + + + + +
+Uses of DisconnectReason in net.schmizz.sshj.connection
+  +

+ + + + + + + + + + + + + + + + + +
Constructors in net.schmizz.sshj.connection with parameters of type DisconnectReason
ConnectionException(DisconnectReason code) + +
+           
ConnectionException(DisconnectReason code, + String message) + +
+           
ConnectionException(DisconnectReason code, + String message, + Throwable cause) + +
+           
ConnectionException(DisconnectReason code, + Throwable cause) + +
+           
+  +

+ + + + + +
+Uses of DisconnectReason in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + + + + + + + + + +
Constructors in net.schmizz.sshj.sftp with parameters of type DisconnectReason
SFTPException(DisconnectReason code) + +
+           
SFTPException(DisconnectReason code, + String message) + +
+           
SFTPException(DisconnectReason code, + String message, + Throwable cause) + +
+           
SFTPException(DisconnectReason code, + Throwable cause) + +
+           
+  +

+ + + + + +
+Uses of DisconnectReason in net.schmizz.sshj.transport
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport with parameters of type DisconnectReason
+ voidTransportImpl.disconnect(DisconnectReason reason) + +
+           
+ voidTransport.disconnect(DisconnectReason reason) + +
+          Send a disconnect packet with the given reason, and closes this transport.
+ voidTransportImpl.disconnect(DisconnectReason reason, + String message) + +
+           
+ voidTransport.disconnect(DisconnectReason reason, + String message) + +
+          Send a disconnect packet with the given reason and message, and closes this + transport.
+ voidDisconnectListener.notifyDisconnect(DisconnectReason reason) + +
+           
+  +

+ + + + + + + + + + + + + + + + + +
Constructors in net.schmizz.sshj.transport with parameters of type DisconnectReason
TransportException(DisconnectReason code) + +
+           
TransportException(DisconnectReason code, + String message) + +
+           
TransportException(DisconnectReason code, + String message, + Throwable cause) + +
+           
TransportException(DisconnectReason code, + Throwable cause) + +
+           
+  +

+ + + + + +
+Uses of DisconnectReason in net.schmizz.sshj.userauth
+  +

+ + + + + + + + + + + + + + + + + +
Constructors in net.schmizz.sshj.userauth with parameters of type DisconnectReason
UserAuthException(DisconnectReason code) + +
+           
UserAuthException(DisconnectReason code, + String message) + +
+           
UserAuthException(DisconnectReason code, + String message, + Throwable cause) + +
+           
UserAuthException(DisconnectReason code, + Throwable cause) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/ErrorNotifiable.Util.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/ErrorNotifiable.Util.html new file mode 100644 index 00000000..b8546078 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/ErrorNotifiable.Util.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.common.ErrorNotifiable.Util (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.common.ErrorNotifiable.Util

+
+No usage of net.schmizz.sshj.common.ErrorNotifiable.Util +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/ErrorNotifiable.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/ErrorNotifiable.html new file mode 100644 index 00000000..23dab64e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/ErrorNotifiable.html @@ -0,0 +1,501 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.common.ErrorNotifiable (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.common.ErrorNotifiable

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use ErrorNotifiable
net.schmizz.sshj  
net.schmizz.sshj.common  
net.schmizz.sshj.connection  
net.schmizz.sshj.connection.channel  
net.schmizz.sshj.connection.channel.direct  
net.schmizz.sshj.connection.channel.forwarded  
net.schmizz.sshj.userauth  
+  +

+ + + + + +
+Uses of ErrorNotifiable in net.schmizz.sshj
+  +

+ + + + + + + + + +
Subinterfaces of ErrorNotifiable in net.schmizz.sshj
+ interfaceService + +
+          Represents a service running on top of the SSH transport layer.
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj that implement ErrorNotifiable
+ classAbstractService + +
+          An abstract class for Service that implements common or default functionality.
+  +

+ + + + + +
+Uses of ErrorNotifiable in net.schmizz.sshj.common
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.common with parameters of type ErrorNotifiable
+static voidErrorNotifiable.Util.alertAll(SSHException error, + ErrorNotifiable... notifiables) + +
+          Notify all notifiables of given error.
+  +

+ + + + + + + + + +
Method parameters in net.schmizz.sshj.common with type arguments of type ErrorNotifiable
+static voidErrorNotifiable.Util.alertAll(SSHException error, + Collection<? extends ErrorNotifiable> notifiables) + +
+          Notify all notifiables of given error.
+  +

+ + + + + +
+Uses of ErrorNotifiable in net.schmizz.sshj.connection
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.connection that implement ErrorNotifiable
+ classConnectionImpl + +
+          Connection implementation.
+  +

+ + + + + +
+Uses of ErrorNotifiable in net.schmizz.sshj.connection.channel
+  +

+ + + + + + + + + + + + + + + + + +
Subinterfaces of ErrorNotifiable in net.schmizz.sshj.connection.channel
+ interfaceChannel + +
+          A channel is the basic medium for application-layer data on top of an SSH transport.
+static interfaceChannel.Direct + +
+          Direct channels are those that are initiated by us.
+static interfaceChannel.Forwarded + +
+          Forwarded channels are those that are initiated by the server.
+  +

+ + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.connection.channel that implement ErrorNotifiable
+ classAbstractChannel + +
+           
+ classChannelInputStream + +
+          InputStream for channels.
+ classChannelOutputStream + +
+          OutputStream for channels.
+  +

+ + + + + +
+Uses of ErrorNotifiable in net.schmizz.sshj.connection.channel.direct
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Subinterfaces of ErrorNotifiable in net.schmizz.sshj.connection.channel.direct
+ interfaceSession + +
+          A session channel provides for execution of a remote command, shell or subsystem.
+static interfaceSession.Command + +
+          Command API.
+static interfaceSession.Shell + +
+          Shell API.
+static interfaceSession.Subsystem + +
+          Subsystem API.
+  +

+ + + + + + + + + + + + + +
Classes in net.schmizz.sshj.connection.channel.direct that implement ErrorNotifiable
+ classAbstractDirectChannel + +
+          Base class for direct channels whose open is initated by the client.
+ classSessionChannel + +
+          Session implementation.
+  +

+ + + + + +
+Uses of ErrorNotifiable in net.schmizz.sshj.connection.channel.forwarded
+  +

+ + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.connection.channel.forwarded that implement ErrorNotifiable
+ classAbstractForwardedChannel + +
+          Base class for forwarded channels whose open is initiated by the server.
+static classRemotePortForwarder.ForwardedTCPIPChannel + +
+          A forwarded-tcpip channel.
+static classX11Forwarder.X11Channel + +
+          An x11 forwarded channel.
+  +

+ + + + + +
+Uses of ErrorNotifiable in net.schmizz.sshj.userauth
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.userauth that implement ErrorNotifiable
+ classUserAuthImpl + +
+          UserAuth implementation.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Factory.Named.Util.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Factory.Named.Util.html new file mode 100644 index 00000000..dbab2a08 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Factory.Named.Util.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.common.Factory.Named.Util (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.common.Factory.Named.Util

+
+No usage of net.schmizz.sshj.common.Factory.Named.Util +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Factory.Named.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Factory.Named.html new file mode 100644 index 00000000..9012f0a3 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Factory.Named.html @@ -0,0 +1,890 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.common.Factory.Named (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.common.Factory.Named

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use Factory.Named
net.schmizz.sshj  
net.schmizz.sshj.common  
net.schmizz.sshj.signature  
net.schmizz.sshj.transport.cipher  
net.schmizz.sshj.transport.compression  
net.schmizz.sshj.transport.digest  
net.schmizz.sshj.transport.kex  
net.schmizz.sshj.transport.mac  
net.schmizz.sshj.transport.random  
net.schmizz.sshj.userauth.keyprovider  
+  +

+ + + + + +
+Uses of Factory.Named in net.schmizz.sshj
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj that return types with arguments of type Factory.Named
+ List<Factory.Named<Cipher>>ConfigImpl.getCipherFactories() + +
+           
+ List<Factory.Named<Cipher>>Config.getCipherFactories() + +
+          Retrieve the list of named factories for Cipher.
+ List<Factory.Named<Compression>>ConfigImpl.getCompressionFactories() + +
+           
+ List<Factory.Named<Compression>>Config.getCompressionFactories() + +
+          Retrieve the list of named factories for Compression.
+ List<Factory.Named<FileKeyProvider>>ConfigImpl.getFileKeyProviderFactories() + +
+           
+ List<Factory.Named<FileKeyProvider>>Config.getFileKeyProviderFactories() + +
+          Retrieve the list of named factories for FileKeyProvider.
+ List<Factory.Named<KeyExchange>>ConfigImpl.getKeyExchangeFactories() + +
+           
+ List<Factory.Named<KeyExchange>>Config.getKeyExchangeFactories() + +
+          Retrieve the list of named factories for KeyExchange.
+ List<Factory.Named<MAC>>ConfigImpl.getMACFactories() + +
+           
+ List<Factory.Named<MAC>>Config.getMACFactories() + +
+          Retrieve the list of named factories for MAC.
+ List<Factory.Named<Signature>>ConfigImpl.getSignatureFactories() + +
+           
+ List<Factory.Named<Signature>>Config.getSignatureFactories() + +
+          Retrieve the list of named factories for Signature
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj with parameters of type Factory.Named
+ voidConfigImpl.setCipherFactories(Factory.Named<Cipher>... cipherFactories) + +
+           
+ voidConfigImpl.setCompressionFactories(Factory.Named<Compression>... compressionFactories) + +
+           
+ voidConfigImpl.setFileKeyProviderFactories(Factory.Named<FileKeyProvider>... fileKeyProviderFactories) + +
+           
+ voidConfigImpl.setKeyExchangeFactories(Factory.Named<KeyExchange>... kexFactories) + +
+           
+ voidConfigImpl.setMACFactories(Factory.Named<MAC>... macFactories) + +
+           
+ voidConfigImpl.setSignatureFactories(Factory.Named<Signature>... signatureFactories) + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method parameters in net.schmizz.sshj with type arguments of type Factory.Named
+ voidConfigImpl.setCipherFactories(List<Factory.Named<Cipher>> cipherFactories) + +
+           
+ voidConfig.setCipherFactories(List<Factory.Named<Cipher>> cipherFactories) + +
+          Set the named factories for Cipher.
+ voidConfigImpl.setCompressionFactories(List<Factory.Named<Compression>> compressionFactories) + +
+           
+ voidConfig.setCompressionFactories(List<Factory.Named<Compression>> compressionFactories) + +
+          Set the named factories for Compression.
+ voidConfigImpl.setFileKeyProviderFactories(List<Factory.Named<FileKeyProvider>> fileKeyProviderFactories) + +
+           
+ voidConfig.setFileKeyProviderFactories(List<Factory.Named<FileKeyProvider>> fileKeyProviderFactories) + +
+          Set the named factories for FileKeyProvider.
+ voidConfigImpl.setKeyExchangeFactories(List<Factory.Named<KeyExchange>> kexFactories) + +
+           
+ voidConfig.setKeyExchangeFactories(List<Factory.Named<KeyExchange>> kexFactories) + +
+          Set the named factories for KeyExchange.
+ voidConfigImpl.setMACFactories(List<Factory.Named<MAC>> macFactories) + +
+           
+ voidConfig.setMACFactories(List<Factory.Named<MAC>> macFactories) + +
+          Set the named factories for MAC.
+ voidConfigImpl.setSignatureFactories(List<Factory.Named<Signature>> signatureFactories) + +
+           
+ voidConfig.setSignatureFactories(List<Factory.Named<Signature>> signatureFactories) + +
+          Set the named factories for Signature.
+  +

+ + + + + +
+Uses of Factory.Named in net.schmizz.sshj.common
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.common that return Factory.Named
+static + + + + +
+<T> Factory.Named<T>
+
Factory.Named.Util.get(List<Factory.Named<T>> factories, + String name) + +
+          Retrieve a particular factory as identified by name from a list of named factories.
+  +

+ + + + + + + + + + + + + + + + + +
Method parameters in net.schmizz.sshj.common with type arguments of type Factory.Named
+static + + + + +
+<T> T
+
Factory.Named.Util.create(List<Factory.Named<T>> factories, + String name) + +
+          Creates an object by picking a factory from factories that is identified by name from a + list of named factories.
+static + + + + +
+<T> Factory.Named<T>
+
Factory.Named.Util.get(List<Factory.Named<T>> factories, + String name) + +
+          Retrieve a particular factory as identified by name from a list of named factories.
+static + + + + +
+<T> List<String>
+
Factory.Named.Util.getNames(List<Factory.Named<T>> factories) + +
+          Get a comma-delimited string containing the factory names from the given list of factories.
+  +

+ + + + + +
+Uses of Factory.Named in net.schmizz.sshj.signature
+  +

+ + + + + + + + + + + + + +
Classes in net.schmizz.sshj.signature that implement Factory.Named
+static classSignatureDSA.Factory + +
+          A named factory for DSA signature
+static classSignatureRSA.Factory + +
+          A named factory for RSA Signature
+  +

+ + + + + +
+Uses of Factory.Named in net.schmizz.sshj.transport.cipher
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.transport.cipher that implement Factory.Named
+static classAES128CBC.Factory + +
+          Named factory for AES128CBC Cipher
+static classAES128CTR.Factory + +
+          Named factory for AES128CBC Cipher
+static classAES192CBC.Factory + +
+          Named factory for AES192CBC Cipher
+static classAES192CTR.Factory + +
+          Named factory for AES192CTR Cipher
+static classAES256CBC.Factory + +
+          Named factory for AES256CBC Cipher
+static classAES256CTR.Factory + +
+          Named factory for AES256CBC Cipher
+static classBlowfishCBC.Factory + +
+          Named factory for BlowfishCBC Cipher
+static classNoneCipher.Factory + +
+          Named factory for the no-op Cipher
+static classTripleDESCBC.Factory + +
+          Named factory for TripleDESCBC Cipher
+  +

+ + + + + +
+Uses of Factory.Named in net.schmizz.sshj.transport.compression
+  +

+ + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.transport.compression that implement Factory.Named
+static classDelayedZlibCompression.Factory + +
+          Named factory for the ZLib Delayed Compression.
+static classNoneCompression.Factory + +
+          Named factory for the no-op Compression
+static classZlibCompression.Factory + +
+          Named factory for the ZLib Compression.
+  +

+ + + + + +
+Uses of Factory.Named in net.schmizz.sshj.transport.digest
+  +

+ + + + + + + + + + + + + +
Classes in net.schmizz.sshj.transport.digest that implement Factory.Named
+static classMD5.Factory + +
+          Named factory for MD5 digest
+static classSHA1.Factory + +
+          Named factory for SHA1 digest
+  +

+ + + + + +
+Uses of Factory.Named in net.schmizz.sshj.transport.kex
+  +

+ + + + + + + + + + + + + +
Classes in net.schmizz.sshj.transport.kex that implement Factory.Named
+static classDHG1.Factory + +
+          Named factory for DHG1 key exchange
+static classDHG14.Factory + +
+          Named factory for DHG14 key exchange
+  +

+ + + + + +
+Uses of Factory.Named in net.schmizz.sshj.transport.mac
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.transport.mac that implement Factory.Named
+static classHMACMD5.Factory + +
+          Named factory for the HMACMD5 MAC
+static classHMACMD596.Factory + +
+          Named factory for the HMAC-MD5-96 MAC
+static classHMACSHA1.Factory + +
+          Named factory for the HMAC-SHA1 MAC
+static classHMACSHA196.Factory + +
+          Named factory for the HMAC-SHA1-96 MAC
+  +

+ + + + + +
+Uses of Factory.Named in net.schmizz.sshj.transport.random
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.transport.random that implement Factory.Named
+static classJCERandom.Factory + +
+          Named factory for the JCE Random
+  +

+ + + + + +
+Uses of Factory.Named in net.schmizz.sshj.userauth.keyprovider
+  +

+ + + + + + + + + + + + + +
Classes in net.schmizz.sshj.userauth.keyprovider that implement Factory.Named
+static classOpenSSHKeyFile.Factory + +
+           
+static classPKCS8KeyFile.Factory + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Factory.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Factory.html new file mode 100644 index 00000000..a459f34a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Factory.html @@ -0,0 +1,640 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.common.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.common.Factory

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use Factory
net.schmizz.sshj  
net.schmizz.sshj.common  
net.schmizz.sshj.signature  
net.schmizz.sshj.transport.cipher  
net.schmizz.sshj.transport.compression  
net.schmizz.sshj.transport.digest  
net.schmizz.sshj.transport.kex  
net.schmizz.sshj.transport.mac  
net.schmizz.sshj.transport.random  
net.schmizz.sshj.userauth.keyprovider  
+  +

+ + + + + +
+Uses of Factory in net.schmizz.sshj
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj that return Factory
+ Factory<Random>ConfigImpl.getRandomFactory() + +
+           
+ Factory<Random>Config.getRandomFactory() + +
+          Retrieve the Random factory.
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj with parameters of type Factory
+ voidConfigImpl.setRandomFactory(Factory<Random> randomFactory) + +
+           
+ voidConfig.setRandomFactory(Factory<Random> randomFactory) + +
+          Set the factory for Random.
+  +

+ + + + + +
+Uses of Factory in net.schmizz.sshj.common
+  +

+ + + + + + + + + +
Subinterfaces of Factory in net.schmizz.sshj.common
+static interfaceFactory.Named<T> + +
+          Inteface for a named factory.
+  +

+ + + + + +
+Uses of Factory in net.schmizz.sshj.signature
+  +

+ + + + + + + + + + + + + +
Classes in net.schmizz.sshj.signature that implement Factory
+static classSignatureDSA.Factory + +
+          A named factory for DSA signature
+static classSignatureRSA.Factory + +
+          A named factory for RSA Signature
+  +

+ + + + + +
+Uses of Factory in net.schmizz.sshj.transport.cipher
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.transport.cipher that implement Factory
+static classAES128CBC.Factory + +
+          Named factory for AES128CBC Cipher
+static classAES128CTR.Factory + +
+          Named factory for AES128CBC Cipher
+static classAES192CBC.Factory + +
+          Named factory for AES192CBC Cipher
+static classAES192CTR.Factory + +
+          Named factory for AES192CTR Cipher
+static classAES256CBC.Factory + +
+          Named factory for AES256CBC Cipher
+static classAES256CTR.Factory + +
+          Named factory for AES256CBC Cipher
+static classBlowfishCBC.Factory + +
+          Named factory for BlowfishCBC Cipher
+static classNoneCipher.Factory + +
+          Named factory for the no-op Cipher
+static classTripleDESCBC.Factory + +
+          Named factory for TripleDESCBC Cipher
+  +

+ + + + + +
+Uses of Factory in net.schmizz.sshj.transport.compression
+  +

+ + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.transport.compression that implement Factory
+static classDelayedZlibCompression.Factory + +
+          Named factory for the ZLib Delayed Compression.
+static classNoneCompression.Factory + +
+          Named factory for the no-op Compression
+static classZlibCompression.Factory + +
+          Named factory for the ZLib Compression.
+  +

+ + + + + +
+Uses of Factory in net.schmizz.sshj.transport.digest
+  +

+ + + + + + + + + + + + + +
Classes in net.schmizz.sshj.transport.digest that implement Factory
+static classMD5.Factory + +
+          Named factory for MD5 digest
+static classSHA1.Factory + +
+          Named factory for SHA1 digest
+  +

+ + + + + +
+Uses of Factory in net.schmizz.sshj.transport.kex
+  +

+ + + + + + + + + + + + + +
Classes in net.schmizz.sshj.transport.kex that implement Factory
+static classDHG1.Factory + +
+          Named factory for DHG1 key exchange
+static classDHG14.Factory + +
+          Named factory for DHG14 key exchange
+  +

+ + + + + +
+Uses of Factory in net.schmizz.sshj.transport.mac
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.transport.mac that implement Factory
+static classHMACMD5.Factory + +
+          Named factory for the HMACMD5 MAC
+static classHMACMD596.Factory + +
+          Named factory for the HMAC-MD5-96 MAC
+static classHMACSHA1.Factory + +
+          Named factory for the HMAC-SHA1 MAC
+static classHMACSHA196.Factory + +
+          Named factory for the HMAC-SHA1-96 MAC
+  +

+ + + + + +
+Uses of Factory in net.schmizz.sshj.transport.random
+  +

+ + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.transport.random that implement Factory
+static classBouncyCastleRandom.Factory + +
+          Named factory for the BouncyCastle Random
+static classJCERandom.Factory + +
+          Named factory for the JCE Random
+ classSingletonRandomFactory + +
+          A random factory wrapper that uses a single random instance.
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.transport.random with parameters of type Factory
SingletonRandomFactory(Factory<Random> factory) + +
+           
+  +

+ + + + + +
+Uses of Factory in net.schmizz.sshj.userauth.keyprovider
+  +

+ + + + + + + + + + + + + +
Classes in net.schmizz.sshj.userauth.keyprovider that implement Factory
+static classOpenSSHKeyFile.Factory + +
+           
+static classPKCS8KeyFile.Factory + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/IOUtils.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/IOUtils.html new file mode 100644 index 00000000..da7cdb0e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/IOUtils.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.common.IOUtils (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.common.IOUtils

+
+No usage of net.schmizz.sshj.common.IOUtils +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/KeyType.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/KeyType.html new file mode 100644 index 00000000..a15c9095 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/KeyType.html @@ -0,0 +1,296 @@ + + + + + + + +Uses of Class net.schmizz.sshj.common.KeyType (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.common.KeyType

+
+ + + + + + + + + + + + + + + + + +
+Packages that use KeyType
net.schmizz.sshj.common  
net.schmizz.sshj.transport.verification  
net.schmizz.sshj.userauth.keyprovider  
+  +

+ + + + + +
+Uses of KeyType in net.schmizz.sshj.common
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.common that return KeyType
+static KeyTypeKeyType.fromKey(Key key) + +
+           
+static KeyTypeKeyType.fromString(String sType) + +
+           
+static KeyTypeKeyType.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static KeyType[]KeyType.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + +
+Uses of KeyType in net.schmizz.sshj.transport.verification
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.transport.verification that return KeyType
+ KeyTypeOpenSSHKnownHosts.Entry.getType() + +
+           
+  +

+ + + + + +
+Uses of KeyType in net.schmizz.sshj.userauth.keyprovider
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.userauth.keyprovider declared as KeyType
+protected  KeyTypePKCS8KeyFile.type + +
+           
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.userauth.keyprovider that return KeyType
+ KeyTypePKCS8KeyFile.getType() + +
+           
+ KeyTypeKeyProvider.getType() + +
+           
+ KeyTypeKeyPairWrapper.getType() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Message.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Message.html new file mode 100644 index 00000000..78b3cb8a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/Message.html @@ -0,0 +1,539 @@ + + + + + + + +Uses of Class net.schmizz.sshj.common.Message (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.common.Message

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use Message
net.schmizz.sshj  
net.schmizz.sshj.common  
net.schmizz.sshj.connection  
net.schmizz.sshj.connection.channel  
net.schmizz.sshj.connection.channel.direct  
net.schmizz.sshj.transport  
net.schmizz.sshj.transport.kex  
net.schmizz.sshj.userauth  
net.schmizz.sshj.userauth.method  
+  +

+ + + + + +
+Uses of Message in net.schmizz.sshj
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj with parameters of type Message
+ voidAbstractService.handle(Message msg, + SSHPacket buf) + +
+           
+  +

+ + + + + +
+Uses of Message in net.schmizz.sshj.common
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.common that return Message
+static MessageMessage.fromByte(byte b) + +
+           
+ MessageSSHPacket.readMessageID() + +
+          Reads an SSH byte and returns it as Message
+static MessageMessage.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static Message[]Message.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.common with parameters of type Message
+ voidSSHPacketHandler.handle(Message msg, + SSHPacket buf) + +
+          Delegate handling of some SSH packet to this object.
+ SSHPacketSSHPacket.putMessageID(Message msg) + +
+          Writes a byte indicating the SSH message identifier
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.common with parameters of type Message
SSHPacket(Message msg) + +
+          Constructs new buffer for the specified SSH packet and reserves the needed space (5 bytes) for the packet + header.
+  +

+ + + + + +
+Uses of Message in net.schmizz.sshj.connection
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.connection with parameters of type Message
+ voidConnectionImpl.handle(Message msg, + SSHPacket buf) + +
+           
+  +

+ + + + + +
+Uses of Message in net.schmizz.sshj.connection.channel
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel with parameters of type Message
+protected  voidAbstractChannel.gotUnknown(Message msg, + SSHPacket buf) + +
+           
+ voidAbstractChannel.handle(Message msg, + SSHPacket buf) + +
+           
+protected  SSHPacketAbstractChannel.newBuffer(Message cmd) + +
+           
+  +

+ + + + + +
+Uses of Message in net.schmizz.sshj.connection.channel.direct
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.direct with parameters of type Message
+protected  voidAbstractDirectChannel.gotUnknown(Message cmd, + SSHPacket buf) + +
+           
+  +

+ + + + + +
+Uses of Message in net.schmizz.sshj.transport
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.transport with parameters of type Message
+ voidTransportImpl.handle(Message msg, + SSHPacket buf) + +
+          This is where all incoming packets are handled.
+  +

+ + + + + +
+Uses of Message in net.schmizz.sshj.transport.kex
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.kex with parameters of type Message
+ booleanKeyExchange.next(Message msg, + SSHPacket buffer) + +
+          Process the next packet
+ booleanAbstractDHG.next(Message msg, + SSHPacket packet) + +
+           
+  +

+ + + + + +
+Uses of Message in net.schmizz.sshj.userauth
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.userauth with parameters of type Message
+ voidUserAuthImpl.handle(Message msg, + SSHPacket buf) + +
+           
+  +

+ + + + + +
+Uses of Message in net.schmizz.sshj.userauth.method
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.userauth.method with parameters of type Message
+ voidAuthPublickey.handle(Message cmd, + SSHPacket buf) + +
+          Internal use.
+ voidAuthPassword.handle(Message cmd, + SSHPacket buf) + +
+           
+ voidAuthKeyboardInteractive.handle(Message cmd, + SSHPacket buf) + +
+           
+ voidAbstractAuthMethod.handle(Message msg, + SSHPacket buf) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/SSHException.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/SSHException.html new file mode 100644 index 00000000..889da937 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/SSHException.html @@ -0,0 +1,731 @@ + + + + + + + +Uses of Class net.schmizz.sshj.common.SSHException (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.common.SSHException

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use SSHException
net.schmizz.sshj  
net.schmizz.sshj.common  
net.schmizz.sshj.connection  
net.schmizz.sshj.connection.channel  
net.schmizz.sshj.connection.channel.direct  
net.schmizz.sshj.sftp  
net.schmizz.sshj.transport  
net.schmizz.sshj.transport.verification  
net.schmizz.sshj.userauth  
net.schmizz.sshj.xfer.scp  
+  +

+ + + + + +
+Uses of SSHException in net.schmizz.sshj
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj with parameters of type SSHException
+ voidAbstractService.notifyError(SSHException error) + +
+           
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj that throw SSHException
+ voidAbstractService.handle(Message msg, + SSHPacket buf) + +
+           
+ voidService.notifyUnimplemented(long seqNum) + +
+          Notifies this service that a SSH_MSG_UNIMPLEMENTED was received for packet with given sequence number.
+ voidAbstractService.notifyUnimplemented(long seqNum) + +
+           
+  +

+ + + + + +
+Uses of SSHException in net.schmizz.sshj.common
+  +

+ + + + + + + + + +
Subclasses of SSHException in net.schmizz.sshj.common
+static classBuffer.BufferException + +
+           
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.common with type parameters of type SSHException
+static ExceptionChainer<SSHException>SSHException.chainer + +
+           
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.common with parameters of type SSHException
+static voidErrorNotifiable.Util.alertAll(SSHException error, + Collection<? extends ErrorNotifiable> notifiables) + +
+          Notify all notifiables of given error.
+static voidErrorNotifiable.Util.alertAll(SSHException error, + ErrorNotifiable... notifiables) + +
+          Notify all notifiables of given error.
+ voidErrorNotifiable.notifyError(SSHException error) + +
+          Notifies this object of an error.
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.common that throw SSHException
+ voidSSHPacketHandler.handle(Message msg, + SSHPacket buf) + +
+          Delegate handling of some SSH packet to this object.
+  +

+ + + + + +
+Uses of SSHException in net.schmizz.sshj.connection
+  +

+ + + + + + + + + +
Subclasses of SSHException in net.schmizz.sshj.connection
+ classConnectionException + +
+          Connection-layer exception.
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.connection with parameters of type SSHException
+ voidConnectionImpl.notifyError(SSHException error) + +
+           
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.connection that throw SSHException
+ voidConnectionImpl.handle(Message msg, + SSHPacket buf) + +
+           
+  +

+ + + + + +
+Uses of SSHException in net.schmizz.sshj.connection.channel
+  +

+ + + + + + + + + +
Subclasses of SSHException in net.schmizz.sshj.connection.channel
+ classOpenFailException + +
+           
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel with parameters of type SSHException
+ voidChannelOutputStream.notifyError(SSHException error) + +
+           
+ voidChannelInputStream.notifyError(SSHException error) + +
+           
+ voidAbstractChannel.notifyError(SSHException error) + +
+           
+  +

+ + + + + +
+Uses of SSHException in net.schmizz.sshj.connection.channel.direct
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.direct with parameters of type SSHException
+ voidSessionChannel.notifyError(SSHException error) + +
+           
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.direct that throw SSHException
+ SessionSessionFactory.startSession() + +
+          Opens a session channel.
+  +

+ + + + + +
+Uses of SSHException in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Subclasses of SSHException in net.schmizz.sshj.sftp
+ classSFTPException + +
+           
+  +

+ + + + + + + + + + + +
Constructors in net.schmizz.sshj.sftp that throw SSHException
SFTPEngine(SessionFactory ssh) + +
+           
SFTPEngine(SessionFactory ssh, + String pathSep) + +
+           
+  +

+ + + + + +
+Uses of SSHException in net.schmizz.sshj.transport
+  +

+ + + + + + + + + +
Subclasses of SSHException in net.schmizz.sshj.transport
+ classTransportException + +
+          Transport-layer exception
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.transport that throw SSHException
+ voidTransportImpl.handle(Message msg, + SSHPacket buf) + +
+          This is where all incoming packets are handled.
+  +

+ + + + + +
+Uses of SSHException in net.schmizz.sshj.transport.verification
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.verification that throw SSHException
+protected  voidOpenSSHKnownHosts.Entry.init(PublicKey key) + +
+           
+protected  voidOpenSSHKnownHosts.Entry.init(String typeString, + String keyString) + +
+           
+  +

+ + + + + + + + + + + + + + +
Constructors in net.schmizz.sshj.transport.verification that throw SSHException
OpenSSHKnownHosts.SimpleEntry(List<String> hosts, + PublicKey key) + +
+           
OpenSSHKnownHosts.SimpleEntry(String line) + +
+           
OpenSSHKnownHosts.SimpleEntry(String host, + PublicKey key) + +
+           
+  +

+ + + + + +
+Uses of SSHException in net.schmizz.sshj.userauth
+  +

+ + + + + + + + + +
Subclasses of SSHException in net.schmizz.sshj.userauth
+ classUserAuthException + +
+          User authentication exception
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.userauth with parameters of type SSHException
+ voidUserAuthImpl.notifyError(SSHException error) + +
+           
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.userauth that throw SSHException
+ voidUserAuthImpl.handle(Message msg, + SSHPacket buf) + +
+           
+  +

+ + + + + +
+Uses of SSHException in net.schmizz.sshj.xfer.scp
+  +

+ + + + + + + + + +
Subclasses of SSHException in net.schmizz.sshj.xfer.scp
+ classSCPException + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/SSHPacket.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/SSHPacket.html new file mode 100644 index 00000000..2aeae296 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/SSHPacket.html @@ -0,0 +1,758 @@ + + + + + + + +Uses of Class net.schmizz.sshj.common.SSHPacket (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.common.SSHPacket

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use SSHPacket
net.schmizz.sshj  
net.schmizz.sshj.common  
net.schmizz.sshj.connection  
net.schmizz.sshj.connection.channel  
net.schmizz.sshj.connection.channel.direct  
net.schmizz.sshj.connection.channel.forwarded  
net.schmizz.sshj.transport  
net.schmizz.sshj.transport.kex  
net.schmizz.sshj.userauth  
net.schmizz.sshj.userauth.method  
+  +

+ + + + + +
+Uses of SSHPacket in net.schmizz.sshj
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj with parameters of type SSHPacket
+ voidAbstractService.handle(Message msg, + SSHPacket buf) + +
+           
+  +

+ + + + + +
+Uses of SSHPacket in net.schmizz.sshj.common
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.common that return SSHPacket
+ SSHPacketSSHPacket.putMessageID(Message msg) + +
+          Writes a byte indicating the SSH message identifier
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.common with parameters of type SSHPacket
+ voidSSHPacketHandler.handle(Message msg, + SSHPacket buf) + +
+          Delegate handling of some SSH packet to this object.
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.common with parameters of type SSHPacket
SSHPacket(SSHPacket p) + +
+           
+  +

+ + + + + +
+Uses of SSHPacket in net.schmizz.sshj.connection
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection that return types with arguments of type SSHPacket
+ Promise<SSHPacket,ConnectionException>ConnectionImpl.sendGlobalRequest(String name, + boolean wantReply, + byte[] specifics) + +
+           
+ Promise<SSHPacket,ConnectionException>Connection.sendGlobalRequest(String name, + boolean wantReply, + byte[] specifics) + +
+          Send an SSH global request.
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.connection with parameters of type SSHPacket
+ voidConnectionImpl.handle(Message msg, + SSHPacket buf) + +
+           
+  +

+ + + + + +
+Uses of SSHPacket in net.schmizz.sshj.connection.channel
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel that return SSHPacket
+protected  SSHPacketAbstractChannel.newBuffer(Message cmd) + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel with parameters of type SSHPacket
+protected  voidAbstractChannel.gotExtendedData(SSHPacket buf) + +
+           
+protected  voidAbstractChannel.gotUnknown(Message msg, + SSHPacket buf) + +
+           
+ voidAbstractChannel.handle(Message msg, + SSHPacket buf) + +
+           
+protected  voidAbstractChannel.handleRequest(String reqType, + SSHPacket buf) + +
+           
+protected  voidAbstractChannel.receiveInto(ChannelInputStream stream, + SSHPacket buf) + +
+           
+  +

+ + + + + +
+Uses of SSHPacket in net.schmizz.sshj.connection.channel.direct
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.direct that return SSHPacket
+protected  SSHPacketAbstractDirectChannel.buildOpenReq() + +
+           
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.direct with parameters of type SSHPacket
+protected  voidSessionChannel.gotExtendedData(SSHPacket buf) + +
+           
+protected  voidAbstractDirectChannel.gotUnknown(Message cmd, + SSHPacket buf) + +
+           
+ voidSessionChannel.handleRequest(String req, + SSHPacket buf) + +
+           
+  +

+ + + + + +
+Uses of SSHPacket in net.schmizz.sshj.connection.channel.forwarded
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.forwarded that return SSHPacket
+protected  SSHPacketRemotePortForwarder.req(String reqName, + RemotePortForwarder.Forward forward) + +
+           
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.forwarded with parameters of type SSHPacket
+ voidX11Forwarder.handleOpen(SSHPacket buf) + +
+          Internal API
+ voidRemotePortForwarder.handleOpen(SSHPacket buf) + +
+          Internal API.
+ voidForwardedChannelOpener.handleOpen(SSHPacket buf) + +
+          Delegates a SSH_MSG_CHANNEL_OPEN request for the channel type claimed by this opener.
+  +

+ + + + + +
+Uses of SSHPacket in net.schmizz.sshj.transport
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport with parameters of type SSHPacket
+ voidTransportImpl.handle(Message msg, + SSHPacket buf) + +
+          This is where all incoming packets are handled.
+ longTransportImpl.write(SSHPacket payload) + +
+           
+ longTransport.write(SSHPacket payload) + +
+          Write a packet over this transport.
+  +

+ + + + + +
+Uses of SSHPacket in net.schmizz.sshj.transport.kex
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.kex with parameters of type SSHPacket
+ booleanKeyExchange.next(Message msg, + SSHPacket buffer) + +
+          Process the next packet
+ booleanAbstractDHG.next(Message msg, + SSHPacket packet) + +
+           
+  +

+ + + + + +
+Uses of SSHPacket in net.schmizz.sshj.userauth
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.userauth with parameters of type SSHPacket
+ voidUserAuthImpl.handle(Message msg, + SSHPacket buf) + +
+           
+  +

+ + + + + +
+Uses of SSHPacket in net.schmizz.sshj.userauth.method
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.userauth.method that return SSHPacket
+protected  SSHPacketAuthPublickey.buildReq() + +
+          Builds a feeler request (sans signature).
+ SSHPacketAuthPassword.buildReq() + +
+           
+ SSHPacketAuthKeyboardInteractive.buildReq() + +
+           
+protected  SSHPacketAuthHostbased.buildReq() + +
+           
+protected  SSHPacketAbstractAuthMethod.buildReq() + +
+          Builds a SSHPacket containing the fields common to all authentication method.
+protected  SSHPacketKeyedAuthMethod.putPubKey(SSHPacket reqBuf) + +
+           
+protected  SSHPacketKeyedAuthMethod.putSig(SSHPacket reqBuf) + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.userauth.method with parameters of type SSHPacket
+ voidAuthPublickey.handle(Message cmd, + SSHPacket buf) + +
+          Internal use.
+ voidAuthPassword.handle(Message cmd, + SSHPacket buf) + +
+           
+ voidAuthKeyboardInteractive.handle(Message cmd, + SSHPacket buf) + +
+           
+ voidAbstractAuthMethod.handle(Message msg, + SSHPacket buf) + +
+           
+protected  SSHPacketKeyedAuthMethod.putPubKey(SSHPacket reqBuf) + +
+           
+protected  SSHPacketKeyedAuthMethod.putSig(SSHPacket reqBuf) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/SSHPacketHandler.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/SSHPacketHandler.html new file mode 100644 index 00000000..359a0d7b --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/SSHPacketHandler.html @@ -0,0 +1,576 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.common.SSHPacketHandler (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.common.SSHPacketHandler

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use SSHPacketHandler
net.schmizz.sshj  
net.schmizz.sshj.connection  
net.schmizz.sshj.connection.channel  
net.schmizz.sshj.connection.channel.direct  
net.schmizz.sshj.connection.channel.forwarded  
net.schmizz.sshj.transport  
net.schmizz.sshj.userauth  
net.schmizz.sshj.userauth.method  
+  +

+ + + + + +
+Uses of SSHPacketHandler in net.schmizz.sshj
+  +

+ + + + + + + + + +
Subinterfaces of SSHPacketHandler in net.schmizz.sshj
+ interfaceService + +
+          Represents a service running on top of the SSH transport layer.
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj that implement SSHPacketHandler
+ classAbstractService + +
+          An abstract class for Service that implements common or default functionality.
+  +

+ + + + + +
+Uses of SSHPacketHandler in net.schmizz.sshj.connection
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.connection that implement SSHPacketHandler
+ classConnectionImpl + +
+          Connection implementation.
+  +

+ + + + + +
+Uses of SSHPacketHandler in net.schmizz.sshj.connection.channel
+  +

+ + + + + + + + + + + + + + + + + +
Subinterfaces of SSHPacketHandler in net.schmizz.sshj.connection.channel
+ interfaceChannel + +
+          A channel is the basic medium for application-layer data on top of an SSH transport.
+static interfaceChannel.Direct + +
+          Direct channels are those that are initiated by us.
+static interfaceChannel.Forwarded + +
+          Forwarded channels are those that are initiated by the server.
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.connection.channel that implement SSHPacketHandler
+ classAbstractChannel + +
+           
+  +

+ + + + + +
+Uses of SSHPacketHandler in net.schmizz.sshj.connection.channel.direct
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Subinterfaces of SSHPacketHandler in net.schmizz.sshj.connection.channel.direct
+ interfaceSession + +
+          A session channel provides for execution of a remote command, shell or subsystem.
+static interfaceSession.Command + +
+          Command API.
+static interfaceSession.Shell + +
+          Shell API.
+static interfaceSession.Subsystem + +
+          Subsystem API.
+  +

+ + + + + + + + + + + + + +
Classes in net.schmizz.sshj.connection.channel.direct that implement SSHPacketHandler
+ classAbstractDirectChannel + +
+          Base class for direct channels whose open is initated by the client.
+ classSessionChannel + +
+          Session implementation.
+  +

+ + + + + +
+Uses of SSHPacketHandler in net.schmizz.sshj.connection.channel.forwarded
+  +

+ + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.connection.channel.forwarded that implement SSHPacketHandler
+ classAbstractForwardedChannel + +
+          Base class for forwarded channels whose open is initiated by the server.
+static classRemotePortForwarder.ForwardedTCPIPChannel + +
+          A forwarded-tcpip channel.
+static classX11Forwarder.X11Channel + +
+          An x11 forwarded channel.
+  +

+ + + + + +
+Uses of SSHPacketHandler in net.schmizz.sshj.transport
+  +

+ + + + + + + + + +
Subinterfaces of SSHPacketHandler in net.schmizz.sshj.transport
+ interfaceTransport + +
+          Transport layer of the SSH protocol.
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.transport that implement SSHPacketHandler
+ classTransportImpl + +
+          A thread-safe Transport implementation.
+  +

+ + + + + +
+Uses of SSHPacketHandler in net.schmizz.sshj.userauth
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.userauth that implement SSHPacketHandler
+ classUserAuthImpl + +
+          UserAuth implementation.
+  +

+ + + + + +
+Uses of SSHPacketHandler in net.schmizz.sshj.userauth.method
+  +

+ + + + + + + + + +
Subinterfaces of SSHPacketHandler in net.schmizz.sshj.userauth.method
+ interfaceAuthMethod + +
+          An authentication method of the SSH Authentication Protocol.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.userauth.method that implement SSHPacketHandler
+ classAbstractAuthMethod + +
+          This abstract class for AuthMethod implements common or default functionality.
+ classAuthHostbased + +
+          Implements the hostbased SSH authentication method.
+ classAuthKeyboardInteractive + +
+          Implements the keyboard-interactive authentication method.
+ classAuthNone + +
+          none auth.
+ classAuthPassword + +
+          Implements the password authentication method.
+ classAuthPublickey + +
+          Implements the "publickey" SSH authentication method.
+ classKeyedAuthMethod + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/SSHRuntimeException.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/SSHRuntimeException.html new file mode 100644 index 00000000..4a02990d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/SSHRuntimeException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.common.SSHRuntimeException (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.common.SSHRuntimeException

+
+No usage of net.schmizz.sshj.common.SSHRuntimeException +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/SecurityUtils.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/SecurityUtils.html new file mode 100644 index 00000000..9b298ac8 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/SecurityUtils.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.common.SecurityUtils (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.common.SecurityUtils

+
+No usage of net.schmizz.sshj.common.SecurityUtils +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/StreamCopier.Listener.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/StreamCopier.Listener.html new file mode 100644 index 00000000..ee491d50 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/StreamCopier.Listener.html @@ -0,0 +1,226 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.common.StreamCopier.Listener (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.common.StreamCopier.Listener

+
+ + + + + + + + + + + + + +
+Packages that use StreamCopier.Listener
net.schmizz.sshj.common  
net.schmizz.sshj.xfer  
+  +

+ + + + + +
+Uses of StreamCopier.Listener in net.schmizz.sshj.common
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.common with parameters of type StreamCopier.Listener
+ StreamCopierStreamCopier.listener(StreamCopier.Listener listener) + +
+           
+  +

+ + + + + +
+Uses of StreamCopier.Listener in net.schmizz.sshj.xfer
+  +

+ + + + + + + + + +
Subinterfaces of StreamCopier.Listener in net.schmizz.sshj.xfer
+ interfaceTransferListener + +
+           
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.xfer that implement StreamCopier.Listener
+ classLoggingTransferListener + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/class-use/StreamCopier.html b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/StreamCopier.html new file mode 100644 index 00000000..41d67646 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/class-use/StreamCopier.html @@ -0,0 +1,205 @@ + + + + + + + +Uses of Class net.schmizz.sshj.common.StreamCopier (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.common.StreamCopier

+
+ + + + + + + + + +
+Packages that use StreamCopier
net.schmizz.sshj.common  
+  +

+ + + + + +
+Uses of StreamCopier in net.schmizz.sshj.common
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.common that return StreamCopier
+ StreamCopierStreamCopier.bufSize(int bufSize) + +
+           
+ StreamCopierStreamCopier.keepFlushing(boolean keepFlushing) + +
+           
+ StreamCopierStreamCopier.length(long length) + +
+           
+ StreamCopierStreamCopier.listener(StreamCopier.Listener listener) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/common/package-frame.html new file mode 100644 index 00000000..3a8cf002 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/package-frame.html @@ -0,0 +1,104 @@ + + + + + + + +net.schmizz.sshj.common (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.common + + + + +
+Interfaces  + +
+ErrorNotifiable +
+Factory +
+Factory.Named +
+SSHPacketHandler +
+StreamCopier.Listener
+ + + + + + +
+Classes  + +
+Base64 +
+Base64.InputStream +
+Base64.OutputStream +
+Buffer +
+Buffer.PlainBuffer +
+ByteArrayUtils +
+ErrorNotifiable.Util +
+Factory.Named.Util +
+IOUtils +
+SecurityUtils +
+SSHPacket +
+StreamCopier
+ + + + + + +
+Enums  + +
+DisconnectReason +
+KeyType +
+Message
+ + + + + + +
+Exceptions  + +
+Buffer.BufferException +
+SSHException +
+SSHRuntimeException
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/common/package-summary.html new file mode 100644 index 00000000..1f19c69e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/package-summary.html @@ -0,0 +1,278 @@ + + + + + + + +net.schmizz.sshj.common (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.common +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Interface Summary
ErrorNotifiableAPI for classes that are capable of being notified on an error so they can cleanup.
Factory<T>A basic factory interface.
Factory.Named<T>Inteface for a named factory.
SSHPacketHandlerAn interface for classes to which packet handling may be delegated.
StreamCopier.Listener 
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
Base64 Encodes and decodes to and from Base64 notation.
Base64.InputStreamA Base64.InputStream will read data from another java.io.InputStream, given in the constructor, + and encode/decode to/from Base64 notation on the fly.
Base64.OutputStreamA Base64.OutputStream will write data to another java.io.OutputStream, given in the constructor, + and encode/decode to/from Base64 notation on the fly.
Buffer<T extends Buffer<T>> 
Buffer.PlainBuffer 
ByteArrayUtilsUtility functions for byte arrays.
ErrorNotifiable.UtilUtility functions.
Factory.Named.UtilUtility functions
IOUtils 
SecurityUtilsStatic utility method relating to security facilities.
SSHPacket 
StreamCopier 
+  + +

+ + + + + + + + + + + + + + + + + +
+Enum Summary
DisconnectReasonDisconnect error codes
KeyTypeType of key e.g.
MessageSSH message identifiers
+  + +

+ + + + + + + + + + + + + + + + + +
+Exception Summary
Buffer.BufferException 
SSHExceptionMost exceptions in the net.schmizz.sshj package are instances of this class.
SSHRuntimeExceptionRepresents unrecoverable exceptions in the net.schmizz.sshj package.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/common/package-tree.html new file mode 100644 index 00000000..5d5f9f62 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/package-tree.html @@ -0,0 +1,194 @@ + + + + + + + +net.schmizz.sshj.common Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.common +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/common/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/common/package-use.html new file mode 100644 index 00000000..adeb7106 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/common/package-use.html @@ -0,0 +1,905 @@ + + + + + + + +Uses of Package net.schmizz.sshj.common (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.common

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.common
net.schmizz.sshj  
net.schmizz.sshj.common  
net.schmizz.sshj.connection  
net.schmizz.sshj.connection.channel  
net.schmizz.sshj.connection.channel.direct  
net.schmizz.sshj.connection.channel.forwarded  
net.schmizz.sshj.sftp  
net.schmizz.sshj.signature  
net.schmizz.sshj.transport  
net.schmizz.sshj.transport.cipher  
net.schmizz.sshj.transport.compression  
net.schmizz.sshj.transport.digest  
net.schmizz.sshj.transport.kex  
net.schmizz.sshj.transport.mac  
net.schmizz.sshj.transport.random  
net.schmizz.sshj.transport.verification  
net.schmizz.sshj.userauth  
net.schmizz.sshj.userauth.keyprovider  
net.schmizz.sshj.userauth.method  
net.schmizz.sshj.xfer  
net.schmizz.sshj.xfer.scp  
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj
ErrorNotifiable + +
+          API for classes that are capable of being notified on an error so they can cleanup.
Factory + +
+          A basic factory interface.
Factory.Named + +
+          Inteface for a named factory.
Message + +
+          SSH message identifiers
SSHException + +
+          Most exceptions in the net.schmizz.sshj package are instances of this class.
SSHPacket + +
+           
SSHPacketHandler + +
+          An interface for classes to which packet handling may be delegated.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.common
Buffer + +
+           
Buffer.BufferException + +
+           
DisconnectReason + +
+          Disconnect error codes
ErrorNotifiable + +
+          API for classes that are capable of being notified on an error so they can cleanup.
Factory + +
+          A basic factory interface.
Factory.Named + +
+          Inteface for a named factory.
KeyType + +
+          Type of key e.g.
Message + +
+          SSH message identifiers
SSHException + +
+          Most exceptions in the net.schmizz.sshj package are instances of this class.
SSHPacket + +
+           
StreamCopier + +
+           
StreamCopier.Listener + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.connection
DisconnectReason + +
+          Disconnect error codes
ErrorNotifiable + +
+          API for classes that are capable of being notified on an error so they can cleanup.
Message + +
+          SSH message identifiers
SSHException + +
+          Most exceptions in the net.schmizz.sshj package are instances of this class.
SSHPacket + +
+           
SSHPacketHandler + +
+          An interface for classes to which packet handling may be delegated.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.connection.channel
Buffer.PlainBuffer + +
+           
ErrorNotifiable + +
+          API for classes that are capable of being notified on an error so they can cleanup.
Message + +
+          SSH message identifiers
SSHException + +
+          Most exceptions in the net.schmizz.sshj package are instances of this class.
SSHPacket + +
+           
SSHPacketHandler + +
+          An interface for classes to which packet handling may be delegated.
+  +

+ + + + + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.connection.channel.direct
ErrorNotifiable + +
+          API for classes that are capable of being notified on an error so they can cleanup.
Message + +
+          SSH message identifiers
SSHException + +
+          Most exceptions in the net.schmizz.sshj package are instances of this class.
SSHPacket + +
+           
SSHPacketHandler + +
+          An interface for classes to which packet handling may be delegated.
+  +

+ + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.connection.channel.forwarded
ErrorNotifiable + +
+          API for classes that are capable of being notified on an error so they can cleanup.
SSHPacket + +
+           
SSHPacketHandler + +
+          An interface for classes to which packet handling may be delegated.
+  +

+ + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.sftp
Buffer + +
+           
DisconnectReason + +
+          Disconnect error codes
SSHException + +
+          Most exceptions in the net.schmizz.sshj package are instances of this class.
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.signature
Factory + +
+          A basic factory interface.
Factory.Named + +
+          Inteface for a named factory.
+  +

+ + + + + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.transport
DisconnectReason + +
+          Disconnect error codes
Message + +
+          SSH message identifiers
SSHException + +
+          Most exceptions in the net.schmizz.sshj package are instances of this class.
SSHPacket + +
+           
SSHPacketHandler + +
+          An interface for classes to which packet handling may be delegated.
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.transport.cipher
Factory + +
+          A basic factory interface.
Factory.Named + +
+          Inteface for a named factory.
+  +

+ + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.transport.compression
Buffer + +
+           
Factory + +
+          A basic factory interface.
Factory.Named + +
+          Inteface for a named factory.
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.transport.digest
Factory + +
+          A basic factory interface.
Factory.Named + +
+          Inteface for a named factory.
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.transport.kex
Factory + +
+          A basic factory interface.
Factory.Named + +
+          Inteface for a named factory.
Message + +
+          SSH message identifiers
SSHPacket + +
+           
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.transport.mac
Factory + +
+          A basic factory interface.
Factory.Named + +
+          Inteface for a named factory.
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.transport.random
Factory + +
+          A basic factory interface.
Factory.Named + +
+          Inteface for a named factory.
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.transport.verification
KeyType + +
+          Type of key e.g.
SSHException + +
+          Most exceptions in the net.schmizz.sshj package are instances of this class.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.userauth
DisconnectReason + +
+          Disconnect error codes
ErrorNotifiable + +
+          API for classes that are capable of being notified on an error so they can cleanup.
Message + +
+          SSH message identifiers
SSHException + +
+          Most exceptions in the net.schmizz.sshj package are instances of this class.
SSHPacket + +
+           
SSHPacketHandler + +
+          An interface for classes to which packet handling may be delegated.
+  +

+ + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.userauth.keyprovider
Factory + +
+          A basic factory interface.
Factory.Named + +
+          Inteface for a named factory.
KeyType + +
+          Type of key e.g.
+  +

+ + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.userauth.method
Message + +
+          SSH message identifiers
SSHPacket + +
+           
SSHPacketHandler + +
+          An interface for classes to which packet handling may be delegated.
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.xfer
StreamCopier.Listener + +
+           
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.common used by net.schmizz.sshj.xfer.scp
SSHException + +
+          Most exceptions in the net.schmizz.sshj package are instances of this class.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/Connection.html b/javadoc/0.4.1/net/schmizz/sshj/connection/Connection.html new file mode 100644 index 00000000..8c6480cb --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/Connection.html @@ -0,0 +1,572 @@ + + + + + + + +Connection (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection +
+Interface Connection

+
+
All Known Implementing Classes:
ConnectionImpl
+
+
+
+
public interface Connection
+ + +

+Connection layer of the SSH protocol. Refer to RFC 254. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidattach(Channel chan) + +
+          Attach a Channel to this connection.
+ voidattach(ForwardedChannelOpener opener) + +
+          Attach a ForwardedChannelOpener to this connection, which will be delegated opening of any CHANNEL_OPEN packets for which it is responsible.
+ voidforget(Channel chan) + +
+          Forget an attached Channel.
+ voidforget(ForwardedChannelOpener opener) + +
+          Forget an attached ForwardedChannelOpener.
+ Channelget(int id) + +
+           
+ ForwardedChannelOpenerget(String chanType) + +
+           
+ intgetMaxPacketSize() + +
+           
+ intgetTimeout() + +
+           
+ TransportgetTransport() + +
+           
+ intgetWindowSize() + +
+           
+ voidjoin() + +
+          Wait for the situation that no channels are attached (e.g., got closed).
+ intnextID() + +
+           
+ Promise<SSHPacket,ConnectionException>sendGlobalRequest(String name, + boolean wantReply, + byte[] specifics) + +
+          Send an SSH global request.
+ voidsendOpenFailure(int recipient, + OpenFailException.Reason reason, + String message) + +
+          Send a SSH_MSG_OPEN_FAILURE for specified Reason and message.
+ voidsetMaxPacketSize(int maxPacketSize) + +
+          Set the maximum packet size for the local window this connection recommends to any Channel's that ask for + it.
+ voidsetTimeout(int timeout) + +
+          Set the timeout this connection uses for blocking operations and recommends to any other + classes that ask for it.
+ voidsetWindowSize(int windowSize) + +
+          Set the size for the local window this connection recommends to any Channel's that ask for it.
+  +

+ + + + + + + + +
+Method Detail
+ +

+attach

+
+void attach(Channel chan)
+
+
Attach a Channel to this connection. A channel must be attached to the connection if it is to receive any + channel-specific data that is received. +

+

+
Parameters:
chan - the channel
+
+
+
+ +

+attach

+
+void attach(ForwardedChannelOpener opener)
+
+
Attach a ForwardedChannelOpener to this connection, which will be delegated opening of any CHANNEL_OPEN packets for which it is responsible. +

+

+
Parameters:
opener - an opener for forwarded channels
+
+
+
+ +

+forget

+
+void forget(Channel chan)
+
+
Forget an attached Channel. +

+

+
Parameters:
chan - the channel
+
+
+
+ +

+forget

+
+void forget(ForwardedChannelOpener opener)
+
+
Forget an attached ForwardedChannelOpener. +

+

+
Parameters:
opener - the opener to forget
+
+
+
+ +

+get

+
+Channel get(int id)
+
+
+
Parameters:
id - number of the channel to retrieve +
Returns:
an attached Channel of specified channel number, or null if no such channel was attached
+
+
+
+ +

+join

+
+void join()
+          throws InterruptedException
+
+
Wait for the situation that no channels are attached (e.g., got closed). +

+

+ +
Throws: +
InterruptedException - if the thread is interrupted
+
+
+
+ +

+get

+
+ForwardedChannelOpener get(String chanType)
+
+
+
Parameters:
chanType - channel type +
Returns:
an attached ForwardedChannelOpener of specified channel-type, or null if no such channel + was attached
+
+
+
+ +

+nextID

+
+int nextID()
+
+
+ +
Returns:
an available ID a Channel can rightfully claim.
+
+
+
+ +

+sendGlobalRequest

+
+Promise<SSHPacket,ConnectionException> sendGlobalRequest(String name,
+                                                         boolean wantReply,
+                                                         byte[] specifics)
+                                                         throws TransportException
+
+
Send an SSH global request. +

+

+
Parameters:
name - request name
wantReply - whether a reply is requested
specifics - SSHPacket containing fields specific to the request +
Returns:
a Promise for the reply data (in case wantReply is true) which allows waiting on the + reply, or null if a reply is not requested. +
Throws: +
TransportException - if there is an error sending the request
+
+
+
+ +

+sendOpenFailure

+
+void sendOpenFailure(int recipient,
+                     OpenFailException.Reason reason,
+                     String message)
+                     throws TransportException
+
+
Send a SSH_MSG_OPEN_FAILURE for specified Reason and message. +

+

+
Parameters:
recipient - number of the recipient channel
reason - a reason for the failure
message - an explanatory message +
Throws: +
TransportException - if there is a transport-layer error
+
+
+
+ +

+getMaxPacketSize

+
+int getMaxPacketSize()
+
+
+ +
Returns:
the maximum packet size for the local window this connection recommends to any Channel's that ask + for it.
+
+
+
+ +

+setMaxPacketSize

+
+void setMaxPacketSize(int maxPacketSize)
+
+
Set the maximum packet size for the local window this connection recommends to any Channel's that ask for + it. +

+

+
Parameters:
maxPacketSize - maximum packet size in bytes
+
+
+
+ +

+getWindowSize

+
+int getWindowSize()
+
+
+ +
Returns:
the size for the local window this connection recommends to any Channel's that ask for it.
+
+
+
+ +

+setWindowSize

+
+void setWindowSize(int windowSize)
+
+
Set the size for the local window this connection recommends to any Channel's that ask for it. +

+

+
Parameters:
windowSize - window size in bytes
+
+
+
+ +

+getTransport

+
+Transport getTransport()
+
+
+ +
Returns:
the associated Transport.
+
+
+
+ +

+getTimeout

+
+int getTimeout()
+
+
+ +
Returns:
the timeout in seconds that this connection uses for blocking operations and recommends to any + other classes that ask for it.
+
+
+
+ +

+setTimeout

+
+void setTimeout(int timeout)
+
+
Set the timeout this connection uses for blocking operations and recommends to any other + classes that ask for it. +

+

+
Parameters:
timeout - timeout in seconds
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/ConnectionException.html b/javadoc/0.4.1/net/schmizz/sshj/connection/ConnectionException.html new file mode 100644 index 00000000..0fab740b --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/ConnectionException.html @@ -0,0 +1,389 @@ + + + + + + + +ConnectionException (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection +
+Class ConnectionException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by net.schmizz.sshj.common.SSHException
+                  extended by net.schmizz.sshj.connection.ConnectionException
+
+
+
All Implemented Interfaces:
Serializable
+
+
+
Direct Known Subclasses:
OpenFailException
+
+
+
+
public class ConnectionException
extends SSHException
+ + +

+Connection-layer exception. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Field Summary
+static ExceptionChainer<ConnectionException>chainer + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
ConnectionException(DisconnectReason code) + +
+           
ConnectionException(DisconnectReason code, + String message) + +
+           
ConnectionException(DisconnectReason code, + String message, + Throwable cause) + +
+           
ConnectionException(DisconnectReason code, + Throwable cause) + +
+           
ConnectionException(String message) + +
+           
ConnectionException(String message, + Throwable cause) + +
+           
ConnectionException(Throwable cause) + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.common.SSHException
getDisconnectReason, getMessage, toString
+ + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+chainer

+
+public static final ExceptionChainer<ConnectionException> chainer
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+ConnectionException

+
+public ConnectionException(DisconnectReason code)
+
+
+
+ +

+ConnectionException

+
+public ConnectionException(DisconnectReason code,
+                           String message)
+
+
+
+ +

+ConnectionException

+
+public ConnectionException(DisconnectReason code,
+                           String message,
+                           Throwable cause)
+
+
+
+ +

+ConnectionException

+
+public ConnectionException(DisconnectReason code,
+                           Throwable cause)
+
+
+
+ +

+ConnectionException

+
+public ConnectionException(String message)
+
+
+
+ +

+ConnectionException

+
+public ConnectionException(String message,
+                           Throwable cause)
+
+
+
+ +

+ConnectionException

+
+public ConnectionException(Throwable cause)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/ConnectionImpl.html b/javadoc/0.4.1/net/schmizz/sshj/connection/ConnectionImpl.html new file mode 100644 index 00000000..8f1bcbd4 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/ConnectionImpl.html @@ -0,0 +1,743 @@ + + + + + + + +ConnectionImpl (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection +
+Class ConnectionImpl

+
+java.lang.Object
+  extended by net.schmizz.sshj.AbstractService
+      extended by net.schmizz.sshj.connection.ConnectionImpl
+
+
+
All Implemented Interfaces:
ErrorNotifiable, SSHPacketHandler, Connection, Service
+
+
+
+
public class ConnectionImpl
extends AbstractService
implements Connection
+ + +

+Connection implementation. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable
ErrorNotifiable.Util
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.AbstractService
log, name, timeout, trans
+  + + + + + + + + + + +
+Constructor Summary
ConnectionImpl(Transport trans) + +
+          Create with an associated Transport.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidattach(Channel chan) + +
+          Attach a Channel to this connection.
+ voidattach(ForwardedChannelOpener opener) + +
+          Attach a ForwardedChannelOpener to this connection, which will be delegated opening of any CHANNEL_OPEN packets for which it is responsible.
+ voidforget(Channel chan) + +
+          Forget an attached Channel.
+ voidforget(ForwardedChannelOpener opener) + +
+          Forget an attached ForwardedChannelOpener.
+ Channelget(int id) + +
+           
+ ForwardedChannelOpenerget(String chanType) + +
+           
+ intgetMaxPacketSize() + +
+           
+ TransportgetTransport() + +
+           
+ intgetWindowSize() + +
+           
+ voidhandle(Message msg, + SSHPacket buf) + +
+          Delegate handling of some SSH packet to this object.
+ voidjoin() + +
+          Wait for the situation that no channels are attached (e.g., got closed).
+ intnextID() + +
+           
+ voidnotifyError(SSHException error) + +
+          Notifies this object of an error.
+ Promise<SSHPacket,ConnectionException>sendGlobalRequest(String name, + boolean wantReply, + byte[] specifics) + +
+          Send an SSH global request.
+ voidsendOpenFailure(int recipient, + OpenFailException.Reason reason, + String message) + +
+          Send a SSH_MSG_OPEN_FAILURE for specified Reason and message.
+ voidsetMaxPacketSize(int maxPacketSize) + +
+          Set the maximum packet size for the local window this connection recommends to any Channel's that ask for + it.
+ voidsetWindowSize(int windowSize) + +
+          Set the size for the local window this connection recommends to any Channel's that ask for it.
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.AbstractService
getName, getTimeout, notifyUnimplemented, request, setTimeout
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.connection.Connection
getTimeout, setTimeout
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ConnectionImpl

+
+public ConnectionImpl(Transport trans)
+
+
Create with an associated Transport. +

+

+
Parameters:
trans - transport layer
+
+ + + + + + + + +
+Method Detail
+ +

+attach

+
+public void attach(Channel chan)
+
+
Description copied from interface: Connection
+
Attach a Channel to this connection. A channel must be attached to the connection if it is to receive any + channel-specific data that is received. +

+

+
Specified by:
attach in interface Connection
+
+
+
Parameters:
chan - the channel
+
+
+
+ +

+get

+
+public Channel get(int id)
+
+
+
Specified by:
get in interface Connection
+
+
+
Parameters:
id - number of the channel to retrieve +
Returns:
an attached Channel of specified channel number, or null if no such channel was attached
+
+
+
+ +

+get

+
+public ForwardedChannelOpener get(String chanType)
+
+
+
Specified by:
get in interface Connection
+
+
+
Parameters:
chanType - channel type +
Returns:
an attached ForwardedChannelOpener of specified channel-type, or null if no such channel + was attached
+
+
+
+ +

+forget

+
+public void forget(Channel chan)
+
+
Description copied from interface: Connection
+
Forget an attached Channel. +

+

+
Specified by:
forget in interface Connection
+
+
+
Parameters:
chan - the channel
+
+
+
+ +

+forget

+
+public void forget(ForwardedChannelOpener opener)
+
+
Description copied from interface: Connection
+
Forget an attached ForwardedChannelOpener. +

+

+
Specified by:
forget in interface Connection
+
+
+
Parameters:
opener - the opener to forget
+
+
+
+ +

+attach

+
+public void attach(ForwardedChannelOpener opener)
+
+
Description copied from interface: Connection
+
Attach a ForwardedChannelOpener to this connection, which will be delegated opening of any CHANNEL_OPEN packets for which it is responsible. +

+

+
Specified by:
attach in interface Connection
+
+
+
Parameters:
opener - an opener for forwarded channels
+
+
+
+ +

+handle

+
+public void handle(Message msg,
+                   SSHPacket buf)
+            throws SSHException
+
+
Description copied from interface: SSHPacketHandler
+
Delegate handling of some SSH packet to this object. +

+

+
Specified by:
handle in interface SSHPacketHandler
Overrides:
handle in class AbstractService
+
+
+
Parameters:
msg - the SSH message identifier
buf - SSHPacket containing rest of the request +
Throws: +
SSHException - if there is a non-recoverable error
+
+
+
+ +

+getMaxPacketSize

+
+public int getMaxPacketSize()
+
+
+
Specified by:
getMaxPacketSize in interface Connection
+
+
+ +
Returns:
the maximum packet size for the local window this connection recommends to any Channel's that ask + for it.
+
+
+
+ +

+getTransport

+
+public Transport getTransport()
+
+
+
Specified by:
getTransport in interface Connection
+
+
+ +
Returns:
the associated Transport.
+
+
+
+ +

+setMaxPacketSize

+
+public void setMaxPacketSize(int maxPacketSize)
+
+
Description copied from interface: Connection
+
Set the maximum packet size for the local window this connection recommends to any Channel's that ask for + it. +

+

+
Specified by:
setMaxPacketSize in interface Connection
+
+
+
Parameters:
maxPacketSize - maximum packet size in bytes
+
+
+
+ +

+getWindowSize

+
+public int getWindowSize()
+
+
+
Specified by:
getWindowSize in interface Connection
+
+
+ +
Returns:
the size for the local window this connection recommends to any Channel's that ask for it.
+
+
+
+ +

+setWindowSize

+
+public void setWindowSize(int windowSize)
+
+
Description copied from interface: Connection
+
Set the size for the local window this connection recommends to any Channel's that ask for it. +

+

+
Specified by:
setWindowSize in interface Connection
+
+
+
Parameters:
windowSize - window size in bytes
+
+
+
+ +

+join

+
+public void join()
+          throws InterruptedException
+
+
Description copied from interface: Connection
+
Wait for the situation that no channels are attached (e.g., got closed). +

+

+
Specified by:
join in interface Connection
+
+
+ +
Throws: +
InterruptedException - if the thread is interrupted
+
+
+
+ +

+nextID

+
+public int nextID()
+
+
+
Specified by:
nextID in interface Connection
+
+
+ +
Returns:
an available ID a Channel can rightfully claim.
+
+
+
+ +

+sendGlobalRequest

+
+public Promise<SSHPacket,ConnectionException> sendGlobalRequest(String name,
+                                                                boolean wantReply,
+                                                                byte[] specifics)
+                                                         throws TransportException
+
+
Description copied from interface: Connection
+
Send an SSH global request. +

+

+
Specified by:
sendGlobalRequest in interface Connection
+
+
+
Parameters:
name - request name
wantReply - whether a reply is requested
specifics - SSHPacket containing fields specific to the request +
Returns:
a Promise for the reply data (in case wantReply is true) which allows waiting on the + reply, or null if a reply is not requested. +
Throws: +
TransportException - if there is an error sending the request
+
+
+
+ +

+sendOpenFailure

+
+public void sendOpenFailure(int recipient,
+                            OpenFailException.Reason reason,
+                            String message)
+                     throws TransportException
+
+
Description copied from interface: Connection
+
Send a SSH_MSG_OPEN_FAILURE for specified Reason and message. +

+

+
Specified by:
sendOpenFailure in interface Connection
+
+
+
Parameters:
recipient - number of the recipient channel
reason - a reason for the failure
message - an explanatory message +
Throws: +
TransportException - if there is a transport-layer error
+
+
+
+ +

+notifyError

+
+public void notifyError(SSHException error)
+
+
Description copied from interface: ErrorNotifiable
+
Notifies this object of an error. +

+

+
Specified by:
notifyError in interface ErrorNotifiable
Overrides:
notifyError in class AbstractService
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/AbstractChannel.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/AbstractChannel.html new file mode 100644 index 00000000..c49cc814 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/AbstractChannel.html @@ -0,0 +1,1187 @@ + + + + + + + +AbstractChannel (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel +
+Class AbstractChannel

+
+java.lang.Object
+  extended by net.schmizz.sshj.connection.channel.AbstractChannel
+
+
+
All Implemented Interfaces:
Closeable, ErrorNotifiable, SSHPacketHandler, Channel
+
+
+
Direct Known Subclasses:
AbstractDirectChannel, AbstractForwardedChannel
+
+
+
+
public abstract class AbstractChannel
extends Object
implements Channel
+ + +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.connection.channel.Channel
Channel.Direct, Channel.Forwarded
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable
ErrorNotifiable.Util
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+protected  Event<ConnectionException>close + +
+          Channel close event
+protected  Connectionconn + +
+          Connection layer
+protected  org.slf4j.Loggerlog + +
+          Logger
+protected  Window.Locallwin + +
+          Local window
+protected  Event<ConnectionException>open + +
+          Channel open event
+protected  Window.Remoterwin + +
+          Remote window
+protected  Transporttrans + +
+          Transport layer
+  + + + + + + + + + + + +
+Constructor Summary
+protected AbstractChannel(Connection conn, + String type) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclose() + +
+          Close this channel.
+protected  voidcloseAllStreams() + +
+          Called when all I/O streams should be closed.
+protected  voideofInputStreams() + +
+          Called when EOF has been received.
+protected  voidfinishOff() + +
+           
+ booleangetAutoExpand() + +
+           
+ intgetID() + +
+           
+ InputStreamgetInputStream() + +
+           
+ intgetLocalMaxPacketSize() + +
+           
+ intgetLocalWinSize() + +
+           
+ OutputStreamgetOutputStream() + +
+           
+ intgetRecipient() + +
+           
+ intgetRemoteMaxPacketSize() + +
+           
+ intgetRemoteWinSize() + +
+           
+ StringgetType() + +
+           
+protected  voidgotExtendedData(SSHPacket buf) + +
+           
+protected  voidgotUnknown(Message msg, + SSHPacket buf) + +
+           
+ voidhandle(Message msg, + SSHPacket buf) + +
+          Delegate handling of some SSH packet to this object.
+protected  voidhandleRequest(String reqType, + SSHPacket buf) + +
+           
+protected  voidinit(int recipient, + int remoteWinSize, + int remoteMaxPacketSize) + +
+           
+ booleanisOpen() + +
+           
+ voidjoin() + +
+           
+ voidjoin(int timeout, + TimeUnit unit) + +
+           
+protected  SSHPacketnewBuffer(Message cmd) + +
+           
+ voidnotifyError(SSHException error) + +
+          Notifies this object of an error.
+protected  voidreceiveInto(ChannelInputStream stream, + SSHPacket buf) + +
+           
+protected  Event<ConnectionException>sendChannelRequest(String reqType, + boolean wantReply, + Buffer.PlainBuffer reqSpecific) + +
+           
+protected  voidsendClose() + +
+           
+ voidsendEOF() + +
+          Sends an EOF message to the server for this channel; indicating that no more data will be sent by us.
+ voidsetAutoExpand(boolean autoExpand) + +
+          Set whether local window should automatically expand when data is received, irrespective of whether data has been + read from that stream.
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+protected final org.slf4j.Logger log
+
+
Logger +

+

+
+
+
+ +

+trans

+
+protected final Transport trans
+
+
Transport layer +

+

+
+
+
+ +

+conn

+
+protected final Connection conn
+
+
Connection layer +

+

+
+
+
+ +

+open

+
+protected final Event<ConnectionException> open
+
+
Channel open event +

+

+
+
+
+ +

+close

+
+protected final Event<ConnectionException> close
+
+
Channel close event +

+

+
+
+
+ +

+lwin

+
+protected final Window.Local lwin
+
+
Local window +

+

+
+
+
+ +

+rwin

+
+protected Window.Remote rwin
+
+
Remote window +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+AbstractChannel

+
+protected AbstractChannel(Connection conn,
+                          String type)
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+protected void init(int recipient,
+                    int remoteWinSize,
+                    int remoteMaxPacketSize)
+
+
+
+
+
+
+
+
+
+ +

+getAutoExpand

+
+public boolean getAutoExpand()
+
+
+
Specified by:
getAutoExpand in interface Channel
+
+
+ +
Returns:
whether auto-expansion of local window is set.
See Also:
Channel.setAutoExpand(boolean)
+
+
+
+ +

+getID

+
+public int getID()
+
+
+
Specified by:
getID in interface Channel
+
+
+ +
Returns:
the channel ID
+
+
+
+ +

+getInputStream

+
+public InputStream getInputStream()
+
+
+
Specified by:
getInputStream in interface Channel
+
+
+ +
Returns:
the InputStream for this channel.
+
+
+
+ +

+getLocalMaxPacketSize

+
+public int getLocalMaxPacketSize()
+
+
+
Specified by:
getLocalMaxPacketSize in interface Channel
+
+
+ +
Returns:
the maximum packet size that we have specified.
+
+
+
+ +

+getLocalWinSize

+
+public int getLocalWinSize()
+
+
+
Specified by:
getLocalWinSize in interface Channel
+
+
+ +
Returns:
the current local window size.
+
+
+
+ +

+getOutputStream

+
+public OutputStream getOutputStream()
+
+
+
Specified by:
getOutputStream in interface Channel
+
+
+ +
Returns:
an OutputStream for this channel.
+
+
+
+ +

+getRecipient

+
+public int getRecipient()
+
+
+
Specified by:
getRecipient in interface Channel
+
+
+ +
Returns:
the channel ID at the remote end.
+
+
+
+ +

+getRemoteMaxPacketSize

+
+public int getRemoteMaxPacketSize()
+
+
+
Specified by:
getRemoteMaxPacketSize in interface Channel
+
+
+ +
Returns:
the maximum packet size as specified by the remote end.
+
+
+
+ +

+getRemoteWinSize

+
+public int getRemoteWinSize()
+
+
+
Specified by:
getRemoteWinSize in interface Channel
+
+
+ +
Returns:
the current remote window size.
+
+
+
+ +

+getType

+
+public String getType()
+
+
+
Specified by:
getType in interface Channel
+
+
+ +
Returns:
the channel type identifier.
+
+
+
+ +

+handle

+
+public void handle(Message msg,
+                   SSHPacket buf)
+            throws ConnectionException,
+                   TransportException
+
+
Description copied from interface: SSHPacketHandler
+
Delegate handling of some SSH packet to this object. +

+

+
Specified by:
handle in interface SSHPacketHandler
+
+
+
Parameters:
msg - the SSH message identifier
buf - SSHPacket containing rest of the request +
Throws: +
ConnectionException +
TransportException
+
+
+
+ +

+closeAllStreams

+
+protected void closeAllStreams()
+
+
Called when all I/O streams should be closed. Subclasses can override but must call super. +

+

+
+
+
+
+
+
+
+ +

+notifyError

+
+public void notifyError(SSHException error)
+
+
Description copied from interface: ErrorNotifiable
+
Notifies this object of an error. +

+

+
Specified by:
notifyError in interface ErrorNotifiable
+
+
+
+
+
+
+ +

+setAutoExpand

+
+public void setAutoExpand(boolean autoExpand)
+
+
Description copied from interface: Channel
+
Set whether local window should automatically expand when data is received, irrespective of whether data has been + read from that stream. This is useful e.g. when a remote command produces a lot of output that would fill the + local window but you are not interested in reading from its InputStream. +

+

+
Specified by:
setAutoExpand in interface Channel
+
+
+
Parameters:
autoExpand - whether local windows should automatically expand
+
+
+
+ +

+close

+
+public void close()
+           throws ConnectionException,
+                  TransportException
+
+
Description copied from interface: Channel
+
Close this channel. +

+

+
Specified by:
close in interface Closeable
Specified by:
close in interface Channel
+
+
+ +
Throws: +
ConnectionException +
TransportException
+
+
+
+ +

+join

+
+public void join()
+          throws ConnectionException
+
+
+
Specified by:
join in interface Channel
+
+
+ +
Throws: +
ConnectionException
+
+
+
+ +

+join

+
+public void join(int timeout,
+                 TimeUnit unit)
+          throws ConnectionException
+
+
+
Specified by:
join in interface Channel
+
+
+ +
Throws: +
ConnectionException
+
+
+
+ +

+sendClose

+
+protected void sendClose()
+                  throws TransportException
+
+
+
+
+
+ +
Throws: +
TransportException
+
+
+
+ +

+isOpen

+
+public boolean isOpen()
+
+
+
Specified by:
isOpen in interface Channel
+
+
+ +
Returns:
whether the channel is open.
+
+
+
+ +

+finishOff

+
+protected void finishOff()
+
+
+
+
+
+
+
+
+
+ +

+gotExtendedData

+
+protected void gotExtendedData(SSHPacket buf)
+                        throws ConnectionException,
+                               TransportException
+
+
+
+
+
+ +
Throws: +
ConnectionException +
TransportException
+
+
+
+ +

+gotUnknown

+
+protected void gotUnknown(Message msg,
+                          SSHPacket buf)
+                   throws ConnectionException,
+                          TransportException
+
+
+
+
+
+ +
Throws: +
ConnectionException +
TransportException
+
+
+
+ +

+handleRequest

+
+protected void handleRequest(String reqType,
+                             SSHPacket buf)
+                      throws ConnectionException,
+                             TransportException
+
+
+
+
+
+ +
Throws: +
ConnectionException +
TransportException
+
+
+
+ +

+newBuffer

+
+protected SSHPacket newBuffer(Message cmd)
+
+
+
+
+
+
+
+
+
+ +

+receiveInto

+
+protected void receiveInto(ChannelInputStream stream,
+                           SSHPacket buf)
+                    throws ConnectionException,
+                           TransportException
+
+
+
+
+
+ +
Throws: +
ConnectionException +
TransportException
+
+
+
+ +

+sendChannelRequest

+
+protected Event<ConnectionException> sendChannelRequest(String reqType,
+                                                        boolean wantReply,
+                                                        Buffer.PlainBuffer reqSpecific)
+                                                 throws TransportException
+
+
+
+
+
+ +
Throws: +
TransportException
+
+
+
+ +

+eofInputStreams

+
+protected void eofInputStreams()
+
+
Called when EOF has been received. Subclasses can override but must call super. +

+

+
+
+
+
+
+
+
+ +

+sendEOF

+
+public void sendEOF()
+             throws TransportException
+
+
Description copied from interface: Channel
+
Sends an EOF message to the server for this channel; indicating that no more data will be sent by us. The OutputStream for this channel will be closed and no longer usable. +

+

+
Specified by:
sendEOF in interface Channel
+
+
+ +
Throws: +
TransportException - if there is an error sending the EOF message
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/Channel.Direct.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/Channel.Direct.html new file mode 100644 index 00000000..96c8a5c2 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/Channel.Direct.html @@ -0,0 +1,287 @@ + + + + + + + +Channel.Direct (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel +
+Interface Channel.Direct

+
+
All Superinterfaces:
Channel, Closeable, ErrorNotifiable, SSHPacketHandler
+
+
+
All Known Implementing Classes:
AbstractDirectChannel, SessionChannel
+
+
+
Enclosing interface:
Channel
+
+
+
+
public static interface Channel.Direct
extends Channel
+ + +

+Direct channels are those that are initiated by us. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.connection.channel.Channel
Channel.Direct, Channel.Forwarded
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable
ErrorNotifiable.Util
+  + + + + + + + + + + + + +
+Method Summary
+ voidopen() + +
+          Request opening this channel from remote end.
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.connection.channel.Channel
close, getAutoExpand, getID, getInputStream, getLocalMaxPacketSize, getLocalWinSize, getOutputStream, getRecipient, getRemoteMaxPacketSize, getRemoteWinSize, getType, isOpen, join, join, sendEOF, setAutoExpand
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.SSHPacketHandler
handle
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.ErrorNotifiable
notifyError
+  +

+ + + + + + + + +
+Method Detail
+ +

+open

+
+void open()
+          throws ConnectionException,
+                 TransportException
+
+
Request opening this channel from remote end. +

+

+
+
+
+ +
Throws: +
OpenFailException - in case the channel open request was rejected +
ConnectionException - other connection-layer error +
TransportException - error writing packets etc.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/Channel.Forwarded.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/Channel.Forwarded.html new file mode 100644 index 00000000..edc0253e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/Channel.Forwarded.html @@ -0,0 +1,359 @@ + + + + + + + +Channel.Forwarded (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel +
+Interface Channel.Forwarded

+
+
All Superinterfaces:
Channel, Closeable, ErrorNotifiable, SSHPacketHandler
+
+
+
All Known Implementing Classes:
AbstractForwardedChannel, RemotePortForwarder.ForwardedTCPIPChannel, X11Forwarder.X11Channel
+
+
+
Enclosing interface:
Channel
+
+
+
+
public static interface Channel.Forwarded
extends Channel
+ + +

+Forwarded channels are those that are initiated by the server. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.connection.channel.Channel
Channel.Direct, Channel.Forwarded
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable
ErrorNotifiable.Util
+  + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidconfirm() + +
+          Confirm CHANNEL_OPEN request.
+ StringgetOriginatorIP() + +
+           
+ intgetOriginatorPort() + +
+           
+ voidreject(OpenFailException.Reason reason, + String message) + +
+          Indicate rejection to remote end.
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.connection.channel.Channel
close, getAutoExpand, getID, getInputStream, getLocalMaxPacketSize, getLocalWinSize, getOutputStream, getRecipient, getRemoteMaxPacketSize, getRemoteWinSize, getType, isOpen, join, join, sendEOF, setAutoExpand
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.SSHPacketHandler
handle
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.ErrorNotifiable
notifyError
+  +

+ + + + + + + + +
+Method Detail
+ +

+confirm

+
+void confirm()
+             throws TransportException
+
+
Confirm CHANNEL_OPEN request. +

+

+
+
+
+ +
Throws: +
TransportException - error sending confirmation packet
+
+
+
+ +

+getOriginatorIP

+
+String getOriginatorIP()
+
+
+
+
+
+ +
Returns:
the IP of where the forwarded connection originates.
+
+
+
+ +

+getOriginatorPort

+
+int getOriginatorPort()
+
+
+
+
+
+ +
Returns:
port from which the forwarded connection originates.
+
+
+
+ +

+reject

+
+void reject(OpenFailException.Reason reason,
+            String message)
+            throws TransportException
+
+
Indicate rejection to remote end. +

+

+
+
+
+
Parameters:
reason - indicate reason for rejection of the request
message - indicate a message for why the request is rejected +
Throws: +
TransportException - error sending rejection packet
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/Channel.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/Channel.html new file mode 100644 index 00000000..70898bc1 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/Channel.html @@ -0,0 +1,642 @@ + + + + + + + +Channel (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel +
+Interface Channel

+
+
All Superinterfaces:
Closeable, ErrorNotifiable, SSHPacketHandler
+
+
+
All Known Subinterfaces:
Channel.Direct, Channel.Forwarded, Session, Session.Command, Session.Shell, Session.Subsystem
+
+
+
All Known Implementing Classes:
AbstractChannel, AbstractDirectChannel, AbstractForwardedChannel, RemotePortForwarder.ForwardedTCPIPChannel, SessionChannel, X11Forwarder.X11Channel
+
+
+
+
public interface Channel
extends Closeable, SSHPacketHandler, ErrorNotifiable
+ + +

+A channel is the basic medium for application-layer data on top of an SSH transport. +

+ +

+


+ +

+ + + + + + + + + + + + + + + +
+Nested Class Summary
+static interfaceChannel.Direct + +
+          Direct channels are those that are initiated by us.
+static interfaceChannel.Forwarded + +
+          Forwarded channels are those that are initiated by the server.
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable
ErrorNotifiable.Util
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclose() + +
+          Close this channel.
+ booleangetAutoExpand() + +
+           
+ intgetID() + +
+           
+ InputStreamgetInputStream() + +
+           
+ intgetLocalMaxPacketSize() + +
+           
+ intgetLocalWinSize() + +
+           
+ OutputStreamgetOutputStream() + +
+           
+ intgetRecipient() + +
+           
+ intgetRemoteMaxPacketSize() + +
+           
+ intgetRemoteWinSize() + +
+           
+ StringgetType() + +
+           
+ booleanisOpen() + +
+           
+ voidjoin() + +
+           
+ voidjoin(int timeout, + TimeUnit unit) + +
+           
+ voidsendEOF() + +
+          Sends an EOF message to the server for this channel; indicating that no more data will be sent by us.
+ voidsetAutoExpand(boolean autoExpand) + +
+          Set whether local window should automatically expand when data is received, irrespective of whether data has been + read from that stream.
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.SSHPacketHandler
handle
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.ErrorNotifiable
notifyError
+  +

+ + + + + + + + +
+Method Detail
+ +

+close

+
+void close()
+           throws TransportException,
+                  ConnectionException
+
+
Close this channel. +

+

+
Specified by:
close in interface Closeable
+
+
+ +
Throws: +
TransportException +
ConnectionException
+
+
+
+ +

+getAutoExpand

+
+boolean getAutoExpand()
+
+
+
+
+
+ +
Returns:
whether auto-expansion of local window is set.
See Also:
setAutoExpand(boolean)
+
+
+
+ +

+getID

+
+int getID()
+
+
+
+
+
+ +
Returns:
the channel ID
+
+
+
+ +

+getInputStream

+
+InputStream getInputStream()
+
+
+
+
+
+ +
Returns:
the InputStream for this channel.
+
+
+
+ +

+getLocalMaxPacketSize

+
+int getLocalMaxPacketSize()
+
+
+
+
+
+ +
Returns:
the maximum packet size that we have specified.
+
+
+
+ +

+getLocalWinSize

+
+int getLocalWinSize()
+
+
+
+
+
+ +
Returns:
the current local window size.
+
+
+
+ +

+getOutputStream

+
+OutputStream getOutputStream()
+
+
+
+
+
+ +
Returns:
an OutputStream for this channel.
+
+
+
+ +

+getRecipient

+
+int getRecipient()
+
+
+
+
+
+ +
Returns:
the channel ID at the remote end.
+
+
+
+ +

+getRemoteMaxPacketSize

+
+int getRemoteMaxPacketSize()
+
+
+
+
+
+ +
Returns:
the maximum packet size as specified by the remote end.
+
+
+
+ +

+getRemoteWinSize

+
+int getRemoteWinSize()
+
+
+
+
+
+ +
Returns:
the current remote window size.
+
+
+
+ +

+getType

+
+String getType()
+
+
+
+
+
+ +
Returns:
the channel type identifier.
+
+
+
+ +

+isOpen

+
+boolean isOpen()
+
+
+
+
+
+ +
Returns:
whether the channel is open.
+
+
+
+ +

+sendEOF

+
+void sendEOF()
+             throws TransportException
+
+
Sends an EOF message to the server for this channel; indicating that no more data will be sent by us. The OutputStream for this channel will be closed and no longer usable. +

+

+
+
+
+ +
Throws: +
TransportException - if there is an error sending the EOF message
+
+
+
+ +

+setAutoExpand

+
+void setAutoExpand(boolean autoExpand)
+
+
Set whether local window should automatically expand when data is received, irrespective of whether data has been + read from that stream. This is useful e.g. when a remote command produces a lot of output that would fill the + local window but you are not interested in reading from its InputStream. +

+

+
+
+
+
Parameters:
autoExpand - whether local windows should automatically expand
+
+
+
+ +

+join

+
+void join()
+          throws ConnectionException
+
+
+
+
+
+ +
Throws: +
ConnectionException
+
+
+
+ +

+join

+
+void join(int timeout,
+          TimeUnit unit)
+          throws ConnectionException
+
+
+
+
+
+ +
Throws: +
ConnectionException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/ChannelInputStream.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/ChannelInputStream.html new file mode 100644 index 00000000..bdba8fc2 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/ChannelInputStream.html @@ -0,0 +1,473 @@ + + + + + + + +ChannelInputStream (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel +
+Class ChannelInputStream

+
+java.lang.Object
+  extended by java.io.InputStream
+      extended by net.schmizz.sshj.connection.channel.ChannelInputStream
+
+
+
All Implemented Interfaces:
Closeable, ErrorNotifiable
+
+
+
+
public final class ChannelInputStream
extends InputStream
implements ErrorNotifiable
+ + +

+InputStream for channels. Can receive data into its buffer for serving to + readers. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable
ErrorNotifiable.Util
+  + + + + + + + + + + + +
+Constructor Summary
ChannelInputStream(Channel chan, + Transport trans, + Window.Local win) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intavailable() + +
+           
+ voidclose() + +
+           
+ voideof() + +
+           
+ voidnotifyError(SSHException error) + +
+          Notifies this object of an error.
+ intread() + +
+           
+ intread(byte[] b, + int off, + int len) + +
+           
+ voidreceive(byte[] data, + int offset, + int len) + +
+           
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.io.InputStream
mark, markSupported, read, reset, skip
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ChannelInputStream

+
+public ChannelInputStream(Channel chan,
+                          Transport trans,
+                          Window.Local win)
+
+
+ + + + + + + + +
+Method Detail
+ +

+available

+
+public int available()
+
+
+
Overrides:
available in class InputStream
+
+
+
+
+
+
+ +

+close

+
+public void close()
+
+
+
Specified by:
close in interface Closeable
Overrides:
close in class InputStream
+
+
+
+
+
+
+ +

+eof

+
+public void eof()
+
+
+
+
+
+
+
+
+
+ +

+notifyError

+
+public void notifyError(SSHException error)
+
+
Description copied from interface: ErrorNotifiable
+
Notifies this object of an error. +

+

+
Specified by:
notifyError in interface ErrorNotifiable
+
+
+
+
+
+
+ +

+read

+
+public int read()
+         throws IOException
+
+
+
Specified by:
read in class InputStream
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+read

+
+public int read(byte[] b,
+                int off,
+                int len)
+         throws IOException
+
+
+
Overrides:
read in class InputStream
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+receive

+
+public void receive(byte[] data,
+                    int offset,
+                    int len)
+             throws ConnectionException,
+                    TransportException
+
+
+
+
+
+ +
Throws: +
ConnectionException +
TransportException
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/ChannelOutputStream.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/ChannelOutputStream.html new file mode 100644 index 00000000..56923ddc --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/ChannelOutputStream.html @@ -0,0 +1,448 @@ + + + + + + + +ChannelOutputStream (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel +
+Class ChannelOutputStream

+
+java.lang.Object
+  extended by java.io.OutputStream
+      extended by net.schmizz.sshj.connection.channel.ChannelOutputStream
+
+
+
All Implemented Interfaces:
Closeable, Flushable, ErrorNotifiable
+
+
+
+
public final class ChannelOutputStream
extends OutputStream
implements ErrorNotifiable
+ + +

+OutputStream for channels. Buffers data upto the remote window's maximum packet size. Data can also be + flushed via flush() and is also flushed on close(). +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable
ErrorNotifiable.Util
+  + + + + + + + + + + + +
+Constructor Summary
ChannelOutputStream(Channel chan, + Transport trans, + Window.Remote win) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclose() + +
+           
+ voidflush() + +
+           
+ voidnotifyError(SSHException error) + +
+          Notifies this object of an error.
+ voidsetClosed() + +
+           
+ StringtoString() + +
+           
+ voidwrite(byte[] data, + int off, + int len) + +
+           
+ voidwrite(int w) + +
+           
+ + + + + + + +
Methods inherited from class java.io.OutputStream
write
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ChannelOutputStream

+
+public ChannelOutputStream(Channel chan,
+                           Transport trans,
+                           Window.Remote win)
+
+
+ + + + + + + + +
+Method Detail
+ +

+write

+
+public void write(int w)
+           throws IOException
+
+
+
Specified by:
write in class OutputStream
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+write

+
+public void write(byte[] data,
+                  int off,
+                  int len)
+           throws IOException
+
+
+
Overrides:
write in class OutputStream
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+notifyError

+
+public void notifyError(SSHException error)
+
+
Description copied from interface: ErrorNotifiable
+
Notifies this object of an error. +

+

+
Specified by:
notifyError in interface ErrorNotifiable
+
+
+
+
+
+
+ +

+close

+
+public void close()
+           throws IOException
+
+
+
Specified by:
close in interface Closeable
Overrides:
close in class OutputStream
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+setClosed

+
+public void setClosed()
+
+
+
+
+
+
+
+
+
+ +

+flush

+
+public void flush()
+           throws IOException
+
+
+
Specified by:
flush in interface Flushable
Overrides:
flush in class OutputStream
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/OpenFailException.Reason.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/OpenFailException.Reason.html new file mode 100644 index 00000000..4cd75c80 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/OpenFailException.Reason.html @@ -0,0 +1,412 @@ + + + + + + + +OpenFailException.Reason (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel +
+Enum OpenFailException.Reason

+
+java.lang.Object
+  extended by java.lang.Enum<OpenFailException.Reason>
+      extended by net.schmizz.sshj.connection.channel.OpenFailException.Reason
+
+
+
All Implemented Interfaces:
Serializable, Comparable<OpenFailException.Reason>
+
+
+
Enclosing class:
OpenFailException
+
+
+
+
public static enum OpenFailException.Reason
extends Enum<OpenFailException.Reason>
+ + +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
ADMINISTRATIVELY_PROHIBITED + +
+           
CONNECT_FAILED + +
+           
RESOURCE_SHORTAGE + +
+           
UNKNOWN + +
+           
UNKNOWN_CHANNEL_TYPE + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static OpenFailException.ReasonfromInt(int code) + +
+           
+ intgetCode() + +
+           
+static OpenFailException.ReasonvalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static OpenFailException.Reason[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+UNKNOWN

+
+public static final OpenFailException.Reason UNKNOWN
+
+
+
+
+
+ +

+ADMINISTRATIVELY_PROHIBITED

+
+public static final OpenFailException.Reason ADMINISTRATIVELY_PROHIBITED
+
+
+
+
+
+ +

+CONNECT_FAILED

+
+public static final OpenFailException.Reason CONNECT_FAILED
+
+
+
+
+
+ +

+UNKNOWN_CHANNEL_TYPE

+
+public static final OpenFailException.Reason UNKNOWN_CHANNEL_TYPE
+
+
+
+
+
+ +

+RESOURCE_SHORTAGE

+
+public static final OpenFailException.Reason RESOURCE_SHORTAGE
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static OpenFailException.Reason[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (OpenFailException.Reason c : OpenFailException.Reason.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static OpenFailException.Reason valueOf(String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+
+
+ +

+fromInt

+
+public static OpenFailException.Reason fromInt(int code)
+
+
+
+
+
+
+ +

+getCode

+
+public int getCode()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/OpenFailException.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/OpenFailException.html new file mode 100644 index 00000000..1c276091 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/OpenFailException.html @@ -0,0 +1,401 @@ + + + + + + + +OpenFailException (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel +
+Class OpenFailException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by net.schmizz.sshj.common.SSHException
+                  extended by net.schmizz.sshj.connection.ConnectionException
+                      extended by net.schmizz.sshj.connection.channel.OpenFailException
+
+
+
All Implemented Interfaces:
Serializable
+
+
+
+
public class OpenFailException
extends ConnectionException
+ + +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classOpenFailException.Reason + +
+           
+ + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.connection.ConnectionException
chainer
+  + + + + + + + + + + + + + +
+Constructor Summary
OpenFailException(String channelType, + int reasonCode, + String message) + +
+           
OpenFailException(String channelType, + OpenFailException.Reason reason, + String message) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StringgetChannelType() + +
+           
+ StringgetMessage() + +
+           
+ OpenFailException.ReasongetReason() + +
+           
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.common.SSHException
getDisconnectReason
+ + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+OpenFailException

+
+public OpenFailException(String channelType,
+                         int reasonCode,
+                         String message)
+
+
+
+ +

+OpenFailException

+
+public OpenFailException(String channelType,
+                         OpenFailException.Reason reason,
+                         String message)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getChannelType

+
+public String getChannelType()
+
+
+
+
+
+
+ +

+getMessage

+
+public String getMessage()
+
+
+
Overrides:
getMessage in class SSHException
+
+
+
+
+
+
+ +

+getReason

+
+public OpenFailException.Reason getReason()
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class SSHException
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/SocketStreamCopyMonitor.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/SocketStreamCopyMonitor.html new file mode 100644 index 00000000..e7739a7f --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/SocketStreamCopyMonitor.html @@ -0,0 +1,280 @@ + + + + + + + +SocketStreamCopyMonitor (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel +
+Class SocketStreamCopyMonitor

+
+java.lang.Object
+  extended by java.lang.Thread
+      extended by net.schmizz.sshj.connection.channel.SocketStreamCopyMonitor
+
+
+
All Implemented Interfaces:
Runnable
+
+
+
+
public class SocketStreamCopyMonitor
extends Thread
+ + +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class java.lang.Thread
Thread.State, Thread.UncaughtExceptionHandler
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
+  + + + + + + + + + + + +
+Method Summary
+static voidmonitor(int frequency, + TimeUnit unit, + Event<IOException> x, + Event<IOException> y, + Channel channel, + Socket socket) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Thread
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, run, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
+ + + + + + + +
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Method Detail
+ +

+monitor

+
+public static void monitor(int frequency,
+                           TimeUnit unit,
+                           Event<IOException> x,
+                           Event<IOException> y,
+                           Channel channel,
+                           Socket socket)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/Window.Local.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/Window.Local.html new file mode 100644 index 00000000..320f64ce --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/Window.Local.html @@ -0,0 +1,309 @@ + + + + + + + +Window.Local (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel +
+Class Window.Local

+
+java.lang.Object
+  extended by net.schmizz.sshj.connection.channel.Window
+      extended by net.schmizz.sshj.connection.channel.Window.Local
+
+
+
Enclosing class:
Window
+
+
+
+
public static final class Window.Local
extends Window
+ + +

+Controls how much data remote end can send before an adjustment notification from us is required. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class net.schmizz.sshj.connection.channel.Window
Window.Local, Window.Remote
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.connection.channel.Window
lock, log, maxPacketSize, size
+  + + + + + + + + + + +
+Constructor Summary
Window.Local(int initialWinSize, + int maxPacketSize) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ intneededAdjustment() + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.connection.channel.Window
consume, expand, getMaxPacketSize, getSize, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Window.Local

+
+public Window.Local(int initialWinSize,
+                    int maxPacketSize)
+
+
+ + + + + + + + +
+Method Detail
+ +

+neededAdjustment

+
+public int neededAdjustment()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/Window.Remote.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/Window.Remote.html new file mode 100644 index 00000000..c8b72d66 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/Window.Remote.html @@ -0,0 +1,312 @@ + + + + + + + +Window.Remote (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel +
+Class Window.Remote

+
+java.lang.Object
+  extended by net.schmizz.sshj.connection.channel.Window
+      extended by net.schmizz.sshj.connection.channel.Window.Remote
+
+
+
Enclosing class:
Window
+
+
+
+
public static final class Window.Remote
extends Window
+ + +

+Controls how much data we can send before an adjustment notification from remote end is required. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class net.schmizz.sshj.connection.channel.Window
Window.Local, Window.Remote
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.connection.channel.Window
lock, log, maxPacketSize, size
+  + + + + + + + + + + +
+Constructor Summary
Window.Remote(int initialWinSize, + int maxPacketSize) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidwaitAndConsume(int howMuch) + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.connection.channel.Window
consume, expand, getMaxPacketSize, getSize, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Window.Remote

+
+public Window.Remote(int initialWinSize,
+                     int maxPacketSize)
+
+
+ + + + + + + + +
+Method Detail
+ +

+waitAndConsume

+
+public void waitAndConsume(int howMuch)
+                    throws ConnectionException
+
+
+ +
Throws: +
ConnectionException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/Window.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/Window.html new file mode 100644 index 00000000..ef358fe9 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/Window.html @@ -0,0 +1,452 @@ + + + + + + + +Window (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel +
+Class Window

+
+java.lang.Object
+  extended by net.schmizz.sshj.connection.channel.Window
+
+
+
Direct Known Subclasses:
Window.Local, Window.Remote
+
+
+
+
public abstract class Window
extends Object
+ + +

+


+ +

+ + + + + + + + + + + + + + + +
+Nested Class Summary
+static classWindow.Local + +
+          Controls how much data remote end can send before an adjustment notification from us is required.
+static classWindow.Remote + +
+          Controls how much data we can send before an adjustment notification from remote end is required.
+ + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+protected  Objectlock + +
+           
+protected  org.slf4j.Loggerlog + +
+           
+protected  intmaxPacketSize + +
+           
+protected  intsize + +
+           
+  + + + + + + + + + + +
+Constructor Summary
Window(int initialWinSize, + int maxPacketSize) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidconsume(int dec) + +
+           
+ voidexpand(int inc) + +
+           
+ intgetMaxPacketSize() + +
+           
+ intgetSize() + +
+           
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+protected final org.slf4j.Logger log
+
+
+
+
+
+ +

+lock

+
+protected final Object lock
+
+
+
+
+
+ +

+maxPacketSize

+
+protected final int maxPacketSize
+
+
+
+
+
+ +

+size

+
+protected int size
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Window

+
+public Window(int initialWinSize,
+              int maxPacketSize)
+
+
+ + + + + + + + +
+Method Detail
+ +

+expand

+
+public void expand(int inc)
+
+
+
+
+
+
+ +

+getMaxPacketSize

+
+public int getMaxPacketSize()
+
+
+
+
+
+
+ +

+getSize

+
+public int getSize()
+
+
+
+
+
+
+ +

+consume

+
+public void consume(int dec)
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/AbstractChannel.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/AbstractChannel.html new file mode 100644 index 00000000..69c949b6 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/AbstractChannel.html @@ -0,0 +1,234 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.AbstractChannel (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.AbstractChannel

+
+ + + + + + + + + + + + + +
+Packages that use AbstractChannel
net.schmizz.sshj.connection.channel.direct  
net.schmizz.sshj.connection.channel.forwarded  
+  +

+ + + + + +
+Uses of AbstractChannel in net.schmizz.sshj.connection.channel.direct
+  +

+ + + + + + + + + + + + + +
Subclasses of AbstractChannel in net.schmizz.sshj.connection.channel.direct
+ classAbstractDirectChannel + +
+          Base class for direct channels whose open is initated by the client.
+ classSessionChannel + +
+          Session implementation.
+  +

+ + + + + +
+Uses of AbstractChannel in net.schmizz.sshj.connection.channel.forwarded
+  +

+ + + + + + + + + + + + + + + + + +
Subclasses of AbstractChannel in net.schmizz.sshj.connection.channel.forwarded
+ classAbstractForwardedChannel + +
+          Base class for forwarded channels whose open is initiated by the server.
+static classRemotePortForwarder.ForwardedTCPIPChannel + +
+          A forwarded-tcpip channel.
+static classX11Forwarder.X11Channel + +
+          An x11 forwarded channel.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/Channel.Direct.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/Channel.Direct.html new file mode 100644 index 00000000..e50fced9 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/Channel.Direct.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.connection.channel.Channel.Direct (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.connection.channel.Channel.Direct

+
+ + + + + + + + + +
+Packages that use Channel.Direct
net.schmizz.sshj.connection.channel.direct  
+  +

+ + + + + +
+Uses of Channel.Direct in net.schmizz.sshj.connection.channel.direct
+  +

+ + + + + + + + + + + + + +
Classes in net.schmizz.sshj.connection.channel.direct that implement Channel.Direct
+ classAbstractDirectChannel + +
+          Base class for direct channels whose open is initated by the client.
+ classSessionChannel + +
+          Session implementation.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/Channel.Forwarded.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/Channel.Forwarded.html new file mode 100644 index 00000000..38a2cfc7 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/Channel.Forwarded.html @@ -0,0 +1,230 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.connection.channel.Channel.Forwarded (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.connection.channel.Channel.Forwarded

+
+ + + + + + + + + +
+Packages that use Channel.Forwarded
net.schmizz.sshj.connection.channel.forwarded  
+  +

+ + + + + +
+Uses of Channel.Forwarded in net.schmizz.sshj.connection.channel.forwarded
+  +

+ + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.connection.channel.forwarded that implement Channel.Forwarded
+ classAbstractForwardedChannel + +
+          Base class for forwarded channels whose open is initiated by the server.
+static classRemotePortForwarder.ForwardedTCPIPChannel + +
+          A forwarded-tcpip channel.
+static classX11Forwarder.X11Channel + +
+          An x11 forwarded channel.
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.forwarded with parameters of type Channel.Forwarded
+protected  voidAbstractForwardedChannelOpener.callListener(ConnectListener listener, + Channel.Forwarded chan) + +
+          Calls the listener with the new channel in a separate thread.
+ voidSocketForwardingConnectListener.gotConnect(Channel.Forwarded chan) + +
+          On connect, confirm the channel and start forwarding.
+ voidConnectListener.gotConnect(Channel.Forwarded chan) + +
+          Notify this listener of a new forwarded channel.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/Channel.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/Channel.html new file mode 100644 index 00000000..ce7af752 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/Channel.html @@ -0,0 +1,449 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.connection.channel.Channel (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.connection.channel.Channel

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use Channel
net.schmizz.sshj.connection  
net.schmizz.sshj.connection.channel  
net.schmizz.sshj.connection.channel.direct  
net.schmizz.sshj.connection.channel.forwarded  
+  +

+ + + + + +
+Uses of Channel in net.schmizz.sshj.connection
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection that return Channel
+ ChannelConnectionImpl.get(int id) + +
+           
+ ChannelConnection.get(int id) + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection with parameters of type Channel
+ voidConnectionImpl.attach(Channel chan) + +
+           
+ voidConnection.attach(Channel chan) + +
+          Attach a Channel to this connection.
+ voidConnectionImpl.forget(Channel chan) + +
+           
+ voidConnection.forget(Channel chan) + +
+          Forget an attached Channel.
+  +

+ + + + + +
+Uses of Channel in net.schmizz.sshj.connection.channel
+  +

+ + + + + + + + + + + + + +
Subinterfaces of Channel in net.schmizz.sshj.connection.channel
+static interfaceChannel.Direct + +
+          Direct channels are those that are initiated by us.
+static interfaceChannel.Forwarded + +
+          Forwarded channels are those that are initiated by the server.
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.connection.channel that implement Channel
+ classAbstractChannel + +
+           
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel with parameters of type Channel
+static voidSocketStreamCopyMonitor.monitor(int frequency, + TimeUnit unit, + Event<IOException> x, + Event<IOException> y, + Channel channel, + Socket socket) + +
+           
+  +

+ + + + + + + + + + + +
Constructors in net.schmizz.sshj.connection.channel with parameters of type Channel
ChannelInputStream(Channel chan, + Transport trans, + Window.Local win) + +
+           
ChannelOutputStream(Channel chan, + Transport trans, + Window.Remote win) + +
+           
+  +

+ + + + + +
+Uses of Channel in net.schmizz.sshj.connection.channel.direct
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Subinterfaces of Channel in net.schmizz.sshj.connection.channel.direct
+ interfaceSession + +
+          A session channel provides for execution of a remote command, shell or subsystem.
+static interfaceSession.Command + +
+          Command API.
+static interfaceSession.Shell + +
+          Shell API.
+static interfaceSession.Subsystem + +
+          Subsystem API.
+  +

+ + + + + + + + + + + + + +
Classes in net.schmizz.sshj.connection.channel.direct that implement Channel
+ classAbstractDirectChannel + +
+          Base class for direct channels whose open is initated by the client.
+ classSessionChannel + +
+          Session implementation.
+  +

+ + + + + +
+Uses of Channel in net.schmizz.sshj.connection.channel.forwarded
+  +

+ + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.connection.channel.forwarded that implement Channel
+ classAbstractForwardedChannel + +
+          Base class for forwarded channels whose open is initiated by the server.
+static classRemotePortForwarder.ForwardedTCPIPChannel + +
+          A forwarded-tcpip channel.
+static classX11Forwarder.X11Channel + +
+          An x11 forwarded channel.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/ChannelInputStream.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/ChannelInputStream.html new file mode 100644 index 00000000..82e03ad9 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/ChannelInputStream.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.ChannelInputStream (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.ChannelInputStream

+
+ + + + + + + + + +
+Packages that use ChannelInputStream
net.schmizz.sshj.connection.channel  
+  +

+ + + + + +
+Uses of ChannelInputStream in net.schmizz.sshj.connection.channel
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel with parameters of type ChannelInputStream
+protected  voidAbstractChannel.receiveInto(ChannelInputStream stream, + SSHPacket buf) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/ChannelOutputStream.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/ChannelOutputStream.html new file mode 100644 index 00000000..5ebe20d5 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/ChannelOutputStream.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.ChannelOutputStream (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.ChannelOutputStream

+
+No usage of net.schmizz.sshj.connection.channel.ChannelOutputStream +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/OpenFailException.Reason.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/OpenFailException.Reason.html new file mode 100644 index 00000000..dcbfd169 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/OpenFailException.Reason.html @@ -0,0 +1,310 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.OpenFailException.Reason (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.OpenFailException.Reason

+
+ + + + + + + + + + + + + + + + + +
+Packages that use OpenFailException.Reason
net.schmizz.sshj.connection  
net.schmizz.sshj.connection.channel  
net.schmizz.sshj.connection.channel.forwarded  
+  +

+ + + + + +
+Uses of OpenFailException.Reason in net.schmizz.sshj.connection
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection with parameters of type OpenFailException.Reason
+ voidConnectionImpl.sendOpenFailure(int recipient, + OpenFailException.Reason reason, + String message) + +
+           
+ voidConnection.sendOpenFailure(int recipient, + OpenFailException.Reason reason, + String message) + +
+          Send a SSH_MSG_OPEN_FAILURE for specified Reason and message.
+  +

+ + + + + +
+Uses of OpenFailException.Reason in net.schmizz.sshj.connection.channel
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel that return OpenFailException.Reason
+static OpenFailException.ReasonOpenFailException.Reason.fromInt(int code) + +
+           
+ OpenFailException.ReasonOpenFailException.getReason() + +
+           
+static OpenFailException.ReasonOpenFailException.Reason.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static OpenFailException.Reason[]OpenFailException.Reason.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel with parameters of type OpenFailException.Reason
+ voidChannel.Forwarded.reject(OpenFailException.Reason reason, + String message) + +
+          Indicate rejection to remote end.
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.connection.channel with parameters of type OpenFailException.Reason
OpenFailException(String channelType, + OpenFailException.Reason reason, + String message) + +
+           
+  +

+ + + + + +
+Uses of OpenFailException.Reason in net.schmizz.sshj.connection.channel.forwarded
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.forwarded with parameters of type OpenFailException.Reason
+ voidAbstractForwardedChannel.reject(OpenFailException.Reason reason, + String message) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/OpenFailException.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/OpenFailException.html new file mode 100644 index 00000000..3cca2ba8 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/OpenFailException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.OpenFailException (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.OpenFailException

+
+No usage of net.schmizz.sshj.connection.channel.OpenFailException +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/SocketStreamCopyMonitor.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/SocketStreamCopyMonitor.html new file mode 100644 index 00000000..632d1200 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/SocketStreamCopyMonitor.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.SocketStreamCopyMonitor (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.SocketStreamCopyMonitor

+
+No usage of net.schmizz.sshj.connection.channel.SocketStreamCopyMonitor +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/Window.Local.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/Window.Local.html new file mode 100644 index 00000000..c81d59b5 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/Window.Local.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.Window.Local (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.Window.Local

+
+ + + + + + + + + +
+Packages that use Window.Local
net.schmizz.sshj.connection.channel  
+  +

+ + + + + +
+Uses of Window.Local in net.schmizz.sshj.connection.channel
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.connection.channel declared as Window.Local
+protected  Window.LocalAbstractChannel.lwin + +
+          Local window
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.connection.channel with parameters of type Window.Local
ChannelInputStream(Channel chan, + Transport trans, + Window.Local win) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/Window.Remote.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/Window.Remote.html new file mode 100644 index 00000000..5bc21fdb --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/Window.Remote.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.Window.Remote (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.Window.Remote

+
+ + + + + + + + + +
+Packages that use Window.Remote
net.schmizz.sshj.connection.channel  
+  +

+ + + + + +
+Uses of Window.Remote in net.schmizz.sshj.connection.channel
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.connection.channel declared as Window.Remote
+protected  Window.RemoteAbstractChannel.rwin + +
+          Remote window
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.connection.channel with parameters of type Window.Remote
ChannelOutputStream(Channel chan, + Transport trans, + Window.Remote win) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/Window.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/Window.html new file mode 100644 index 00000000..f90a482b --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/class-use/Window.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.Window (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.Window

+
+ + + + + + + + + +
+Packages that use Window
net.schmizz.sshj.connection.channel  
+  +

+ + + + + +
+Uses of Window in net.schmizz.sshj.connection.channel
+  +

+ + + + + + + + + + + + + +
Subclasses of Window in net.schmizz.sshj.connection.channel
+static classWindow.Local + +
+          Controls how much data remote end can send before an adjustment notification from us is required.
+static classWindow.Remote + +
+          Controls how much data we can send before an adjustment notification from remote end is required.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/AbstractDirectChannel.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/AbstractDirectChannel.html new file mode 100644 index 00000000..033467b4 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/AbstractDirectChannel.html @@ -0,0 +1,414 @@ + + + + + + + +AbstractDirectChannel (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.direct +
+Class AbstractDirectChannel

+
+java.lang.Object
+  extended by net.schmizz.sshj.connection.channel.AbstractChannel
+      extended by net.schmizz.sshj.connection.channel.direct.AbstractDirectChannel
+
+
+
All Implemented Interfaces:
Closeable, ErrorNotifiable, SSHPacketHandler, Channel, Channel.Direct
+
+
+
Direct Known Subclasses:
SessionChannel
+
+
+
+
public abstract class AbstractDirectChannel
extends AbstractChannel
implements Channel.Direct
+ + +

+Base class for direct channels whose open is initated by the client. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.connection.channel.Channel
Channel.Direct, Channel.Forwarded
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable
ErrorNotifiable.Util
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.connection.channel.AbstractChannel
close, conn, log, lwin, open, rwin, trans
+  + + + + + + + + + + + +
+Constructor Summary
+protected AbstractDirectChannel(Connection conn, + String type) + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+protected  SSHPacketbuildOpenReq() + +
+           
+protected  voidgotUnknown(Message cmd, + SSHPacket buf) + +
+           
+ voidopen() + +
+          Request opening this channel from remote end.
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.connection.channel.AbstractChannel
close, closeAllStreams, eofInputStreams, finishOff, getAutoExpand, getID, getInputStream, getLocalMaxPacketSize, getLocalWinSize, getOutputStream, getRecipient, getRemoteMaxPacketSize, getRemoteWinSize, getType, gotExtendedData, handle, handleRequest, init, isOpen, join, join, newBuffer, notifyError, receiveInto, sendChannelRequest, sendClose, sendEOF, setAutoExpand, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.connection.channel.Channel
close, getAutoExpand, getID, getInputStream, getLocalMaxPacketSize, getLocalWinSize, getOutputStream, getRecipient, getRemoteMaxPacketSize, getRemoteWinSize, getType, isOpen, join, join, sendEOF, setAutoExpand
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.SSHPacketHandler
handle
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.ErrorNotifiable
notifyError
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AbstractDirectChannel

+
+protected AbstractDirectChannel(Connection conn,
+                                String type)
+
+
+ + + + + + + + +
+Method Detail
+ +

+open

+
+public void open()
+          throws ConnectionException,
+                 TransportException
+
+
Description copied from interface: Channel.Direct
+
Request opening this channel from remote end. +

+

+
Specified by:
open in interface Channel.Direct
+
+
+ +
Throws: +
OpenFailException - in case the channel open request was rejected +
ConnectionException - other connection-layer error +
TransportException - error writing packets etc.
+
+
+
+ +

+buildOpenReq

+
+protected SSHPacket buildOpenReq()
+
+
+
+
+
+
+
+
+
+ +

+gotUnknown

+
+protected void gotUnknown(Message cmd,
+                          SSHPacket buf)
+                   throws ConnectionException,
+                          TransportException
+
+
+
Overrides:
gotUnknown in class AbstractChannel
+
+
+ +
Throws: +
ConnectionException +
TransportException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/LocalPortForwarder.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/LocalPortForwarder.html new file mode 100644 index 00000000..592bdfe6 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/LocalPortForwarder.html @@ -0,0 +1,324 @@ + + + + + + + +LocalPortForwarder (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.direct +
+Class LocalPortForwarder

+
+java.lang.Object
+  extended by net.schmizz.sshj.connection.channel.direct.LocalPortForwarder
+
+
+
+
public class LocalPortForwarder
extends Object
+ + +

+


+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
LocalPortForwarder(Connection conn, + SocketAddress listeningAddr, + String host, + int port) + +
+          Create a local port forwarder with specified binding (listeningAddr.
LocalPortForwarder(ServerSocketFactory ssf, + Connection conn, + SocketAddress listeningAddr, + String host, + int port) + +
+          Create a local port forwarder with specified binding (listeningAddr.
+  + + + + + + + + + + + + + + + +
+Method Summary
+ SocketAddressgetListeningAddress() + +
+           
+ voidlisten() + +
+          Start listening for incoming connections and forward to remote host as a channel.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+LocalPortForwarder

+
+public LocalPortForwarder(Connection conn,
+                          SocketAddress listeningAddr,
+                          String host,
+                          int port)
+                   throws IOException
+
+
Create a local port forwarder with specified binding (listeningAddr. It does not, however, start + listening unless explicitly told to. The default server socket factory is used. +

+

+
Parameters:
conn - Connection implementation
listeningAddr - SocketAddress this forwarder will listen on, if null then an ephemeral port + and valid local address will be picked to bind the server socket
host - what host the SSH server will further forward to
port - port on toHost +
Throws: +
IOException - if there is an error binding on specified listeningAddr
+
+
+ +

+LocalPortForwarder

+
+public LocalPortForwarder(ServerSocketFactory ssf,
+                          Connection conn,
+                          SocketAddress listeningAddr,
+                          String host,
+                          int port)
+                   throws IOException
+
+
Create a local port forwarder with specified binding (listeningAddr. It does not, however, start + listening unless explicitly told to. +

+

+
Parameters:
ssf - factory to use for creating the server socket
conn - Connection implementation
listeningAddr - SocketAddress this forwarder will listen on, if null then an ephemeral port + and valid local address will be picked to bind the server socket
host - what host the SSH server will further forward to
port - port on toHost +
Throws: +
IOException - if there is an error binding on specified listeningAddr
+
+ + + + + + + + +
+Method Detail
+ +

+getListeningAddress

+
+public SocketAddress getListeningAddress()
+
+
+ +
Returns:
the address to which this forwarder is bound for listening
+
+
+
+ +

+listen

+
+public void listen()
+            throws IOException
+
+
Start listening for incoming connections and forward to remote host as a channel. +

+

+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/PTYMode.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/PTYMode.html new file mode 100644 index 00000000..6d181504 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/PTYMode.html @@ -0,0 +1,1324 @@ + + + + + + + +PTYMode (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.direct +
+Enum PTYMode

+
+java.lang.Object
+  extended by java.lang.Enum<PTYMode>
+      extended by net.schmizz.sshj.connection.channel.direct.PTYMode
+
+
+
All Implemented Interfaces:
Serializable, Comparable<PTYMode>
+
+
+
+
public enum PTYMode
extends Enum<PTYMode>
+ + +

+Various modes for a psuedo-terminal. They are meant to have integer parameters. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
CS7 + +
+          7 bit mode.
CS8 + +
+          8 bit mode.
ECHO + +
+          Enable echoing.
ECHOCTL + +
+          Echo control characters as ˆ(Char).
ECHOE + +
+          Visually erase chars.
ECHOK + +
+          Kill character discards current line.
ECHOKE + +
+          Visual erase for line kill.
ECHONL + +
+          Echo NL even if ECHO is off.
ICANON + +
+          Canonicalize input lines.
ICRNL + +
+          Map CR to NL on input.
IEXTEN + +
+          Enable extensions.
IGNCR + +
+          Ignore CR on input.
IGNPAR + +
+          The ignore parity flag.
IMAXBEL + +
+          Ring bell on input queue full.
INLCR + +
+          Map NL into CR on input.
INPCK + +
+          Enable checking of parity errors.
ISIG + +
+          Enable signals INTR, QUIT, [D]SUSP.
ISTRIP + +
+          Strip 8th bit off characters.
IUCLC + +
+          Translate uppercase characters to lowercase.
IXANY + +
+          Any char will restart after stop.
IXOFF + +
+          Enable input flow control.
IXON + +
+          Enable output flow control.
NOFLSH + +
+          Don't flush after interrupt.
OCRNL + +
+          Translate carriage return to newline (output).
OLCUC + +
+          Convert lowercase to uppercase.
ONLCR + +
+          Map NL to CR-NL.
ONLRET + +
+          Newline performs a carriage return (output).
ONOCR + +
+          Translate newline to carriage return-newline (output).
OPOST + +
+          Enable output processing.
PARENB + +
+          Parity enable.
PARMRK + +
+          Mark parity and framing errors.
PARODD + +
+          Odd parity, else even.
PENDIN + +
+          Retype pending input.
TOSTOP + +
+          Stop background jobs from output.
TTY_OP_ISPEED + +
+          Specifies the input baud rate in bits per second.
TTY_OP_OSPEED + +
+          Specifies the output baud rate in bits per second.
VDISCARD + +
+          Toggles the flushing of terminal output.
VDSUSP + +
+          Another suspend character.
VEOF + +
+          End-of-file character (sends EOF from the terminal).
VEOL + +
+          End-of-line character in addition to carriage return and/or linefeed.
VEOL2 + +
+          Additional end-of-line character.
VERASE + +
+          Erase the character to left of the cursor.
VFLUSH + +
+          Character to flush output.
VINTR + +
+          Interrupt character; 255 if none.
VKILL + +
+          Kill the current input line.
VLNEXT + +
+          Enter the next character typed literally, even if it is a special character.
VQUIT + +
+          The quit character (sends SIGQUIT signal on POSIX systems).
VREPRINT + +
+          Reprints the current input line.
VSTART + +
+          Continues paused output (normally control-Q).
VSTATUS + +
+          Prints system status line (load, command, pid, etc).
VSTOP + +
+          Pauses output (normally control-S).
VSUSP + +
+          Suspends the current program.
VSWTCH + +
+          Switch to a different shell layer.
VWERASE + +
+          Erases a word left of cursor.
XCASE + +
+          Enable input and output of uppercase characters by preceding their lowercase equivalents with "\".
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static byte[]encode(Map<PTYMode,Integer> modes) + +
+           
+ bytegetOpcode() + +
+           
+static PTYModevalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static PTYMode[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+VINTR

+
+public static final PTYMode VINTR
+
+
Interrupt character; 255 if none. Similarly for the other characters. Not all of these characters are supported + on all systems. +

+

+
+
+
+ +

+VQUIT

+
+public static final PTYMode VQUIT
+
+
The quit character (sends SIGQUIT signal on POSIX systems). +

+

+
+
+
+ +

+VERASE

+
+public static final PTYMode VERASE
+
+
Erase the character to left of the cursor. +

+

+
+
+
+ +

+VKILL

+
+public static final PTYMode VKILL
+
+
Kill the current input line. +

+

+
+
+
+ +

+VEOF

+
+public static final PTYMode VEOF
+
+
End-of-file character (sends EOF from the terminal). +

+

+
+
+
+ +

+VEOL

+
+public static final PTYMode VEOL
+
+
End-of-line character in addition to carriage return and/or linefeed. +

+

+
+
+
+ +

+VEOL2

+
+public static final PTYMode VEOL2
+
+
Additional end-of-line character. +

+

+
+
+
+ +

+VSTART

+
+public static final PTYMode VSTART
+
+
Continues paused output (normally control-Q). +

+

+
+
+
+ +

+VSTOP

+
+public static final PTYMode VSTOP
+
+
Pauses output (normally control-S). +

+

+
+
+
+ +

+VSUSP

+
+public static final PTYMode VSUSP
+
+
Suspends the current program. +

+

+
+
+
+ +

+VDSUSP

+
+public static final PTYMode VDSUSP
+
+
Another suspend character. +

+

+
+
+
+ +

+VREPRINT

+
+public static final PTYMode VREPRINT
+
+
Reprints the current input line. +

+

+
+
+
+ +

+VWERASE

+
+public static final PTYMode VWERASE
+
+
Erases a word left of cursor. +

+

+
+
+
+ +

+VLNEXT

+
+public static final PTYMode VLNEXT
+
+
Enter the next character typed literally, even if it is a special character. +

+

+
+
+
+ +

+VFLUSH

+
+public static final PTYMode VFLUSH
+
+
Character to flush output. +

+

+
+
+
+ +

+VSWTCH

+
+public static final PTYMode VSWTCH
+
+
Switch to a different shell layer. +

+

+
+
+
+ +

+VSTATUS

+
+public static final PTYMode VSTATUS
+
+
Prints system status line (load, command, pid, etc). +

+

+
+
+
+ +

+VDISCARD

+
+public static final PTYMode VDISCARD
+
+
Toggles the flushing of terminal output. +

+

+
+
+
+ +

+IGNPAR

+
+public static final PTYMode IGNPAR
+
+
The ignore parity flag. The parameter SHOULD be 0 if this flag is FALSE, and 1 if it is TRUE. +

+

+
+
+
+ +

+PARMRK

+
+public static final PTYMode PARMRK
+
+
Mark parity and framing errors. +

+

+
+
+
+ +

+INPCK

+
+public static final PTYMode INPCK
+
+
Enable checking of parity errors. +

+

+
+
+
+ +

+ISTRIP

+
+public static final PTYMode ISTRIP
+
+
Strip 8th bit off characters. +

+

+
+
+
+ +

+INLCR

+
+public static final PTYMode INLCR
+
+
Map NL into CR on input. +

+

+
+
+
+ +

+IGNCR

+
+public static final PTYMode IGNCR
+
+
Ignore CR on input. +

+

+
+
+
+ +

+ICRNL

+
+public static final PTYMode ICRNL
+
+
Map CR to NL on input. +

+

+
+
+
+ +

+IUCLC

+
+public static final PTYMode IUCLC
+
+
Translate uppercase characters to lowercase. +

+

+
+
+
+ +

+IXON

+
+public static final PTYMode IXON
+
+
Enable output flow control. +

+

+
+
+
+ +

+IXANY

+
+public static final PTYMode IXANY
+
+
Any char will restart after stop. +

+

+
+
+
+ +

+IXOFF

+
+public static final PTYMode IXOFF
+
+
Enable input flow control. +

+

+
+
+
+ +

+IMAXBEL

+
+public static final PTYMode IMAXBEL
+
+
Ring bell on input queue full. +

+

+
+
+
+ +

+ISIG

+
+public static final PTYMode ISIG
+
+
Enable signals INTR, QUIT, [D]SUSP. +

+

+
+
+
+ +

+ICANON

+
+public static final PTYMode ICANON
+
+
Canonicalize input lines. +

+

+
+
+
+ +

+XCASE

+
+public static final PTYMode XCASE
+
+
Enable input and output of uppercase characters by preceding their lowercase equivalents with "\". +

+

+
+
+
+ +

+ECHO

+
+public static final PTYMode ECHO
+
+
Enable echoing. +

+

+
+
+
+ +

+ECHOE

+
+public static final PTYMode ECHOE
+
+
Visually erase chars. +

+

+
+
+
+ +

+ECHOK

+
+public static final PTYMode ECHOK
+
+
Kill character discards current line. +

+

+
+
+
+ +

+ECHONL

+
+public static final PTYMode ECHONL
+
+
Echo NL even if ECHO is off. +

+

+
+
+
+ +

+NOFLSH

+
+public static final PTYMode NOFLSH
+
+
Don't flush after interrupt. +

+

+
+
+
+ +

+TOSTOP

+
+public static final PTYMode TOSTOP
+
+
Stop background jobs from output. +

+

+
+
+
+ +

+IEXTEN

+
+public static final PTYMode IEXTEN
+
+
Enable extensions. +

+

+
+
+
+ +

+ECHOCTL

+
+public static final PTYMode ECHOCTL
+
+
Echo control characters as ˆ(Char). +

+

+
+
+
+ +

+ECHOKE

+
+public static final PTYMode ECHOKE
+
+
Visual erase for line kill. +

+

+
+
+
+ +

+PENDIN

+
+public static final PTYMode PENDIN
+
+
Retype pending input. +

+

+
+
+
+ +

+OPOST

+
+public static final PTYMode OPOST
+
+
Enable output processing. +

+

+
+
+
+ +

+OLCUC

+
+public static final PTYMode OLCUC
+
+
Convert lowercase to uppercase. +

+

+
+
+
+ +

+ONLCR

+
+public static final PTYMode ONLCR
+
+
Map NL to CR-NL. +

+

+
+
+
+ +

+OCRNL

+
+public static final PTYMode OCRNL
+
+
Translate carriage return to newline (output). +

+

+
+
+
+ +

+ONOCR

+
+public static final PTYMode ONOCR
+
+
Translate newline to carriage return-newline (output). +

+

+
+
+
+ +

+ONLRET

+
+public static final PTYMode ONLRET
+
+
Newline performs a carriage return (output). +

+

+
+
+
+ +

+CS7

+
+public static final PTYMode CS7
+
+
7 bit mode. +

+

+
+
+
+ +

+CS8

+
+public static final PTYMode CS8
+
+
8 bit mode. +

+

+
+
+
+ +

+PARENB

+
+public static final PTYMode PARENB
+
+
Parity enable. +

+

+
+
+
+ +

+PARODD

+
+public static final PTYMode PARODD
+
+
Odd parity, else even. +

+

+
+
+
+ +

+TTY_OP_ISPEED

+
+public static final PTYMode TTY_OP_ISPEED
+
+
Specifies the input baud rate in bits per second. +

+

+
+
+
+ +

+TTY_OP_OSPEED

+
+public static final PTYMode TTY_OP_OSPEED
+
+
Specifies the output baud rate in bits per second. +

+

+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static PTYMode[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (PTYMode c : PTYMode.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static PTYMode valueOf(String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+
+
+ +

+encode

+
+public static byte[] encode(Map<PTYMode,Integer> modes)
+
+
+
+
+
+
+ +

+getOpcode

+
+public byte getOpcode()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/Session.Command.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/Session.Command.html new file mode 100644 index 00000000..3a04a48d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/Session.Command.html @@ -0,0 +1,469 @@ + + + + + + + +Session.Command (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.direct +
+Interface Session.Command

+
+
All Superinterfaces:
Channel, Closeable, ErrorNotifiable, SSHPacketHandler
+
+
+
All Known Implementing Classes:
SessionChannel
+
+
+
Enclosing interface:
Session
+
+
+
+
public static interface Session.Command
extends Channel
+ + +

+Command API. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.connection.channel.Channel
Channel.Direct, Channel.Forwarded
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable
ErrorNotifiable.Util
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StringgetErrorAsString() + +
+          Deprecated. 
+ InputStreamgetErrorStream() + +
+          Returns the command's stderr stream.
+ StringgetExitErrorMessage() + +
+          If the command exit violently with a signal, an error message would have been + received and can be retrieved via this method.
+ SignalgetExitSignal() + +
+          Returns the signal if the command exit violently, or null if this information was not + received.
+ IntegergetExitStatus() + +
+          Returns the exit status of the command if it was received, or null if this information was not + received.
+ BooleangetExitWasCoreDumped() + +
+          If the command exit violently with a signal, information about whether a core dump + took place would have been received and can be retrieved via this method.
+ StringgetOutputAsString() + +
+          Deprecated. 
+ voidsignal(Signal signal) + +
+          Send a signal to the remote command.
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.connection.channel.Channel
close, getAutoExpand, getID, getInputStream, getLocalMaxPacketSize, getLocalWinSize, getOutputStream, getRecipient, getRemoteMaxPacketSize, getRemoteWinSize, getType, isOpen, join, join, sendEOF, setAutoExpand
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.SSHPacketHandler
handle
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.ErrorNotifiable
notifyError
+  +

+ + + + + + + + +
+Method Detail
+ +

+getErrorStream

+
+InputStream getErrorStream()
+
+
Returns the command's stderr stream. +

+

+
+
+
+
+
+
+
+ +

+getExitErrorMessage

+
+String getExitErrorMessage()
+
+
If the command exit violently with a signal, an error message would have been + received and can be retrieved via this method. Otherwise, this method will return null. +

+

+
+
+
+
+
+
+
+ +

+getExitSignal

+
+Signal getExitSignal()
+
+
Returns the signal if the command exit violently, or null if this information was not + received. +

+

+
+
+
+
+
+
+
+ +

+getExitStatus

+
+Integer getExitStatus()
+
+
Returns the exit status of the command if it was received, or null if this information was not + received. +

+

+
+
+
+
+
+
+
+ +

+getExitWasCoreDumped

+
+Boolean getExitWasCoreDumped()
+
+
If the command exit violently with a signal, information about whether a core dump + took place would have been received and can be retrieved via this method. Otherwise, this method will return + null. +

+

+
+
+
+
+
+
+
+ +

+signal

+
+void signal(Signal signal)
+            throws TransportException
+
+
Send a signal to the remote command. +

+

+
+
+
+
Parameters:
signal - the signal +
Throws: +
TransportException - if error sending the signal
+
+
+
+ +

+getOutputAsString

+
+@Deprecated
+String getOutputAsString()
+                         throws IOException
+
+
Deprecated.  +

+

+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+getErrorAsString

+
+@Deprecated
+String getErrorAsString()
+                        throws IOException
+
+
Deprecated.  +

+

+
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/Session.Shell.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/Session.Shell.html new file mode 100644 index 00000000..79e17d5c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/Session.Shell.html @@ -0,0 +1,367 @@ + + + + + + + +Session.Shell (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.direct +
+Interface Session.Shell

+
+
All Superinterfaces:
Channel, Closeable, ErrorNotifiable, SSHPacketHandler
+
+
+
All Known Implementing Classes:
SessionChannel
+
+
+
Enclosing interface:
Session
+
+
+
+
public static interface Session.Shell
extends Channel
+ + +

+Shell API. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.connection.channel.Channel
Channel.Direct, Channel.Forwarded
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable
ErrorNotifiable.Util
+  + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ BooleancanDoFlowControl() + +
+          Whether the client can do local flow control using control-S and control-Q.
+ voidchangeWindowDimensions(int cols, + int rows, + int width, + int height) + +
+          Sends a window dimension change message.
+ InputStreamgetErrorStream() + +
+          Returns the shell's stderr stream.
+ voidsignal(Signal signal) + +
+          Send a signal.
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.connection.channel.Channel
close, getAutoExpand, getID, getInputStream, getLocalMaxPacketSize, getLocalWinSize, getOutputStream, getRecipient, getRemoteMaxPacketSize, getRemoteWinSize, getType, isOpen, join, join, sendEOF, setAutoExpand
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.SSHPacketHandler
handle
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.ErrorNotifiable
notifyError
+  +

+ + + + + + + + +
+Method Detail
+ +

+canDoFlowControl

+
+Boolean canDoFlowControl()
+
+
Whether the client can do local flow control using control-S and control-Q. +

+

+
+
+
+ +
Returns:
boolean value indicating whether 'client can do', or null if no such information was + received
+
+
+
+ +

+changeWindowDimensions

+
+void changeWindowDimensions(int cols,
+                            int rows,
+                            int width,
+                            int height)
+                            throws TransportException
+
+
Sends a window dimension change message. +

+

+
+
+
+
Parameters:
cols - terminal width, columns
rows - terminal height, rows
width - terminal width, pixels
height - terminal height, pixels +
Throws: +
TransportException
+
+
+
+ +

+getErrorStream

+
+InputStream getErrorStream()
+
+
Returns the shell's stderr stream. +

+

+
+
+
+
+
+
+
+ +

+signal

+
+void signal(Signal signal)
+            throws TransportException
+
+
Send a signal. +

+

+
+
+
+
Parameters:
signal - the signal +
Throws: +
TransportException - if error sending the signal
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/Session.Subsystem.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/Session.Subsystem.html new file mode 100644 index 00000000..7ec4e41e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/Session.Subsystem.html @@ -0,0 +1,279 @@ + + + + + + + +Session.Subsystem (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.direct +
+Interface Session.Subsystem

+
+
All Superinterfaces:
Channel, Closeable, ErrorNotifiable, SSHPacketHandler
+
+
+
All Known Implementing Classes:
SessionChannel
+
+
+
Enclosing interface:
Session
+
+
+
+
public static interface Session.Subsystem
extends Channel
+ + +

+Subsystem API. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.connection.channel.Channel
Channel.Direct, Channel.Forwarded
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable
ErrorNotifiable.Util
+  + + + + + + + + + + + + +
+Method Summary
+ IntegergetExitStatus() + +
+           
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.connection.channel.Channel
close, getAutoExpand, getID, getInputStream, getLocalMaxPacketSize, getLocalWinSize, getOutputStream, getRecipient, getRemoteMaxPacketSize, getRemoteWinSize, getType, isOpen, join, join, sendEOF, setAutoExpand
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.SSHPacketHandler
handle
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.ErrorNotifiable
notifyError
+  +

+ + + + + + + + +
+Method Detail
+ +

+getExitStatus

+
+Integer getExitStatus()
+
+
+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/Session.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/Session.html new file mode 100644 index 00000000..640591df --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/Session.html @@ -0,0 +1,511 @@ + + + + + + + +Session (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.direct +
+Interface Session

+
+
All Superinterfaces:
Channel, Closeable, ErrorNotifiable, SSHPacketHandler
+
+
+
All Known Implementing Classes:
SessionChannel
+
+
+
+
public interface Session
extends Channel
+ + +

+A session channel provides for execution of a remote command, shell or subsystem. Before this requests like starting X11 forwarding, setting environment variables, allocating a + PTY etc. can be made. +

+ It is not legal to reuse a session channel for more than one of command, shell, or subsystem. Once one of + these has been started this instance's API is invalid and that of the specific targets + returned should be used. +

+ +

+

+
See Also:
Session.Command, +Session.Shell, +Session.Subsystem
+
+ +

+ + + + + + + + + + + + + + + + + + + +
+Nested Class Summary
+static interfaceSession.Command + +
+          Command API.
+static interfaceSession.Shell + +
+          Shell API.
+static interfaceSession.Subsystem + +
+          Subsystem API.
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.connection.channel.Channel
Channel.Direct, Channel.Forwarded
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable
ErrorNotifiable.Util
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidallocateDefaultPTY() + +
+          Allocates a default PTY.
+ voidallocatePTY(String term, + int cols, + int rows, + int width, + int height, + Map<PTYMode,Integer> modes) + +
+          Allocate a psuedo-terminal for this session.
+ Session.Commandexec(String command) + +
+          Execute a remote command.
+ voidreqX11Forwarding(String authProto, + String authCookie, + int screen) + +
+          Request X11 forwarding.
+ voidsetEnvVar(String name, + String value) + +
+          Set an enviornment variable.
+ Session.ShellstartShell() + +
+          Request a shell.
+ Session.SubsystemstartSubsystem(String name) + +
+          Request a subsystem.
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.connection.channel.Channel
close, getAutoExpand, getID, getInputStream, getLocalMaxPacketSize, getLocalWinSize, getOutputStream, getRecipient, getRemoteMaxPacketSize, getRemoteWinSize, getType, isOpen, join, join, sendEOF, setAutoExpand
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.SSHPacketHandler
handle
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.ErrorNotifiable
notifyError
+  +

+ + + + + + + + +
+Method Detail
+ +

+allocateDefaultPTY

+
+void allocateDefaultPTY()
+                        throws ConnectionException,
+                               TransportException
+
+
Allocates a default PTY. The default PTY is "vt100" with the echo modes disabled. +

+

+
+
+
+ +
Throws: +
ConnectionException +
TransportException
+
+
+
+ +

+allocatePTY

+
+void allocatePTY(String term,
+                 int cols,
+                 int rows,
+                 int width,
+                 int height,
+                 Map<PTYMode,Integer> modes)
+                 throws ConnectionException,
+                        TransportException
+
+
Allocate a psuedo-terminal for this session. +

+ 0 dimension parameters will be ignored by the server. +

+

+
+
+
+
Parameters:
term - TERM environment variable value (e.g., vt100)
cols - terminal width, cols (e.g., 80)
rows - terminal height, rows (e.g., 24)
width - terminal width, pixels (e.g., 640)
height - terminal height, pixels (e.g., 480)
modes - +
Throws: +
ConnectionException +
TransportException
+
+
+
+ +

+exec

+
+Session.Command exec(String command)
+                     throws ConnectionException,
+                            TransportException
+
+
Execute a remote command. +

+

+
+
+
+
Parameters:
command - +
Returns:
Session.Command instance which should now be used +
Throws: +
ConnectionException - if the request to execute the command failed +
TransportException - if there is an error sending the request
+
+
+
+ +

+reqX11Forwarding

+
+void reqX11Forwarding(String authProto,
+                      String authCookie,
+                      int screen)
+                      throws ConnectionException,
+                             TransportException
+
+
Request X11 forwarding. +

+

+
+
+
+
Parameters:
authProto - X11 authentication protocol name
authCookie - X11 authentication cookie
screen - X11 screen number +
Throws: +
ConnectionException - if the request failed +
TransportException - if there was an error sending the request
+
+
+
+ +

+setEnvVar

+
+void setEnvVar(String name,
+               String value)
+               throws ConnectionException,
+                      TransportException
+
+
Set an enviornment variable. +

+

+
+
+
+
Parameters:
name - name of the variable
value - value to set +
Throws: +
ConnectionException - if the request failed +
TransportException - if there was an error sending the request
+
+
+
+ +

+startShell

+
+Session.Shell startShell()
+                         throws ConnectionException,
+                                TransportException
+
+
Request a shell. +

+

+
+
+
+ +
Returns:
Session.Shell instance which should now be used +
Throws: +
ConnectionException - if the request failed +
TransportException - if there was an error sending the request
+
+
+
+ +

+startSubsystem

+
+Session.Subsystem startSubsystem(String name)
+                                 throws ConnectionException,
+                                        TransportException
+
+
Request a subsystem. +

+

+
+
+
+
Parameters:
name - subsystem name +
Returns:
Session.Subsystem instance which should now be used +
Throws: +
ConnectionException - if the request failed +
TransportException - if there was an error sending the request
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/SessionChannel.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/SessionChannel.html new file mode 100644 index 00000000..1ce68ba7 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/SessionChannel.html @@ -0,0 +1,977 @@ + + + + + + + +SessionChannel (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.direct +
+Class SessionChannel

+
+java.lang.Object
+  extended by net.schmizz.sshj.connection.channel.AbstractChannel
+      extended by net.schmizz.sshj.connection.channel.direct.AbstractDirectChannel
+          extended by net.schmizz.sshj.connection.channel.direct.SessionChannel
+
+
+
All Implemented Interfaces:
Closeable, ErrorNotifiable, SSHPacketHandler, Channel, Channel.Direct, Session, Session.Command, Session.Shell, Session.Subsystem
+
+
+
+
public class SessionChannel
extends AbstractDirectChannel
implements Session, Session.Command, Session.Shell, Session.Subsystem
+ + +

+Session implementation. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.connection.channel.direct.Session
Session.Command, Session.Shell, Session.Subsystem
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.connection.channel.Channel
Channel.Direct, Channel.Forwarded
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable
ErrorNotifiable.Util
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.connection.channel.AbstractChannel
close, conn, log, lwin, open, rwin, trans
+  + + + + + + + + + + +
+Constructor Summary
SessionChannel(Connection conn) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidallocateDefaultPTY() + +
+          Allocates a default PTY.
+ voidallocatePTY(String term, + int cols, + int rows, + int width, + int height, + Map<PTYMode,Integer> modes) + +
+          Allocate a psuedo-terminal for this session.
+ BooleancanDoFlowControl() + +
+          Whether the client can do local flow control using control-S and control-Q.
+ voidchangeWindowDimensions(int cols, + int rows, + int width, + int height) + +
+          Sends a window dimension change message.
+protected  voidcloseAllStreams() + +
+          Called when all I/O streams should be closed.
+protected  voideofInputStreams() + +
+          Called when EOF has been received.
+ Session.Commandexec(String command) + +
+          Execute a remote command.
+ StringgetErrorAsString() + +
+          Deprecated. 
+ InputStreamgetErrorStream() + +
+          Returns the command's stderr stream.
+ StringgetExitErrorMessage() + +
+          If the command exit violently with a signal, an error message would have been + received and can be retrieved via this method.
+ SignalgetExitSignal() + +
+          Returns the signal if the command exit violently, or null if this information was not + received.
+ IntegergetExitStatus() + +
+          Returns the exit status of the command if it was received, or null if this information was not + received.
+ BooleangetExitWasCoreDumped() + +
+          If the command exit violently with a signal, information about whether a core dump + took place would have been received and can be retrieved via this method.
+ StringgetOutputAsString() + +
+          Deprecated. 
+protected  voidgotExtendedData(SSHPacket buf) + +
+           
+ voidhandleRequest(String req, + SSHPacket buf) + +
+           
+ voidnotifyError(SSHException error) + +
+          Notifies this object of an error.
+ voidreqX11Forwarding(String authProto, + String authCookie, + int screen) + +
+          Request X11 forwarding.
+ voidsetEnvVar(String name, + String value) + +
+          Set an enviornment variable.
+ voidsignal(Signal sig) + +
+          Send a signal to the remote command.
+ Session.ShellstartShell() + +
+          Request a shell.
+ Session.SubsystemstartSubsystem(String name) + +
+          Request a subsystem.
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.connection.channel.direct.AbstractDirectChannel
buildOpenReq, gotUnknown, open
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.connection.channel.AbstractChannel
close, finishOff, getAutoExpand, getID, getInputStream, getLocalMaxPacketSize, getLocalWinSize, getOutputStream, getRecipient, getRemoteMaxPacketSize, getRemoteWinSize, getType, handle, init, isOpen, join, join, newBuffer, receiveInto, sendChannelRequest, sendClose, sendEOF, setAutoExpand, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.connection.channel.Channel
close, getAutoExpand, getID, getInputStream, getLocalMaxPacketSize, getLocalWinSize, getOutputStream, getRecipient, getRemoteMaxPacketSize, getRemoteWinSize, getType, isOpen, join, join, sendEOF, setAutoExpand
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.SSHPacketHandler
handle
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SessionChannel

+
+public SessionChannel(Connection conn)
+
+
+ + + + + + + + +
+Method Detail
+ +

+allocateDefaultPTY

+
+public void allocateDefaultPTY()
+                        throws ConnectionException,
+                               TransportException
+
+
Description copied from interface: Session
+
Allocates a default PTY. The default PTY is "vt100" with the echo modes disabled. +

+

+
Specified by:
allocateDefaultPTY in interface Session
+
+
+ +
Throws: +
ConnectionException +
TransportException
+
+
+
+ +

+allocatePTY

+
+public void allocatePTY(String term,
+                        int cols,
+                        int rows,
+                        int width,
+                        int height,
+                        Map<PTYMode,Integer> modes)
+                 throws ConnectionException,
+                        TransportException
+
+
Description copied from interface: Session
+
Allocate a psuedo-terminal for this session. +

+ 0 dimension parameters will be ignored by the server. +

+

+
Specified by:
allocatePTY in interface Session
+
+
+
Parameters:
term - TERM environment variable value (e.g., vt100)
cols - terminal width, cols (e.g., 80)
rows - terminal height, rows (e.g., 24)
width - terminal width, pixels (e.g., 640)
height - terminal height, pixels (e.g., 480) +
Throws: +
ConnectionException +
TransportException
+
+
+
+ +

+canDoFlowControl

+
+public Boolean canDoFlowControl()
+
+
Description copied from interface: Session.Shell
+
Whether the client can do local flow control using control-S and control-Q. +

+

+
Specified by:
canDoFlowControl in interface Session.Shell
+
+
+ +
Returns:
boolean value indicating whether 'client can do', or null if no such information was + received
+
+
+
+ +

+changeWindowDimensions

+
+public void changeWindowDimensions(int cols,
+                                   int rows,
+                                   int width,
+                                   int height)
+                            throws TransportException
+
+
Description copied from interface: Session.Shell
+
Sends a window dimension change message. +

+

+
Specified by:
changeWindowDimensions in interface Session.Shell
+
+
+
Parameters:
cols - terminal width, columns
rows - terminal height, rows
width - terminal width, pixels
height - terminal height, pixels +
Throws: +
TransportException
+
+
+
+ +

+exec

+
+public Session.Command exec(String command)
+                     throws ConnectionException,
+                            TransportException
+
+
Description copied from interface: Session
+
Execute a remote command. +

+

+
Specified by:
exec in interface Session
+
+
+ +
Returns:
Session.Command instance which should now be used +
Throws: +
ConnectionException - if the request to execute the command failed +
TransportException - if there is an error sending the request
+
+
+
+ +

+getErrorStream

+
+public InputStream getErrorStream()
+
+
Description copied from interface: Session.Command
+
Returns the command's stderr stream. +

+

+
Specified by:
getErrorStream in interface Session.Command
Specified by:
getErrorStream in interface Session.Shell
+
+
+
+
+
+
+ +

+getExitErrorMessage

+
+public String getExitErrorMessage()
+
+
Description copied from interface: Session.Command
+
If the command exit violently with a signal, an error message would have been + received and can be retrieved via this method. Otherwise, this method will return null. +

+

+
Specified by:
getExitErrorMessage in interface Session.Command
+
+
+
+
+
+
+ +

+getExitSignal

+
+public Signal getExitSignal()
+
+
Description copied from interface: Session.Command
+
Returns the signal if the command exit violently, or null if this information was not + received. +

+

+
Specified by:
getExitSignal in interface Session.Command
+
+
+
+
+
+
+ +

+getExitStatus

+
+public Integer getExitStatus()
+
+
Description copied from interface: Session.Command
+
Returns the exit status of the command if it was received, or null if this information was not + received. +

+

+
Specified by:
getExitStatus in interface Session.Command
Specified by:
getExitStatus in interface Session.Subsystem
+
+
+
+
+
+
+ +

+handleRequest

+
+public void handleRequest(String req,
+                          SSHPacket buf)
+                   throws ConnectionException,
+                          TransportException
+
+
+
Overrides:
handleRequest in class AbstractChannel
+
+
+ +
Throws: +
ConnectionException +
TransportException
+
+
+
+ +

+reqX11Forwarding

+
+public void reqX11Forwarding(String authProto,
+                             String authCookie,
+                             int screen)
+                      throws ConnectionException,
+                             TransportException
+
+
Description copied from interface: Session
+
Request X11 forwarding. +

+

+
Specified by:
reqX11Forwarding in interface Session
+
+
+
Parameters:
authProto - X11 authentication protocol name
authCookie - X11 authentication cookie
screen - X11 screen number +
Throws: +
ConnectionException - if the request failed +
TransportException - if there was an error sending the request
+
+
+
+ +

+setEnvVar

+
+public void setEnvVar(String name,
+                      String value)
+               throws ConnectionException,
+                      TransportException
+
+
Description copied from interface: Session
+
Set an enviornment variable. +

+

+
Specified by:
setEnvVar in interface Session
+
+
+
Parameters:
name - name of the variable
value - value to set +
Throws: +
ConnectionException - if the request failed +
TransportException - if there was an error sending the request
+
+
+
+ +

+signal

+
+public void signal(Signal sig)
+            throws TransportException
+
+
Description copied from interface: Session.Command
+
Send a signal to the remote command. +

+

+
Specified by:
signal in interface Session.Command
Specified by:
signal in interface Session.Shell
+
+
+
Parameters:
sig - the signal +
Throws: +
TransportException - if error sending the signal
+
+
+
+ +

+startShell

+
+public Session.Shell startShell()
+                         throws ConnectionException,
+                                TransportException
+
+
Description copied from interface: Session
+
Request a shell. +

+

+
Specified by:
startShell in interface Session
+
+
+ +
Returns:
Session.Shell instance which should now be used +
Throws: +
ConnectionException - if the request failed +
TransportException - if there was an error sending the request
+
+
+
+ +

+startSubsystem

+
+public Session.Subsystem startSubsystem(String name)
+                                 throws ConnectionException,
+                                        TransportException
+
+
Description copied from interface: Session
+
Request a subsystem. +

+

+
Specified by:
startSubsystem in interface Session
+
+
+
Parameters:
name - subsystem name +
Returns:
Session.Subsystem instance which should now be used +
Throws: +
ConnectionException - if the request failed +
TransportException - if there was an error sending the request
+
+
+
+ +

+getExitWasCoreDumped

+
+public Boolean getExitWasCoreDumped()
+
+
Description copied from interface: Session.Command
+
If the command exit violently with a signal, information about whether a core dump + took place would have been received and can be retrieved via this method. Otherwise, this method will return + null. +

+

+
Specified by:
getExitWasCoreDumped in interface Session.Command
+
+
+
+
+
+
+ +

+closeAllStreams

+
+protected void closeAllStreams()
+
+
Description copied from class: AbstractChannel
+
Called when all I/O streams should be closed. Subclasses can override but must call super. +

+

+
Overrides:
closeAllStreams in class AbstractChannel
+
+
+
+
+
+
+ +

+eofInputStreams

+
+protected void eofInputStreams()
+
+
Description copied from class: AbstractChannel
+
Called when EOF has been received. Subclasses can override but must call super. +

+

+
Overrides:
eofInputStreams in class AbstractChannel
+
+
+
+
+
+
+ +

+gotExtendedData

+
+protected void gotExtendedData(SSHPacket buf)
+                        throws ConnectionException,
+                               TransportException
+
+
+
Overrides:
gotExtendedData in class AbstractChannel
+
+
+ +
Throws: +
ConnectionException +
TransportException
+
+
+
+ +

+notifyError

+
+public void notifyError(SSHException error)
+
+
Description copied from interface: ErrorNotifiable
+
Notifies this object of an error. +

+

+
Specified by:
notifyError in interface ErrorNotifiable
Overrides:
notifyError in class AbstractChannel
+
+
+
+
+
+
+ +

+getOutputAsString

+
+@Deprecated
+public String getOutputAsString()
+                         throws IOException
+
+
Deprecated.  +

+

+
Specified by:
getOutputAsString in interface Session.Command
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+getErrorAsString

+
+@Deprecated
+public String getErrorAsString()
+                        throws IOException
+
+
Deprecated.  +

+

+
Specified by:
getErrorAsString in interface Session.Command
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/SessionFactory.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/SessionFactory.html new file mode 100644 index 00000000..476e7078 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/SessionFactory.html @@ -0,0 +1,220 @@ + + + + + + + +SessionFactory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.direct +
+Interface SessionFactory

+
+
All Known Implementing Classes:
SSHClient
+
+
+
+
public interface SessionFactory
+ + +

+A factory interface for creating SSH session channels. +

+ +

+


+ +

+ + + + + + + + + + + + +
+Method Summary
+ SessionstartSession() + +
+          Opens a session channel.
+  +

+ + + + + + + + +
+Method Detail
+ +

+startSession

+
+Session startSession()
+                     throws SSHException
+
+
Opens a session channel. The returned Session instance allows executing a remote command, starting a subsystem, or starting a shell. +

+

+ +
Returns:
the opened session channel +
Throws: +
SSHException
See Also:
Session
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/Signal.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/Signal.html new file mode 100644 index 00000000..ef2fd0d3 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/Signal.html @@ -0,0 +1,541 @@ + + + + + + + +Signal (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.direct +
+Enum Signal

+
+java.lang.Object
+  extended by java.lang.Enum<Signal>
+      extended by net.schmizz.sshj.connection.channel.direct.Signal
+
+
+
All Implemented Interfaces:
Serializable, Comparable<Signal>
+
+
+
+
public enum Signal
extends Enum<Signal>
+ + +

+Various signals that may be sent or received. The signals are from POSIX and simply miss the "SIG_" prefix. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
ABRT + +
+           
ALRM + +
+           
FPE + +
+           
HUP + +
+           
ILL + +
+           
INT + +
+           
KILL + +
+           
PIPE + +
+           
QUIT + +
+           
SEGV + +
+           
TERM + +
+           
UNKNOWN + +
+           
USR1 + +
+           
USR2 + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static SignalfromString(String name) + +
+          Create from the string representation used when the signal is received as part of an SSH packet.
+static SignalvalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static Signal[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+ABRT

+
+public static final Signal ABRT
+
+
+
+
+
+ +

+ALRM

+
+public static final Signal ALRM
+
+
+
+
+
+ +

+FPE

+
+public static final Signal FPE
+
+
+
+
+
+ +

+HUP

+
+public static final Signal HUP
+
+
+
+
+
+ +

+ILL

+
+public static final Signal ILL
+
+
+
+
+
+ +

+INT

+
+public static final Signal INT
+
+
+
+
+
+ +

+KILL

+
+public static final Signal KILL
+
+
+
+
+
+ +

+PIPE

+
+public static final Signal PIPE
+
+
+
+
+
+ +

+QUIT

+
+public static final Signal QUIT
+
+
+
+
+
+ +

+SEGV

+
+public static final Signal SEGV
+
+
+
+
+
+ +

+TERM

+
+public static final Signal TERM
+
+
+
+
+
+ +

+USR1

+
+public static final Signal USR1
+
+
+
+
+
+ +

+USR2

+
+public static final Signal USR2
+
+
+
+
+
+ +

+UNKNOWN

+
+public static final Signal UNKNOWN
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static Signal[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (Signal c : Signal.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static Signal valueOf(String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+
+
+ +

+fromString

+
+public static Signal fromString(String name)
+
+
Create from the string representation used when the signal is received as part of an SSH packet. +

+

+
Parameters:
name - name of the signal as received +
Returns:
the enum constant inferred
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/AbstractDirectChannel.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/AbstractDirectChannel.html new file mode 100644 index 00000000..cee54494 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/AbstractDirectChannel.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.direct.AbstractDirectChannel (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.direct.AbstractDirectChannel

+
+ + + + + + + + + +
+Packages that use AbstractDirectChannel
net.schmizz.sshj.connection.channel.direct  
+  +

+ + + + + +
+Uses of AbstractDirectChannel in net.schmizz.sshj.connection.channel.direct
+  +

+ + + + + + + + + +
Subclasses of AbstractDirectChannel in net.schmizz.sshj.connection.channel.direct
+ classSessionChannel + +
+          Session implementation.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/LocalPortForwarder.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/LocalPortForwarder.html new file mode 100644 index 00000000..9d967f8e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/LocalPortForwarder.html @@ -0,0 +1,184 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.direct.LocalPortForwarder (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.direct.LocalPortForwarder

+
+ + + + + + + + + +
+Packages that use LocalPortForwarder
net.schmizz.sshj  
+  +

+ + + + + +
+Uses of LocalPortForwarder in net.schmizz.sshj
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj that return LocalPortForwarder
+ LocalPortForwarderSSHClient.newLocalPortForwarder(SocketAddress address, + String host, + int port) + +
+          Create a LocalPortForwarder that will listen on address and forward incoming connections to the + server; which will further forward them to host:port.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/PTYMode.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/PTYMode.html new file mode 100644 index 00000000..82549847 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/PTYMode.html @@ -0,0 +1,232 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.direct.PTYMode (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.direct.PTYMode

+
+ + + + + + + + + +
+Packages that use PTYMode
net.schmizz.sshj.connection.channel.direct  
+  +

+ + + + + +
+Uses of PTYMode in net.schmizz.sshj.connection.channel.direct
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.direct that return PTYMode
+static PTYModePTYMode.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static PTYMode[]PTYMode.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + + + + + + + + + +
Method parameters in net.schmizz.sshj.connection.channel.direct with type arguments of type PTYMode
+ voidSessionChannel.allocatePTY(String term, + int cols, + int rows, + int width, + int height, + Map<PTYMode,Integer> modes) + +
+           
+ voidSession.allocatePTY(String term, + int cols, + int rows, + int width, + int height, + Map<PTYMode,Integer> modes) + +
+          Allocate a psuedo-terminal for this session.
+static byte[]PTYMode.encode(Map<PTYMode,Integer> modes) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/Session.Command.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/Session.Command.html new file mode 100644 index 00000000..ef9603e0 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/Session.Command.html @@ -0,0 +1,205 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.connection.channel.direct.Session.Command (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.connection.channel.direct.Session.Command

+
+ + + + + + + + + +
+Packages that use Session.Command
net.schmizz.sshj.connection.channel.direct  
+  +

+ + + + + +
+Uses of Session.Command in net.schmizz.sshj.connection.channel.direct
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.connection.channel.direct that implement Session.Command
+ classSessionChannel + +
+          Session implementation.
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.direct that return Session.Command
+ Session.CommandSessionChannel.exec(String command) + +
+           
+ Session.CommandSession.exec(String command) + +
+          Execute a remote command.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/Session.Shell.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/Session.Shell.html new file mode 100644 index 00000000..e62abb2f --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/Session.Shell.html @@ -0,0 +1,205 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.connection.channel.direct.Session.Shell (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.connection.channel.direct.Session.Shell

+
+ + + + + + + + + +
+Packages that use Session.Shell
net.schmizz.sshj.connection.channel.direct  
+  +

+ + + + + +
+Uses of Session.Shell in net.schmizz.sshj.connection.channel.direct
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.connection.channel.direct that implement Session.Shell
+ classSessionChannel + +
+          Session implementation.
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.direct that return Session.Shell
+ Session.ShellSessionChannel.startShell() + +
+           
+ Session.ShellSession.startShell() + +
+          Request a shell.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/Session.Subsystem.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/Session.Subsystem.html new file mode 100644 index 00000000..b7b4dd0c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/Session.Subsystem.html @@ -0,0 +1,250 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.connection.channel.direct.Session.Subsystem (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.connection.channel.direct.Session.Subsystem

+
+ + + + + + + + + + + + + +
+Packages that use Session.Subsystem
net.schmizz.sshj.connection.channel.direct  
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of Session.Subsystem in net.schmizz.sshj.connection.channel.direct
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.connection.channel.direct that implement Session.Subsystem
+ classSessionChannel + +
+          Session implementation.
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.direct that return Session.Subsystem
+ Session.SubsystemSessionChannel.startSubsystem(String name) + +
+           
+ Session.SubsystemSession.startSubsystem(String name) + +
+          Request a subsystem.
+  +

+ + + + + +
+Uses of Session.Subsystem in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.sftp declared as Session.Subsystem
+protected  Session.SubsystemSFTPEngine.sub + +
+           
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return Session.Subsystem
+ Session.SubsystemSFTPEngine.getSubsystem() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/Session.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/Session.html new file mode 100644 index 00000000..b410e2ac --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/Session.html @@ -0,0 +1,226 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.connection.channel.direct.Session (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.connection.channel.direct.Session

+
+ + + + + + + + + + + + + +
+Packages that use Session
net.schmizz.sshj  
net.schmizz.sshj.connection.channel.direct  
+  +

+ + + + + +
+Uses of Session in net.schmizz.sshj
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj that return Session
+ SessionSSHClient.startSession() + +
+           
+  +

+ + + + + +
+Uses of Session in net.schmizz.sshj.connection.channel.direct
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.connection.channel.direct that implement Session
+ classSessionChannel + +
+          Session implementation.
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.direct that return Session
+ SessionSessionFactory.startSession() + +
+          Opens a session channel.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/SessionChannel.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/SessionChannel.html new file mode 100644 index 00000000..9a314d24 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/SessionChannel.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.direct.SessionChannel (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.direct.SessionChannel

+
+No usage of net.schmizz.sshj.connection.channel.direct.SessionChannel +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/SessionFactory.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/SessionFactory.html new file mode 100644 index 00000000..ffff26d0 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/SessionFactory.html @@ -0,0 +1,242 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.connection.channel.direct.SessionFactory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.connection.channel.direct.SessionFactory

+
+ + + + + + + + + + + + + + + + + +
+Packages that use SessionFactory
net.schmizz.sshj  
net.schmizz.sshj.sftp  
net.schmizz.sshj.xfer.scp  
+  +

+ + + + + +
+Uses of SessionFactory in net.schmizz.sshj
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj that implement SessionFactory
+ classSSHClient + +
+          Secure SHell client API.
+  +

+ + + + + +
+Uses of SessionFactory in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + + + +
Constructors in net.schmizz.sshj.sftp with parameters of type SessionFactory
SFTPEngine(SessionFactory ssh) + +
+           
SFTPEngine(SessionFactory ssh, + String pathSep) + +
+           
+  +

+ + + + + +
+Uses of SessionFactory in net.schmizz.sshj.xfer.scp
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.xfer.scp with parameters of type SessionFactory
SCPFileTransfer(SessionFactory sessionFactory) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/Signal.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/Signal.html new file mode 100644 index 00000000..69218170 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/class-use/Signal.html @@ -0,0 +1,247 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.direct.Signal (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.direct.Signal

+
+ + + + + + + + + +
+Packages that use Signal
net.schmizz.sshj.connection.channel.direct  
+  +

+ + + + + +
+Uses of Signal in net.schmizz.sshj.connection.channel.direct
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.direct that return Signal
+static SignalSignal.fromString(String name) + +
+          Create from the string representation used when the signal is received as part of an SSH packet.
+ SignalSessionChannel.getExitSignal() + +
+           
+ SignalSession.Command.getExitSignal() + +
+          Returns the signal if the command exit violently, or null if this information was not + received.
+static SignalSignal.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static Signal[]Signal.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.direct with parameters of type Signal
+ voidSessionChannel.signal(Signal sig) + +
+           
+ voidSession.Command.signal(Signal signal) + +
+          Send a signal to the remote command.
+ voidSession.Shell.signal(Signal signal) + +
+          Send a signal.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/package-frame.html new file mode 100644 index 00000000..b5596243 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/package-frame.html @@ -0,0 +1,69 @@ + + + + + + + +net.schmizz.sshj.connection.channel.direct (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.connection.channel.direct + + + + +
+Interfaces  + +
+Session +
+Session.Command +
+Session.Shell +
+Session.Subsystem +
+SessionFactory
+ + + + + + +
+Classes  + +
+AbstractDirectChannel +
+LocalPortForwarder +
+SessionChannel
+ + + + + + +
+Enums  + +
+PTYMode +
+Signal
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/package-summary.html new file mode 100644 index 00000000..26c08a24 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/package-summary.html @@ -0,0 +1,214 @@ + + + + + + + +net.schmizz.sshj.connection.channel.direct (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.connection.channel.direct +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Interface Summary
SessionA session channel provides for execution of a remote command, shell or subsystem.
Session.CommandCommand API.
Session.ShellShell API.
Session.SubsystemSubsystem API.
SessionFactoryA factory interface for creating SSH session channels.
+  + +

+ + + + + + + + + + + + + + + + + +
+Class Summary
AbstractDirectChannelBase class for direct channels whose open is initated by the client.
LocalPortForwarder 
SessionChannelSession implementation.
+  + +

+ + + + + + + + + + + + + +
+Enum Summary
PTYModeVarious modes for a psuedo-terminal.
SignalVarious signals that may be sent or received.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/package-tree.html new file mode 100644 index 00000000..94890a72 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/package-tree.html @@ -0,0 +1,191 @@ + + + + + + + +net.schmizz.sshj.connection.channel.direct Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.connection.channel.direct +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/package-use.html new file mode 100644 index 00000000..b7fbdd80 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/direct/package-use.html @@ -0,0 +1,282 @@ + + + + + + + +Uses of Package net.schmizz.sshj.connection.channel.direct (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.connection.channel.direct

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.connection.channel.direct
net.schmizz.sshj  
net.schmizz.sshj.connection.channel.direct  
net.schmizz.sshj.sftp  
net.schmizz.sshj.xfer.scp  
+  +

+ + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.connection.channel.direct used by net.schmizz.sshj
LocalPortForwarder + +
+           
Session + +
+          A session channel provides for execution of a remote command, shell or subsystem.
SessionFactory + +
+          A factory interface for creating SSH session channels.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.connection.channel.direct used by net.schmizz.sshj.connection.channel.direct
AbstractDirectChannel + +
+          Base class for direct channels whose open is initated by the client.
PTYMode + +
+          Various modes for a psuedo-terminal.
Session + +
+          A session channel provides for execution of a remote command, shell or subsystem.
Session.Command + +
+          Command API.
Session.Shell + +
+          Shell API.
Session.Subsystem + +
+          Subsystem API.
Signal + +
+          Various signals that may be sent or received.
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.connection.channel.direct used by net.schmizz.sshj.sftp
Session.Subsystem + +
+          Subsystem API.
SessionFactory + +
+          A factory interface for creating SSH session channels.
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.connection.channel.direct used by net.schmizz.sshj.xfer.scp
SessionFactory + +
+          A factory interface for creating SSH session channels.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/AbstractForwardedChannel.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/AbstractForwardedChannel.html new file mode 100644 index 00000000..b79f4e45 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/AbstractForwardedChannel.html @@ -0,0 +1,491 @@ + + + + + + + +AbstractForwardedChannel (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.forwarded +
+Class AbstractForwardedChannel

+
+java.lang.Object
+  extended by net.schmizz.sshj.connection.channel.AbstractChannel
+      extended by net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannel
+
+
+
All Implemented Interfaces:
Closeable, ErrorNotifiable, SSHPacketHandler, Channel, Channel.Forwarded
+
+
+
Direct Known Subclasses:
RemotePortForwarder.ForwardedTCPIPChannel, X11Forwarder.X11Channel
+
+
+
+
public abstract class AbstractForwardedChannel
extends AbstractChannel
implements Channel.Forwarded
+ + +

+Base class for forwarded channels whose open is initiated by the server. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.connection.channel.Channel
Channel.Direct, Channel.Forwarded
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable
ErrorNotifiable.Util
+  + + + + + + + + + + + + + + + +
+Field Summary
+protected  StringorigIP + +
+           
+protected  intorigPort + +
+           
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.connection.channel.AbstractChannel
close, conn, log, lwin, open, rwin, trans
+  + + + + + + + + + + + +
+Constructor Summary
+protected AbstractForwardedChannel(Connection conn, + String type, + int recipient, + int remoteWinSize, + int remoteMaxPacketSize, + String origIP, + int origPort) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidconfirm() + +
+          Confirm CHANNEL_OPEN request.
+ StringgetOriginatorIP() + +
+           
+ intgetOriginatorPort() + +
+           
+ voidreject(OpenFailException.Reason reason, + String message) + +
+          Indicate rejection to remote end.
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.connection.channel.AbstractChannel
close, closeAllStreams, eofInputStreams, finishOff, getAutoExpand, getID, getInputStream, getLocalMaxPacketSize, getLocalWinSize, getOutputStream, getRecipient, getRemoteMaxPacketSize, getRemoteWinSize, getType, gotExtendedData, gotUnknown, handle, handleRequest, init, isOpen, join, join, newBuffer, notifyError, receiveInto, sendChannelRequest, sendClose, sendEOF, setAutoExpand, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.connection.channel.Channel
close, getAutoExpand, getID, getInputStream, getLocalMaxPacketSize, getLocalWinSize, getOutputStream, getRecipient, getRemoteMaxPacketSize, getRemoteWinSize, getType, isOpen, join, join, sendEOF, setAutoExpand
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.SSHPacketHandler
handle
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.ErrorNotifiable
notifyError
+  +

+ + + + + + + + +
+Field Detail
+ +

+origIP

+
+protected final String origIP
+
+
+
+
+
+ +

+origPort

+
+protected final int origPort
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+AbstractForwardedChannel

+
+protected AbstractForwardedChannel(Connection conn,
+                                   String type,
+                                   int recipient,
+                                   int remoteWinSize,
+                                   int remoteMaxPacketSize,
+                                   String origIP,
+                                   int origPort)
+
+
+ + + + + + + + +
+Method Detail
+ +

+confirm

+
+public void confirm()
+             throws TransportException
+
+
Description copied from interface: Channel.Forwarded
+
Confirm CHANNEL_OPEN request. +

+

+
Specified by:
confirm in interface Channel.Forwarded
+
+
+ +
Throws: +
TransportException - error sending confirmation packet
+
+
+
+ +

+reject

+
+public void reject(OpenFailException.Reason reason,
+                   String message)
+            throws TransportException
+
+
Description copied from interface: Channel.Forwarded
+
Indicate rejection to remote end. +

+

+
Specified by:
reject in interface Channel.Forwarded
+
+
+
Parameters:
reason - indicate reason for rejection of the request
message - indicate a message for why the request is rejected +
Throws: +
TransportException - error sending rejection packet
+
+
+
+ +

+getOriginatorIP

+
+public String getOriginatorIP()
+
+
+
Specified by:
getOriginatorIP in interface Channel.Forwarded
+
+
+ +
Returns:
the IP of where the forwarded connection originates.
+
+
+
+ +

+getOriginatorPort

+
+public int getOriginatorPort()
+
+
+
Specified by:
getOriginatorPort in interface Channel.Forwarded
+
+
+ +
Returns:
port from which the forwarded connection originates.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/AbstractForwardedChannelOpener.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/AbstractForwardedChannelOpener.html new file mode 100644 index 00000000..23bfaf0c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/AbstractForwardedChannelOpener.html @@ -0,0 +1,380 @@ + + + + + + + +AbstractForwardedChannelOpener (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.forwarded +
+Class AbstractForwardedChannelOpener

+
+java.lang.Object
+  extended by net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannelOpener
+
+
+
All Implemented Interfaces:
ForwardedChannelOpener
+
+
+
Direct Known Subclasses:
RemotePortForwarder, X11Forwarder
+
+
+
+
public abstract class AbstractForwardedChannelOpener
extends Object
implements ForwardedChannelOpener
+ + +

+Base class for ForwardedChannelOpener's. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + +
+Field Summary
+protected  StringchanType + +
+           
+protected  Connectionconn + +
+           
+protected  org.slf4j.Loggerlog + +
+           
+  + + + + + + + + + + + +
+Constructor Summary
+protected AbstractForwardedChannelOpener(String chanType, + Connection conn) + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+protected  voidcallListener(ConnectListener listener, + Channel.Forwarded chan) + +
+          Calls the listener with the new channel in a separate thread.
+ StringgetChannelType() + +
+          Returns the name of the channel type this opener can next.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.connection.channel.forwarded.ForwardedChannelOpener
handleOpen
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+protected final org.slf4j.Logger log
+
+
+
+
+
+ +

+chanType

+
+protected final String chanType
+
+
+
+
+
+ +

+conn

+
+protected final Connection conn
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+AbstractForwardedChannelOpener

+
+protected AbstractForwardedChannelOpener(String chanType,
+                                         Connection conn)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getChannelType

+
+public String getChannelType()
+
+
Description copied from interface: ForwardedChannelOpener
+
Returns the name of the channel type this opener can next. +

+

+
Specified by:
getChannelType in interface ForwardedChannelOpener
+
+
+
+
+
+
+ +

+callListener

+
+protected void callListener(ConnectListener listener,
+                            Channel.Forwarded chan)
+
+
Calls the listener with the new channel in a separate thread. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/ConnectListener.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/ConnectListener.html new file mode 100644 index 00000000..f601ffff --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/ConnectListener.html @@ -0,0 +1,220 @@ + + + + + + + +ConnectListener (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.forwarded +
+Interface ConnectListener

+
+
All Known Implementing Classes:
SocketForwardingConnectListener
+
+
+
+
public interface ConnectListener
+ + +

+A connect listener is just that: it listens for new forwarded channels and can be delegated charge of them. +

+ +

+


+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidgotConnect(Channel.Forwarded chan) + +
+          Notify this listener of a new forwarded channel.
+  +

+ + + + + + + + +
+Method Detail
+ +

+gotConnect

+
+void gotConnect(Channel.Forwarded chan)
+                throws IOException
+
+
Notify this listener of a new forwarded channel. An implementation should firstly confirm or reject that + channel. +

+

+
Parameters:
chan - the forwarded channel +
Throws: +
IOException - if there is a problem handling the channel
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/ForwardedChannelOpener.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/ForwardedChannelOpener.html new file mode 100644 index 00000000..42043825 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/ForwardedChannelOpener.html @@ -0,0 +1,242 @@ + + + + + + + +ForwardedChannelOpener (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.forwarded +
+Interface ForwardedChannelOpener

+
+
All Known Implementing Classes:
AbstractForwardedChannelOpener, RemotePortForwarder, X11Forwarder
+
+
+
+
public interface ForwardedChannelOpener
+ + +

+Takes care of handling SSH_MSG_CHANNEL_OPEN requests for forwarded channels of a specific type. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ StringgetChannelType() + +
+          Returns the name of the channel type this opener can next.
+ voidhandleOpen(SSHPacket buf) + +
+          Delegates a SSH_MSG_CHANNEL_OPEN request for the channel type claimed by this opener.
+  +

+ + + + + + + + +
+Method Detail
+ +

+getChannelType

+
+String getChannelType()
+
+
Returns the name of the channel type this opener can next. +

+

+
+
+
+
+ +

+handleOpen

+
+void handleOpen(SSHPacket buf)
+                throws ConnectionException,
+                       TransportException
+
+
Delegates a SSH_MSG_CHANNEL_OPEN request for the channel type claimed by this opener. +

+

+
Parameters:
buf - SSHPacket containg the request except for the message identifier and channel type field +
Throws: +
ConnectionException +
TransportException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/RemotePortForwarder.Forward.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/RemotePortForwarder.Forward.html new file mode 100644 index 00000000..c6356234 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/RemotePortForwarder.Forward.html @@ -0,0 +1,410 @@ + + + + + + + +RemotePortForwarder.Forward (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.forwarded +
+Class RemotePortForwarder.Forward

+
+java.lang.Object
+  extended by net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder.Forward
+
+
+
Enclosing class:
RemotePortForwarder
+
+
+
+
public static final class RemotePortForwarder.Forward
extends Object
+ + +

+Represents a particular forwarding. From RFC 4254, s. 7.1 +

+

+    The 'address to bind' and 'port number to bind' specify the IP
+    address (or domain name) and port on which connections for forwarding
+    are to be accepted.  Some strings used for 'address to bind' have
+    special-case semantics.
+ 

+ o "" means that connections are to be accepted on all protocol + families supported by the SSH implementation. +

+ o "0.0.0.0" means to listen on all IPv4 addresses. +

+ o "::" means to listen on all IPv6 addresses. +

+ o "localhost" means to listen on all protocol families supported by + the SSH implementation on loopback addresses only ([RFC3330] and + [RFC3513]). +

+ o "127.0.0.1" and "::1" indicate listening on the loopback + interfaces for IPv4 and IPv6, respectively. +

+

+ +

+


+ +

+ + + + + + + + + + + + + + + + + +
+Constructor Summary
RemotePortForwarder.Forward(int port) + +
+          Creates this forward with address as "" and specified port.
RemotePortForwarder.Forward(String address) + +
+          Creates this forward with specified address and port as 0.
RemotePortForwarder.Forward(String address, + int port) + +
+          Creates this forward with specified address and port number.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(Object obj) + +
+           
+ StringgetAddress() + +
+           
+ intgetPort() + +
+           
+ inthashCode() + +
+           
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+RemotePortForwarder.Forward

+
+public RemotePortForwarder.Forward(int port)
+
+
Creates this forward with address as "" and specified port. +

+

+
Parameters:
port -
+
+
+ +

+RemotePortForwarder.Forward

+
+public RemotePortForwarder.Forward(String address)
+
+
Creates this forward with specified address and port as 0. +

+

+
Parameters:
address -
+
+
+ +

+RemotePortForwarder.Forward

+
+public RemotePortForwarder.Forward(String address,
+                                   int port)
+
+
Creates this forward with specified address and port number. +

+

+
Parameters:
address - address to bind
port - port number
+
+ + + + + + + + +
+Method Detail
+ +

+equals

+
+public boolean equals(Object obj)
+
+
+
Overrides:
equals in class Object
+
+
+
+
+
+
+ +

+getAddress

+
+public String getAddress()
+
+
+ +
Returns:
the address represented by this forward.
+
+
+
+ +

+getPort

+
+public int getPort()
+
+
+ +
Returns:
the port represented by this forward.
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class Object
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/RemotePortForwarder.ForwardedTCPIPChannel.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/RemotePortForwarder.ForwardedTCPIPChannel.html new file mode 100644 index 00000000..c7fe3a66 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/RemotePortForwarder.ForwardedTCPIPChannel.html @@ -0,0 +1,406 @@ + + + + + + + +RemotePortForwarder.ForwardedTCPIPChannel (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.forwarded +
+Class RemotePortForwarder.ForwardedTCPIPChannel

+
+java.lang.Object
+  extended by net.schmizz.sshj.connection.channel.AbstractChannel
+      extended by net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannel
+          extended by net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder.ForwardedTCPIPChannel
+
+
+
All Implemented Interfaces:
Closeable, ErrorNotifiable, SSHPacketHandler, Channel, Channel.Forwarded
+
+
+
Enclosing class:
RemotePortForwarder
+
+
+
+
public static class RemotePortForwarder.ForwardedTCPIPChannel
extends AbstractForwardedChannel
+ + +

+A forwarded-tcpip channel. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.connection.channel.Channel
Channel.Direct, Channel.Forwarded
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable
ErrorNotifiable.Util
+  + + + + + + + + + + + +
+Field Summary
+static StringTYPE + +
+           
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannel
origIP, origPort
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.connection.channel.AbstractChannel
close, conn, log, lwin, open, rwin, trans
+  + + + + + + + + + + +
+Constructor Summary
RemotePortForwarder.ForwardedTCPIPChannel(Connection conn, + int recipient, + int remoteWinSize, + int remoteMaxPacketSize, + RemotePortForwarder.Forward fwd, + String origIP, + int origPort) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ RemotePortForwarder.ForwardgetParentForward() + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannel
confirm, getOriginatorIP, getOriginatorPort, reject
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.connection.channel.AbstractChannel
close, closeAllStreams, eofInputStreams, finishOff, getAutoExpand, getID, getInputStream, getLocalMaxPacketSize, getLocalWinSize, getOutputStream, getRecipient, getRemoteMaxPacketSize, getRemoteWinSize, getType, gotExtendedData, gotUnknown, handle, handleRequest, init, isOpen, join, join, newBuffer, notifyError, receiveInto, sendChannelRequest, sendClose, sendEOF, setAutoExpand, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.connection.channel.Channel
close, getAutoExpand, getID, getInputStream, getLocalMaxPacketSize, getLocalWinSize, getOutputStream, getRecipient, getRemoteMaxPacketSize, getRemoteWinSize, getType, isOpen, join, join, sendEOF, setAutoExpand
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.SSHPacketHandler
handle
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.ErrorNotifiable
notifyError
+  +

+ + + + + + + + +
+Field Detail
+ +

+TYPE

+
+public static final String TYPE
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+RemotePortForwarder.ForwardedTCPIPChannel

+
+public RemotePortForwarder.ForwardedTCPIPChannel(Connection conn,
+                                                 int recipient,
+                                                 int remoteWinSize,
+                                                 int remoteMaxPacketSize,
+                                                 RemotePortForwarder.Forward fwd,
+                                                 String origIP,
+                                                 int origPort)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getParentForward

+
+public RemotePortForwarder.Forward getParentForward()
+
+
+ +
Returns:
the forwarding from which this channel originates.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/RemotePortForwarder.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/RemotePortForwarder.html new file mode 100644 index 00000000..d6ddfc27 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/RemotePortForwarder.html @@ -0,0 +1,489 @@ + + + + + + + +RemotePortForwarder (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.forwarded +
+Class RemotePortForwarder

+
+java.lang.Object
+  extended by net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannelOpener
+      extended by net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder
+
+
+
All Implemented Interfaces:
ForwardedChannelOpener
+
+
+
+
public class RemotePortForwarder
extends AbstractForwardedChannelOpener
+ + +

+Handles remote port forwarding. +

+ +

+


+ +

+ + + + + + + + + + + + + + + +
+Nested Class Summary
+static classRemotePortForwarder.Forward + +
+          Represents a particular forwarding.
+static classRemotePortForwarder.ForwardedTCPIPChannel + +
+          A forwarded-tcpip channel.
+ + + + + + + + + + + + + + + + + + +
+Field Summary
+protected  Map<RemotePortForwarder.Forward,ConnectListener>listeners + +
+           
+protected static StringPF_CANCEL + +
+           
+protected static StringPF_REQ + +
+           
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannelOpener
chanType, conn, log
+  + + + + + + + + + + +
+Constructor Summary
RemotePortForwarder(Connection conn) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ RemotePortForwarder.Forwardbind(RemotePortForwarder.Forward forward, + ConnectListener listener) + +
+          Request forwarding from the remote host on the specified RemotePortForwarder.Forward.
+ voidcancel(RemotePortForwarder.Forward forward) + +
+          Request cancellation of some forwarding.
+ Set<RemotePortForwarder.Forward>getActiveForwards() + +
+           
+ voidhandleOpen(SSHPacket buf) + +
+          Internal API.
+protected  SSHPacketreq(String reqName, + RemotePortForwarder.Forward forward) + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannelOpener
callListener, getChannelType
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+PF_REQ

+
+protected static final String PF_REQ
+
+
+
See Also:
Constant Field Values
+
+
+ +

+PF_CANCEL

+
+protected static final String PF_CANCEL
+
+
+
See Also:
Constant Field Values
+
+
+ +

+listeners

+
+protected final Map<RemotePortForwarder.Forward,ConnectListener> listeners
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+RemotePortForwarder

+
+public RemotePortForwarder(Connection conn)
+
+
+ + + + + + + + +
+Method Detail
+ +

+bind

+
+public RemotePortForwarder.Forward bind(RemotePortForwarder.Forward forward,
+                                        ConnectListener listener)
+                                 throws ConnectionException,
+                                        TransportException
+
+
Request forwarding from the remote host on the specified RemotePortForwarder.Forward. Forwarded connections will be handled + by supplied listener. +

+ If forward specifies as 0, the returned forward will have the correct port number as informed by remote + host. +

+

+
Parameters:
forward - the RemotePortForwarder.Forward to put in place on remote host
listener - the listener which will next forwarded connection +
Returns:
the RemotePortForwarder.Forward which was put into place on the remote host +
Throws: +
ConnectionException - if there is an error requesting the forwarding +
TransportException
+
+
+
+ +

+cancel

+
+public void cancel(RemotePortForwarder.Forward forward)
+            throws ConnectionException,
+                   TransportException
+
+
Request cancellation of some forwarding. +

+

+
Parameters:
forward - the forward which is being cancelled +
Throws: +
ConnectionException - if there is an error with the cancellation request +
TransportException
+
+
+
+ +

+req

+
+protected SSHPacket req(String reqName,
+                        RemotePortForwarder.Forward forward)
+                 throws ConnectionException,
+                        TransportException
+
+
+ +
Throws: +
ConnectionException +
TransportException
+
+
+
+ +

+getActiveForwards

+
+public Set<RemotePortForwarder.Forward> getActiveForwards()
+
+
+ +
Returns:
the active forwards.
+
+
+
+ +

+handleOpen

+
+public void handleOpen(SSHPacket buf)
+                throws ConnectionException,
+                       TransportException
+
+
Internal API. Creates a RemotePortForwarder.ForwardedTCPIPChannel from the CHANNEL_OPEN request and calls associated + ConnectListener for that forward in a separate thread. +

+

+
Parameters:
buf - SSHPacket containg the request except for the message identifier and channel type field +
Throws: +
ConnectionException +
TransportException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/SocketForwardingConnectListener.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/SocketForwardingConnectListener.html new file mode 100644 index 00000000..7075f39d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/SocketForwardingConnectListener.html @@ -0,0 +1,324 @@ + + + + + + + +SocketForwardingConnectListener (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.forwarded +
+Class SocketForwardingConnectListener

+
+java.lang.Object
+  extended by net.schmizz.sshj.connection.channel.forwarded.SocketForwardingConnectListener
+
+
+
All Implemented Interfaces:
ConnectListener
+
+
+
+
public class SocketForwardingConnectListener
extends Object
implements ConnectListener
+ + +

+A ConnectListener that forwards what is received over the channel to a socket and vice-versa. +

+ +

+


+ +

+ + + + + + + + + + + + + + + +
+Field Summary
+protected  SocketAddressaddr + +
+           
+protected  org.slf4j.Loggerlog + +
+           
+  + + + + + + + + + + +
+Constructor Summary
SocketForwardingConnectListener(SocketAddress addr) + +
+          Create with a SocketAddress this listener will forward to.
+  + + + + + + + + + + + +
+Method Summary
+ voidgotConnect(Channel.Forwarded chan) + +
+          On connect, confirm the channel and start forwarding.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+protected final org.slf4j.Logger log
+
+
+
+
+
+ +

+addr

+
+protected final SocketAddress addr
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+SocketForwardingConnectListener

+
+public SocketForwardingConnectListener(SocketAddress addr)
+
+
Create with a SocketAddress this listener will forward to. +

+

+ + + + + + + + +
+Method Detail
+ +

+gotConnect

+
+public void gotConnect(Channel.Forwarded chan)
+                throws IOException
+
+
On connect, confirm the channel and start forwarding. +

+

+
Specified by:
gotConnect in interface ConnectListener
+
+
+
Parameters:
chan - the forwarded channel +
Throws: +
IOException - if there is a problem handling the channel
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/X11Forwarder.X11Channel.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/X11Forwarder.X11Channel.html new file mode 100644 index 00000000..a2350dd5 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/X11Forwarder.X11Channel.html @@ -0,0 +1,375 @@ + + + + + + + +X11Forwarder.X11Channel (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.forwarded +
+Class X11Forwarder.X11Channel

+
+java.lang.Object
+  extended by net.schmizz.sshj.connection.channel.AbstractChannel
+      extended by net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannel
+          extended by net.schmizz.sshj.connection.channel.forwarded.X11Forwarder.X11Channel
+
+
+
All Implemented Interfaces:
Closeable, ErrorNotifiable, SSHPacketHandler, Channel, Channel.Forwarded
+
+
+
Enclosing class:
X11Forwarder
+
+
+
+
public static class X11Forwarder.X11Channel
extends AbstractForwardedChannel
+ + +

+An x11 forwarded channel. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.connection.channel.Channel
Channel.Direct, Channel.Forwarded
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable
ErrorNotifiable.Util
+  + + + + + + + + + + + +
+Field Summary
+static StringTYPE + +
+           
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannel
origIP, origPort
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.connection.channel.AbstractChannel
close, conn, log, lwin, open, rwin, trans
+  + + + + + + + + + + +
+Constructor Summary
X11Forwarder.X11Channel(Connection conn, + int recipient, + int remoteWinSize, + int remoteMaxPacketSize, + String origIP, + int origPort) + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannel
confirm, getOriginatorIP, getOriginatorPort, reject
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.connection.channel.AbstractChannel
close, closeAllStreams, eofInputStreams, finishOff, getAutoExpand, getID, getInputStream, getLocalMaxPacketSize, getLocalWinSize, getOutputStream, getRecipient, getRemoteMaxPacketSize, getRemoteWinSize, getType, gotExtendedData, gotUnknown, handle, handleRequest, init, isOpen, join, join, newBuffer, notifyError, receiveInto, sendChannelRequest, sendClose, sendEOF, setAutoExpand, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.connection.channel.Channel
close, getAutoExpand, getID, getInputStream, getLocalMaxPacketSize, getLocalWinSize, getOutputStream, getRecipient, getRemoteMaxPacketSize, getRemoteWinSize, getType, isOpen, join, join, sendEOF, setAutoExpand
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.SSHPacketHandler
handle
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.ErrorNotifiable
notifyError
+  +

+ + + + + + + + +
+Field Detail
+ +

+TYPE

+
+public static final String TYPE
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+X11Forwarder.X11Channel

+
+public X11Forwarder.X11Channel(Connection conn,
+                               int recipient,
+                               int remoteWinSize,
+                               int remoteMaxPacketSize,
+                               String origIP,
+                               int origPort)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/X11Forwarder.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/X11Forwarder.html new file mode 100644 index 00000000..42690d00 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/X11Forwarder.html @@ -0,0 +1,337 @@ + + + + + + + +X11Forwarder (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.connection.channel.forwarded +
+Class X11Forwarder

+
+java.lang.Object
+  extended by net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannelOpener
+      extended by net.schmizz.sshj.connection.channel.forwarded.X11Forwarder
+
+
+
All Implemented Interfaces:
ForwardedChannelOpener
+
+
+
+
public class X11Forwarder
extends AbstractForwardedChannelOpener
+ + +

+Handles forwarded x11 channels. The actual request to forward X11 should be made from the specific Session. +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classX11Forwarder.X11Channel + +
+          An x11 forwarded channel.
+ + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannelOpener
chanType, conn, log
+  + + + + + + + + + + +
+Constructor Summary
X11Forwarder(Connection conn, + ConnectListener listener) + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidhandleOpen(SSHPacket buf) + +
+          Internal API
+ voidstop() + +
+          Stop handling x11 channel open requests.
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannelOpener
callListener, getChannelType
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+X11Forwarder

+
+public X11Forwarder(Connection conn,
+                    ConnectListener listener)
+
+
+
Parameters:
conn - connection layer
listener - listener which will be delegated X11Forwarder.X11Channel's to next
+
+ + + + + + + + +
+Method Detail
+ +

+handleOpen

+
+public void handleOpen(SSHPacket buf)
+                throws ConnectionException,
+                       TransportException
+
+
Internal API +

+

+
Parameters:
buf - SSHPacket containg the request except for the message identifier and channel type field +
Throws: +
ConnectionException +
TransportException
+
+
+
+ +

+stop

+
+public void stop()
+
+
Stop handling x11 channel open requests. De-registers itself with connection layer. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/AbstractForwardedChannel.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/AbstractForwardedChannel.html new file mode 100644 index 00000000..c9834ea7 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/AbstractForwardedChannel.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannel (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannel

+
+ + + + + + + + + +
+Packages that use AbstractForwardedChannel
net.schmizz.sshj.connection.channel.forwarded  
+  +

+ + + + + +
+Uses of AbstractForwardedChannel in net.schmizz.sshj.connection.channel.forwarded
+  +

+ + + + + + + + + + + + + +
Subclasses of AbstractForwardedChannel in net.schmizz.sshj.connection.channel.forwarded
+static classRemotePortForwarder.ForwardedTCPIPChannel + +
+          A forwarded-tcpip channel.
+static classX11Forwarder.X11Channel + +
+          An x11 forwarded channel.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/AbstractForwardedChannelOpener.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/AbstractForwardedChannelOpener.html new file mode 100644 index 00000000..9ca7961d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/AbstractForwardedChannelOpener.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannelOpener (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.forwarded.AbstractForwardedChannelOpener

+
+ + + + + + + + + +
+Packages that use AbstractForwardedChannelOpener
net.schmizz.sshj.connection.channel.forwarded  
+  +

+ + + + + +
+Uses of AbstractForwardedChannelOpener in net.schmizz.sshj.connection.channel.forwarded
+  +

+ + + + + + + + + + + + + +
Subclasses of AbstractForwardedChannelOpener in net.schmizz.sshj.connection.channel.forwarded
+ classRemotePortForwarder + +
+          Handles remote port forwarding.
+ classX11Forwarder + +
+          Handles forwarded x11 channels.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/ConnectListener.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/ConnectListener.html new file mode 100644 index 00000000..7ccfdf1b --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/ConnectListener.html @@ -0,0 +1,267 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.connection.channel.forwarded.ConnectListener (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.connection.channel.forwarded.ConnectListener

+
+ + + + + + + + + + + + + +
+Packages that use ConnectListener
net.schmizz.sshj  
net.schmizz.sshj.connection.channel.forwarded  
+  +

+ + + + + +
+Uses of ConnectListener in net.schmizz.sshj
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj with parameters of type ConnectListener
+ X11ForwarderSSHClient.registerX11Forwarder(ConnectListener listener) + +
+          Register a listener for handling forwarded X11 channels.
+  +

+ + + + + +
+Uses of ConnectListener in net.schmizz.sshj.connection.channel.forwarded
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.connection.channel.forwarded that implement ConnectListener
+ classSocketForwardingConnectListener + +
+          A ConnectListener that forwards what is received over the channel to a socket and vice-versa.
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.connection.channel.forwarded with type parameters of type ConnectListener
+protected  Map<RemotePortForwarder.Forward,ConnectListener>RemotePortForwarder.listeners + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.forwarded with parameters of type ConnectListener
+ RemotePortForwarder.ForwardRemotePortForwarder.bind(RemotePortForwarder.Forward forward, + ConnectListener listener) + +
+          Request forwarding from the remote host on the specified RemotePortForwarder.Forward.
+protected  voidAbstractForwardedChannelOpener.callListener(ConnectListener listener, + Channel.Forwarded chan) + +
+          Calls the listener with the new channel in a separate thread.
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.connection.channel.forwarded with parameters of type ConnectListener
X11Forwarder(Connection conn, + ConnectListener listener) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/ForwardedChannelOpener.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/ForwardedChannelOpener.html new file mode 100644 index 00000000..7e84865b --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/ForwardedChannelOpener.html @@ -0,0 +1,274 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.connection.channel.forwarded.ForwardedChannelOpener (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.connection.channel.forwarded.ForwardedChannelOpener

+
+ + + + + + + + + + + + + +
+Packages that use ForwardedChannelOpener
net.schmizz.sshj.connection  
net.schmizz.sshj.connection.channel.forwarded  
+  +

+ + + + + +
+Uses of ForwardedChannelOpener in net.schmizz.sshj.connection
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection that return ForwardedChannelOpener
+ ForwardedChannelOpenerConnectionImpl.get(String chanType) + +
+           
+ ForwardedChannelOpenerConnection.get(String chanType) + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection with parameters of type ForwardedChannelOpener
+ voidConnectionImpl.attach(ForwardedChannelOpener opener) + +
+           
+ voidConnection.attach(ForwardedChannelOpener opener) + +
+          Attach a ForwardedChannelOpener to this connection, which will be delegated opening of any CHANNEL_OPEN packets for which it is responsible.
+ voidConnectionImpl.forget(ForwardedChannelOpener opener) + +
+           
+ voidConnection.forget(ForwardedChannelOpener opener) + +
+          Forget an attached ForwardedChannelOpener.
+  +

+ + + + + +
+Uses of ForwardedChannelOpener in net.schmizz.sshj.connection.channel.forwarded
+  +

+ + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.connection.channel.forwarded that implement ForwardedChannelOpener
+ classAbstractForwardedChannelOpener + +
+          Base class for ForwardedChannelOpener's.
+ classRemotePortForwarder + +
+          Handles remote port forwarding.
+ classX11Forwarder + +
+          Handles forwarded x11 channels.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/RemotePortForwarder.Forward.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/RemotePortForwarder.Forward.html new file mode 100644 index 00000000..7a790ed7 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/RemotePortForwarder.Forward.html @@ -0,0 +1,276 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder.Forward (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder.Forward

+
+ + + + + + + + + +
+Packages that use RemotePortForwarder.Forward
net.schmizz.sshj.connection.channel.forwarded  
+  +

+ + + + + +
+Uses of RemotePortForwarder.Forward in net.schmizz.sshj.connection.channel.forwarded
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.connection.channel.forwarded with type parameters of type RemotePortForwarder.Forward
+protected  Map<RemotePortForwarder.Forward,ConnectListener>RemotePortForwarder.listeners + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.forwarded that return RemotePortForwarder.Forward
+ RemotePortForwarder.ForwardRemotePortForwarder.bind(RemotePortForwarder.Forward forward, + ConnectListener listener) + +
+          Request forwarding from the remote host on the specified RemotePortForwarder.Forward.
+ RemotePortForwarder.ForwardRemotePortForwarder.ForwardedTCPIPChannel.getParentForward() + +
+           
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.forwarded that return types with arguments of type RemotePortForwarder.Forward
+ Set<RemotePortForwarder.Forward>RemotePortForwarder.getActiveForwards() + +
+           
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.forwarded with parameters of type RemotePortForwarder.Forward
+ RemotePortForwarder.ForwardRemotePortForwarder.bind(RemotePortForwarder.Forward forward, + ConnectListener listener) + +
+          Request forwarding from the remote host on the specified RemotePortForwarder.Forward.
+ voidRemotePortForwarder.cancel(RemotePortForwarder.Forward forward) + +
+          Request cancellation of some forwarding.
+protected  SSHPacketRemotePortForwarder.req(String reqName, + RemotePortForwarder.Forward forward) + +
+           
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.connection.channel.forwarded with parameters of type RemotePortForwarder.Forward
RemotePortForwarder.ForwardedTCPIPChannel(Connection conn, + int recipient, + int remoteWinSize, + int remoteMaxPacketSize, + RemotePortForwarder.Forward fwd, + String origIP, + int origPort) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/RemotePortForwarder.ForwardedTCPIPChannel.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/RemotePortForwarder.ForwardedTCPIPChannel.html new file mode 100644 index 00000000..e1e8ded3 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/RemotePortForwarder.ForwardedTCPIPChannel.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder.ForwardedTCPIPChannel (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder.ForwardedTCPIPChannel

+
+No usage of net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder.ForwardedTCPIPChannel +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/RemotePortForwarder.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/RemotePortForwarder.html new file mode 100644 index 00000000..88fff1bd --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/RemotePortForwarder.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.forwarded.RemotePortForwarder

+
+ + + + + + + + + +
+Packages that use RemotePortForwarder
net.schmizz.sshj  
+  +

+ + + + + +
+Uses of RemotePortForwarder in net.schmizz.sshj
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj that return RemotePortForwarder
+ RemotePortForwarderSSHClient.getRemotePortForwarder() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/SocketForwardingConnectListener.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/SocketForwardingConnectListener.html new file mode 100644 index 00000000..1c7a4d0b --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/SocketForwardingConnectListener.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.forwarded.SocketForwardingConnectListener (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.forwarded.SocketForwardingConnectListener

+
+No usage of net.schmizz.sshj.connection.channel.forwarded.SocketForwardingConnectListener +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/X11Forwarder.X11Channel.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/X11Forwarder.X11Channel.html new file mode 100644 index 00000000..e6f6df6c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/X11Forwarder.X11Channel.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.forwarded.X11Forwarder.X11Channel (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.forwarded.X11Forwarder.X11Channel

+
+No usage of net.schmizz.sshj.connection.channel.forwarded.X11Forwarder.X11Channel +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/X11Forwarder.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/X11Forwarder.html new file mode 100644 index 00000000..3f8d6cdf --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/class-use/X11Forwarder.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.channel.forwarded.X11Forwarder (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.channel.forwarded.X11Forwarder

+
+ + + + + + + + + +
+Packages that use X11Forwarder
net.schmizz.sshj  
+  +

+ + + + + +
+Uses of X11Forwarder in net.schmizz.sshj
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj that return X11Forwarder
+ X11ForwarderSSHClient.registerX11Forwarder(ConnectListener listener) + +
+          Register a listener for handling forwarded X11 channels.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/package-frame.html new file mode 100644 index 00000000..a4a53b03 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/package-frame.html @@ -0,0 +1,60 @@ + + + + + + + +net.schmizz.sshj.connection.channel.forwarded (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.connection.channel.forwarded + + + + +
+Interfaces  + +
+ConnectListener +
+ForwardedChannelOpener
+ + + + + + +
+Classes  + +
+AbstractForwardedChannel +
+AbstractForwardedChannelOpener +
+RemotePortForwarder +
+RemotePortForwarder.Forward +
+RemotePortForwarder.ForwardedTCPIPChannel +
+SocketForwardingConnectListener +
+X11Forwarder +
+X11Forwarder.X11Channel
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/package-summary.html new file mode 100644 index 00000000..08b93b6d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/package-summary.html @@ -0,0 +1,204 @@ + + + + + + + +net.schmizz.sshj.connection.channel.forwarded (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.connection.channel.forwarded +

+ + + + + + + + + + + + + +
+Interface Summary
ConnectListenerA connect listener is just that: it listens for new forwarded channels and can be delegated charge of them.
ForwardedChannelOpenerTakes care of handling SSH_MSG_CHANNEL_OPEN requests for forwarded channels of a specific type.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
AbstractForwardedChannelBase class for forwarded channels whose open is initiated by the server.
AbstractForwardedChannelOpenerBase class for ForwardedChannelOpener's.
RemotePortForwarderHandles remote port forwarding.
RemotePortForwarder.ForwardRepresents a particular forwarding.
RemotePortForwarder.ForwardedTCPIPChannelA forwarded-tcpip channel.
SocketForwardingConnectListenerA ConnectListener that forwards what is received over the channel to a socket and vice-versa.
X11ForwarderHandles forwarded x11 channels.
X11Forwarder.X11ChannelAn x11 forwarded channel.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/package-tree.html new file mode 100644 index 00000000..2f991386 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/package-tree.html @@ -0,0 +1,169 @@ + + + + + + + +net.schmizz.sshj.connection.channel.forwarded Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.connection.channel.forwarded +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/package-use.html new file mode 100644 index 00000000..685b7628 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/forwarded/package-use.html @@ -0,0 +1,245 @@ + + + + + + + +Uses of Package net.schmizz.sshj.connection.channel.forwarded (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.connection.channel.forwarded

+
+ + + + + + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.connection.channel.forwarded
net.schmizz.sshj  
net.schmizz.sshj.connection  
net.schmizz.sshj.connection.channel.forwarded  
+  +

+ + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.connection.channel.forwarded used by net.schmizz.sshj
ConnectListener + +
+          A connect listener is just that: it listens for new forwarded channels and can be delegated charge of them.
RemotePortForwarder + +
+          Handles remote port forwarding.
X11Forwarder + +
+          Handles forwarded x11 channels.
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.connection.channel.forwarded used by net.schmizz.sshj.connection
ForwardedChannelOpener + +
+          Takes care of handling SSH_MSG_CHANNEL_OPEN requests for forwarded channels of a specific type.
+  +

+ + + + + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.connection.channel.forwarded used by net.schmizz.sshj.connection.channel.forwarded
AbstractForwardedChannel + +
+          Base class for forwarded channels whose open is initiated by the server.
AbstractForwardedChannelOpener + +
+          Base class for ForwardedChannelOpener's.
ConnectListener + +
+          A connect listener is just that: it listens for new forwarded channels and can be delegated charge of them.
ForwardedChannelOpener + +
+          Takes care of handling SSH_MSG_CHANNEL_OPEN requests for forwarded channels of a specific type.
RemotePortForwarder.Forward + +
+          Represents a particular forwarding.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/package-frame.html new file mode 100644 index 00000000..33fb44f0 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/package-frame.html @@ -0,0 +1,82 @@ + + + + + + + +net.schmizz.sshj.connection.channel (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.connection.channel + + + + +
+Interfaces  + +
+Channel +
+Channel.Direct +
+Channel.Forwarded
+ + + + + + +
+Classes  + +
+AbstractChannel +
+ChannelInputStream +
+ChannelOutputStream +
+SocketStreamCopyMonitor +
+Window +
+Window.Local +
+Window.Remote
+ + + + + + +
+Enums  + +
+OpenFailException.Reason
+ + + + + + +
+Exceptions  + +
+OpenFailException
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/package-summary.html new file mode 100644 index 00000000..9e85f8e4 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/package-summary.html @@ -0,0 +1,232 @@ + + + + + + + +net.schmizz.sshj.connection.channel (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.connection.channel +

+ + + + + + + + + + + + + + + + + +
+Interface Summary
ChannelA channel is the basic medium for application-layer data on top of an SSH transport.
Channel.DirectDirect channels are those that are initiated by us.
Channel.ForwardedForwarded channels are those that are initiated by the server.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
AbstractChannel 
ChannelInputStreamInputStream for channels.
ChannelOutputStreamOutputStream for channels.
SocketStreamCopyMonitor 
Window 
Window.LocalControls how much data remote end can send before an adjustment notification from us is required.
Window.RemoteControls how much data we can send before an adjustment notification from remote end is required.
+  + +

+ + + + + + + + + +
+Enum Summary
OpenFailException.Reason 
+  + +

+ + + + + + + + + +
+Exception Summary
OpenFailException 
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/package-tree.html new file mode 100644 index 00000000..b921856f --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/package-tree.html @@ -0,0 +1,209 @@ + + + + + + + +net.schmizz.sshj.connection.channel Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.connection.channel +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/channel/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/package-use.html new file mode 100644 index 00000000..f35a56c1 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/channel/package-use.html @@ -0,0 +1,294 @@ + + + + + + + +Uses of Package net.schmizz.sshj.connection.channel (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.connection.channel

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.connection.channel
net.schmizz.sshj.connection  
net.schmizz.sshj.connection.channel  
net.schmizz.sshj.connection.channel.direct  
net.schmizz.sshj.connection.channel.forwarded  
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.connection.channel used by net.schmizz.sshj.connection
Channel + +
+          A channel is the basic medium for application-layer data on top of an SSH transport.
OpenFailException.Reason + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.connection.channel used by net.schmizz.sshj.connection.channel
Channel + +
+          A channel is the basic medium for application-layer data on top of an SSH transport.
ChannelInputStream + +
+          InputStream for channels.
OpenFailException.Reason + +
+           
Window + +
+           
Window.Local + +
+          Controls how much data remote end can send before an adjustment notification from us is required.
Window.Remote + +
+          Controls how much data we can send before an adjustment notification from remote end is required.
+  +

+ + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.connection.channel used by net.schmizz.sshj.connection.channel.direct
AbstractChannel + +
+           
Channel + +
+          A channel is the basic medium for application-layer data on top of an SSH transport.
Channel.Direct + +
+          Direct channels are those that are initiated by us.
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.connection.channel used by net.schmizz.sshj.connection.channel.forwarded
AbstractChannel + +
+           
Channel + +
+          A channel is the basic medium for application-layer data on top of an SSH transport.
Channel.Forwarded + +
+          Forwarded channels are those that are initiated by the server.
OpenFailException.Reason + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/class-use/Connection.html b/javadoc/0.4.1/net/schmizz/sshj/connection/class-use/Connection.html new file mode 100644 index 00000000..3dcddf18 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/class-use/Connection.html @@ -0,0 +1,415 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.connection.Connection (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.connection.Connection

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use Connection
net.schmizz.sshj  
net.schmizz.sshj.connection  
net.schmizz.sshj.connection.channel  
net.schmizz.sshj.connection.channel.direct  
net.schmizz.sshj.connection.channel.forwarded  
+  +

+ + + + + +
+Uses of Connection in net.schmizz.sshj
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj declared as Connection
+protected  ConnectionSSHClient.conn + +
+          ssh-connection service
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj that return Connection
+ ConnectionSSHClient.getConnection() + +
+           
+  +

+ + + + + +
+Uses of Connection in net.schmizz.sshj.connection
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.connection that implement Connection
+ classConnectionImpl + +
+          Connection implementation.
+  +

+ + + + + +
+Uses of Connection in net.schmizz.sshj.connection.channel
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.connection.channel declared as Connection
+protected  ConnectionAbstractChannel.conn + +
+          Connection layer
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.connection.channel with parameters of type Connection
AbstractChannel(Connection conn, + String type) + +
+           
+  +

+ + + + + +
+Uses of Connection in net.schmizz.sshj.connection.channel.direct
+  +

+ + + + + + + + + + + + + + + + + +
Constructors in net.schmizz.sshj.connection.channel.direct with parameters of type Connection
AbstractDirectChannel(Connection conn, + String type) + +
+           
LocalPortForwarder(Connection conn, + SocketAddress listeningAddr, + String host, + int port) + +
+          Create a local port forwarder with specified binding (listeningAddr.
LocalPortForwarder(ServerSocketFactory ssf, + Connection conn, + SocketAddress listeningAddr, + String host, + int port) + +
+          Create a local port forwarder with specified binding (listeningAddr.
SessionChannel(Connection conn) + +
+           
+  +

+ + + + + +
+Uses of Connection in net.schmizz.sshj.connection.channel.forwarded
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.connection.channel.forwarded declared as Connection
+protected  ConnectionAbstractForwardedChannelOpener.conn + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + + + +
Constructors in net.schmizz.sshj.connection.channel.forwarded with parameters of type Connection
AbstractForwardedChannel(Connection conn, + String type, + int recipient, + int remoteWinSize, + int remoteMaxPacketSize, + String origIP, + int origPort) + +
+           
AbstractForwardedChannelOpener(String chanType, + Connection conn) + +
+           
RemotePortForwarder.ForwardedTCPIPChannel(Connection conn, + int recipient, + int remoteWinSize, + int remoteMaxPacketSize, + RemotePortForwarder.Forward fwd, + String origIP, + int origPort) + +
+           
RemotePortForwarder(Connection conn) + +
+           
X11Forwarder.X11Channel(Connection conn, + int recipient, + int remoteWinSize, + int remoteMaxPacketSize, + String origIP, + int origPort) + +
+           
X11Forwarder(Connection conn, + ConnectListener listener) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/class-use/ConnectionException.html b/javadoc/0.4.1/net/schmizz/sshj/connection/class-use/ConnectionException.html new file mode 100644 index 00000000..cbe05f6f --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/class-use/ConnectionException.html @@ -0,0 +1,691 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.ConnectionException (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.ConnectionException

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use ConnectionException
net.schmizz.sshj  
net.schmizz.sshj.connection  
net.schmizz.sshj.connection.channel  
net.schmizz.sshj.connection.channel.direct  
net.schmizz.sshj.connection.channel.forwarded  
+  +

+ + + + + +
+Uses of ConnectionException in net.schmizz.sshj
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj that throw ConnectionException
+ SessionSSHClient.startSession() + +
+           
+  +

+ + + + + +
+Uses of ConnectionException in net.schmizz.sshj.connection
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.connection with type parameters of type ConnectionException
+static ExceptionChainer<ConnectionException>ConnectionException.chainer + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection that return types with arguments of type ConnectionException
+ Promise<SSHPacket,ConnectionException>ConnectionImpl.sendGlobalRequest(String name, + boolean wantReply, + byte[] specifics) + +
+           
+ Promise<SSHPacket,ConnectionException>Connection.sendGlobalRequest(String name, + boolean wantReply, + byte[] specifics) + +
+          Send an SSH global request.
+  +

+ + + + + +
+Uses of ConnectionException in net.schmizz.sshj.connection.channel
+  +

+ + + + + + + + + +
Subclasses of ConnectionException in net.schmizz.sshj.connection.channel
+ classOpenFailException + +
+           
+  +

+ + + + + + + + + + + + + +
Fields in net.schmizz.sshj.connection.channel with type parameters of type ConnectionException
+protected  Event<ConnectionException>AbstractChannel.close + +
+          Channel close event
+protected  Event<ConnectionException>AbstractChannel.open + +
+          Channel open event
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel that return types with arguments of type ConnectionException
+protected  Event<ConnectionException>AbstractChannel.sendChannelRequest(String reqType, + boolean wantReply, + Buffer.PlainBuffer reqSpecific) + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel that throw ConnectionException
+ voidChannel.close() + +
+          Close this channel.
+ voidAbstractChannel.close() + +
+           
+protected  voidAbstractChannel.gotExtendedData(SSHPacket buf) + +
+           
+protected  voidAbstractChannel.gotUnknown(Message msg, + SSHPacket buf) + +
+           
+ voidAbstractChannel.handle(Message msg, + SSHPacket buf) + +
+           
+protected  voidAbstractChannel.handleRequest(String reqType, + SSHPacket buf) + +
+           
+ voidChannel.join() + +
+           
+ voidAbstractChannel.join() + +
+           
+ voidChannel.join(int timeout, + TimeUnit unit) + +
+           
+ voidAbstractChannel.join(int timeout, + TimeUnit unit) + +
+           
+ voidChannel.Direct.open() + +
+          Request opening this channel from remote end.
+ voidChannelInputStream.receive(byte[] data, + int offset, + int len) + +
+           
+protected  voidAbstractChannel.receiveInto(ChannelInputStream stream, + SSHPacket buf) + +
+           
+ voidWindow.Remote.waitAndConsume(int howMuch) + +
+           
+  +

+ + + + + +
+Uses of ConnectionException in net.schmizz.sshj.connection.channel.direct
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.direct that throw ConnectionException
+ voidSessionChannel.allocateDefaultPTY() + +
+           
+ voidSession.allocateDefaultPTY() + +
+          Allocates a default PTY.
+ voidSessionChannel.allocatePTY(String term, + int cols, + int rows, + int width, + int height, + Map<PTYMode,Integer> modes) + +
+           
+ voidSession.allocatePTY(String term, + int cols, + int rows, + int width, + int height, + Map<PTYMode,Integer> modes) + +
+          Allocate a psuedo-terminal for this session.
+ Session.CommandSessionChannel.exec(String command) + +
+           
+ Session.CommandSession.exec(String command) + +
+          Execute a remote command.
+protected  voidSessionChannel.gotExtendedData(SSHPacket buf) + +
+           
+protected  voidAbstractDirectChannel.gotUnknown(Message cmd, + SSHPacket buf) + +
+           
+ voidSessionChannel.handleRequest(String req, + SSHPacket buf) + +
+           
+ voidAbstractDirectChannel.open() + +
+           
+ voidSessionChannel.reqX11Forwarding(String authProto, + String authCookie, + int screen) + +
+           
+ voidSession.reqX11Forwarding(String authProto, + String authCookie, + int screen) + +
+          Request X11 forwarding.
+ voidSessionChannel.setEnvVar(String name, + String value) + +
+           
+ voidSession.setEnvVar(String name, + String value) + +
+          Set an enviornment variable.
+ Session.ShellSessionChannel.startShell() + +
+           
+ Session.ShellSession.startShell() + +
+          Request a shell.
+ Session.SubsystemSessionChannel.startSubsystem(String name) + +
+           
+ Session.SubsystemSession.startSubsystem(String name) + +
+          Request a subsystem.
+  +

+ + + + + +
+Uses of ConnectionException in net.schmizz.sshj.connection.channel.forwarded
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.forwarded that throw ConnectionException
+ RemotePortForwarder.ForwardRemotePortForwarder.bind(RemotePortForwarder.Forward forward, + ConnectListener listener) + +
+          Request forwarding from the remote host on the specified RemotePortForwarder.Forward.
+ voidRemotePortForwarder.cancel(RemotePortForwarder.Forward forward) + +
+          Request cancellation of some forwarding.
+ voidX11Forwarder.handleOpen(SSHPacket buf) + +
+          Internal API
+ voidRemotePortForwarder.handleOpen(SSHPacket buf) + +
+          Internal API.
+ voidForwardedChannelOpener.handleOpen(SSHPacket buf) + +
+          Delegates a SSH_MSG_CHANNEL_OPEN request for the channel type claimed by this opener.
+protected  SSHPacketRemotePortForwarder.req(String reqName, + RemotePortForwarder.Forward forward) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/class-use/ConnectionImpl.html b/javadoc/0.4.1/net/schmizz/sshj/connection/class-use/ConnectionImpl.html new file mode 100644 index 00000000..f97fb5bf --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/class-use/ConnectionImpl.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.connection.ConnectionImpl (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.connection.ConnectionImpl

+
+No usage of net.schmizz.sshj.connection.ConnectionImpl +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/connection/package-frame.html new file mode 100644 index 00000000..989fca0e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/package-frame.html @@ -0,0 +1,55 @@ + + + + + + + +net.schmizz.sshj.connection (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.connection + + + + +
+Interfaces  + +
+Connection
+ + + + + + +
+Classes  + +
+ConnectionImpl
+ + + + + + +
+Exceptions  + +
+ConnectionException
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/connection/package-summary.html new file mode 100644 index 00000000..7b64087f --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/package-summary.html @@ -0,0 +1,186 @@ + + + + + + + +net.schmizz.sshj.connection (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.connection +

+ + + + + + + + + +
+Interface Summary
ConnectionConnection layer of the SSH protocol.
+  + +

+ + + + + + + + + +
+Class Summary
ConnectionImplConnection implementation.
+  + +

+ + + + + + + + + +
+Exception Summary
ConnectionExceptionConnection-layer exception.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/connection/package-tree.html new file mode 100644 index 00000000..ed307bb4 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/package-tree.html @@ -0,0 +1,172 @@ + + + + + + + +net.schmizz.sshj.connection Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.connection +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/connection/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/connection/package-use.html new file mode 100644 index 00000000..61fb3444 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/connection/package-use.html @@ -0,0 +1,277 @@ + + + + + + + +Uses of Package net.schmizz.sshj.connection (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.connection

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.connection
net.schmizz.sshj  
net.schmizz.sshj.connection  
net.schmizz.sshj.connection.channel  
net.schmizz.sshj.connection.channel.direct  
net.schmizz.sshj.connection.channel.forwarded  
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.connection used by net.schmizz.sshj
Connection + +
+          Connection layer of the SSH protocol.
ConnectionException + +
+          Connection-layer exception.
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.connection used by net.schmizz.sshj.connection
Connection + +
+          Connection layer of the SSH protocol.
ConnectionException + +
+          Connection-layer exception.
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.connection used by net.schmizz.sshj.connection.channel
Connection + +
+          Connection layer of the SSH protocol.
ConnectionException + +
+          Connection-layer exception.
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.connection used by net.schmizz.sshj.connection.channel.direct
Connection + +
+          Connection layer of the SSH protocol.
ConnectionException + +
+          Connection-layer exception.
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.connection used by net.schmizz.sshj.connection.channel.forwarded
Connection + +
+          Connection layer of the SSH protocol.
ConnectionException + +
+          Connection-layer exception.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/package-frame.html new file mode 100644 index 00000000..0507682b --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/package-frame.html @@ -0,0 +1,54 @@ + + + + + + + +net.schmizz.sshj (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj + + + + +
+Interfaces  + +
+Config +
+Service
+ + + + + + +
+Classes  + +
+AbstractService +
+AndroidConfig +
+ConfigImpl +
+DefaultConfig +
+SSHClient
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/package-summary.html new file mode 100644 index 00000000..74048309 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/package-summary.html @@ -0,0 +1,192 @@ + + + + + + + +net.schmizz.sshj (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj +

+ + + + + + + + + + + + + +
+Interface Summary
ConfigHolds configuration information and factories.
ServiceRepresents a service running on top of the SSH transport layer.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
AbstractServiceAn abstract class for Service that implements common or default functionality.
AndroidConfig 
ConfigImpl 
DefaultConfigA Config that is initialized as follows.
SSHClientSecure SHell client API.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/package-tree.html new file mode 100644 index 00000000..7985b3fe --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/package-tree.html @@ -0,0 +1,172 @@ + + + + + + + +net.schmizz.sshj Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/package-use.html new file mode 100644 index 00000000..f877b3b7 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/package-use.html @@ -0,0 +1,264 @@ + + + + + + + +Uses of Package net.schmizz.sshj (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj
net.schmizz.sshj  
net.schmizz.sshj.connection  
net.schmizz.sshj.transport  
net.schmizz.sshj.userauth  
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj used by net.schmizz.sshj
Config + +
+          Holds configuration information and factories.
ConfigImpl + +
+           
DefaultConfig + +
+          A Config that is initialized as follows.
Service + +
+          Represents a service running on top of the SSH transport layer.
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj used by net.schmizz.sshj.connection
AbstractService + +
+          An abstract class for Service that implements common or default functionality.
Service + +
+          Represents a service running on top of the SSH transport layer.
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj used by net.schmizz.sshj.transport
Config + +
+          Holds configuration information and factories.
Service + +
+          Represents a service running on top of the SSH transport layer.
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj used by net.schmizz.sshj.userauth
AbstractService + +
+          An abstract class for Service that implements common or default functionality.
Service + +
+          Represents a service running on top of the SSH transport layer.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/FileAttributes.Builder.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/FileAttributes.Builder.html new file mode 100644 index 00000000..99b19f93 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/FileAttributes.Builder.html @@ -0,0 +1,414 @@ + + + + + + + +FileAttributes.Builder (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class FileAttributes.Builder

+
+java.lang.Object
+  extended by net.schmizz.sshj.sftp.FileAttributes.Builder
+
+
+
Enclosing class:
FileAttributes
+
+
+
+
public static class FileAttributes.Builder
extends Object
+ + +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
FileAttributes.Builder() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ FileAttributesbuild() + +
+           
+ FileAttributes.BuilderwithAtimeMtime(long atime, + long mtime) + +
+           
+ FileAttributes.BuilderwithExtended(Map<String,String> ext) + +
+           
+ FileAttributes.BuilderwithExtended(String type, + String data) + +
+           
+ FileAttributes.BuilderwithPermissions(int perms) + +
+           
+ FileAttributes.BuilderwithPermissions(Set<FilePermission> perms) + +
+           
+ FileAttributes.BuilderwithSize(long size) + +
+           
+ FileAttributes.BuilderwithType(FileMode.Type type) + +
+           
+ FileAttributes.BuilderwithUIDGID(int uid, + int gid) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+FileAttributes.Builder

+
+public FileAttributes.Builder()
+
+
+ + + + + + + + +
+Method Detail
+ +

+withSize

+
+public FileAttributes.Builder withSize(long size)
+
+
+
+
+
+
+ +

+withAtimeMtime

+
+public FileAttributes.Builder withAtimeMtime(long atime,
+                                             long mtime)
+
+
+
+
+
+
+ +

+withUIDGID

+
+public FileAttributes.Builder withUIDGID(int uid,
+                                         int gid)
+
+
+
+
+
+
+ +

+withPermissions

+
+public FileAttributes.Builder withPermissions(Set<FilePermission> perms)
+
+
+
+
+
+
+ +

+withPermissions

+
+public FileAttributes.Builder withPermissions(int perms)
+
+
+
+
+
+
+ +

+withType

+
+public FileAttributes.Builder withType(FileMode.Type type)
+
+
+
+
+
+
+ +

+withExtended

+
+public FileAttributes.Builder withExtended(String type,
+                                           String data)
+
+
+
+
+
+
+ +

+withExtended

+
+public FileAttributes.Builder withExtended(Map<String,String> ext)
+
+
+
+
+
+
+ +

+build

+
+public FileAttributes build()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/FileAttributes.Flag.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/FileAttributes.Flag.html new file mode 100644 index 00000000..4258818d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/FileAttributes.Flag.html @@ -0,0 +1,412 @@ + + + + + + + +FileAttributes.Flag (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Enum FileAttributes.Flag

+
+java.lang.Object
+  extended by java.lang.Enum<FileAttributes.Flag>
+      extended by net.schmizz.sshj.sftp.FileAttributes.Flag
+
+
+
All Implemented Interfaces:
Serializable, Comparable<FileAttributes.Flag>
+
+
+
Enclosing class:
FileAttributes
+
+
+
+
public static enum FileAttributes.Flag
extends Enum<FileAttributes.Flag>
+ + +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
ACMODTIME + +
+           
EXTENDED + +
+           
MODE + +
+           
SIZE + +
+           
UIDGID + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intget() + +
+           
+ booleanisSet(int mask) + +
+           
+static FileAttributes.FlagvalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static FileAttributes.Flag[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+SIZE

+
+public static final FileAttributes.Flag SIZE
+
+
+
+
+
+ +

+UIDGID

+
+public static final FileAttributes.Flag UIDGID
+
+
+
+
+
+ +

+MODE

+
+public static final FileAttributes.Flag MODE
+
+
+
+
+
+ +

+ACMODTIME

+
+public static final FileAttributes.Flag ACMODTIME
+
+
+
+
+
+ +

+EXTENDED

+
+public static final FileAttributes.Flag EXTENDED
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static FileAttributes.Flag[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (FileAttributes.Flag c : FileAttributes.Flag.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static FileAttributes.Flag valueOf(String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+
+
+ +

+isSet

+
+public boolean isSet(int mask)
+
+
+
+
+
+
+ +

+get

+
+public int get()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/FileAttributes.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/FileAttributes.html new file mode 100644 index 00000000..eaf0e023 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/FileAttributes.html @@ -0,0 +1,540 @@ + + + + + + + +FileAttributes (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class FileAttributes

+
+java.lang.Object
+  extended by net.schmizz.sshj.sftp.FileAttributes
+
+
+
+
public final class FileAttributes
extends Object
+ + +

+


+ +

+ + + + + + + + + + + + + + + +
+Nested Class Summary
+static classFileAttributes.Builder + +
+           
+static classFileAttributes.Flag + +
+           
+ + + + + + + + + + +
+Field Summary
+static FileAttributesEMPTY + +
+           
+  + + + + + + + + + + +
+Constructor Summary
FileAttributes(int mask, + long size, + int uid, + int gid, + FileMode mode, + long atime, + long mtime, + Map<String,String> ext) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ longgetAtime() + +
+           
+ StringgetExtended(String type) + +
+           
+ intgetGID() + +
+           
+ FileModegetMode() + +
+           
+ longgetMtime() + +
+           
+ Set<FilePermission>getPermissions() + +
+           
+ longgetSize() + +
+           
+ FileMode.TypegetType() + +
+           
+ intgetUID() + +
+           
+ booleanhas(FileAttributes.Flag flag) + +
+           
+ byte[]toBytes() + +
+           
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+EMPTY

+
+public static final FileAttributes EMPTY
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+FileAttributes

+
+public FileAttributes(int mask,
+                      long size,
+                      int uid,
+                      int gid,
+                      FileMode mode,
+                      long atime,
+                      long mtime,
+                      Map<String,String> ext)
+
+
+ + + + + + + + +
+Method Detail
+ +

+has

+
+public boolean has(FileAttributes.Flag flag)
+
+
+
+
+
+
+ +

+getSize

+
+public long getSize()
+
+
+
+
+
+
+ +

+getUID

+
+public int getUID()
+
+
+
+
+
+
+ +

+getGID

+
+public int getGID()
+
+
+
+
+
+
+ +

+getMode

+
+public FileMode getMode()
+
+
+
+
+
+
+ +

+getPermissions

+
+public Set<FilePermission> getPermissions()
+
+
+
+
+
+
+ +

+getType

+
+public FileMode.Type getType()
+
+
+
+
+
+
+ +

+getAtime

+
+public long getAtime()
+
+
+
+
+
+
+ +

+getMtime

+
+public long getMtime()
+
+
+
+
+
+
+ +

+getExtended

+
+public String getExtended(String type)
+
+
+
+
+
+
+ +

+toBytes

+
+public byte[] toBytes()
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/FileMode.Type.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/FileMode.Type.html new file mode 100644 index 00000000..1f4dab08 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/FileMode.Type.html @@ -0,0 +1,476 @@ + + + + + + + +FileMode.Type (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Enum FileMode.Type

+
+java.lang.Object
+  extended by java.lang.Enum<FileMode.Type>
+      extended by net.schmizz.sshj.sftp.FileMode.Type
+
+
+
All Implemented Interfaces:
Serializable, Comparable<FileMode.Type>
+
+
+
Enclosing class:
FileMode
+
+
+
+
public static enum FileMode.Type
extends Enum<FileMode.Type>
+ + +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
BLOCK_SPECIAL + +
+          block special
CHAR_SPECIAL + +
+          character special
DIRECTORY + +
+          directory
FIFO_SPECIAL + +
+          FIFO special
REGULAR + +
+          regular
SOCKET_SPECIAL + +
+          socket special
SYMKLINK + +
+          symbolic link
UNKNOWN + +
+          unknown
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static FileMode.TypefromMask(int mask) + +
+           
+ inttoMask() + +
+           
+static FileMode.TypevalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static FileMode.Type[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+BLOCK_SPECIAL

+
+public static final FileMode.Type BLOCK_SPECIAL
+
+
block special +

+

+
+
+
+ +

+CHAR_SPECIAL

+
+public static final FileMode.Type CHAR_SPECIAL
+
+
character special +

+

+
+
+
+ +

+FIFO_SPECIAL

+
+public static final FileMode.Type FIFO_SPECIAL
+
+
FIFO special +

+

+
+
+
+ +

+SOCKET_SPECIAL

+
+public static final FileMode.Type SOCKET_SPECIAL
+
+
socket special +

+

+
+
+
+ +

+REGULAR

+
+public static final FileMode.Type REGULAR
+
+
regular +

+

+
+
+
+ +

+DIRECTORY

+
+public static final FileMode.Type DIRECTORY
+
+
directory +

+

+
+
+
+ +

+SYMKLINK

+
+public static final FileMode.Type SYMKLINK
+
+
symbolic link +

+

+
+
+
+ +

+UNKNOWN

+
+public static final FileMode.Type UNKNOWN
+
+
unknown +

+

+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static FileMode.Type[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (FileMode.Type c : FileMode.Type.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static FileMode.Type valueOf(String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+
+
+ +

+fromMask

+
+public static FileMode.Type fromMask(int mask)
+
+
+
+
+
+
+ +

+toMask

+
+public int toMask()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/FileMode.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/FileMode.html new file mode 100644 index 00000000..d2208899 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/FileMode.html @@ -0,0 +1,368 @@ + + + + + + + +FileMode (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class FileMode

+
+java.lang.Object
+  extended by net.schmizz.sshj.sftp.FileMode
+
+
+
+
public class FileMode
extends Object
+ + +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classFileMode.Type + +
+           
+  + + + + + + + + + + +
+Constructor Summary
FileMode(int mask) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetMask() + +
+           
+ Set<FilePermission>getPermissions() + +
+           
+ intgetPermissionsMask() + +
+           
+ FileMode.TypegetType() + +
+           
+ intgetTypeMask() + +
+           
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+FileMode

+
+public FileMode(int mask)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getMask

+
+public int getMask()
+
+
+
+
+
+
+ +

+getTypeMask

+
+public int getTypeMask()
+
+
+
+
+
+
+ +

+getPermissionsMask

+
+public int getPermissionsMask()
+
+
+
+
+
+
+ +

+getType

+
+public FileMode.Type getType()
+
+
+
+
+
+
+ +

+getPermissions

+
+public Set<FilePermission> getPermissions()
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/OpenMode.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/OpenMode.html new file mode 100644 index 00000000..11eca087 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/OpenMode.html @@ -0,0 +1,422 @@ + + + + + + + +OpenMode (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Enum OpenMode

+
+java.lang.Object
+  extended by java.lang.Enum<OpenMode>
+      extended by net.schmizz.sshj.sftp.OpenMode
+
+
+
All Implemented Interfaces:
Serializable, Comparable<OpenMode>
+
+
+
+
public enum OpenMode
extends Enum<OpenMode>
+ + +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
APPEND + +
+          Force all writes to append data at the end of the file.
CREAT + +
+          If this flag is specified, then a new file will be created if one does not already exist (if TRUNC is specified, the new file will be truncated to zero length if it previously exists).
EXCL + +
+          Causes the request to fail if the named file already exists.
READ + +
+          Open the file for reading.
TRUNC + +
+          Forces an existing file with the same name to be truncated to zero length when creating a file by specifying + CREAT.
WRITE + +
+          Open the file for writing.
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static inttoMask(Set<OpenMode> modes) + +
+           
+static OpenModevalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static OpenMode[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+READ

+
+public static final OpenMode READ
+
+
Open the file for reading. +

+

+
+
+
+ +

+WRITE

+
+public static final OpenMode WRITE
+
+
Open the file for writing. If both this and READ are specified, the file is opened for both + reading and writing. +

+

+
+
+
+ +

+APPEND

+
+public static final OpenMode APPEND
+
+
Force all writes to append data at the end of the file. +

+

+
+
+
+ +

+CREAT

+
+public static final OpenMode CREAT
+
+
If this flag is specified, then a new file will be created if one does not already exist (if TRUNC is specified, the new file will be truncated to zero length if it previously exists). +

+

+
+
+
+ +

+TRUNC

+
+public static final OpenMode TRUNC
+
+
Forces an existing file with the same name to be truncated to zero length when creating a file by specifying + CREAT. CREAT MUST also be specified if this flag is used. +

+

+
+
+
+ +

+EXCL

+
+public static final OpenMode EXCL
+
+
Causes the request to fail if the named file already exists. CREAT MUST also be specified if + this flag is used. +

+

+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static OpenMode[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (OpenMode c : OpenMode.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static OpenMode valueOf(String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+
+
+ +

+toMask

+
+public static int toMask(Set<OpenMode> modes)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/PacketReader.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/PacketReader.html new file mode 100644 index 00000000..0f3bbf00 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/PacketReader.html @@ -0,0 +1,369 @@ + + + + + + + +PacketReader (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class PacketReader

+
+java.lang.Object
+  extended by java.lang.Thread
+      extended by net.schmizz.sshj.sftp.PacketReader
+
+
+
All Implemented Interfaces:
Runnable
+
+
+
+
public class PacketReader
extends Thread
+ + +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class java.lang.Thread
Thread.State, Thread.UncaughtExceptionHandler
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
+  + + + + + + + + + + +
+Constructor Summary
PacketReader(SFTPEngine engine) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidexpectResponseTo(Request req) + +
+           
+ voidhandle() + +
+           
+ SFTPPacket<Response>readPacket() + +
+           
+ voidrun() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Thread
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
+ + + + + + + +
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PacketReader

+
+public PacketReader(SFTPEngine engine)
+
+
+ + + + + + + + +
+Method Detail
+ +

+readPacket

+
+public SFTPPacket<Response> readPacket()
+                                throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+run

+
+public void run()
+
+
+
Specified by:
run in interface Runnable
Overrides:
run in class Thread
+
+
+
+
+
+
+ +

+handle

+
+public void handle()
+            throws SFTPException
+
+
+ +
Throws: +
SFTPException
+
+
+
+ +

+expectResponseTo

+
+public void expectResponseTo(Request req)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/PacketType.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/PacketType.html new file mode 100644 index 00000000..73cc2337 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/PacketType.html @@ -0,0 +1,777 @@ + + + + + + + +PacketType (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Enum PacketType

+
+java.lang.Object
+  extended by java.lang.Enum<PacketType>
+      extended by net.schmizz.sshj.sftp.PacketType
+
+
+
All Implemented Interfaces:
Serializable, Comparable<PacketType>
+
+
+
+
public enum PacketType
extends Enum<PacketType>
+ + +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
ATTRS + +
+           
CLOSE + +
+           
DATA + +
+           
EXTENDED + +
+           
EXTENDED_REPLY + +
+           
FSETSTAT + +
+           
FSTAT + +
+           
HANDLE + +
+           
INIT + +
+           
LSTAT + +
+           
MKDIR + +
+           
NAME + +
+           
OPEN + +
+           
OPENDIR + +
+           
READ + +
+           
READDIR + +
+           
READLINK + +
+           
REALPATH + +
+           
REMOVE + +
+           
RENAME + +
+           
RMDIR + +
+           
SETSTAT + +
+           
STAT + +
+           
STATUS + +
+           
SYMLINK + +
+           
UNKNOWN + +
+           
VERSION + +
+           
WRITE + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static PacketTypefromByte(byte b) + +
+           
+ bytetoByte() + +
+           
+static PacketTypevalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static PacketType[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+UNKNOWN

+
+public static final PacketType UNKNOWN
+
+
+
+
+
+ +

+INIT

+
+public static final PacketType INIT
+
+
+
+
+
+ +

+VERSION

+
+public static final PacketType VERSION
+
+
+
+
+
+ +

+OPEN

+
+public static final PacketType OPEN
+
+
+
+
+
+ +

+CLOSE

+
+public static final PacketType CLOSE
+
+
+
+
+
+ +

+READ

+
+public static final PacketType READ
+
+
+
+
+
+ +

+WRITE

+
+public static final PacketType WRITE
+
+
+
+
+
+ +

+LSTAT

+
+public static final PacketType LSTAT
+
+
+
+
+
+ +

+FSTAT

+
+public static final PacketType FSTAT
+
+
+
+
+
+ +

+SETSTAT

+
+public static final PacketType SETSTAT
+
+
+
+
+
+ +

+FSETSTAT

+
+public static final PacketType FSETSTAT
+
+
+
+
+
+ +

+OPENDIR

+
+public static final PacketType OPENDIR
+
+
+
+
+
+ +

+READDIR

+
+public static final PacketType READDIR
+
+
+
+
+
+ +

+REMOVE

+
+public static final PacketType REMOVE
+
+
+
+
+
+ +

+MKDIR

+
+public static final PacketType MKDIR
+
+
+
+
+
+ +

+RMDIR

+
+public static final PacketType RMDIR
+
+
+
+
+
+ +

+REALPATH

+
+public static final PacketType REALPATH
+
+
+
+
+
+ +

+STAT

+
+public static final PacketType STAT
+
+
+
+
+
+ +

+RENAME

+
+public static final PacketType RENAME
+
+
+
+
+
+ +

+READLINK

+
+public static final PacketType READLINK
+
+
+
+
+
+ +

+SYMLINK

+
+public static final PacketType SYMLINK
+
+
+
+
+
+ +

+STATUS

+
+public static final PacketType STATUS
+
+
+
+
+
+ +

+HANDLE

+
+public static final PacketType HANDLE
+
+
+
+
+
+ +

+DATA

+
+public static final PacketType DATA
+
+
+
+
+
+ +

+NAME

+
+public static final PacketType NAME
+
+
+
+
+
+ +

+ATTRS

+
+public static final PacketType ATTRS
+
+
+
+
+
+ +

+EXTENDED

+
+public static final PacketType EXTENDED
+
+
+
+
+
+ +

+EXTENDED_REPLY

+
+public static final PacketType EXTENDED_REPLY
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static PacketType[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (PacketType c : PacketType.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static PacketType valueOf(String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+
+
+ +

+fromByte

+
+public static PacketType fromByte(byte b)
+
+
+
+
+
+
+ +

+toByte

+
+public byte toByte()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/PathComponents.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/PathComponents.html new file mode 100644 index 00000000..02aab97c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/PathComponents.html @@ -0,0 +1,361 @@ + + + + + + + +PathComponents (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class PathComponents

+
+java.lang.Object
+  extended by net.schmizz.sshj.sftp.PathComponents
+
+
+
+
public class PathComponents
extends Object
+ + +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
PathComponents(String parent, + String name, + String pathSep) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(Object o) + +
+           
+ StringgetName() + +
+           
+ StringgetParent() + +
+           
+ StringgetPath() + +
+           
+ inthashCode() + +
+           
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PathComponents

+
+public PathComponents(String parent,
+                      String name,
+                      String pathSep)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getParent

+
+public String getParent()
+
+
+
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
+
+
+
+ +

+getPath

+
+public String getPath()
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(Object o)
+
+
+
Overrides:
equals in class Object
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class Object
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/PathHelper.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/PathHelper.html new file mode 100644 index 00000000..9ee155a2 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/PathHelper.html @@ -0,0 +1,374 @@ + + + + + + + +PathHelper (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class PathHelper

+
+java.lang.Object
+  extended by net.schmizz.sshj.sftp.PathHelper
+
+
+
+
public class PathHelper
extends Object
+ + +

+


+ +

+ + + + + + + + + + + +
+Field Summary
+static StringDEFAULT_PATH_SEPARATOR + +
+           
+  + + + + + + + + + + +
+Constructor Summary
PathHelper(SFTPEngine engine, + String pathSep) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StringadjustForParent(String parent, + String path) + +
+           
+ PathComponentsgetComponents(String path) + +
+           
+ PathComponentsgetComponents(String parent, + String name) + +
+           
+ StringgetPathSeparator() + +
+           
+ StringtrimTrailingSeparator(String path) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+DEFAULT_PATH_SEPARATOR

+
+public static final String DEFAULT_PATH_SEPARATOR
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+PathHelper

+
+public PathHelper(SFTPEngine engine,
+                  String pathSep)
+
+
+ + + + + + + + +
+Method Detail
+ +

+adjustForParent

+
+public String adjustForParent(String parent,
+                              String path)
+
+
+
+
+
+
+ +

+trimTrailingSeparator

+
+public String trimTrailingSeparator(String path)
+
+
+
+
+
+
+ +

+getPathSeparator

+
+public String getPathSeparator()
+
+
+
+
+
+
+ +

+getComponents

+
+public PathComponents getComponents(String parent,
+                                    String name)
+
+
+
+
+
+
+ +

+getComponents

+
+public PathComponents getComponents(String path)
+                             throws IOException
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/RandomAccessRemoteFile.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/RandomAccessRemoteFile.html new file mode 100644 index 00000000..b60ec5e5 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/RandomAccessRemoteFile.html @@ -0,0 +1,1093 @@ + + + + + + + +RandomAccessRemoteFile (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class RandomAccessRemoteFile

+
+java.lang.Object
+  extended by net.schmizz.sshj.sftp.RandomAccessRemoteFile
+
+
+
All Implemented Interfaces:
DataInput, DataOutput
+
+
+
+
public class RandomAccessRemoteFile
extends Object
implements DataInput, DataOutput
+ + +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
RandomAccessRemoteFile(RemoteFile rf) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ longgetFilePointer() + +
+           
+ intread() + +
+           
+ intread(byte[] b) + +
+           
+ intread(byte[] b, + int off, + int len) + +
+           
+ booleanreadBoolean() + +
+           
+ bytereadByte() + +
+           
+ charreadChar() + +
+           
+ doublereadDouble() + +
+           
+ floatreadFloat() + +
+           
+ voidreadFully(byte[] b) + +
+           
+ voidreadFully(byte[] b, + int off, + int len) + +
+           
+ intreadInt() + +
+           
+ StringreadLine() + +
+           
+ longreadLong() + +
+           
+ shortreadShort() + +
+           
+ intreadUnsignedByte() + +
+           
+ intreadUnsignedShort() + +
+           
+ StringreadUTF() + +
+           
+ voidseek(long fp) + +
+           
+ intskipBytes(int n) + +
+           
+ voidwrite(byte[] b) + +
+           
+ voidwrite(byte[] b, + int off, + int len) + +
+           
+ voidwrite(int i) + +
+           
+ voidwriteBoolean(boolean v) + +
+           
+ voidwriteByte(int v) + +
+           
+ voidwriteBytes(String s) + +
+           
+ voidwriteChar(int v) + +
+           
+ voidwriteChars(String s) + +
+           
+ voidwriteDouble(double v) + +
+           
+ voidwriteFloat(float v) + +
+           
+ voidwriteInt(int v) + +
+           
+ voidwriteLong(long v) + +
+           
+ voidwriteShort(int v) + +
+           
+ voidwriteUTF(String str) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+RandomAccessRemoteFile

+
+public RandomAccessRemoteFile(RemoteFile rf)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getFilePointer

+
+public long getFilePointer()
+
+
+
+
+
+
+
+
+
+ +

+seek

+
+public void seek(long fp)
+
+
+
+
+
+
+
+
+
+ +

+read

+
+public int read()
+         throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+read

+
+public int read(byte[] b)
+         throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+read

+
+public int read(byte[] b,
+                int off,
+                int len)
+         throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readBoolean

+
+public boolean readBoolean()
+                    throws IOException
+
+
+
Specified by:
readBoolean in interface DataInput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readByte

+
+public byte readByte()
+              throws IOException
+
+
+
Specified by:
readByte in interface DataInput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readChar

+
+public char readChar()
+              throws IOException
+
+
+
Specified by:
readChar in interface DataInput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readDouble

+
+public double readDouble()
+                  throws IOException
+
+
+
Specified by:
readDouble in interface DataInput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readFloat

+
+public float readFloat()
+                throws IOException
+
+
+
Specified by:
readFloat in interface DataInput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readFully

+
+public void readFully(byte[] b)
+               throws IOException
+
+
+
Specified by:
readFully in interface DataInput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readFully

+
+public void readFully(byte[] b,
+                      int off,
+                      int len)
+               throws IOException
+
+
+
Specified by:
readFully in interface DataInput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readInt

+
+public int readInt()
+            throws IOException
+
+
+
Specified by:
readInt in interface DataInput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readLine

+
+public String readLine()
+                throws IOException
+
+
+
Specified by:
readLine in interface DataInput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readLong

+
+public long readLong()
+              throws IOException
+
+
+
Specified by:
readLong in interface DataInput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readShort

+
+public short readShort()
+                throws IOException
+
+
+
Specified by:
readShort in interface DataInput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readUTF

+
+public String readUTF()
+               throws IOException
+
+
+
Specified by:
readUTF in interface DataInput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readUnsignedByte

+
+public int readUnsignedByte()
+                     throws IOException
+
+
+
Specified by:
readUnsignedByte in interface DataInput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readUnsignedShort

+
+public int readUnsignedShort()
+                      throws IOException
+
+
+
Specified by:
readUnsignedShort in interface DataInput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+skipBytes

+
+public int skipBytes(int n)
+              throws IOException
+
+
+
Specified by:
skipBytes in interface DataInput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+write

+
+public void write(int i)
+           throws IOException
+
+
+
Specified by:
write in interface DataOutput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+write

+
+public void write(byte[] b)
+           throws IOException
+
+
+
Specified by:
write in interface DataOutput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+write

+
+public void write(byte[] b,
+                  int off,
+                  int len)
+           throws IOException
+
+
+
Specified by:
write in interface DataOutput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+writeBoolean

+
+public void writeBoolean(boolean v)
+                  throws IOException
+
+
+
Specified by:
writeBoolean in interface DataOutput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+writeByte

+
+public void writeByte(int v)
+               throws IOException
+
+
+
Specified by:
writeByte in interface DataOutput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+writeBytes

+
+public void writeBytes(String s)
+                throws IOException
+
+
+
Specified by:
writeBytes in interface DataOutput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+writeChar

+
+public void writeChar(int v)
+               throws IOException
+
+
+
Specified by:
writeChar in interface DataOutput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+writeChars

+
+public void writeChars(String s)
+                throws IOException
+
+
+
Specified by:
writeChars in interface DataOutput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+writeDouble

+
+public void writeDouble(double v)
+                 throws IOException
+
+
+
Specified by:
writeDouble in interface DataOutput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+writeFloat

+
+public void writeFloat(float v)
+                throws IOException
+
+
+
Specified by:
writeFloat in interface DataOutput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+writeInt

+
+public void writeInt(int v)
+              throws IOException
+
+
+
Specified by:
writeInt in interface DataOutput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+writeLong

+
+public void writeLong(long v)
+               throws IOException
+
+
+
Specified by:
writeLong in interface DataOutput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+writeShort

+
+public void writeShort(int v)
+                throws IOException
+
+
+
Specified by:
writeShort in interface DataOutput
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+writeUTF

+
+public void writeUTF(String str)
+              throws IOException
+
+
+
Specified by:
writeUTF in interface DataOutput
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteDirectory.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteDirectory.html new file mode 100644 index 00000000..cbc55dbb --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteDirectory.html @@ -0,0 +1,291 @@ + + + + + + + +RemoteDirectory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class RemoteDirectory

+
+java.lang.Object
+  extended by net.schmizz.sshj.sftp.RemoteResource
+      extended by net.schmizz.sshj.sftp.RemoteDirectory
+
+
+
All Implemented Interfaces:
Closeable
+
+
+
+
public class RemoteDirectory
extends RemoteResource
+ + +

+


+ +

+ + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.sftp.RemoteResource
handle, log, path, requester
+  + + + + + + + + + + +
+Constructor Summary
RemoteDirectory(Requester requester, + String path, + String handle) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ List<RemoteResourceInfo>scan(RemoteResourceFilter filter) + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.sftp.RemoteResource
close, getPath, newRequest, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+RemoteDirectory

+
+public RemoteDirectory(Requester requester,
+                       String path,
+                       String handle)
+
+
+ + + + + + + + +
+Method Detail
+ +

+scan

+
+public List<RemoteResourceInfo> scan(RemoteResourceFilter filter)
+                              throws IOException
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteFile.RemoteFileInputStream.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteFile.RemoteFileInputStream.html new file mode 100644 index 00000000..4d2aa5ff --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteFile.RemoteFileInputStream.html @@ -0,0 +1,412 @@ + + + + + + + +RemoteFile.RemoteFileInputStream (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class RemoteFile.RemoteFileInputStream

+
+java.lang.Object
+  extended by java.io.InputStream
+      extended by net.schmizz.sshj.sftp.RemoteFile.RemoteFileInputStream
+
+
+
All Implemented Interfaces:
Closeable
+
+
+
Enclosing class:
RemoteFile
+
+
+
+
public class RemoteFile.RemoteFileInputStream
extends InputStream
+ + +

+


+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
RemoteFile.RemoteFileInputStream() + +
+           
RemoteFile.RemoteFileInputStream(int fileOffset) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidmark(int readLimit) + +
+           
+ booleanmarkSupported() + +
+           
+ intread() + +
+           
+ intread(byte[] into, + int off, + int len) + +
+           
+ voidreset() + +
+           
+ longskip(long n) + +
+           
+ + + + + + + +
Methods inherited from class java.io.InputStream
available, close, read
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+RemoteFile.RemoteFileInputStream

+
+public RemoteFile.RemoteFileInputStream()
+
+
+
+ +

+RemoteFile.RemoteFileInputStream

+
+public RemoteFile.RemoteFileInputStream(int fileOffset)
+
+
+ + + + + + + + +
+Method Detail
+ +

+markSupported

+
+public boolean markSupported()
+
+
+
Overrides:
markSupported in class InputStream
+
+
+
+
+
+
+ +

+mark

+
+public void mark(int readLimit)
+
+
+
Overrides:
mark in class InputStream
+
+
+
+
+
+
+ +

+reset

+
+public void reset()
+           throws IOException
+
+
+
Overrides:
reset in class InputStream
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+skip

+
+public long skip(long n)
+          throws IOException
+
+
+
Overrides:
skip in class InputStream
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+read

+
+public int read()
+         throws IOException
+
+
+
Specified by:
read in class InputStream
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+read

+
+public int read(byte[] into,
+                int off,
+                int len)
+         throws IOException
+
+
+
Overrides:
read in class InputStream
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteFile.RemoteFileOutputStream.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteFile.RemoteFileOutputStream.html new file mode 100644 index 00000000..ad4c2201 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteFile.RemoteFileOutputStream.html @@ -0,0 +1,318 @@ + + + + + + + +RemoteFile.RemoteFileOutputStream (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class RemoteFile.RemoteFileOutputStream

+
+java.lang.Object
+  extended by java.io.OutputStream
+      extended by net.schmizz.sshj.sftp.RemoteFile.RemoteFileOutputStream
+
+
+
All Implemented Interfaces:
Closeable, Flushable
+
+
+
Enclosing class:
RemoteFile
+
+
+
+
public class RemoteFile.RemoteFileOutputStream
extends OutputStream
+ + +

+


+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
RemoteFile.RemoteFileOutputStream() + +
+           
RemoteFile.RemoteFileOutputStream(long fileOffset) + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidwrite(byte[] buf, + int off, + int len) + +
+           
+ voidwrite(int w) + +
+           
+ + + + + + + +
Methods inherited from class java.io.OutputStream
close, flush, write
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+RemoteFile.RemoteFileOutputStream

+
+public RemoteFile.RemoteFileOutputStream()
+
+
+
+ +

+RemoteFile.RemoteFileOutputStream

+
+public RemoteFile.RemoteFileOutputStream(long fileOffset)
+
+
+ + + + + + + + +
+Method Detail
+ +

+write

+
+public void write(int w)
+           throws IOException
+
+
+
Specified by:
write in class OutputStream
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+write

+
+public void write(byte[] buf,
+                  int off,
+                  int len)
+           throws IOException
+
+
+
Overrides:
write in class OutputStream
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteFile.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteFile.html new file mode 100644 index 00000000..b0584579 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteFile.html @@ -0,0 +1,495 @@ + + + + + + + +RemoteFile (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class RemoteFile

+
+java.lang.Object
+  extended by net.schmizz.sshj.sftp.RemoteResource
+      extended by net.schmizz.sshj.sftp.RemoteFile
+
+
+
All Implemented Interfaces:
Closeable
+
+
+
+
public class RemoteFile
extends RemoteResource
+ + +

+


+ +

+ + + + + + + + + + + + + + + +
+Nested Class Summary
+ classRemoteFile.RemoteFileInputStream + +
+           
+ classRemoteFile.RemoteFileOutputStream + +
+           
+ + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.sftp.RemoteResource
handle, log, path, requester
+  + + + + + + + + + + +
+Constructor Summary
RemoteFile(Requester requester, + String path, + String handle) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ FileAttributesfetchAttributes() + +
+           
+ RemoteFile.RemoteFileInputStreamgetInputStream() + +
+           
+ intgetOutgoingPacketOverhead() + +
+           
+ RemoteFile.RemoteFileOutputStreamgetOutputStream() + +
+           
+ longlength() + +
+           
+ intread(long fileOffset, + byte[] to, + int offset, + int len) + +
+           
+ voidsetAttributes(FileAttributes attrs) + +
+           
+ voidsetLength(long len) + +
+           
+ voidwrite(long fileOffset, + byte[] data, + int off, + int len) + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.sftp.RemoteResource
close, getPath, newRequest, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+RemoteFile

+
+public RemoteFile(Requester requester,
+                  String path,
+                  String handle)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getInputStream

+
+public RemoteFile.RemoteFileInputStream getInputStream()
+
+
+
+
+
+
+ +

+getOutputStream

+
+public RemoteFile.RemoteFileOutputStream getOutputStream()
+
+
+
+
+
+
+ +

+fetchAttributes

+
+public FileAttributes fetchAttributes()
+                               throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+length

+
+public long length()
+            throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+setLength

+
+public void setLength(long len)
+               throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+read

+
+public int read(long fileOffset,
+                byte[] to,
+                int offset,
+                int len)
+         throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+write

+
+public void write(long fileOffset,
+                  byte[] data,
+                  int off,
+                  int len)
+           throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+setAttributes

+
+public void setAttributes(FileAttributes attrs)
+                   throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+getOutgoingPacketOverhead

+
+public int getOutgoingPacketOverhead()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteResource.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteResource.html new file mode 100644 index 00000000..243efc63 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteResource.html @@ -0,0 +1,429 @@ + + + + + + + +RemoteResource (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class RemoteResource

+
+java.lang.Object
+  extended by net.schmizz.sshj.sftp.RemoteResource
+
+
+
All Implemented Interfaces:
Closeable
+
+
+
Direct Known Subclasses:
RemoteDirectory, RemoteFile
+
+
+
+
public abstract class RemoteResource
extends Object
implements Closeable
+ + +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+protected  Stringhandle + +
+           
+protected  org.slf4j.Loggerlog + +
+          Logger
+protected  Stringpath + +
+           
+protected  Requesterrequester + +
+           
+  + + + + + + + + + + + +
+Constructor Summary
+protected RemoteResource(Requester requester, + String path, + String handle) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclose() + +
+           
+ StringgetPath() + +
+           
+protected  RequestnewRequest(PacketType type) + +
+           
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+protected final org.slf4j.Logger log
+
+
Logger +

+

+
+
+
+ +

+requester

+
+protected final Requester requester
+
+
+
+
+
+ +

+path

+
+protected final String path
+
+
+
+
+
+ +

+handle

+
+protected final String handle
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+RemoteResource

+
+protected RemoteResource(Requester requester,
+                         String path,
+                         String handle)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getPath

+
+public String getPath()
+
+
+
+
+
+
+
+
+
+ +

+newRequest

+
+protected Request newRequest(PacketType type)
+
+
+
+
+
+
+
+
+
+ +

+close

+
+public void close()
+           throws IOException
+
+
+
Specified by:
close in interface Closeable
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteResourceFilter.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteResourceFilter.html new file mode 100644 index 00000000..c8482deb --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteResourceFilter.html @@ -0,0 +1,207 @@ + + + + + + + +RemoteResourceFilter (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Interface RemoteResourceFilter

+
+
+
public interface RemoteResourceFilter
+ + +

+


+ +

+ + + + + + + + + + + + +
+Method Summary
+ booleanaccept(RemoteResourceInfo resource) + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+accept

+
+boolean accept(RemoteResourceInfo resource)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteResourceInfo.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteResourceInfo.html new file mode 100644 index 00000000..d86e82a4 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/RemoteResourceInfo.html @@ -0,0 +1,416 @@ + + + + + + + +RemoteResourceInfo (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class RemoteResourceInfo

+
+java.lang.Object
+  extended by net.schmizz.sshj.sftp.RemoteResourceInfo
+
+
+
+
public class RemoteResourceInfo
extends Object
+ + +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
RemoteResourceInfo(PathComponents comps, + FileAttributes attrs) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(Object o) + +
+           
+ FileAttributesgetAttributes() + +
+           
+ StringgetName() + +
+           
+ StringgetParent() + +
+           
+ StringgetPath() + +
+           
+ inthashCode() + +
+           
+ booleanisDirectory() + +
+           
+ booleanisRegularFile() + +
+           
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+RemoteResourceInfo

+
+public RemoteResourceInfo(PathComponents comps,
+                          FileAttributes attrs)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getPath

+
+public String getPath()
+
+
+
+
+
+
+ +

+getParent

+
+public String getParent()
+
+
+
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
+
+
+
+ +

+getAttributes

+
+public FileAttributes getAttributes()
+
+
+
+
+
+
+ +

+isRegularFile

+
+public boolean isRegularFile()
+
+
+
+
+
+
+ +

+isDirectory

+
+public boolean isDirectory()
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(Object o)
+
+
+
Overrides:
equals in class Object
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class Object
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/Request.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/Request.html new file mode 100644 index 00000000..a7ccc44c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/Request.html @@ -0,0 +1,372 @@ + + + + + + + +Request (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class Request

+
+java.lang.Object
+  extended by net.schmizz.sshj.common.Buffer<T>
+      extended by net.schmizz.sshj.sftp.SFTPPacket<Request>
+          extended by net.schmizz.sshj.sftp.Request
+
+
+
+
public class Request
extends SFTPPacket<Request>
+ + +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class net.schmizz.sshj.common.Buffer
Buffer.BufferException, Buffer.PlainBuffer
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.common.Buffer
data, DEFAULT_SIZE, rpos, wpos
+  + + + + + + + + + + +
+Constructor Summary
Request(PacketType type, + long reqID) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ longgetRequestID() + +
+           
+ Promise<Response,SFTPException>getResponsePromise() + +
+           
+ PacketTypegetType() + +
+           
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.sftp.SFTPPacket
putFileAttributes, putType, readFileAttributes, readType
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.common.Buffer
array, available, clear, compact, ensureAvailable, ensureCapacity, getCompactData, getNextPowerOf2, printHex, putBoolean, putBuffer, putByte, putBytes, putBytes, putMPInt, putPublicKey, putRawBytes, putRawBytes, putSensitiveString, putSignature, putString, putString, putString, putUInt32, putUInt64, readBoolean, readByte, readBytes, readMPInt, readPublicKey, readRawBytes, readRawBytes, readString, readStringAsBytes, readUInt32, readUInt32AsInt, readUInt64, rpos, rpos, wpos, wpos
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Request

+
+public Request(PacketType type,
+               long reqID)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getRequestID

+
+public long getRequestID()
+
+
+
+
+
+
+ +

+getType

+
+public PacketType getType()
+
+
+
+
+
+
+ +

+getResponsePromise

+
+public Promise<Response,SFTPException> getResponsePromise()
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Buffer<Request>
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/Requester.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/Requester.html new file mode 100644 index 00000000..0021431f --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/Requester.html @@ -0,0 +1,251 @@ + + + + + + + +Requester (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Interface Requester

+
+
All Known Implementing Classes:
SFTPEngine
+
+
+
+
public interface Requester
+ + +

+


+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ ResponsedoRequest(Request req) + +
+           
+ PathHelpergetPathHelper() + +
+           
+ RequestnewRequest(PacketType type) + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+getPathHelper

+
+PathHelper getPathHelper()
+
+
+
+
+
+
+ +

+newRequest

+
+Request newRequest(PacketType type)
+
+
+
+
+
+
+ +

+doRequest

+
+Response doRequest(Request req)
+                   throws IOException
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/Response.StatusCode.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/Response.StatusCode.html new file mode 100644 index 00000000..8074238c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/Response.StatusCode.html @@ -0,0 +1,473 @@ + + + + + + + +Response.StatusCode (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Enum Response.StatusCode

+
+java.lang.Object
+  extended by java.lang.Enum<Response.StatusCode>
+      extended by net.schmizz.sshj.sftp.Response.StatusCode
+
+
+
All Implemented Interfaces:
Serializable, Comparable<Response.StatusCode>
+
+
+
Enclosing class:
Response
+
+
+
+
public static enum Response.StatusCode
extends Enum<Response.StatusCode>
+ + +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
BAD_MESSAGE + +
+           
CONNECITON_LOST + +
+           
EOF + +
+           
FAILURE + +
+           
NO_CONNECTION + +
+           
NO_SUCH_FILE + +
+           
OK + +
+           
OP_UNSUPPORTED + +
+           
PERMISSION_DENIED + +
+           
UNKNOWN + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static Response.StatusCodefromInt(int code) + +
+           
+static Response.StatusCodevalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static Response.StatusCode[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+UNKNOWN

+
+public static final Response.StatusCode UNKNOWN
+
+
+
+
+
+ +

+OK

+
+public static final Response.StatusCode OK
+
+
+
+
+
+ +

+EOF

+
+public static final Response.StatusCode EOF
+
+
+
+
+
+ +

+NO_SUCH_FILE

+
+public static final Response.StatusCode NO_SUCH_FILE
+
+
+
+
+
+ +

+PERMISSION_DENIED

+
+public static final Response.StatusCode PERMISSION_DENIED
+
+
+
+
+
+ +

+FAILURE

+
+public static final Response.StatusCode FAILURE
+
+
+
+
+
+ +

+BAD_MESSAGE

+
+public static final Response.StatusCode BAD_MESSAGE
+
+
+
+
+
+ +

+NO_CONNECTION

+
+public static final Response.StatusCode NO_CONNECTION
+
+
+
+
+
+ +

+CONNECITON_LOST

+
+public static final Response.StatusCode CONNECITON_LOST
+
+
+
+
+
+ +

+OP_UNSUPPORTED

+
+public static final Response.StatusCode OP_UNSUPPORTED
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static Response.StatusCode[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (Response.StatusCode c : Response.StatusCode.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static Response.StatusCode valueOf(String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+
+
+ +

+fromInt

+
+public static Response.StatusCode fromInt(int code)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/Response.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/Response.html new file mode 100644 index 00000000..7ad971c9 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/Response.html @@ -0,0 +1,473 @@ + + + + + + + +Response (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class Response

+
+java.lang.Object
+  extended by net.schmizz.sshj.common.Buffer<T>
+      extended by net.schmizz.sshj.sftp.SFTPPacket<Response>
+          extended by net.schmizz.sshj.sftp.Response
+
+
+
+
public class Response
extends SFTPPacket<Response>
+ + +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classResponse.StatusCode + +
+           
+ + + + + + + +
Nested classes/interfaces inherited from class net.schmizz.sshj.common.Buffer
Buffer.BufferException, Buffer.PlainBuffer
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.common.Buffer
data, DEFAULT_SIZE, rpos, wpos
+  + + + + + + + + + + +
+Constructor Summary
Response(Buffer<Response> pk, + int protocolVersion) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ ResponseensurePacketTypeIs(PacketType pt) + +
+           
+ ResponseensureStatusIs(Response.StatusCode acceptable) + +
+           
+ ResponseensureStatusPacketIsOK() + +
+           
+protected  Stringerror(Response.StatusCode sc) + +
+           
+ intgetProtocolVersion() + +
+           
+ longgetRequestID() + +
+           
+ PacketTypegetType() + +
+           
+ Response.StatusCodereadStatusCode() + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.sftp.SFTPPacket
putFileAttributes, putType, readFileAttributes, readType
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.common.Buffer
array, available, clear, compact, ensureAvailable, ensureCapacity, getCompactData, getNextPowerOf2, printHex, putBoolean, putBuffer, putByte, putBytes, putBytes, putMPInt, putPublicKey, putRawBytes, putRawBytes, putSensitiveString, putSignature, putString, putString, putString, putUInt32, putUInt64, readBoolean, readByte, readBytes, readMPInt, readPublicKey, readRawBytes, readRawBytes, readString, readStringAsBytes, readUInt32, readUInt32AsInt, readUInt64, rpos, rpos, toString, wpos, wpos
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Response

+
+public Response(Buffer<Response> pk,
+                int protocolVersion)
+         throws SFTPException
+
+
+ +
Throws: +
SFTPException
+
+ + + + + + + + +
+Method Detail
+ +

+getProtocolVersion

+
+public int getProtocolVersion()
+
+
+
+
+
+
+ +

+getRequestID

+
+public long getRequestID()
+
+
+
+
+
+
+ +

+getType

+
+public PacketType getType()
+
+
+
+
+
+
+ +

+readStatusCode

+
+public Response.StatusCode readStatusCode()
+                                   throws SFTPException
+
+
+ +
Throws: +
SFTPException
+
+
+
+ +

+ensurePacketTypeIs

+
+public Response ensurePacketTypeIs(PacketType pt)
+                            throws SFTPException
+
+
+ +
Throws: +
SFTPException
+
+
+
+ +

+ensureStatusPacketIsOK

+
+public Response ensureStatusPacketIsOK()
+                                throws SFTPException
+
+
+ +
Throws: +
SFTPException
+
+
+
+ +

+ensureStatusIs

+
+public Response ensureStatusIs(Response.StatusCode acceptable)
+                        throws SFTPException
+
+
+ +
Throws: +
SFTPException
+
+
+
+ +

+error

+
+protected String error(Response.StatusCode sc)
+                throws SFTPException
+
+
+ +
Throws: +
SFTPException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/SFTPClient.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/SFTPClient.html new file mode 100644 index 00000000..6d21ee4a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/SFTPClient.html @@ -0,0 +1,1260 @@ + + + + + + + +SFTPClient (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class SFTPClient

+
+java.lang.Object
+  extended by net.schmizz.sshj.sftp.SFTPClient
+
+
+
All Implemented Interfaces:
Closeable
+
+
+
Direct Known Subclasses:
StatefulSFTPClient
+
+
+
+
public class SFTPClient
extends Object
implements Closeable
+ + +

+


+ +

+ + + + + + + + + + + + + + + + + + + +
+Field Summary
+protected  SFTPEngineengine + +
+           
+protected  org.slf4j.Loggerlog + +
+          Logger
+protected  SFTPFileTransferxfer + +
+           
+  + + + + + + + + + + +
+Constructor Summary
SFTPClient(SFTPEngine engine) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ longatime(String path) + +
+           
+ Stringcanonicalize(String path) + +
+           
+ voidchgrp(String path, + int gid) + +
+           
+ voidchmod(String path, + int perms) + +
+           
+ voidchown(String path, + int uid) + +
+           
+ voidclose() + +
+           
+ voidget(String source, + LocalDestFile dest) + +
+           
+ voidget(String source, + String dest) + +
+           
+ SFTPFileTransfergetFileTansfer() + +
+           
+ SFTPEnginegetSFTPEngine() + +
+           
+ intgid(String path) + +
+           
+ List<RemoteResourceInfo>ls(String path) + +
+           
+ List<RemoteResourceInfo>ls(String path, + RemoteResourceFilter filter) + +
+           
+ FileAttributeslstat(String path) + +
+           
+ voidmkdir(String dirname) + +
+           
+ voidmkdirs(String path) + +
+           
+ FileModemode(String path) + +
+           
+ longmtime(String path) + +
+           
+ RemoteFileopen(String filename) + +
+           
+ RemoteFileopen(String filename, + Set<OpenMode> mode) + +
+           
+ RemoteFileopen(String filename, + Set<OpenMode> mode, + FileAttributes attrs) + +
+           
+ Set<FilePermission>perms(String path) + +
+           
+ voidput(LocalSourceFile source, + String dest) + +
+           
+ voidput(String source, + String dest) + +
+           
+ Stringreadlink(String path) + +
+           
+ voidrename(String oldpath, + String newpath) + +
+           
+ voidrm(String filename) + +
+           
+ voidrmdir(String dirname) + +
+           
+ voidsetattr(String path, + FileAttributes attrs) + +
+           
+ longsize(String path) + +
+           
+ FileAttributesstat(String path) + +
+           
+ FileAttributesstatExistence(String path) + +
+           
+ voidsymlink(String linkpath, + String targetpath) + +
+           
+ voidtruncate(String path, + long size) + +
+           
+ FileMode.Typetype(String path) + +
+           
+ intuid(String path) + +
+           
+ intversion() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+protected final org.slf4j.Logger log
+
+
Logger +

+

+
+
+
+ +

+engine

+
+protected final SFTPEngine engine
+
+
+
+
+
+ +

+xfer

+
+protected final SFTPFileTransfer xfer
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+SFTPClient

+
+public SFTPClient(SFTPEngine engine)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getSFTPEngine

+
+public SFTPEngine getSFTPEngine()
+
+
+
+
+
+
+
+
+
+ +

+getFileTansfer

+
+public SFTPFileTransfer getFileTansfer()
+
+
+
+
+
+
+
+
+
+ +

+ls

+
+public List<RemoteResourceInfo> ls(String path)
+                            throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+ls

+
+public List<RemoteResourceInfo> ls(String path,
+                                   RemoteResourceFilter filter)
+                            throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+open

+
+public RemoteFile open(String filename,
+                       Set<OpenMode> mode,
+                       FileAttributes attrs)
+                throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+open

+
+public RemoteFile open(String filename,
+                       Set<OpenMode> mode)
+                throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+open

+
+public RemoteFile open(String filename)
+                throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+mkdir

+
+public void mkdir(String dirname)
+           throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+mkdirs

+
+public void mkdirs(String path)
+            throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+statExistence

+
+public FileAttributes statExistence(String path)
+                             throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+rename

+
+public void rename(String oldpath,
+                   String newpath)
+            throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+rm

+
+public void rm(String filename)
+        throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+rmdir

+
+public void rmdir(String dirname)
+           throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+symlink

+
+public void symlink(String linkpath,
+                    String targetpath)
+             throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+version

+
+public int version()
+
+
+
+
+
+
+
+
+
+ +

+setattr

+
+public void setattr(String path,
+                    FileAttributes attrs)
+             throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+uid

+
+public int uid(String path)
+        throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+gid

+
+public int gid(String path)
+        throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+atime

+
+public long atime(String path)
+           throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+mtime

+
+public long mtime(String path)
+           throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+perms

+
+public Set<FilePermission> perms(String path)
+                          throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+mode

+
+public FileMode mode(String path)
+              throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+type

+
+public FileMode.Type type(String path)
+                   throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readlink

+
+public String readlink(String path)
+                throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+stat

+
+public FileAttributes stat(String path)
+                    throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+lstat

+
+public FileAttributes lstat(String path)
+                     throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+chown

+
+public void chown(String path,
+                  int uid)
+           throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+chmod

+
+public void chmod(String path,
+                  int perms)
+           throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+chgrp

+
+public void chgrp(String path,
+                  int gid)
+           throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+truncate

+
+public void truncate(String path,
+                     long size)
+              throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+canonicalize

+
+public String canonicalize(String path)
+                    throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+size

+
+public long size(String path)
+          throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+get

+
+public void get(String source,
+                String dest)
+         throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+put

+
+public void put(String source,
+                String dest)
+         throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+get

+
+public void get(String source,
+                LocalDestFile dest)
+         throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+put

+
+public void put(LocalSourceFile source,
+                String dest)
+         throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+close

+
+public void close()
+           throws IOException
+
+
+
Specified by:
close in interface Closeable
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/SFTPEngine.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/SFTPEngine.html new file mode 100644 index 00000000..f2c36bdd --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/SFTPEngine.html @@ -0,0 +1,1176 @@ + + + + + + + +SFTPEngine (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class SFTPEngine

+
+java.lang.Object
+  extended by net.schmizz.sshj.sftp.SFTPEngine
+
+
+
All Implemented Interfaces:
Closeable, Requester
+
+
+
+
public class SFTPEngine
extends Object
implements Requester, Closeable
+ + +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intDEFAULT_TIMEOUT + +
+           
+protected  org.slf4j.Loggerlog + +
+          Logger
+static intMAX_SUPPORTED_VERSION + +
+           
+protected  intoperativeVersion + +
+           
+protected  OutputStreamout + +
+           
+protected  PathHelperpathHelper + +
+           
+protected  PacketReaderreader + +
+           
+protected  longreqID + +
+           
+protected  Map<String,String>serverExtensions + +
+           
+protected  Session.Subsystemsub + +
+           
+protected  inttimeout + +
+           
+  + + + + + + + + + + + + + +
+Constructor Summary
SFTPEngine(SessionFactory ssh) + +
+           
SFTPEngine(SessionFactory ssh, + String pathSep) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Stringcanonicalize(String path) + +
+           
+ voidclose() + +
+           
+ ResponsedoRequest(Request req) + +
+           
+ intgetOperativeProtocolVersion() + +
+           
+ PathHelpergetPathHelper() + +
+           
+ Session.SubsystemgetSubsystem() + +
+           
+ intgetTimeout() + +
+           
+ SFTPEngineinit() + +
+           
+ FileAttributeslstat(String path) + +
+           
+ voidmakeDir(String path) + +
+           
+ voidmakeDir(String path, + FileAttributes attrs) + +
+           
+ RequestnewExtendedRequest(String reqName) + +
+           
+ RequestnewRequest(PacketType type) + +
+           
+ RemoteFileopen(String filename) + +
+           
+ RemoteFileopen(String filename, + Set<OpenMode> modes) + +
+           
+ RemoteFileopen(String path, + Set<OpenMode> modes, + FileAttributes fa) + +
+           
+ RemoteDirectoryopenDir(String path) + +
+           
+ StringreadLink(String path) + +
+           
+protected static StringreadSingleName(Response res) + +
+           
+ voidremove(String filename) + +
+           
+ voidremoveDir(String path) + +
+           
+ voidrename(String oldPath, + String newPath) + +
+           
+ voidsetAttributes(String path, + FileAttributes attrs) + +
+           
+ voidsetTimeout(int timeout) + +
+           
+protected  FileAttributesstat(PacketType pt, + String path) + +
+           
+ FileAttributesstat(String path) + +
+           
+ voidsymlink(String linkpath, + String targetpath) + +
+           
+protected  voidtransmit(SFTPPacket<Request> payload) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+MAX_SUPPORTED_VERSION

+
+public static final int MAX_SUPPORTED_VERSION
+
+
+
See Also:
Constant Field Values
+
+
+ +

+DEFAULT_TIMEOUT

+
+public static final int DEFAULT_TIMEOUT
+
+
+
See Also:
Constant Field Values
+
+
+ +

+log

+
+protected final org.slf4j.Logger log
+
+
Logger +

+

+
+
+
+ +

+timeout

+
+protected volatile int timeout
+
+
+
+
+
+ +

+pathHelper

+
+protected final PathHelper pathHelper
+
+
+
+
+
+ +

+sub

+
+protected final Session.Subsystem sub
+
+
+
+
+
+ +

+reader

+
+protected final PacketReader reader
+
+
+
+
+
+ +

+out

+
+protected final OutputStream out
+
+
+
+
+
+ +

+reqID

+
+protected long reqID
+
+
+
+
+
+ +

+operativeVersion

+
+protected int operativeVersion
+
+
+
+
+
+ +

+serverExtensions

+
+protected final Map<String,String> serverExtensions
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+SFTPEngine

+
+public SFTPEngine(SessionFactory ssh)
+           throws SSHException
+
+
+ +
Throws: +
SSHException
+
+
+ +

+SFTPEngine

+
+public SFTPEngine(SessionFactory ssh,
+                  String pathSep)
+           throws SSHException
+
+
+ +
Throws: +
SSHException
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public SFTPEngine init()
+                throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+getSubsystem

+
+public Session.Subsystem getSubsystem()
+
+
+
+
+
+
+
+
+
+ +

+getOperativeProtocolVersion

+
+public int getOperativeProtocolVersion()
+
+
+
+
+
+
+
+
+
+ +

+newExtendedRequest

+
+public Request newExtendedRequest(String reqName)
+
+
+
+
+
+
+
+
+
+ +

+getPathHelper

+
+public PathHelper getPathHelper()
+
+
+
Specified by:
getPathHelper in interface Requester
+
+
+
+
+
+
+ +

+newRequest

+
+public Request newRequest(PacketType type)
+
+
+
Specified by:
newRequest in interface Requester
+
+
+
+
+
+
+ +

+doRequest

+
+public Response doRequest(Request req)
+                   throws IOException
+
+
+
Specified by:
doRequest in interface Requester
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+open

+
+public RemoteFile open(String path,
+                       Set<OpenMode> modes,
+                       FileAttributes fa)
+                throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+open

+
+public RemoteFile open(String filename,
+                       Set<OpenMode> modes)
+                throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+open

+
+public RemoteFile open(String filename)
+                throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+openDir

+
+public RemoteDirectory openDir(String path)
+                        throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+setAttributes

+
+public void setAttributes(String path,
+                          FileAttributes attrs)
+                   throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readLink

+
+public String readLink(String path)
+                throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+makeDir

+
+public void makeDir(String path,
+                    FileAttributes attrs)
+             throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+makeDir

+
+public void makeDir(String path)
+             throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+symlink

+
+public void symlink(String linkpath,
+                    String targetpath)
+             throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+remove

+
+public void remove(String filename)
+            throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+removeDir

+
+public void removeDir(String path)
+               throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+stat

+
+public FileAttributes stat(String path)
+                    throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+lstat

+
+public FileAttributes lstat(String path)
+                     throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+rename

+
+public void rename(String oldPath,
+                   String newPath)
+            throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+canonicalize

+
+public String canonicalize(String path)
+                    throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+setTimeout

+
+public void setTimeout(int timeout)
+
+
+
+
+
+
+
+
+
+ +

+getTimeout

+
+public int getTimeout()
+
+
+
+
+
+
+
+
+
+ +

+close

+
+public void close()
+           throws IOException
+
+
+
Specified by:
close in interface Closeable
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+stat

+
+protected FileAttributes stat(PacketType pt,
+                              String path)
+                       throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readSingleName

+
+protected static String readSingleName(Response res)
+                                throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+transmit

+
+protected void transmit(SFTPPacket<Request> payload)
+                 throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/SFTPException.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/SFTPException.html new file mode 100644 index 00000000..15d9c5d6 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/SFTPException.html @@ -0,0 +1,426 @@ + + + + + + + +SFTPException (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class SFTPException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by net.schmizz.sshj.common.SSHException
+                  extended by net.schmizz.sshj.sftp.SFTPException
+
+
+
All Implemented Interfaces:
Serializable
+
+
+
+
public class SFTPException
extends SSHException
+ + +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Field Summary
+static ExceptionChainer<SFTPException>chainer + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
SFTPException(DisconnectReason code) + +
+           
SFTPException(DisconnectReason code, + String message) + +
+           
SFTPException(DisconnectReason code, + String message, + Throwable cause) + +
+           
SFTPException(DisconnectReason code, + Throwable cause) + +
+           
SFTPException(Response.StatusCode sc, + String msg) + +
+           
SFTPException(String message) + +
+           
SFTPException(String message, + Throwable cause) + +
+           
SFTPException(Throwable cause) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ Response.StatusCodegetStatusCode() + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.common.SSHException
getDisconnectReason, getMessage, toString
+ + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+chainer

+
+public static final ExceptionChainer<SFTPException> chainer
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+SFTPException

+
+public SFTPException(DisconnectReason code)
+
+
+
+ +

+SFTPException

+
+public SFTPException(DisconnectReason code,
+                     String message)
+
+
+
+ +

+SFTPException

+
+public SFTPException(DisconnectReason code,
+                     String message,
+                     Throwable cause)
+
+
+
+ +

+SFTPException

+
+public SFTPException(DisconnectReason code,
+                     Throwable cause)
+
+
+
+ +

+SFTPException

+
+public SFTPException(String message)
+
+
+
+ +

+SFTPException

+
+public SFTPException(String message,
+                     Throwable cause)
+
+
+
+ +

+SFTPException

+
+public SFTPException(Throwable cause)
+
+
+
+ +

+SFTPException

+
+public SFTPException(Response.StatusCode sc,
+                     String msg)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getStatusCode

+
+public Response.StatusCode getStatusCode()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/SFTPFileTransfer.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/SFTPFileTransfer.html new file mode 100644 index 00000000..fc596705 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/SFTPFileTransfer.html @@ -0,0 +1,470 @@ + + + + + + + +SFTPFileTransfer (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class SFTPFileTransfer

+
+java.lang.Object
+  extended by net.schmizz.sshj.xfer.AbstractFileTransfer
+      extended by net.schmizz.sshj.sftp.SFTPFileTransfer
+
+
+
All Implemented Interfaces:
FileTransfer
+
+
+
+
public class SFTPFileTransfer
extends AbstractFileTransfer
implements FileTransfer
+ + +

+


+ +

+ + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.xfer.AbstractFileTransfer
log, LOGGING_TRANSFER_LISTENER
+  + + + + + + + + + + +
+Constructor Summary
SFTPFileTransfer(SFTPEngine engine) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddownload(String source, + LocalDestFile dest) + +
+           
+ voiddownload(String source, + String dest) + +
+           
+ RemoteResourceFiltergetDownloadFilter() + +
+           
+ LocalFileFiltergetUploadFilter() + +
+           
+ voidsetDownloadFilter(RemoteResourceFilter downloadFilter) + +
+           
+ voidsetUploadFilter(LocalFileFilter uploadFilter) + +
+           
+ voidupload(LocalSourceFile localFile, + String remotePath) + +
+           
+ voidupload(String source, + String dest) + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.xfer.AbstractFileTransfer
getTransferListener, setTransferListener
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.xfer.FileTransfer
getTransferListener, setTransferListener
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SFTPFileTransfer

+
+public SFTPFileTransfer(SFTPEngine engine)
+
+
+ + + + + + + + +
+Method Detail
+ +

+upload

+
+public void upload(String source,
+                   String dest)
+            throws IOException
+
+
+
Specified by:
upload in interface FileTransfer
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+download

+
+public void download(String source,
+                     String dest)
+              throws IOException
+
+
+
Specified by:
download in interface FileTransfer
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+upload

+
+public void upload(LocalSourceFile localFile,
+                   String remotePath)
+            throws IOException
+
+
+
Specified by:
upload in interface FileTransfer
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+download

+
+public void download(String source,
+                     LocalDestFile dest)
+              throws IOException
+
+
+
Specified by:
download in interface FileTransfer
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+setUploadFilter

+
+public void setUploadFilter(LocalFileFilter uploadFilter)
+
+
+
+
+
+
+
+
+
+ +

+setDownloadFilter

+
+public void setDownloadFilter(RemoteResourceFilter downloadFilter)
+
+
+
+
+
+
+
+
+
+ +

+getUploadFilter

+
+public LocalFileFilter getUploadFilter()
+
+
+
+
+
+
+
+
+
+ +

+getDownloadFilter

+
+public RemoteResourceFilter getDownloadFilter()
+
+
+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/SFTPPacket.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/SFTPPacket.html new file mode 100644 index 00000000..0ef0d7ca --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/SFTPPacket.html @@ -0,0 +1,394 @@ + + + + + + + +SFTPPacket (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class SFTPPacket<T extends SFTPPacket<T>>

+
+java.lang.Object
+  extended by net.schmizz.sshj.common.Buffer<T>
+      extended by net.schmizz.sshj.sftp.SFTPPacket<T>
+
+
+
Direct Known Subclasses:
Request, Response
+
+
+
+
public class SFTPPacket<T extends SFTPPacket<T>>
extends Buffer<T>
+ + +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class net.schmizz.sshj.common.Buffer
Buffer.BufferException, Buffer.PlainBuffer
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.common.Buffer
data, DEFAULT_SIZE, rpos, wpos
+  + + + + + + + + + + + + + + + + +
+Constructor Summary
SFTPPacket() + +
+           
SFTPPacket(Buffer<T> buf) + +
+           
SFTPPacket(PacketType pt) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ TputFileAttributes(FileAttributes fa) + +
+           
+ TputType(PacketType type) + +
+           
+ FileAttributesreadFileAttributes() + +
+           
+ PacketTypereadType() + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.common.Buffer
array, available, clear, compact, ensureAvailable, ensureCapacity, getCompactData, getNextPowerOf2, printHex, putBoolean, putBuffer, putByte, putBytes, putBytes, putMPInt, putPublicKey, putRawBytes, putRawBytes, putSensitiveString, putSignature, putString, putString, putString, putUInt32, putUInt64, readBoolean, readByte, readBytes, readMPInt, readPublicKey, readRawBytes, readRawBytes, readString, readStringAsBytes, readUInt32, readUInt32AsInt, readUInt64, rpos, rpos, toString, wpos, wpos
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SFTPPacket

+
+public SFTPPacket()
+
+
+
+ +

+SFTPPacket

+
+public SFTPPacket(Buffer<T> buf)
+
+
+
+ +

+SFTPPacket

+
+public SFTPPacket(PacketType pt)
+
+
+ + + + + + + + +
+Method Detail
+ +

+readFileAttributes

+
+public FileAttributes readFileAttributes()
+                                  throws SFTPException
+
+
+ +
Throws: +
SFTPException
+
+
+
+ +

+readType

+
+public PacketType readType()
+                    throws SFTPException
+
+
+ +
Throws: +
SFTPException
+
+
+
+ +

+putFileAttributes

+
+public T putFileAttributes(FileAttributes fa)
+
+
+
+
+
+
+ +

+putType

+
+public T putType(PacketType type)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/StatefulSFTPClient.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/StatefulSFTPClient.html new file mode 100644 index 00000000..c9e19e03 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/StatefulSFTPClient.html @@ -0,0 +1,878 @@ + + + + + + + +StatefulSFTPClient (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.sftp +
+Class StatefulSFTPClient

+
+java.lang.Object
+  extended by net.schmizz.sshj.sftp.SFTPClient
+      extended by net.schmizz.sshj.sftp.StatefulSFTPClient
+
+
+
All Implemented Interfaces:
Closeable
+
+
+
+
public class StatefulSFTPClient
extends SFTPClient
+ + +

+


+ +

+ + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.sftp.SFTPClient
engine, log, xfer
+  + + + + + + + + + + +
+Constructor Summary
StatefulSFTPClient(SFTPEngine engine) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Stringcanonicalize(String path) + +
+           
+ voidcd(String dirname) + +
+           
+ voidget(String source, + String dest) + +
+           
+ List<RemoteResourceInfo>ls() + +
+           
+ List<RemoteResourceInfo>ls(RemoteResourceFilter filter) + +
+           
+ List<RemoteResourceInfo>ls(String path) + +
+           
+ List<RemoteResourceInfo>ls(String path, + RemoteResourceFilter filter) + +
+           
+ FileAttributeslstat(String path) + +
+           
+ voidmkdir(String dirname) + +
+           
+ voidmkdirs(String path) + +
+           
+ RemoteFileopen(String filename) + +
+           
+ RemoteFileopen(String filename, + Set<OpenMode> mode) + +
+           
+ RemoteFileopen(String filename, + Set<OpenMode> mode, + FileAttributes attrs) + +
+           
+ voidput(String source, + String dest) + +
+           
+ Stringpwd() + +
+           
+ Stringreadlink(String path) + +
+           
+ voidrename(String oldpath, + String newpath) + +
+           
+ voidrm(String filename) + +
+           
+ voidrmdir(String dirname) + +
+           
+ voidsetattr(String path, + FileAttributes attrs) + +
+           
+ FileAttributesstat(String path) + +
+           
+ FileAttributesstatExistence(String path) + +
+           
+ voidsymlink(String linkpath, + String targetpath) + +
+           
+ voidtruncate(String path, + long size) + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.sftp.SFTPClient
atime, chgrp, chmod, chown, close, get, getFileTansfer, getSFTPEngine, gid, mode, mtime, perms, put, size, type, uid, version
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StatefulSFTPClient

+
+public StatefulSFTPClient(SFTPEngine engine)
+                   throws IOException
+
+
+ +
Throws: +
IOException
+
+ + + + + + + + +
+Method Detail
+ +

+cd

+
+public void cd(String dirname)
+        throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+ls

+
+public List<RemoteResourceInfo> ls()
+                            throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+ls

+
+public List<RemoteResourceInfo> ls(RemoteResourceFilter filter)
+                            throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+pwd

+
+public String pwd()
+           throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+ls

+
+public List<RemoteResourceInfo> ls(String path)
+                            throws IOException
+
+
+
Overrides:
ls in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+ls

+
+public List<RemoteResourceInfo> ls(String path,
+                                   RemoteResourceFilter filter)
+                            throws IOException
+
+
+
Overrides:
ls in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+open

+
+public RemoteFile open(String filename,
+                       Set<OpenMode> mode,
+                       FileAttributes attrs)
+                throws IOException
+
+
+
Overrides:
open in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+open

+
+public RemoteFile open(String filename,
+                       Set<OpenMode> mode)
+                throws IOException
+
+
+
Overrides:
open in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+open

+
+public RemoteFile open(String filename)
+                throws IOException
+
+
+
Overrides:
open in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+mkdir

+
+public void mkdir(String dirname)
+           throws IOException
+
+
+
Overrides:
mkdir in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+mkdirs

+
+public void mkdirs(String path)
+            throws IOException
+
+
+
Overrides:
mkdirs in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+statExistence

+
+public FileAttributes statExistence(String path)
+                             throws IOException
+
+
+
Overrides:
statExistence in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+rename

+
+public void rename(String oldpath,
+                   String newpath)
+            throws IOException
+
+
+
Overrides:
rename in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+rm

+
+public void rm(String filename)
+        throws IOException
+
+
+
Overrides:
rm in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+rmdir

+
+public void rmdir(String dirname)
+           throws IOException
+
+
+
Overrides:
rmdir in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+symlink

+
+public void symlink(String linkpath,
+                    String targetpath)
+             throws IOException
+
+
+
Overrides:
symlink in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+setattr

+
+public void setattr(String path,
+                    FileAttributes attrs)
+             throws IOException
+
+
+
Overrides:
setattr in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+readlink

+
+public String readlink(String path)
+                throws IOException
+
+
+
Overrides:
readlink in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+stat

+
+public FileAttributes stat(String path)
+                    throws IOException
+
+
+
Overrides:
stat in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+lstat

+
+public FileAttributes lstat(String path)
+                     throws IOException
+
+
+
Overrides:
lstat in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+truncate

+
+public void truncate(String path,
+                     long size)
+              throws IOException
+
+
+
Overrides:
truncate in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+canonicalize

+
+public String canonicalize(String path)
+                    throws IOException
+
+
+
Overrides:
canonicalize in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+get

+
+public void get(String source,
+                String dest)
+         throws IOException
+
+
+
Overrides:
get in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+put

+
+public void put(String source,
+                String dest)
+         throws IOException
+
+
+
Overrides:
put in class SFTPClient
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/FileAttributes.Builder.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/FileAttributes.Builder.html new file mode 100644 index 00000000..2a3efe38 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/FileAttributes.Builder.html @@ -0,0 +1,240 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.FileAttributes.Builder (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.FileAttributes.Builder

+
+ + + + + + + + + +
+Packages that use FileAttributes.Builder
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of FileAttributes.Builder in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return FileAttributes.Builder
+ FileAttributes.BuilderFileAttributes.Builder.withAtimeMtime(long atime, + long mtime) + +
+           
+ FileAttributes.BuilderFileAttributes.Builder.withExtended(Map<String,String> ext) + +
+           
+ FileAttributes.BuilderFileAttributes.Builder.withExtended(String type, + String data) + +
+           
+ FileAttributes.BuilderFileAttributes.Builder.withPermissions(int perms) + +
+           
+ FileAttributes.BuilderFileAttributes.Builder.withPermissions(Set<FilePermission> perms) + +
+           
+ FileAttributes.BuilderFileAttributes.Builder.withSize(long size) + +
+           
+ FileAttributes.BuilderFileAttributes.Builder.withType(FileMode.Type type) + +
+           
+ FileAttributes.BuilderFileAttributes.Builder.withUIDGID(int uid, + int gid) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/FileAttributes.Flag.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/FileAttributes.Flag.html new file mode 100644 index 00000000..2337855f --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/FileAttributes.Flag.html @@ -0,0 +1,206 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.FileAttributes.Flag (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.FileAttributes.Flag

+
+ + + + + + + + + +
+Packages that use FileAttributes.Flag
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of FileAttributes.Flag in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return FileAttributes.Flag
+static FileAttributes.FlagFileAttributes.Flag.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static FileAttributes.Flag[]FileAttributes.Flag.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.sftp with parameters of type FileAttributes.Flag
+ booleanFileAttributes.has(FileAttributes.Flag flag) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/FileAttributes.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/FileAttributes.html new file mode 100644 index 00000000..496c7dfb --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/FileAttributes.html @@ -0,0 +1,399 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.FileAttributes (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.FileAttributes

+
+ + + + + + + + + +
+Packages that use FileAttributes
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of FileAttributes in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.sftp declared as FileAttributes
+static FileAttributesFileAttributes.EMPTY + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return FileAttributes
+ FileAttributesFileAttributes.Builder.build() + +
+           
+ FileAttributesRemoteFile.fetchAttributes() + +
+           
+ FileAttributesRemoteResourceInfo.getAttributes() + +
+           
+ FileAttributesStatefulSFTPClient.lstat(String path) + +
+           
+ FileAttributesSFTPEngine.lstat(String path) + +
+           
+ FileAttributesSFTPClient.lstat(String path) + +
+           
+ FileAttributesSFTPPacket.readFileAttributes() + +
+           
+protected  FileAttributesSFTPEngine.stat(PacketType pt, + String path) + +
+           
+ FileAttributesStatefulSFTPClient.stat(String path) + +
+           
+ FileAttributesSFTPEngine.stat(String path) + +
+           
+ FileAttributesSFTPClient.stat(String path) + +
+           
+ FileAttributesStatefulSFTPClient.statExistence(String path) + +
+           
+ FileAttributesSFTPClient.statExistence(String path) + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp with parameters of type FileAttributes
+ voidSFTPEngine.makeDir(String path, + FileAttributes attrs) + +
+           
+ RemoteFileStatefulSFTPClient.open(String filename, + Set<OpenMode> mode, + FileAttributes attrs) + +
+           
+ RemoteFileSFTPEngine.open(String path, + Set<OpenMode> modes, + FileAttributes fa) + +
+           
+ RemoteFileSFTPClient.open(String filename, + Set<OpenMode> mode, + FileAttributes attrs) + +
+           
+ TSFTPPacket.putFileAttributes(FileAttributes fa) + +
+           
+ voidStatefulSFTPClient.setattr(String path, + FileAttributes attrs) + +
+           
+ voidSFTPClient.setattr(String path, + FileAttributes attrs) + +
+           
+ voidRemoteFile.setAttributes(FileAttributes attrs) + +
+           
+ voidSFTPEngine.setAttributes(String path, + FileAttributes attrs) + +
+           
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.sftp with parameters of type FileAttributes
RemoteResourceInfo(PathComponents comps, + FileAttributes attrs) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/FileMode.Type.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/FileMode.Type.html new file mode 100644 index 00000000..ed808b73 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/FileMode.Type.html @@ -0,0 +1,238 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.FileMode.Type (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.FileMode.Type

+
+ + + + + + + + + +
+Packages that use FileMode.Type
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of FileMode.Type in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return FileMode.Type
+static FileMode.TypeFileMode.Type.fromMask(int mask) + +
+           
+ FileMode.TypeFileMode.getType() + +
+           
+ FileMode.TypeFileAttributes.getType() + +
+           
+ FileMode.TypeSFTPClient.type(String path) + +
+           
+static FileMode.TypeFileMode.Type.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static FileMode.Type[]FileMode.Type.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.sftp with parameters of type FileMode.Type
+ FileAttributes.BuilderFileAttributes.Builder.withType(FileMode.Type type) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/FileMode.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/FileMode.html new file mode 100644 index 00000000..853e68c0 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/FileMode.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.FileMode (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.FileMode

+
+ + + + + + + + + +
+Packages that use FileMode
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of FileMode in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return FileMode
+ FileModeFileAttributes.getMode() + +
+           
+ FileModeSFTPClient.mode(String path) + +
+           
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.sftp with parameters of type FileMode
FileAttributes(int mask, + long size, + int uid, + int gid, + FileMode mode, + long atime, + long mtime, + Map<String,String> ext) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/OpenMode.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/OpenMode.html new file mode 100644 index 00000000..ac9524d7 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/OpenMode.html @@ -0,0 +1,263 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.OpenMode (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.OpenMode

+
+ + + + + + + + + +
+Packages that use OpenMode
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of OpenMode in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return OpenMode
+static OpenModeOpenMode.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static OpenMode[]OpenMode.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method parameters in net.schmizz.sshj.sftp with type arguments of type OpenMode
+ RemoteFileStatefulSFTPClient.open(String filename, + Set<OpenMode> mode) + +
+           
+ RemoteFileSFTPEngine.open(String filename, + Set<OpenMode> modes) + +
+           
+ RemoteFileSFTPClient.open(String filename, + Set<OpenMode> mode) + +
+           
+ RemoteFileStatefulSFTPClient.open(String filename, + Set<OpenMode> mode, + FileAttributes attrs) + +
+           
+ RemoteFileSFTPEngine.open(String path, + Set<OpenMode> modes, + FileAttributes fa) + +
+           
+ RemoteFileSFTPClient.open(String filename, + Set<OpenMode> mode, + FileAttributes attrs) + +
+           
+static intOpenMode.toMask(Set<OpenMode> modes) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/PacketReader.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/PacketReader.html new file mode 100644 index 00000000..d54cc4e3 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/PacketReader.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.PacketReader (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.PacketReader

+
+ + + + + + + + + +
+Packages that use PacketReader
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of PacketReader in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.sftp declared as PacketReader
+protected  PacketReaderSFTPEngine.reader + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/PacketType.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/PacketType.html new file mode 100644 index 00000000..e4a31a43 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/PacketType.html @@ -0,0 +1,300 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.PacketType (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.PacketType

+
+ + + + + + + + + +
+Packages that use PacketType
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of PacketType in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return PacketType
+static PacketTypePacketType.fromByte(byte b) + +
+           
+ PacketTypeResponse.getType() + +
+           
+ PacketTypeRequest.getType() + +
+           
+ PacketTypeSFTPPacket.readType() + +
+           
+static PacketTypePacketType.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static PacketType[]PacketType.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp with parameters of type PacketType
+ ResponseResponse.ensurePacketTypeIs(PacketType pt) + +
+           
+ RequestSFTPEngine.newRequest(PacketType type) + +
+           
+ RequestRequester.newRequest(PacketType type) + +
+           
+protected  RequestRemoteResource.newRequest(PacketType type) + +
+           
+ TSFTPPacket.putType(PacketType type) + +
+           
+protected  FileAttributesSFTPEngine.stat(PacketType pt, + String path) + +
+           
+  +

+ + + + + + + + + + + +
Constructors in net.schmizz.sshj.sftp with parameters of type PacketType
Request(PacketType type, + long reqID) + +
+           
SFTPPacket(PacketType pt) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/PathComponents.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/PathComponents.html new file mode 100644 index 00000000..bafa0ff7 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/PathComponents.html @@ -0,0 +1,205 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.PathComponents (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.PathComponents

+
+ + + + + + + + + +
+Packages that use PathComponents
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of PathComponents in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return PathComponents
+ PathComponentsPathHelper.getComponents(String path) + +
+           
+ PathComponentsPathHelper.getComponents(String parent, + String name) + +
+           
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.sftp with parameters of type PathComponents
RemoteResourceInfo(PathComponents comps, + FileAttributes attrs) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/PathHelper.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/PathHelper.html new file mode 100644 index 00000000..6bd87d96 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/PathHelper.html @@ -0,0 +1,205 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.PathHelper (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.PathHelper

+
+ + + + + + + + + +
+Packages that use PathHelper
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of PathHelper in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.sftp declared as PathHelper
+protected  PathHelperSFTPEngine.pathHelper + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return PathHelper
+ PathHelperSFTPEngine.getPathHelper() + +
+           
+ PathHelperRequester.getPathHelper() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RandomAccessRemoteFile.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RandomAccessRemoteFile.html new file mode 100644 index 00000000..01adabad --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RandomAccessRemoteFile.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.RandomAccessRemoteFile (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.RandomAccessRemoteFile

+
+No usage of net.schmizz.sshj.sftp.RandomAccessRemoteFile +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteDirectory.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteDirectory.html new file mode 100644 index 00000000..41c6b837 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteDirectory.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.RemoteDirectory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.RemoteDirectory

+
+ + + + + + + + + +
+Packages that use RemoteDirectory
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of RemoteDirectory in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return RemoteDirectory
+ RemoteDirectorySFTPEngine.openDir(String path) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteFile.RemoteFileInputStream.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteFile.RemoteFileInputStream.html new file mode 100644 index 00000000..f64151b9 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteFile.RemoteFileInputStream.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.RemoteFile.RemoteFileInputStream (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.RemoteFile.RemoteFileInputStream

+
+ + + + + + + + + +
+Packages that use RemoteFile.RemoteFileInputStream
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of RemoteFile.RemoteFileInputStream in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return RemoteFile.RemoteFileInputStream
+ RemoteFile.RemoteFileInputStreamRemoteFile.getInputStream() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteFile.RemoteFileOutputStream.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteFile.RemoteFileOutputStream.html new file mode 100644 index 00000000..95424822 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteFile.RemoteFileOutputStream.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.RemoteFile.RemoteFileOutputStream (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.RemoteFile.RemoteFileOutputStream

+
+ + + + + + + + + +
+Packages that use RemoteFile.RemoteFileOutputStream
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of RemoteFile.RemoteFileOutputStream in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return RemoteFile.RemoteFileOutputStream
+ RemoteFile.RemoteFileOutputStreamRemoteFile.getOutputStream() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteFile.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteFile.html new file mode 100644 index 00000000..df1df411 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteFile.html @@ -0,0 +1,268 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.RemoteFile (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.RemoteFile

+
+ + + + + + + + + +
+Packages that use RemoteFile
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of RemoteFile in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return RemoteFile
+ RemoteFileStatefulSFTPClient.open(String filename) + +
+           
+ RemoteFileSFTPEngine.open(String filename) + +
+           
+ RemoteFileSFTPClient.open(String filename) + +
+           
+ RemoteFileStatefulSFTPClient.open(String filename, + Set<OpenMode> mode) + +
+           
+ RemoteFileSFTPEngine.open(String filename, + Set<OpenMode> modes) + +
+           
+ RemoteFileSFTPClient.open(String filename, + Set<OpenMode> mode) + +
+           
+ RemoteFileStatefulSFTPClient.open(String filename, + Set<OpenMode> mode, + FileAttributes attrs) + +
+           
+ RemoteFileSFTPEngine.open(String path, + Set<OpenMode> modes, + FileAttributes fa) + +
+           
+ RemoteFileSFTPClient.open(String filename, + Set<OpenMode> mode, + FileAttributes attrs) + +
+           
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.sftp with parameters of type RemoteFile
RandomAccessRemoteFile(RemoteFile rf) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteResource.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteResource.html new file mode 100644 index 00000000..23aa3fc1 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteResource.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.RemoteResource (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.RemoteResource

+
+ + + + + + + + + +
+Packages that use RemoteResource
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of RemoteResource in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + + + + + +
Subclasses of RemoteResource in net.schmizz.sshj.sftp
+ classRemoteDirectory + +
+           
+ classRemoteFile + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteResourceFilter.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteResourceFilter.html new file mode 100644 index 00000000..bbc8435c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteResourceFilter.html @@ -0,0 +1,231 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.sftp.RemoteResourceFilter (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.sftp.RemoteResourceFilter

+
+ + + + + + + + + +
+Packages that use RemoteResourceFilter
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of RemoteResourceFilter in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return RemoteResourceFilter
+ RemoteResourceFilterSFTPFileTransfer.getDownloadFilter() + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp with parameters of type RemoteResourceFilter
+ List<RemoteResourceInfo>StatefulSFTPClient.ls(RemoteResourceFilter filter) + +
+           
+ List<RemoteResourceInfo>StatefulSFTPClient.ls(String path, + RemoteResourceFilter filter) + +
+           
+ List<RemoteResourceInfo>SFTPClient.ls(String path, + RemoteResourceFilter filter) + +
+           
+ List<RemoteResourceInfo>RemoteDirectory.scan(RemoteResourceFilter filter) + +
+           
+ voidSFTPFileTransfer.setDownloadFilter(RemoteResourceFilter downloadFilter) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteResourceInfo.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteResourceInfo.html new file mode 100644 index 00000000..cdc64f7d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/RemoteResourceInfo.html @@ -0,0 +1,247 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.RemoteResourceInfo (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.RemoteResourceInfo

+
+ + + + + + + + + +
+Packages that use RemoteResourceInfo
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of RemoteResourceInfo in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return types with arguments of type RemoteResourceInfo
+ List<RemoteResourceInfo>StatefulSFTPClient.ls() + +
+           
+ List<RemoteResourceInfo>StatefulSFTPClient.ls(RemoteResourceFilter filter) + +
+           
+ List<RemoteResourceInfo>StatefulSFTPClient.ls(String path) + +
+           
+ List<RemoteResourceInfo>SFTPClient.ls(String path) + +
+           
+ List<RemoteResourceInfo>StatefulSFTPClient.ls(String path, + RemoteResourceFilter filter) + +
+           
+ List<RemoteResourceInfo>SFTPClient.ls(String path, + RemoteResourceFilter filter) + +
+           
+ List<RemoteResourceInfo>RemoteDirectory.scan(RemoteResourceFilter filter) + +
+           
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.sftp with parameters of type RemoteResourceInfo
+ booleanRemoteResourceFilter.accept(RemoteResourceInfo resource) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/Request.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/Request.html new file mode 100644 index 00000000..6b359a9c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/Request.html @@ -0,0 +1,253 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.Request (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.Request

+
+ + + + + + + + + +
+Packages that use Request
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of Request in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return Request
+ RequestSFTPEngine.newExtendedRequest(String reqName) + +
+           
+ RequestSFTPEngine.newRequest(PacketType type) + +
+           
+ RequestRequester.newRequest(PacketType type) + +
+           
+protected  RequestRemoteResource.newRequest(PacketType type) + +
+           
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp with parameters of type Request
+ ResponseSFTPEngine.doRequest(Request req) + +
+           
+ ResponseRequester.doRequest(Request req) + +
+           
+ voidPacketReader.expectResponseTo(Request req) + +
+           
+  +

+ + + + + + + + + +
Method parameters in net.schmizz.sshj.sftp with type arguments of type Request
+protected  voidSFTPEngine.transmit(SFTPPacket<Request> payload) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/Requester.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/Requester.html new file mode 100644 index 00000000..9656fff7 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/Requester.html @@ -0,0 +1,229 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.sftp.Requester (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.sftp.Requester

+
+ + + + + + + + + +
+Packages that use Requester
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of Requester in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.sftp that implement Requester
+ classSFTPEngine + +
+           
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.sftp declared as Requester
+protected  RequesterRemoteResource.requester + +
+           
+  +

+ + + + + + + + + + + + + + +
Constructors in net.schmizz.sshj.sftp with parameters of type Requester
RemoteDirectory(Requester requester, + String path, + String handle) + +
+           
RemoteFile(Requester requester, + String path, + String handle) + +
+           
RemoteResource(Requester requester, + String path, + String handle) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/Response.StatusCode.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/Response.StatusCode.html new file mode 100644 index 00000000..1621b20d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/Response.StatusCode.html @@ -0,0 +1,253 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.Response.StatusCode (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.Response.StatusCode

+
+ + + + + + + + + +
+Packages that use Response.StatusCode
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of Response.StatusCode in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return Response.StatusCode
+static Response.StatusCodeResponse.StatusCode.fromInt(int code) + +
+           
+ Response.StatusCodeSFTPException.getStatusCode() + +
+           
+ Response.StatusCodeResponse.readStatusCode() + +
+           
+static Response.StatusCodeResponse.StatusCode.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static Response.StatusCode[]Response.StatusCode.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp with parameters of type Response.StatusCode
+ ResponseResponse.ensureStatusIs(Response.StatusCode acceptable) + +
+           
+protected  StringResponse.error(Response.StatusCode sc) + +
+           
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.sftp with parameters of type Response.StatusCode
SFTPException(Response.StatusCode sc, + String msg) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/Response.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/Response.html new file mode 100644 index 00000000..1d7f4af8 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/Response.html @@ -0,0 +1,268 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.Response (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.Response

+
+ + + + + + + + + +
+Packages that use Response
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of Response in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return Response
+ ResponseSFTPEngine.doRequest(Request req) + +
+           
+ ResponseRequester.doRequest(Request req) + +
+           
+ ResponseResponse.ensurePacketTypeIs(PacketType pt) + +
+           
+ ResponseResponse.ensureStatusIs(Response.StatusCode acceptable) + +
+           
+ ResponseResponse.ensureStatusPacketIsOK() + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return types with arguments of type Response
+ Promise<Response,SFTPException>Request.getResponsePromise() + +
+           
+ SFTPPacket<Response>PacketReader.readPacket() + +
+           
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.sftp with parameters of type Response
+protected static StringSFTPEngine.readSingleName(Response res) + +
+           
+  +

+ + + + + + + + +
Constructor parameters in net.schmizz.sshj.sftp with type arguments of type Response
Response(Buffer<Response> pk, + int protocolVersion) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/SFTPClient.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/SFTPClient.html new file mode 100644 index 00000000..b47b77f2 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/SFTPClient.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.SFTPClient (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.SFTPClient

+
+ + + + + + + + + + + + + +
+Packages that use SFTPClient
net.schmizz.sshj  
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of SFTPClient in net.schmizz.sshj
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj that return SFTPClient
+ SFTPClientSSHClient.newSFTPClient() + +
+           
+  +

+ + + + + +
+Uses of SFTPClient in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Subclasses of SFTPClient in net.schmizz.sshj.sftp
+ classStatefulSFTPClient + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/SFTPEngine.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/SFTPEngine.html new file mode 100644 index 00000000..6a2f292c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/SFTPEngine.html @@ -0,0 +1,244 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.SFTPEngine (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.SFTPEngine

+
+ + + + + + + + + +
+Packages that use SFTPEngine
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of SFTPEngine in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.sftp declared as SFTPEngine
+protected  SFTPEngineSFTPClient.engine + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return SFTPEngine
+ SFTPEngineSFTPClient.getSFTPEngine() + +
+           
+ SFTPEngineSFTPEngine.init() + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + +
Constructors in net.schmizz.sshj.sftp with parameters of type SFTPEngine
PacketReader(SFTPEngine engine) + +
+           
PathHelper(SFTPEngine engine, + String pathSep) + +
+           
SFTPClient(SFTPEngine engine) + +
+           
SFTPFileTransfer(SFTPEngine engine) + +
+           
StatefulSFTPClient(SFTPEngine engine) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/SFTPException.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/SFTPException.html new file mode 100644 index 00000000..adc74f89 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/SFTPException.html @@ -0,0 +1,284 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.SFTPException (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.SFTPException

+
+ + + + + + + + + +
+Packages that use SFTPException
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of SFTPException in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.sftp with type parameters of type SFTPException
+static ExceptionChainer<SFTPException>SFTPException.chainer + +
+           
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return types with arguments of type SFTPException
+ Promise<Response,SFTPException>Request.getResponsePromise() + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp that throw SFTPException
+ ResponseResponse.ensurePacketTypeIs(PacketType pt) + +
+           
+ ResponseResponse.ensureStatusIs(Response.StatusCode acceptable) + +
+           
+ ResponseResponse.ensureStatusPacketIsOK() + +
+           
+protected  StringResponse.error(Response.StatusCode sc) + +
+           
+ voidPacketReader.handle() + +
+           
+ FileAttributesSFTPPacket.readFileAttributes() + +
+           
+ Response.StatusCodeResponse.readStatusCode() + +
+           
+ PacketTypeSFTPPacket.readType() + +
+           
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.sftp that throw SFTPException
Response(Buffer<Response> pk, + int protocolVersion) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/SFTPFileTransfer.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/SFTPFileTransfer.html new file mode 100644 index 00000000..c3a9d327 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/SFTPFileTransfer.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.SFTPFileTransfer (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.SFTPFileTransfer

+
+ + + + + + + + + +
+Packages that use SFTPFileTransfer
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of SFTPFileTransfer in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.sftp declared as SFTPFileTransfer
+protected  SFTPFileTransferSFTPClient.xfer + +
+           
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return SFTPFileTransfer
+ SFTPFileTransferSFTPClient.getFileTansfer() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/SFTPPacket.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/SFTPPacket.html new file mode 100644 index 00000000..b68e1d39 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/SFTPPacket.html @@ -0,0 +1,237 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.SFTPPacket (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.SFTPPacket

+
+ + + + + + + + + +
+Packages that use SFTPPacket
net.schmizz.sshj.sftp  
+  +

+ + + + + +
+Uses of SFTPPacket in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.sftp with type parameters of type SFTPPacket
+ classSFTPPacket<T extends SFTPPacket<T>> + +
+           
+  +

+ + + + + + + + + + + + + +
Subclasses of SFTPPacket in net.schmizz.sshj.sftp
+ classRequest + +
+           
+ classResponse + +
+           
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return SFTPPacket
+ SFTPPacket<Response>PacketReader.readPacket() + +
+           
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.sftp with parameters of type SFTPPacket
+protected  voidSFTPEngine.transmit(SFTPPacket<Request> payload) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/StatefulSFTPClient.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/StatefulSFTPClient.html new file mode 100644 index 00000000..cdc9d92e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/class-use/StatefulSFTPClient.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.sftp.StatefulSFTPClient (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.sftp.StatefulSFTPClient

+
+No usage of net.schmizz.sshj.sftp.StatefulSFTPClient +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/package-frame.html new file mode 100644 index 00000000..61b52b13 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/package-frame.html @@ -0,0 +1,110 @@ + + + + + + + +net.schmizz.sshj.sftp (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.sftp + + + + +
+Interfaces  + +
+RemoteResourceFilter +
+Requester
+ + + + + + +
+Classes  + +
+FileAttributes +
+FileAttributes.Builder +
+FileMode +
+PacketReader +
+PathComponents +
+PathHelper +
+RandomAccessRemoteFile +
+RemoteDirectory +
+RemoteFile +
+RemoteResource +
+RemoteResourceInfo +
+Request +
+Response +
+SFTPClient +
+SFTPEngine +
+SFTPFileTransfer +
+SFTPPacket +
+StatefulSFTPClient
+ + + + + + +
+Enums  + +
+FileAttributes.Flag +
+FileMode.Type +
+OpenMode +
+PacketType +
+Response.StatusCode
+ + + + + + +
+Exceptions  + +
+SFTPException
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/package-summary.html new file mode 100644 index 00000000..2b0277cc --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/package-summary.html @@ -0,0 +1,288 @@ + + + + + + + +net.schmizz.sshj.sftp (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.sftp +

+ + + + + + + + + + + + + +
+Interface Summary
RemoteResourceFilter 
Requester 
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
FileAttributes 
FileAttributes.Builder 
FileMode 
PacketReader 
PathComponents 
PathHelper 
RandomAccessRemoteFile 
RemoteDirectory 
RemoteFile 
RemoteResource 
RemoteResourceInfo 
Request 
Response 
SFTPClient 
SFTPEngine 
SFTPFileTransfer 
SFTPPacket<T extends SFTPPacket<T>> 
StatefulSFTPClient 
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Enum Summary
FileAttributes.Flag 
FileMode.Type 
OpenMode 
PacketType 
Response.StatusCode 
+  + +

+ + + + + + + + + +
+Exception Summary
SFTPException 
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/package-tree.html new file mode 100644 index 00000000..cb0f6704 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/package-tree.html @@ -0,0 +1,202 @@ + + + + + + + +net.schmizz.sshj.sftp Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.sftp +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/sftp/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/sftp/package-use.html new file mode 100644 index 00000000..e5a027e3 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/sftp/package-use.html @@ -0,0 +1,340 @@ + + + + + + + +Uses of Package net.schmizz.sshj.sftp (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.sftp

+
+ + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.sftp
net.schmizz.sshj  
net.schmizz.sshj.sftp  
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.sftp used by net.schmizz.sshj
SFTPClient + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.sftp used by net.schmizz.sshj.sftp
FileAttributes + +
+           
FileAttributes.Builder + +
+           
FileAttributes.Flag + +
+           
FileMode + +
+           
FileMode.Type + +
+           
OpenMode + +
+           
PacketReader + +
+           
PacketType + +
+           
PathComponents + +
+           
PathHelper + +
+           
RemoteDirectory + +
+           
RemoteFile + +
+           
RemoteFile.RemoteFileInputStream + +
+           
RemoteFile.RemoteFileOutputStream + +
+           
RemoteResource + +
+           
RemoteResourceFilter + +
+           
RemoteResourceInfo + +
+           
Request + +
+           
Requester + +
+           
Response + +
+           
Response.StatusCode + +
+           
SFTPClient + +
+           
SFTPEngine + +
+           
SFTPException + +
+           
SFTPFileTransfer + +
+           
SFTPPacket + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/signature/AbstractSignature.html b/javadoc/0.4.1/net/schmizz/sshj/signature/AbstractSignature.html new file mode 100644 index 00000000..0e030488 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/signature/AbstractSignature.html @@ -0,0 +1,413 @@ + + + + + + + +AbstractSignature (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.signature +
+Class AbstractSignature

+
+java.lang.Object
+  extended by net.schmizz.sshj.signature.AbstractSignature
+
+
+
All Implemented Interfaces:
Signature
+
+
+
Direct Known Subclasses:
SignatureDSA, SignatureRSA
+
+
+
+
public abstract class AbstractSignature
extends Object
implements Signature
+ + +

+An abstract class for Signature that implements common functionality. +

+ +

+


+ +

+ + + + + + + + + + + + + + + +
+Field Summary
+protected  Stringalgorithm + +
+           
+protected  Signaturesignature + +
+           
+  + + + + + + + + + + + +
+Constructor Summary
+protected AbstractSignature(String algorithm) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+protected  byte[]extractSig(byte[] sig) + +
+           
+ voidinit(PublicKey publicKey, + PrivateKey privateKey) + +
+          Initialize this signature with the given public key and private key.
+ voidupdate(byte[] foo) + +
+          Convenience method, same as calling Signature.update(byte[], int, int) with offset as 0 and H.length.
+ voidupdate(byte[] foo, + int off, + int len) + +
+          Update the computed signature with the given data.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.signature.Signature
sign, verify
+  +

+ + + + + + + + +
+Field Detail
+ +

+algorithm

+
+protected final String algorithm
+
+
+
+
+
+ +

+signature

+
+protected Signature signature
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+AbstractSignature

+
+protected AbstractSignature(String algorithm)
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(PublicKey publicKey,
+                 PrivateKey privateKey)
+
+
Description copied from interface: Signature
+
Initialize this signature with the given public key and private key. If the private key is null, only signature + verification can be performed. +

+

+
Specified by:
init in interface Signature
+
+
+
Parameters:
publicKey - (null-ok) specify in case verification is needed
privateKey - (null-ok) specify in case signing is needed
+
+
+
+ +

+update

+
+public void update(byte[] foo)
+
+
Description copied from interface: Signature
+
Convenience method, same as calling Signature.update(byte[], int, int) with offset as 0 and H.length. +

+

+
Specified by:
update in interface Signature
+
+
+
Parameters:
foo - the byte-array to update with
+
+
+
+ +

+update

+
+public void update(byte[] foo,
+                   int off,
+                   int len)
+
+
Description copied from interface: Signature
+
Update the computed signature with the given data. +

+

+
Specified by:
update in interface Signature
+
+
+
Parameters:
foo - byte-array to update with
off - offset within the array
len - length until which to compute
+
+
+
+ +

+extractSig

+
+protected byte[] extractSig(byte[] sig)
+
+
+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/signature/Signature.html b/javadoc/0.4.1/net/schmizz/sshj/signature/Signature.html new file mode 100644 index 00000000..e3fb811d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/signature/Signature.html @@ -0,0 +1,309 @@ + + + + + + + +Signature (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.signature +
+Interface Signature

+
+
All Known Implementing Classes:
AbstractSignature, SignatureDSA, SignatureRSA
+
+
+
+
public interface Signature
+ + +

+Signature interface for SSH used to sign or verify data. Usually wraps a javax.crypto.Signature object. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidinit(PublicKey pubkey, + PrivateKey prvkey) + +
+          Initialize this signature with the given public key and private key.
+ byte[]sign() + +
+          Compute the signature.
+ voidupdate(byte[] H) + +
+          Convenience method, same as calling update(byte[], int, int) with offset as 0 and H.length.
+ voidupdate(byte[] H, + int off, + int len) + +
+          Update the computed signature with the given data.
+ booleanverify(byte[] sig) + +
+          Verify against the given signature.
+  +

+ + + + + + + + +
+Method Detail
+ +

+init

+
+void init(PublicKey pubkey,
+          PrivateKey prvkey)
+
+
Initialize this signature with the given public key and private key. If the private key is null, only signature + verification can be performed. +

+

+
Parameters:
pubkey - (null-ok) specify in case verification is needed
prvkey - (null-ok) specify in case signing is needed
+
+
+
+ +

+update

+
+void update(byte[] H)
+
+
Convenience method, same as calling update(byte[], int, int) with offset as 0 and H.length. +

+

+
Parameters:
H - the byte-array to update with
+
+
+
+ +

+update

+
+void update(byte[] H,
+            int off,
+            int len)
+
+
Update the computed signature with the given data. +

+

+
Parameters:
H - byte-array to update with
off - offset within the array
len - length until which to compute
+
+
+
+ +

+sign

+
+byte[] sign()
+
+
Compute the signature. +

+

+ +
Returns:
the computed signature
+
+
+
+ +

+verify

+
+boolean verify(byte[] sig)
+
+
Verify against the given signature. +

+

+
Parameters:
sig - the signature to verify against +
Returns:
true on successful verification, false on failure
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/signature/SignatureDSA.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/signature/SignatureDSA.Factory.html new file mode 100644 index 00000000..248bc75f --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/signature/SignatureDSA.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +SignatureDSA.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.signature +
+Class SignatureDSA.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.signature.SignatureDSA.Factory
+
+
+
All Implemented Interfaces:
Factory<Signature>, Factory.Named<Signature>
+
+
+
Enclosing class:
SignatureDSA
+
+
+
+
public static class SignatureDSA.Factory
extends Object
implements Factory.Named<Signature>
+ + +

+A named factory for DSA signature +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
SignatureDSA.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Signaturecreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SignatureDSA.Factory

+
+public SignatureDSA.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public Signature create()
+
+
+
Specified by:
create in interface Factory<Signature>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<Signature>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/signature/SignatureDSA.html b/javadoc/0.4.1/net/schmizz/sshj/signature/SignatureDSA.html new file mode 100644 index 00000000..3ade9b31 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/signature/SignatureDSA.html @@ -0,0 +1,332 @@ + + + + + + + +SignatureDSA (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.signature +
+Class SignatureDSA

+
+java.lang.Object
+  extended by net.schmizz.sshj.signature.AbstractSignature
+      extended by net.schmizz.sshj.signature.SignatureDSA
+
+
+
All Implemented Interfaces:
Signature
+
+
+
+
public class SignatureDSA
extends AbstractSignature
+ + +

+DSA Signature +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classSignatureDSA.Factory + +
+          A named factory for DSA signature
+ + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.signature.AbstractSignature
algorithm, signature
+  + + + + + + + + + + +
+Constructor Summary
SignatureDSA() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ byte[]sign() + +
+          Compute the signature.
+ booleanverify(byte[] sig) + +
+          Verify against the given signature.
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.signature.AbstractSignature
extractSig, init, update, update
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SignatureDSA

+
+public SignatureDSA()
+
+
+ + + + + + + + +
+Method Detail
+ +

+sign

+
+public byte[] sign()
+
+
Description copied from interface: Signature
+
Compute the signature. +

+

+ +
Returns:
the computed signature
+
+
+
+ +

+verify

+
+public boolean verify(byte[] sig)
+
+
Description copied from interface: Signature
+
Verify against the given signature. +

+

+
Parameters:
sig - the signature to verify against +
Returns:
true on successful verification, false on failure
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/signature/SignatureRSA.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/signature/SignatureRSA.Factory.html new file mode 100644 index 00000000..cac135ea --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/signature/SignatureRSA.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +SignatureRSA.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.signature +
+Class SignatureRSA.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.signature.SignatureRSA.Factory
+
+
+
All Implemented Interfaces:
Factory<Signature>, Factory.Named<Signature>
+
+
+
Enclosing class:
SignatureRSA
+
+
+
+
public static class SignatureRSA.Factory
extends Object
implements Factory.Named<Signature>
+ + +

+A named factory for RSA Signature +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
SignatureRSA.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Signaturecreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SignatureRSA.Factory

+
+public SignatureRSA.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public Signature create()
+
+
+
Specified by:
create in interface Factory<Signature>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<Signature>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/signature/SignatureRSA.html b/javadoc/0.4.1/net/schmizz/sshj/signature/SignatureRSA.html new file mode 100644 index 00000000..d43c1d29 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/signature/SignatureRSA.html @@ -0,0 +1,332 @@ + + + + + + + +SignatureRSA (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.signature +
+Class SignatureRSA

+
+java.lang.Object
+  extended by net.schmizz.sshj.signature.AbstractSignature
+      extended by net.schmizz.sshj.signature.SignatureRSA
+
+
+
All Implemented Interfaces:
Signature
+
+
+
+
public class SignatureRSA
extends AbstractSignature
+ + +

+RSA Signature +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classSignatureRSA.Factory + +
+          A named factory for RSA Signature
+ + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.signature.AbstractSignature
algorithm, signature
+  + + + + + + + + + + +
+Constructor Summary
SignatureRSA() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ byte[]sign() + +
+          Compute the signature.
+ booleanverify(byte[] sig) + +
+          Verify against the given signature.
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.signature.AbstractSignature
extractSig, init, update, update
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SignatureRSA

+
+public SignatureRSA()
+
+
+ + + + + + + + +
+Method Detail
+ +

+sign

+
+public byte[] sign()
+
+
Description copied from interface: Signature
+
Compute the signature. +

+

+ +
Returns:
the computed signature
+
+
+
+ +

+verify

+
+public boolean verify(byte[] sig)
+
+
Description copied from interface: Signature
+
Verify against the given signature. +

+

+
Parameters:
sig - the signature to verify against +
Returns:
true on successful verification, false on failure
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/signature/class-use/AbstractSignature.html b/javadoc/0.4.1/net/schmizz/sshj/signature/class-use/AbstractSignature.html new file mode 100644 index 00000000..9d152a81 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/signature/class-use/AbstractSignature.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class net.schmizz.sshj.signature.AbstractSignature (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.signature.AbstractSignature

+
+ + + + + + + + + +
+Packages that use AbstractSignature
net.schmizz.sshj.signature  
+  +

+ + + + + +
+Uses of AbstractSignature in net.schmizz.sshj.signature
+  +

+ + + + + + + + + + + + + +
Subclasses of AbstractSignature in net.schmizz.sshj.signature
+ classSignatureDSA + +
+          DSA Signature
+ classSignatureRSA + +
+          RSA Signature
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/signature/class-use/Signature.html b/javadoc/0.4.1/net/schmizz/sshj/signature/class-use/Signature.html new file mode 100644 index 00000000..531f00c5 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/signature/class-use/Signature.html @@ -0,0 +1,282 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.signature.Signature (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.signature.Signature

+
+ + + + + + + + + + + + + +
+Packages that use Signature
net.schmizz.sshj  
net.schmizz.sshj.signature  
+  +

+ + + + + +
+Uses of Signature in net.schmizz.sshj
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj that return types with arguments of type Signature
+ List<Factory.Named<Signature>>ConfigImpl.getSignatureFactories() + +
+           
+ List<Factory.Named<Signature>>Config.getSignatureFactories() + +
+          Retrieve the list of named factories for Signature
+  +

+ + + + + + + + + + + + + +
Method parameters in net.schmizz.sshj with type arguments of type Signature
+ voidConfigImpl.setSignatureFactories(List<Factory.Named<Signature>> signatureFactories) + +
+           
+ voidConfig.setSignatureFactories(List<Factory.Named<Signature>> signatureFactories) + +
+          Set the named factories for Signature.
+  +

+ + + + + +
+Uses of Signature in net.schmizz.sshj.signature
+  +

+ + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.signature that implement Signature
+ classAbstractSignature + +
+          An abstract class for Signature that implements common functionality.
+ classSignatureDSA + +
+          DSA Signature
+ classSignatureRSA + +
+          RSA Signature
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.signature that return Signature
+ SignatureSignatureRSA.Factory.create() + +
+           
+ SignatureSignatureDSA.Factory.create() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/signature/class-use/SignatureDSA.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/signature/class-use/SignatureDSA.Factory.html new file mode 100644 index 00000000..aa366866 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/signature/class-use/SignatureDSA.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.signature.SignatureDSA.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.signature.SignatureDSA.Factory

+
+No usage of net.schmizz.sshj.signature.SignatureDSA.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/signature/class-use/SignatureDSA.html b/javadoc/0.4.1/net/schmizz/sshj/signature/class-use/SignatureDSA.html new file mode 100644 index 00000000..ad9a0e68 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/signature/class-use/SignatureDSA.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.signature.SignatureDSA (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.signature.SignatureDSA

+
+No usage of net.schmizz.sshj.signature.SignatureDSA +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/signature/class-use/SignatureRSA.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/signature/class-use/SignatureRSA.Factory.html new file mode 100644 index 00000000..3adeb2eb --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/signature/class-use/SignatureRSA.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.signature.SignatureRSA.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.signature.SignatureRSA.Factory

+
+No usage of net.schmizz.sshj.signature.SignatureRSA.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/signature/class-use/SignatureRSA.html b/javadoc/0.4.1/net/schmizz/sshj/signature/class-use/SignatureRSA.html new file mode 100644 index 00000000..21f507b5 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/signature/class-use/SignatureRSA.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.signature.SignatureRSA (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.signature.SignatureRSA

+
+No usage of net.schmizz.sshj.signature.SignatureRSA +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/signature/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/signature/package-frame.html new file mode 100644 index 00000000..265c6698 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/signature/package-frame.html @@ -0,0 +1,52 @@ + + + + + + + +net.schmizz.sshj.signature (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.signature + + + + +
+Interfaces  + +
+Signature
+ + + + + + +
+Classes  + +
+AbstractSignature +
+SignatureDSA +
+SignatureDSA.Factory +
+SignatureRSA +
+SignatureRSA.Factory
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/signature/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/signature/package-summary.html new file mode 100644 index 00000000..bada5abc --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/signature/package-summary.html @@ -0,0 +1,188 @@ + + + + + + + +net.schmizz.sshj.signature (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.signature +

+ + + + + + + + + +
+Interface Summary
SignatureSignature interface for SSH used to sign or verify data.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
AbstractSignatureAn abstract class for Signature that implements common functionality.
SignatureDSADSA Signature
SignatureDSA.FactoryA named factory for DSA signature
SignatureRSARSA Signature
SignatureRSA.FactoryA named factory for RSA Signature
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/signature/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/signature/package-tree.html new file mode 100644 index 00000000..c1e7be10 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/signature/package-tree.html @@ -0,0 +1,164 @@ + + + + + + + +net.schmizz.sshj.signature Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.signature +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/signature/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/signature/package-use.html new file mode 100644 index 00000000..dd991e53 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/signature/package-use.html @@ -0,0 +1,196 @@ + + + + + + + +Uses of Package net.schmizz.sshj.signature (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.signature

+
+ + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.signature
net.schmizz.sshj  
net.schmizz.sshj.signature  
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.signature used by net.schmizz.sshj
Signature + +
+          Signature interface for SSH used to sign or verify data.
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.signature used by net.schmizz.sshj.signature
AbstractSignature + +
+          An abstract class for Signature that implements common functionality.
Signature + +
+          Signature interface for SSH used to sign or verify data.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/DisconnectListener.html b/javadoc/0.4.1/net/schmizz/sshj/transport/DisconnectListener.html new file mode 100644 index 00000000..926cec63 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/DisconnectListener.html @@ -0,0 +1,207 @@ + + + + + + + +DisconnectListener (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport +
+Interface DisconnectListener

+
+
+
public interface DisconnectListener
+ + +

+


+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidnotifyDisconnect(DisconnectReason reason) + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+notifyDisconnect

+
+void notifyDisconnect(DisconnectReason reason)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/NegotiatedAlgorithms.html b/javadoc/0.4.1/net/schmizz/sshj/transport/NegotiatedAlgorithms.html new file mode 100644 index 00000000..427a4bcd --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/NegotiatedAlgorithms.html @@ -0,0 +1,375 @@ + + + + + + + +NegotiatedAlgorithms (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport +
+Class NegotiatedAlgorithms

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.NegotiatedAlgorithms
+
+
+
+
public final class NegotiatedAlgorithms
extends Object
+ + +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StringgetClient2ServerCipherAlgorithm() + +
+           
+ StringgetClient2ServerCompressionAlgorithm() + +
+           
+ StringgetClient2ServerMACAlgorithm() + +
+           
+ StringgetKeyExchangeAlgorithm() + +
+           
+ StringgetServer2ClientCipherAlgorithm() + +
+           
+ StringgetServer2ClientCompressionAlgorithm() + +
+           
+ StringgetServer2ClientMACAlgorithm() + +
+           
+ StringgetSignatureAlgorithm() + +
+           
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Method Detail
+ +

+getKeyExchangeAlgorithm

+
+public String getKeyExchangeAlgorithm()
+
+
+
+
+
+
+ +

+getSignatureAlgorithm

+
+public String getSignatureAlgorithm()
+
+
+
+
+
+
+ +

+getClient2ServerCipherAlgorithm

+
+public String getClient2ServerCipherAlgorithm()
+
+
+
+
+
+
+ +

+getServer2ClientCipherAlgorithm

+
+public String getServer2ClientCipherAlgorithm()
+
+
+
+
+
+
+ +

+getClient2ServerMACAlgorithm

+
+public String getClient2ServerMACAlgorithm()
+
+
+
+
+
+
+ +

+getServer2ClientMACAlgorithm

+
+public String getServer2ClientMACAlgorithm()
+
+
+
+
+
+
+ +

+getClient2ServerCompressionAlgorithm

+
+public String getClient2ServerCompressionAlgorithm()
+
+
+
+
+
+
+ +

+getServer2ClientCompressionAlgorithm

+
+public String getServer2ClientCompressionAlgorithm()
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/Reader.html b/javadoc/0.4.1/net/schmizz/sshj/transport/Reader.html new file mode 100644 index 00000000..15dee94f --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/Reader.html @@ -0,0 +1,306 @@ + + + + + + + +Reader (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport +
+Class Reader

+
+java.lang.Object
+  extended by java.lang.Thread
+      extended by net.schmizz.sshj.transport.Reader
+
+
+
All Implemented Interfaces:
Runnable
+
+
+
+
public final class Reader
extends Thread
+ + +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class java.lang.Thread
Thread.State, Thread.UncaughtExceptionHandler
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
+  + + + + + + + + + + +
+Constructor Summary
Reader(TransportImpl trans) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidrun() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Thread
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
+ + + + + + + +
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Reader

+
+public Reader(TransportImpl trans)
+
+
+ + + + + + + + +
+Method Detail
+ +

+run

+
+public void run()
+
+
+
Specified by:
run in interface Runnable
Overrides:
run in class Thread
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/Transport.html b/javadoc/0.4.1/net/schmizz/sshj/transport/Transport.html new file mode 100644 index 00000000..37d57aa7 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/Transport.html @@ -0,0 +1,916 @@ + + + + + + + +Transport (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport +
+Interface Transport

+
+
All Superinterfaces:
SSHPacketHandler
+
+
+
All Known Implementing Classes:
TransportImpl
+
+
+
+
public interface Transport
extends SSHPacketHandler
+ + +

+Transport layer of the SSH protocol. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddHostKeyVerifier(HostKeyVerifier hkv) + +
+          Adds the specified verifier.
+ voiddisconnect() + +
+          Send a disconnection packet with reason as DisconnectReason.BY_APPLICATION, and closes this transport.
+ voiddisconnect(DisconnectReason reason) + +
+          Send a disconnect packet with the given reason, and closes this transport.
+ voiddisconnect(DisconnectReason reason, + String message) + +
+          Send a disconnect packet with the given reason and message, and closes this + transport.
+ voiddoKex() + +
+          Do key exchange and algorithm negotiation.
+ StringgetClientVersion() + +
+           
+ ConfiggetConfig() + +
+           
+ DisconnectListenergetDisconnectListener() + +
+           
+ intgetHeartbeatInterval() + +
+           
+ StringgetRemoteHost() + +
+           
+ intgetRemotePort() + +
+           
+ StringgetServerVersion() + +
+          Returns the version string as sent by the SSH server for identification purposes, e.g.
+ ServicegetService() + +
+           
+ byte[]getSessionID() + +
+           
+ intgetTimeout() + +
+           
+ voidinit(String host, + int port, + InputStream in, + OutputStream out) + +
+          Sets the host information and the streams to be used by this transport.
+ booleanisAuthenticated() + +
+           
+ booleanisRunning() + +
+           
+ voidjoin() + +
+          Joins the thread calling this method to the transport's death.
+ voidjoin(int timeout, + TimeUnit unit) + +
+          Joins the thread calling this method to the transport's death.
+ voidreqService(Service service) + +
+          Request a SSH service represented by a Service instance.
+ longsendUnimplemented() + +
+          Sends SSH_MSG_UNIMPLEMENTED in response to the last packet received.
+ voidsetAuthenticated() + +
+          Informs this transport that authentication has been completed.
+ voidsetDisconnectListener(DisconnectListener listener) + +
+          Specify a listener that will be notified upon disconnection.
+ voidsetHeartbeatInterval(int interval) + +
+           
+ voidsetService(Service service) + +
+          Sets the currently active Service.
+ voidsetTimeout(int timeout) + +
+          Set a timeout for methods that may block.
+ longwrite(SSHPacket payload) + +
+          Write a packet over this transport.
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.SSHPacketHandler
handle
+  +

+ + + + + + + + +
+Method Detail
+ +

+init

+
+void init(String host,
+          int port,
+          InputStream in,
+          OutputStream out)
+          throws TransportException
+
+
Sets the host information and the streams to be used by this transport. Identification information is exchanged + with the server. A TransportException is thrown in case of SSH protocol version incompatibility. +

+

+
+
+
+
Parameters:
host - server's hostname
port - server's port
in - input stream for the connection
out - output stream for the connection +
Throws: +
TransportException - if there is an error during exchange of identification information
+
+
+
+ +

+addHostKeyVerifier

+
+void addHostKeyVerifier(HostKeyVerifier hkv)
+
+
Adds the specified verifier. +

+

+
+
+
+
Parameters:
hkv - the host key verifier
+
+
+
+ +

+doKex

+
+void doKex()
+           throws TransportException
+
+
Do key exchange and algorithm negotiation. This can be the initial one or for algorithm renegotiation. +

+

+
+
+
+ +
Throws: +
TransportException - if there was an error during key exchange
+
+
+
+ +

+getClientVersion

+
+String getClientVersion()
+
+
+
+
+
+ +
Returns:
the version string used by this client to identify itself to an SSH server, e.g. "SSHJ_3_0"
+
+
+
+ +

+getConfig

+
+Config getConfig()
+
+
+
+
+
+ +
Returns:
the Config associated with this transport.
+
+
+
+ +

+getTimeout

+
+int getTimeout()
+
+
+
+
+
+ +
Returns:
the timeout that is currently set for blocking operations.
+
+
+
+ +

+setTimeout

+
+void setTimeout(int timeout)
+
+
Set a timeout for methods that may block. +

+

+
+
+
+
Parameters:
timeout - the timeout in seconds
+
+
+
+ +

+getHeartbeatInterval

+
+int getHeartbeatInterval()
+
+
+
+
+
+ +
Returns:
the interval in seconds at which a heartbeat message is sent to the server
+
+
+
+ +

+setHeartbeatInterval

+
+void setHeartbeatInterval(int interval)
+
+
+
+
+
+
Parameters:
interval - the interval in seconds, 0 means no hearbeat
+
+
+
+ +

+getRemoteHost

+
+String getRemoteHost()
+
+
+
+
+
+ +
Returns:
the hostname to which this transport is connected.
+
+
+
+ +

+getRemotePort

+
+int getRemotePort()
+
+
+
+
+
+ +
Returns:
the port number on the remote host to which this transport is connected.
+
+
+
+ +

+getServerVersion

+
+String getServerVersion()
+
+
Returns the version string as sent by the SSH server for identification purposes, e.g. "OpenSSH_$version". +

+ If the transport has not yet been initialized via init(java.lang.String, int, java.io.InputStream, java.io.OutputStream), it will be null. +

+

+
+
+
+ +
Returns:
server's version string (may be null)
+
+
+
+ +

+getSessionID

+
+byte[] getSessionID()
+
+
+
+
+
+ +
Returns:
the session identifier assigned by server
+
+
+
+ +

+getService

+
+Service getService()
+
+
+
+
+
+ +
Returns:
the currently active Service instance.
+
+
+
+ +

+reqService

+
+void reqService(Service service)
+                throws TransportException
+
+
Request a SSH service represented by a Service instance. A separate call to setService(net.schmizz.sshj.Service) is not + needed. +

+

+
+
+
+
Parameters:
service - the SSH service to be requested +
Throws: +
TransportException - if the request failed for any reason
+
+
+
+ +

+setService

+
+void setService(Service service)
+
+
Sets the currently active Service. Handling of non-transport-layer packets is delegated to that service. +

+ For this method to be successful, at least one service request via reqService(net.schmizz.sshj.Service) must have been successful + (not necessarily for the service being set). +

+

+
+
+
+
Parameters:
service - (null-ok) the Service
+
+
+
+ +

+isAuthenticated

+
+boolean isAuthenticated()
+
+
+
+
+
+ +
Returns:
whether the transport thinks it is authenticated.
+
+
+
+ +

+setAuthenticated

+
+void setAuthenticated()
+
+
Informs this transport that authentication has been completed. This method must be called after + successful authentication, so that delayed compression may become effective if applicable. +

+

+
+
+
+
+
+
+
+ +

+sendUnimplemented

+
+long sendUnimplemented()
+                       throws TransportException
+
+
Sends SSH_MSG_UNIMPLEMENTED in response to the last packet received. +

+

+
+
+
+ +
Returns:
the sequence number of the packet sent +
Throws: +
TransportException - if an error occured sending the packet
+
+
+
+ +

+isRunning

+
+boolean isRunning()
+
+
+
+
+
+ +
Returns:
whether this transport is active. +

+ The transport is considered to be running if it has been initialized without error via init(java.lang.String, int, java.io.InputStream, java.io.OutputStream) and + has not been disconnected.

+
+
+
+ +

+join

+
+void join()
+          throws TransportException
+
+
Joins the thread calling this method to the transport's death. +

+

+
+
+
+ +
Throws: +
TransportException - if the transport dies of an exception
+
+
+
+ +

+join

+
+void join(int timeout,
+          TimeUnit unit)
+          throws TransportException
+
+
Joins the thread calling this method to the transport's death. +

+

+
+
+
+ +
Throws: +
TransportException - if the transport dies of an exception
+
+
+
+ +

+disconnect

+
+void disconnect()
+
+
Send a disconnection packet with reason as DisconnectReason.BY_APPLICATION, and closes this transport. +

+

+
+
+
+
+
+
+
+ +

+disconnect

+
+void disconnect(DisconnectReason reason)
+
+
Send a disconnect packet with the given reason, and closes this transport. +

+

+
+
+
+
Parameters:
reason - reason for disconnecting
+
+
+
+ +

+disconnect

+
+void disconnect(DisconnectReason reason,
+                String message)
+
+
Send a disconnect packet with the given reason and message, and closes this + transport. +

+

+
+
+
+
Parameters:
reason - the reason code for this disconnect
message - the text message
+
+
+
+ +

+write

+
+long write(SSHPacket payload)
+           throws TransportException
+
+
Write a packet over this transport. +

+ The payload SSHPacket should have 5 bytes free at the beginning to avoid a performance penalty + associated with making space for header bytes (packet length, padding length). +

+

+
+
+
+
Parameters:
payload - the SSHPacket containing data to send +
Returns:
sequence number of the sent packet +
Throws: +
TransportException - if an error occurred sending the packet
+
+
+
+ +

+setDisconnectListener

+
+void setDisconnectListener(DisconnectListener listener)
+
+
Specify a listener that will be notified upon disconnection. +

+

+
+
+
+
Parameters:
listener -
+
+
+
+ +

+getDisconnectListener

+
+DisconnectListener getDisconnectListener()
+
+
+
+
+
+ +
Returns:
the current disconnect listener.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/TransportException.html b/javadoc/0.4.1/net/schmizz/sshj/transport/TransportException.html new file mode 100644 index 00000000..4227b9d7 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/TransportException.html @@ -0,0 +1,386 @@ + + + + + + + +TransportException (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport +
+Class TransportException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by net.schmizz.sshj.common.SSHException
+                  extended by net.schmizz.sshj.transport.TransportException
+
+
+
All Implemented Interfaces:
Serializable
+
+
+
+
public class TransportException
extends SSHException
+ + +

+Transport-layer exception +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Field Summary
+static ExceptionChainer<TransportException>chainer + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
TransportException(DisconnectReason code) + +
+           
TransportException(DisconnectReason code, + String message) + +
+           
TransportException(DisconnectReason code, + String message, + Throwable cause) + +
+           
TransportException(DisconnectReason code, + Throwable cause) + +
+           
TransportException(String message) + +
+           
TransportException(String message, + Throwable cause) + +
+           
TransportException(Throwable cause) + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.common.SSHException
getDisconnectReason, getMessage, toString
+ + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+chainer

+
+public static final ExceptionChainer<TransportException> chainer
+
+
+
See Also:
ExceptionChainer
+
+ + + + + + + + +
+Constructor Detail
+ +

+TransportException

+
+public TransportException(DisconnectReason code)
+
+
+
+ +

+TransportException

+
+public TransportException(DisconnectReason code,
+                          String message)
+
+
+
+ +

+TransportException

+
+public TransportException(DisconnectReason code,
+                          String message,
+                          Throwable cause)
+
+
+
+ +

+TransportException

+
+public TransportException(DisconnectReason code,
+                          Throwable cause)
+
+
+
+ +

+TransportException

+
+public TransportException(String message)
+
+
+
+ +

+TransportException

+
+public TransportException(String message,
+                          Throwable cause)
+
+
+
+ +

+TransportException

+
+public TransportException(Throwable cause)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/TransportImpl.html b/javadoc/0.4.1/net/schmizz/sshj/transport/TransportImpl.html new file mode 100644 index 00000000..2f91c37e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/TransportImpl.html @@ -0,0 +1,1023 @@ + + + + + + + +TransportImpl (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport +
+Class TransportImpl

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.TransportImpl
+
+
+
All Implemented Interfaces:
SSHPacketHandler, Transport
+
+
+
+
public final class TransportImpl
extends Object
implements Transport
+ + +

+A thread-safe Transport implementation. +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
TransportImpl(Config config) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddHostKeyVerifier(HostKeyVerifier hkv) + +
+          Adds the specified verifier.
+ voiddisconnect() + +
+          Send a disconnection packet with reason as DisconnectReason.BY_APPLICATION, and closes this transport.
+ voiddisconnect(DisconnectReason reason) + +
+          Send a disconnect packet with the given reason, and closes this transport.
+ voiddisconnect(DisconnectReason reason, + String message) + +
+          Send a disconnect packet with the given reason and message, and closes this + transport.
+ voiddoKex() + +
+          Do key exchange and algorithm negotiation.
+ StringgetClientVersion() + +
+           
+ ConfiggetConfig() + +
+           
+ DisconnectListenergetDisconnectListener() + +
+           
+ intgetHeartbeatInterval() + +
+           
+ StringgetRemoteHost() + +
+           
+ intgetRemotePort() + +
+           
+ StringgetServerVersion() + +
+          Returns the version string as sent by the SSH server for identification purposes, e.g.
+ ServicegetService() + +
+           
+ byte[]getSessionID() + +
+           
+ intgetTimeout() + +
+           
+ voidhandle(Message msg, + SSHPacket buf) + +
+          This is where all incoming packets are handled.
+ voidinit(String remoteHost, + int remotePort, + InputStream in, + OutputStream out) + +
+          Sets the host information and the streams to be used by this transport.
+ booleanisAuthenticated() + +
+           
+ booleanisKexDone() + +
+           
+ booleanisRunning() + +
+           
+ voidjoin() + +
+          Joins the thread calling this method to the transport's death.
+ voidjoin(int timeout, + TimeUnit unit) + +
+          Joins the thread calling this method to the transport's death.
+ voidreqService(Service service) + +
+          Request a SSH service represented by a Service instance.
+ longsendUnimplemented() + +
+          Sends SSH_MSG_UNIMPLEMENTED in response to the last packet received.
+ voidsetAuthenticated() + +
+          Informs this transport that authentication has been completed.
+ voidsetDisconnectListener(DisconnectListener listener) + +
+          Specify a listener that will be notified upon disconnection.
+ voidsetHeartbeatInterval(int interval) + +
+           
+ voidsetService(Service service) + +
+          Sets the currently active Service.
+ voidsetTimeout(int timeout) + +
+          Set a timeout for methods that may block.
+ longwrite(SSHPacket payload) + +
+          Write a packet over this transport.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TransportImpl

+
+public TransportImpl(Config config)
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(String remoteHost,
+                 int remotePort,
+                 InputStream in,
+                 OutputStream out)
+          throws TransportException
+
+
Description copied from interface: Transport
+
Sets the host information and the streams to be used by this transport. Identification information is exchanged + with the server. A TransportException is thrown in case of SSH protocol version incompatibility. +

+

+
Specified by:
init in interface Transport
+
+
+
Parameters:
remoteHost - server's hostname
remotePort - server's port
in - input stream for the connection
out - output stream for the connection +
Throws: +
TransportException - if there is an error during exchange of identification information
+
+
+
+ +

+addHostKeyVerifier

+
+public void addHostKeyVerifier(HostKeyVerifier hkv)
+
+
Description copied from interface: Transport
+
Adds the specified verifier. +

+

+
Specified by:
addHostKeyVerifier in interface Transport
+
+
+
Parameters:
hkv - the host key verifier
+
+
+
+ +

+doKex

+
+public void doKex()
+           throws TransportException
+
+
Description copied from interface: Transport
+
Do key exchange and algorithm negotiation. This can be the initial one or for algorithm renegotiation. +

+

+
Specified by:
doKex in interface Transport
+
+
+ +
Throws: +
TransportException - if there was an error during key exchange
+
+
+
+ +

+isKexDone

+
+public boolean isKexDone()
+
+
+
+
+
+
+
+
+
+ +

+getTimeout

+
+public int getTimeout()
+
+
+
Specified by:
getTimeout in interface Transport
+
+
+ +
Returns:
the timeout that is currently set for blocking operations.
+
+
+
+ +

+setTimeout

+
+public void setTimeout(int timeout)
+
+
Description copied from interface: Transport
+
Set a timeout for methods that may block. +

+

+
Specified by:
setTimeout in interface Transport
+
+
+
Parameters:
timeout - the timeout in seconds
+
+
+
+ +

+getHeartbeatInterval

+
+public int getHeartbeatInterval()
+
+
+
Specified by:
getHeartbeatInterval in interface Transport
+
+
+ +
Returns:
the interval in seconds at which a heartbeat message is sent to the server
+
+
+
+ +

+setHeartbeatInterval

+
+public void setHeartbeatInterval(int interval)
+
+
+
Specified by:
setHeartbeatInterval in interface Transport
+
+
+
Parameters:
interval - the interval in seconds, 0 means no hearbeat
+
+
+
+ +

+getRemoteHost

+
+public String getRemoteHost()
+
+
+
Specified by:
getRemoteHost in interface Transport
+
+
+ +
Returns:
the hostname to which this transport is connected.
+
+
+
+ +

+getRemotePort

+
+public int getRemotePort()
+
+
+
Specified by:
getRemotePort in interface Transport
+
+
+ +
Returns:
the port number on the remote host to which this transport is connected.
+
+
+
+ +

+getClientVersion

+
+public String getClientVersion()
+
+
+
Specified by:
getClientVersion in interface Transport
+
+
+ +
Returns:
the version string used by this client to identify itself to an SSH server, e.g. "SSHJ_3_0"
+
+
+
+ +

+getConfig

+
+public Config getConfig()
+
+
+
Specified by:
getConfig in interface Transport
+
+
+ +
Returns:
the Config associated with this transport.
+
+
+
+ +

+getServerVersion

+
+public String getServerVersion()
+
+
Description copied from interface: Transport
+
Returns the version string as sent by the SSH server for identification purposes, e.g. "OpenSSH_$version". +

+ If the transport has not yet been initialized via Transport.init(java.lang.String, int, java.io.InputStream, java.io.OutputStream), it will be null. +

+

+
Specified by:
getServerVersion in interface Transport
+
+
+ +
Returns:
server's version string (may be null)
+
+
+
+ +

+getSessionID

+
+public byte[] getSessionID()
+
+
+
Specified by:
getSessionID in interface Transport
+
+
+ +
Returns:
the session identifier assigned by server
+
+
+
+ +

+getService

+
+public Service getService()
+
+
+
Specified by:
getService in interface Transport
+
+
+ +
Returns:
the currently active Service instance.
+
+
+
+ +

+setService

+
+public void setService(Service service)
+
+
Description copied from interface: Transport
+
Sets the currently active Service. Handling of non-transport-layer packets is delegated to that service. +

+ For this method to be successful, at least one service request via Transport.reqService(net.schmizz.sshj.Service) must have been successful + (not necessarily for the service being set). +

+

+
Specified by:
setService in interface Transport
+
+
+
Parameters:
service - (null-ok) the Service
+
+
+
+ +

+reqService

+
+public void reqService(Service service)
+                throws TransportException
+
+
Description copied from interface: Transport
+
Request a SSH service represented by a Service instance. A separate call to Transport.setService(net.schmizz.sshj.Service) is not + needed. +

+

+
Specified by:
reqService in interface Transport
+
+
+
Parameters:
service - the SSH service to be requested +
Throws: +
TransportException - if the request failed for any reason
+
+
+
+ +

+setAuthenticated

+
+public void setAuthenticated()
+
+
Description copied from interface: Transport
+
Informs this transport that authentication has been completed. This method must be called after + successful authentication, so that delayed compression may become effective if applicable. +

+

+
Specified by:
setAuthenticated in interface Transport
+
+
+
+
+
+
+ +

+isAuthenticated

+
+public boolean isAuthenticated()
+
+
+
Specified by:
isAuthenticated in interface Transport
+
+
+ +
Returns:
whether the transport thinks it is authenticated.
+
+
+
+ +

+sendUnimplemented

+
+public long sendUnimplemented()
+                       throws TransportException
+
+
Description copied from interface: Transport
+
Sends SSH_MSG_UNIMPLEMENTED in response to the last packet received. +

+

+
Specified by:
sendUnimplemented in interface Transport
+
+
+ +
Returns:
the sequence number of the packet sent +
Throws: +
TransportException - if an error occured sending the packet
+
+
+
+ +

+join

+
+public void join()
+          throws TransportException
+
+
Description copied from interface: Transport
+
Joins the thread calling this method to the transport's death. +

+

+
Specified by:
join in interface Transport
+
+
+ +
Throws: +
TransportException - if the transport dies of an exception
+
+
+
+ +

+join

+
+public void join(int timeout,
+                 TimeUnit unit)
+          throws TransportException
+
+
Description copied from interface: Transport
+
Joins the thread calling this method to the transport's death. +

+

+
Specified by:
join in interface Transport
+
+
+ +
Throws: +
TransportException - if the transport dies of an exception
+
+
+
+ +

+isRunning

+
+public boolean isRunning()
+
+
+
Specified by:
isRunning in interface Transport
+
+
+ +
Returns:
whether this transport is active. +

+ The transport is considered to be running if it has been initialized without error via Transport.init(java.lang.String, int, java.io.InputStream, java.io.OutputStream) and + has not been disconnected.

+
+
+
+ +

+disconnect

+
+public void disconnect()
+
+
Description copied from interface: Transport
+
Send a disconnection packet with reason as DisconnectReason.BY_APPLICATION, and closes this transport. +

+

+
Specified by:
disconnect in interface Transport
+
+
+
+
+
+
+ +

+disconnect

+
+public void disconnect(DisconnectReason reason)
+
+
Description copied from interface: Transport
+
Send a disconnect packet with the given reason, and closes this transport. +

+

+
Specified by:
disconnect in interface Transport
+
+
+
Parameters:
reason - reason for disconnecting
+
+
+
+ +

+disconnect

+
+public void disconnect(DisconnectReason reason,
+                       String message)
+
+
Description copied from interface: Transport
+
Send a disconnect packet with the given reason and message, and closes this + transport. +

+

+
Specified by:
disconnect in interface Transport
+
+
+
Parameters:
reason - the reason code for this disconnect
message - the text message
+
+
+
+ +

+setDisconnectListener

+
+public void setDisconnectListener(DisconnectListener listener)
+
+
Description copied from interface: Transport
+
Specify a listener that will be notified upon disconnection. +

+

+
Specified by:
setDisconnectListener in interface Transport
+
+
+
+
+
+
+ +

+getDisconnectListener

+
+public DisconnectListener getDisconnectListener()
+
+
+
Specified by:
getDisconnectListener in interface Transport
+
+
+ +
Returns:
the current disconnect listener.
+
+
+
+ +

+write

+
+public long write(SSHPacket payload)
+           throws TransportException
+
+
Description copied from interface: Transport
+
Write a packet over this transport. +

+ The payload SSHPacket should have 5 bytes free at the beginning to avoid a performance penalty + associated with making space for header bytes (packet length, padding length). +

+

+
Specified by:
write in interface Transport
+
+
+
Parameters:
payload - the SSHPacket containing data to send +
Returns:
sequence number of the sent packet +
Throws: +
TransportException - if an error occurred sending the packet
+
+
+
+ +

+handle

+
+public void handle(Message msg,
+                   SSHPacket buf)
+            throws SSHException
+
+
This is where all incoming packets are handled. If they pertain to the transport layer, they are handled here; + otherwise they are delegated to the active service instance if any via SSHPacketHandler.handle(net.schmizz.sshj.common.Message, net.schmizz.sshj.common.SSHPacket). +

+ Even among the transport layer specific packets, key exchange packets are delegated to KeyExchanger.handle(net.schmizz.sshj.common.Message, net.schmizz.sshj.common.SSHPacket). +

+ This method is called in the context of the reader thread via Decoder.received(byte[], int) when a full + packet has been decoded. +

+

+
Specified by:
handle in interface SSHPacketHandler
+
+
+
Parameters:
msg - the message identifer
buf - buffer containg rest of the packet +
Throws: +
SSHException - if an error occurs during handling (unrecoverable)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES128CBC.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES128CBC.Factory.html new file mode 100644 index 00000000..88d46bc6 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES128CBC.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +AES128CBC.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Class AES128CBC.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.cipher.AES128CBC.Factory
+
+
+
All Implemented Interfaces:
Factory<Cipher>, Factory.Named<Cipher>
+
+
+
Enclosing class:
AES128CBC
+
+
+
+
public static class AES128CBC.Factory
extends Object
implements Factory.Named<Cipher>
+ + +

+Named factory for AES128CBC Cipher +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
AES128CBC.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Ciphercreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AES128CBC.Factory

+
+public AES128CBC.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public Cipher create()
+
+
+
Specified by:
create in interface Factory<Cipher>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<Cipher>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES128CBC.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES128CBC.html new file mode 100644 index 00000000..f8e82df6 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES128CBC.html @@ -0,0 +1,269 @@ + + + + + + + +AES128CBC (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Class AES128CBC

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.cipher.BaseCipher
+      extended by net.schmizz.sshj.transport.cipher.AES128CBC
+
+
+
All Implemented Interfaces:
Cipher
+
+
+
+
public class AES128CBC
extends BaseCipher
+ + +

+aes128-cbc cipher +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classAES128CBC.Factory + +
+          Named factory for AES128CBC Cipher
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.transport.cipher.Cipher
Cipher.Mode
+  + + + + + + + + + + + +
+Constructor Summary
AES128CBC() + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.cipher.BaseCipher
getBlockSize, getIVSize, init, update
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AES128CBC

+
+public AES128CBC()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES128CTR.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES128CTR.Factory.html new file mode 100644 index 00000000..ed0f9433 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES128CTR.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +AES128CTR.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Class AES128CTR.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.cipher.AES128CTR.Factory
+
+
+
All Implemented Interfaces:
Factory<Cipher>, Factory.Named<Cipher>
+
+
+
Enclosing class:
AES128CTR
+
+
+
+
public static class AES128CTR.Factory
extends Object
implements Factory.Named<Cipher>
+ + +

+Named factory for AES128CBC Cipher +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
AES128CTR.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Ciphercreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AES128CTR.Factory

+
+public AES128CTR.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public Cipher create()
+
+
+
Specified by:
create in interface Factory<Cipher>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<Cipher>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES128CTR.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES128CTR.html new file mode 100644 index 00000000..d097eb52 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES128CTR.html @@ -0,0 +1,269 @@ + + + + + + + +AES128CTR (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Class AES128CTR

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.cipher.BaseCipher
+      extended by net.schmizz.sshj.transport.cipher.AES128CTR
+
+
+
All Implemented Interfaces:
Cipher
+
+
+
+
public class AES128CTR
extends BaseCipher
+ + +

+aes128-ctr cipher +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classAES128CTR.Factory + +
+          Named factory for AES128CBC Cipher
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.transport.cipher.Cipher
Cipher.Mode
+  + + + + + + + + + + + +
+Constructor Summary
AES128CTR() + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.cipher.BaseCipher
getBlockSize, getIVSize, init, update
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AES128CTR

+
+public AES128CTR()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES192CBC.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES192CBC.Factory.html new file mode 100644 index 00000000..c67c307c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES192CBC.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +AES192CBC.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Class AES192CBC.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.cipher.AES192CBC.Factory
+
+
+
All Implemented Interfaces:
Factory<Cipher>, Factory.Named<Cipher>
+
+
+
Enclosing class:
AES192CBC
+
+
+
+
public static class AES192CBC.Factory
extends Object
implements Factory.Named<Cipher>
+ + +

+Named factory for AES192CBC Cipher +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
AES192CBC.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Ciphercreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AES192CBC.Factory

+
+public AES192CBC.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public Cipher create()
+
+
+
Specified by:
create in interface Factory<Cipher>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<Cipher>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES192CBC.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES192CBC.html new file mode 100644 index 00000000..9046539e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES192CBC.html @@ -0,0 +1,269 @@ + + + + + + + +AES192CBC (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Class AES192CBC

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.cipher.BaseCipher
+      extended by net.schmizz.sshj.transport.cipher.AES192CBC
+
+
+
All Implemented Interfaces:
Cipher
+
+
+
+
public class AES192CBC
extends BaseCipher
+ + +

+aes192-cbc cipher +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classAES192CBC.Factory + +
+          Named factory for AES192CBC Cipher
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.transport.cipher.Cipher
Cipher.Mode
+  + + + + + + + + + + + +
+Constructor Summary
AES192CBC() + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.cipher.BaseCipher
getBlockSize, getIVSize, init, update
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AES192CBC

+
+public AES192CBC()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES192CTR.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES192CTR.Factory.html new file mode 100644 index 00000000..566f7be7 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES192CTR.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +AES192CTR.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Class AES192CTR.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.cipher.AES192CTR.Factory
+
+
+
All Implemented Interfaces:
Factory<Cipher>, Factory.Named<Cipher>
+
+
+
Enclosing class:
AES192CTR
+
+
+
+
public static class AES192CTR.Factory
extends Object
implements Factory.Named<Cipher>
+ + +

+Named factory for AES192CTR Cipher +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
AES192CTR.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Ciphercreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AES192CTR.Factory

+
+public AES192CTR.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public Cipher create()
+
+
+
Specified by:
create in interface Factory<Cipher>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<Cipher>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES192CTR.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES192CTR.html new file mode 100644 index 00000000..895d2eb2 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES192CTR.html @@ -0,0 +1,269 @@ + + + + + + + +AES192CTR (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Class AES192CTR

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.cipher.BaseCipher
+      extended by net.schmizz.sshj.transport.cipher.AES192CTR
+
+
+
All Implemented Interfaces:
Cipher
+
+
+
+
public class AES192CTR
extends BaseCipher
+ + +

+aes192-ctr cipher +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classAES192CTR.Factory + +
+          Named factory for AES192CTR Cipher
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.transport.cipher.Cipher
Cipher.Mode
+  + + + + + + + + + + + +
+Constructor Summary
AES192CTR() + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.cipher.BaseCipher
getBlockSize, getIVSize, init, update
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AES192CTR

+
+public AES192CTR()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES256CBC.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES256CBC.Factory.html new file mode 100644 index 00000000..7499335f --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES256CBC.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +AES256CBC.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Class AES256CBC.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.cipher.AES256CBC.Factory
+
+
+
All Implemented Interfaces:
Factory<Cipher>, Factory.Named<Cipher>
+
+
+
Enclosing class:
AES256CBC
+
+
+
+
public static class AES256CBC.Factory
extends Object
implements Factory.Named<Cipher>
+ + +

+Named factory for AES256CBC Cipher +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
AES256CBC.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Ciphercreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AES256CBC.Factory

+
+public AES256CBC.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public Cipher create()
+
+
+
Specified by:
create in interface Factory<Cipher>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<Cipher>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES256CBC.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES256CBC.html new file mode 100644 index 00000000..fe5db06a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES256CBC.html @@ -0,0 +1,269 @@ + + + + + + + +AES256CBC (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Class AES256CBC

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.cipher.BaseCipher
+      extended by net.schmizz.sshj.transport.cipher.AES256CBC
+
+
+
All Implemented Interfaces:
Cipher
+
+
+
+
public class AES256CBC
extends BaseCipher
+ + +

+aes256-ctr cipher +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classAES256CBC.Factory + +
+          Named factory for AES256CBC Cipher
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.transport.cipher.Cipher
Cipher.Mode
+  + + + + + + + + + + + +
+Constructor Summary
AES256CBC() + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.cipher.BaseCipher
getBlockSize, getIVSize, init, update
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AES256CBC

+
+public AES256CBC()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES256CTR.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES256CTR.Factory.html new file mode 100644 index 00000000..fa4feb3a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES256CTR.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +AES256CTR.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Class AES256CTR.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.cipher.AES256CTR.Factory
+
+
+
All Implemented Interfaces:
Factory<Cipher>, Factory.Named<Cipher>
+
+
+
Enclosing class:
AES256CTR
+
+
+
+
public static class AES256CTR.Factory
extends Object
implements Factory.Named<Cipher>
+ + +

+Named factory for AES256CBC Cipher +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
AES256CTR.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Ciphercreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AES256CTR.Factory

+
+public AES256CTR.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public Cipher create()
+
+
+
Specified by:
create in interface Factory<Cipher>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<Cipher>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES256CTR.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES256CTR.html new file mode 100644 index 00000000..2d948d29 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/AES256CTR.html @@ -0,0 +1,269 @@ + + + + + + + +AES256CTR (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Class AES256CTR

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.cipher.BaseCipher
+      extended by net.schmizz.sshj.transport.cipher.AES256CTR
+
+
+
All Implemented Interfaces:
Cipher
+
+
+
+
public class AES256CTR
extends BaseCipher
+ + +

+aes256-ctr cipher +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classAES256CTR.Factory + +
+          Named factory for AES256CBC Cipher
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.transport.cipher.Cipher
Cipher.Mode
+  + + + + + + + + + + + +
+Constructor Summary
AES256CTR() + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.cipher.BaseCipher
getBlockSize, getIVSize, init, update
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AES256CTR

+
+public AES256CTR()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/BaseCipher.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/BaseCipher.html new file mode 100644 index 00000000..9d1d333c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/BaseCipher.html @@ -0,0 +1,373 @@ + + + + + + + +BaseCipher (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Class BaseCipher

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.cipher.BaseCipher
+
+
+
All Implemented Interfaces:
Cipher
+
+
+
Direct Known Subclasses:
AES128CBC, AES128CTR, AES192CBC, AES192CTR, AES256CBC, AES256CTR, BlowfishCBC, TripleDESCBC
+
+
+
+
public class BaseCipher
extends Object
implements Cipher
+ + +

+Base class for all Cipher implementations delegating to the JCE provider. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.transport.cipher.Cipher
Cipher.Mode
+  + + + + + + + + + + + +
+Constructor Summary
BaseCipher(int ivsize, + int bsize, + String algorithm, + String transformation) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetBlockSize() + +
+           
+ intgetIVSize() + +
+           
+ voidinit(Cipher.Mode mode, + byte[] key, + byte[] iv) + +
+          Initialize the cipher for encryption or decryption with the given private key and initialization vector
+ voidupdate(byte[] input, + int inputOffset, + int inputLen) + +
+          Performs in-place encryption or decryption on the given data.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+BaseCipher

+
+public BaseCipher(int ivsize,
+                  int bsize,
+                  String algorithm,
+                  String transformation)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getBlockSize

+
+public int getBlockSize()
+
+
+
Specified by:
getBlockSize in interface Cipher
+
+
+ +
Returns:
the block size for this cipher
+
+
+
+ +

+getIVSize

+
+public int getIVSize()
+
+
+
Specified by:
getIVSize in interface Cipher
+
+
+ +
Returns:
the size of the initialization vector
+
+
+
+ +

+init

+
+public void init(Cipher.Mode mode,
+                 byte[] key,
+                 byte[] iv)
+
+
Description copied from interface: Cipher
+
Initialize the cipher for encryption or decryption with the given private key and initialization vector +

+

+
Specified by:
init in interface Cipher
+
+
+
Parameters:
mode - whether this instance wil encrypt or decrypt
key - the key for the cipher
iv - initialization vector
+
+
+
+ +

+update

+
+public void update(byte[] input,
+                   int inputOffset,
+                   int inputLen)
+
+
Description copied from interface: Cipher
+
Performs in-place encryption or decryption on the given data. +

+

+
Specified by:
update in interface Cipher
+
+
+
Parameters:
input - the subject
inputOffset - offset at which to start
inputLen - number of bytes starting at inputOffset
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/BlowfishCBC.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/BlowfishCBC.Factory.html new file mode 100644 index 00000000..03a97e06 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/BlowfishCBC.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +BlowfishCBC.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Class BlowfishCBC.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.cipher.BlowfishCBC.Factory
+
+
+
All Implemented Interfaces:
Factory<Cipher>, Factory.Named<Cipher>
+
+
+
Enclosing class:
BlowfishCBC
+
+
+
+
public static class BlowfishCBC.Factory
extends Object
implements Factory.Named<Cipher>
+ + +

+Named factory for BlowfishCBC Cipher +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
BlowfishCBC.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Ciphercreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+BlowfishCBC.Factory

+
+public BlowfishCBC.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public Cipher create()
+
+
+
Specified by:
create in interface Factory<Cipher>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<Cipher>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/BlowfishCBC.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/BlowfishCBC.html new file mode 100644 index 00000000..cd2007b9 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/BlowfishCBC.html @@ -0,0 +1,269 @@ + + + + + + + +BlowfishCBC (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Class BlowfishCBC

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.cipher.BaseCipher
+      extended by net.schmizz.sshj.transport.cipher.BlowfishCBC
+
+
+
All Implemented Interfaces:
Cipher
+
+
+
+
public class BlowfishCBC
extends BaseCipher
+ + +

+blowfish-ctr cipher +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classBlowfishCBC.Factory + +
+          Named factory for BlowfishCBC Cipher
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.transport.cipher.Cipher
Cipher.Mode
+  + + + + + + + + + + + +
+Constructor Summary
BlowfishCBC() + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.cipher.BaseCipher
getBlockSize, getIVSize, init, update
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+BlowfishCBC

+
+public BlowfishCBC()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/Cipher.Mode.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/Cipher.Mode.html new file mode 100644 index 00000000..a06f0430 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/Cipher.Mode.html @@ -0,0 +1,326 @@ + + + + + + + +Cipher.Mode (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Enum Cipher.Mode

+
+java.lang.Object
+  extended by java.lang.Enum<Cipher.Mode>
+      extended by net.schmizz.sshj.transport.cipher.Cipher.Mode
+
+
+
All Implemented Interfaces:
Serializable, Comparable<Cipher.Mode>
+
+
+
Enclosing interface:
Cipher
+
+
+
+
public static enum Cipher.Mode
extends Enum<Cipher.Mode>
+ + +

+


+ +

+ + + + + + + + + + + + + +
+Enum Constant Summary
Decrypt + +
+           
Encrypt + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static Cipher.ModevalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static Cipher.Mode[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+Encrypt

+
+public static final Cipher.Mode Encrypt
+
+
+
+
+
+ +

+Decrypt

+
+public static final Cipher.Mode Decrypt
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static Cipher.Mode[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (Cipher.Mode c : Cipher.Mode.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static Cipher.Mode valueOf(String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/Cipher.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/Cipher.html new file mode 100644 index 00000000..54cdc285 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/Cipher.html @@ -0,0 +1,302 @@ + + + + + + + +Cipher (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Interface Cipher

+
+
All Known Implementing Classes:
AES128CBC, AES128CTR, AES192CBC, AES192CTR, AES256CBC, AES256CTR, BaseCipher, BlowfishCBC, NoneCipher, TripleDESCBC
+
+
+
+
public interface Cipher
+ + +

+Wrapper for a cryptographic cipher, used either for encryption or decryption. +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classCipher.Mode + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetBlockSize() + +
+           
+ intgetIVSize() + +
+           
+ voidinit(Cipher.Mode mode, + byte[] key, + byte[] iv) + +
+          Initialize the cipher for encryption or decryption with the given private key and initialization vector
+ voidupdate(byte[] input, + int inputOffset, + int inputLen) + +
+          Performs in-place encryption or decryption on the given data.
+  +

+ + + + + + + + +
+Method Detail
+ +

+getBlockSize

+
+int getBlockSize()
+
+
+ +
Returns:
the block size for this cipher
+
+
+
+ +

+getIVSize

+
+int getIVSize()
+
+
+ +
Returns:
the size of the initialization vector
+
+
+
+ +

+init

+
+void init(Cipher.Mode mode,
+          byte[] key,
+          byte[] iv)
+
+
Initialize the cipher for encryption or decryption with the given private key and initialization vector +

+

+
Parameters:
mode - whether this instance wil encrypt or decrypt
key - the key for the cipher
iv - initialization vector
+
+
+
+ +

+update

+
+void update(byte[] input,
+            int inputOffset,
+            int inputLen)
+
+
Performs in-place encryption or decryption on the given data. +

+

+
Parameters:
input - the subject
inputOffset - offset at which to start
inputLen - number of bytes starting at inputOffset
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/NoneCipher.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/NoneCipher.Factory.html new file mode 100644 index 00000000..d5b9266c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/NoneCipher.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +NoneCipher.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Class NoneCipher.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.cipher.NoneCipher.Factory
+
+
+
All Implemented Interfaces:
Factory<Cipher>, Factory.Named<Cipher>
+
+
+
Enclosing class:
NoneCipher
+
+
+
+
public static class NoneCipher.Factory
extends Object
implements Factory.Named<Cipher>
+ + +

+Named factory for the no-op Cipher +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
NoneCipher.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Ciphercreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+NoneCipher.Factory

+
+public NoneCipher.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public Cipher create()
+
+
+
Specified by:
create in interface Factory<Cipher>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<Cipher>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/NoneCipher.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/NoneCipher.html new file mode 100644 index 00000000..6bb00ff9 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/NoneCipher.html @@ -0,0 +1,372 @@ + + + + + + + +NoneCipher (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Class NoneCipher

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.cipher.NoneCipher
+
+
+
All Implemented Interfaces:
Cipher
+
+
+
+
public class NoneCipher
extends Object
implements Cipher
+ + +

+Represents a no-op cipher. +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classNoneCipher.Factory + +
+          Named factory for the no-op Cipher
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.transport.cipher.Cipher
Cipher.Mode
+  + + + + + + + + + + + +
+Constructor Summary
NoneCipher() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetBlockSize() + +
+           
+ intgetIVSize() + +
+           
+ voidinit(Cipher.Mode mode, + byte[] bytes, + byte[] bytes1) + +
+          Initialize the cipher for encryption or decryption with the given private key and initialization vector
+ voidupdate(byte[] input, + int inputOffset, + int inputLen) + +
+          Performs in-place encryption or decryption on the given data.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+NoneCipher

+
+public NoneCipher()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getBlockSize

+
+public int getBlockSize()
+
+
+
Specified by:
getBlockSize in interface Cipher
+
+
+ +
Returns:
the block size for this cipher
+
+
+
+ +

+getIVSize

+
+public int getIVSize()
+
+
+
Specified by:
getIVSize in interface Cipher
+
+
+ +
Returns:
the size of the initialization vector
+
+
+
+ +

+init

+
+public void init(Cipher.Mode mode,
+                 byte[] bytes,
+                 byte[] bytes1)
+
+
Description copied from interface: Cipher
+
Initialize the cipher for encryption or decryption with the given private key and initialization vector +

+

+
Specified by:
init in interface Cipher
+
+
+
Parameters:
mode - whether this instance wil encrypt or decrypt
bytes - the key for the cipher
bytes1 - initialization vector
+
+
+
+ +

+update

+
+public void update(byte[] input,
+                   int inputOffset,
+                   int inputLen)
+
+
Description copied from interface: Cipher
+
Performs in-place encryption or decryption on the given data. +

+

+
Specified by:
update in interface Cipher
+
+
+
Parameters:
input - the subject
inputOffset - offset at which to start
inputLen - number of bytes starting at inputOffset
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/TripleDESCBC.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/TripleDESCBC.Factory.html new file mode 100644 index 00000000..b8aa3659 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/TripleDESCBC.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +TripleDESCBC.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Class TripleDESCBC.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.cipher.TripleDESCBC.Factory
+
+
+
All Implemented Interfaces:
Factory<Cipher>, Factory.Named<Cipher>
+
+
+
Enclosing class:
TripleDESCBC
+
+
+
+
public static class TripleDESCBC.Factory
extends Object
implements Factory.Named<Cipher>
+ + +

+Named factory for TripleDESCBC Cipher +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
TripleDESCBC.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Ciphercreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TripleDESCBC.Factory

+
+public TripleDESCBC.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public Cipher create()
+
+
+
Specified by:
create in interface Factory<Cipher>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<Cipher>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/TripleDESCBC.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/TripleDESCBC.html new file mode 100644 index 00000000..5981c12e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/TripleDESCBC.html @@ -0,0 +1,269 @@ + + + + + + + +TripleDESCBC (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.cipher +
+Class TripleDESCBC

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.cipher.BaseCipher
+      extended by net.schmizz.sshj.transport.cipher.TripleDESCBC
+
+
+
All Implemented Interfaces:
Cipher
+
+
+
+
public class TripleDESCBC
extends BaseCipher
+ + +

+3des-cbc cipher +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classTripleDESCBC.Factory + +
+          Named factory for TripleDESCBC Cipher
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.transport.cipher.Cipher
Cipher.Mode
+  + + + + + + + + + + + +
+Constructor Summary
TripleDESCBC() + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.cipher.BaseCipher
getBlockSize, getIVSize, init, update
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TripleDESCBC

+
+public TripleDESCBC()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES128CBC.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES128CBC.Factory.html new file mode 100644 index 00000000..1691fb83 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES128CBC.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.AES128CBC.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.AES128CBC.Factory

+
+No usage of net.schmizz.sshj.transport.cipher.AES128CBC.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES128CBC.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES128CBC.html new file mode 100644 index 00000000..d6905bad --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES128CBC.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.AES128CBC (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.AES128CBC

+
+No usage of net.schmizz.sshj.transport.cipher.AES128CBC +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES128CTR.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES128CTR.Factory.html new file mode 100644 index 00000000..e06c4560 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES128CTR.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.AES128CTR.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.AES128CTR.Factory

+
+No usage of net.schmizz.sshj.transport.cipher.AES128CTR.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES128CTR.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES128CTR.html new file mode 100644 index 00000000..05d7e75e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES128CTR.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.AES128CTR (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.AES128CTR

+
+No usage of net.schmizz.sshj.transport.cipher.AES128CTR +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES192CBC.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES192CBC.Factory.html new file mode 100644 index 00000000..177e7946 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES192CBC.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.AES192CBC.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.AES192CBC.Factory

+
+No usage of net.schmizz.sshj.transport.cipher.AES192CBC.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES192CBC.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES192CBC.html new file mode 100644 index 00000000..0b2a66ed --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES192CBC.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.AES192CBC (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.AES192CBC

+
+No usage of net.schmizz.sshj.transport.cipher.AES192CBC +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES192CTR.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES192CTR.Factory.html new file mode 100644 index 00000000..6de5de7d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES192CTR.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.AES192CTR.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.AES192CTR.Factory

+
+No usage of net.schmizz.sshj.transport.cipher.AES192CTR.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES192CTR.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES192CTR.html new file mode 100644 index 00000000..bf895531 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES192CTR.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.AES192CTR (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.AES192CTR

+
+No usage of net.schmizz.sshj.transport.cipher.AES192CTR +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES256CBC.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES256CBC.Factory.html new file mode 100644 index 00000000..8dff6fbb --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES256CBC.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.AES256CBC.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.AES256CBC.Factory

+
+No usage of net.schmizz.sshj.transport.cipher.AES256CBC.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES256CBC.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES256CBC.html new file mode 100644 index 00000000..f9aba808 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES256CBC.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.AES256CBC (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.AES256CBC

+
+No usage of net.schmizz.sshj.transport.cipher.AES256CBC +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES256CTR.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES256CTR.Factory.html new file mode 100644 index 00000000..f35bdd0c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES256CTR.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.AES256CTR.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.AES256CTR.Factory

+
+No usage of net.schmizz.sshj.transport.cipher.AES256CTR.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES256CTR.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES256CTR.html new file mode 100644 index 00000000..fb50e72f --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/AES256CTR.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.AES256CTR (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.AES256CTR

+
+No usage of net.schmizz.sshj.transport.cipher.AES256CTR +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/BaseCipher.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/BaseCipher.html new file mode 100644 index 00000000..a56fc8a4 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/BaseCipher.html @@ -0,0 +1,237 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.BaseCipher (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.BaseCipher

+
+ + + + + + + + + +
+Packages that use BaseCipher
net.schmizz.sshj.transport.cipher  
+  +

+ + + + + +
+Uses of BaseCipher in net.schmizz.sshj.transport.cipher
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Subclasses of BaseCipher in net.schmizz.sshj.transport.cipher
+ classAES128CBC + +
+          aes128-cbc cipher
+ classAES128CTR + +
+          aes128-ctr cipher
+ classAES192CBC + +
+          aes192-cbc cipher
+ classAES192CTR + +
+          aes192-ctr cipher
+ classAES256CBC + +
+          aes256-ctr cipher
+ classAES256CTR + +
+          aes256-ctr cipher
+ classBlowfishCBC + +
+          blowfish-ctr cipher
+ classTripleDESCBC + +
+          3des-cbc cipher
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/BlowfishCBC.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/BlowfishCBC.Factory.html new file mode 100644 index 00000000..2b6efab1 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/BlowfishCBC.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.BlowfishCBC.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.BlowfishCBC.Factory

+
+No usage of net.schmizz.sshj.transport.cipher.BlowfishCBC.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/BlowfishCBC.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/BlowfishCBC.html new file mode 100644 index 00000000..3b2aea91 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/BlowfishCBC.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.BlowfishCBC (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.BlowfishCBC

+
+No usage of net.schmizz.sshj.transport.cipher.BlowfishCBC +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/Cipher.Mode.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/Cipher.Mode.html new file mode 100644 index 00000000..f15d65c6 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/Cipher.Mode.html @@ -0,0 +1,228 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.Cipher.Mode (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.Cipher.Mode

+
+ + + + + + + + + +
+Packages that use Cipher.Mode
net.schmizz.sshj.transport.cipher  
+  +

+ + + + + +
+Uses of Cipher.Mode in net.schmizz.sshj.transport.cipher
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.cipher that return Cipher.Mode
+static Cipher.ModeCipher.Mode.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static Cipher.Mode[]Cipher.Mode.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.cipher with parameters of type Cipher.Mode
+ voidNoneCipher.init(Cipher.Mode mode, + byte[] bytes, + byte[] bytes1) + +
+           
+ voidCipher.init(Cipher.Mode mode, + byte[] key, + byte[] iv) + +
+          Initialize the cipher for encryption or decryption with the given private key and initialization vector
+ voidBaseCipher.init(Cipher.Mode mode, + byte[] key, + byte[] iv) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/Cipher.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/Cipher.html new file mode 100644 index 00000000..2fd7b47e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/Cipher.html @@ -0,0 +1,394 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.transport.cipher.Cipher (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.transport.cipher.Cipher

+
+ + + + + + + + + + + + + +
+Packages that use Cipher
net.schmizz.sshj  
net.schmizz.sshj.transport.cipher  
+  +

+ + + + + +
+Uses of Cipher in net.schmizz.sshj
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj that return types with arguments of type Cipher
+ List<Factory.Named<Cipher>>ConfigImpl.getCipherFactories() + +
+           
+ List<Factory.Named<Cipher>>Config.getCipherFactories() + +
+          Retrieve the list of named factories for Cipher.
+  +

+ + + + + + + + + + + + + +
Method parameters in net.schmizz.sshj with type arguments of type Cipher
+ voidConfigImpl.setCipherFactories(List<Factory.Named<Cipher>> cipherFactories) + +
+           
+ voidConfig.setCipherFactories(List<Factory.Named<Cipher>> cipherFactories) + +
+          Set the named factories for Cipher.
+  +

+ + + + + +
+Uses of Cipher in net.schmizz.sshj.transport.cipher
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.transport.cipher that implement Cipher
+ classAES128CBC + +
+          aes128-cbc cipher
+ classAES128CTR + +
+          aes128-ctr cipher
+ classAES192CBC + +
+          aes192-cbc cipher
+ classAES192CTR + +
+          aes192-ctr cipher
+ classAES256CBC + +
+          aes256-ctr cipher
+ classAES256CTR + +
+          aes256-ctr cipher
+ classBaseCipher + +
+          Base class for all Cipher implementations delegating to the JCE provider.
+ classBlowfishCBC + +
+          blowfish-ctr cipher
+ classNoneCipher + +
+          Represents a no-op cipher.
+ classTripleDESCBC + +
+          3des-cbc cipher
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.cipher that return Cipher
+ CipherTripleDESCBC.Factory.create() + +
+           
+ CipherNoneCipher.Factory.create() + +
+           
+ CipherBlowfishCBC.Factory.create() + +
+           
+ CipherAES256CTR.Factory.create() + +
+           
+ CipherAES256CBC.Factory.create() + +
+           
+ CipherAES192CTR.Factory.create() + +
+           
+ CipherAES192CBC.Factory.create() + +
+           
+ CipherAES128CTR.Factory.create() + +
+           
+ CipherAES128CBC.Factory.create() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/NoneCipher.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/NoneCipher.Factory.html new file mode 100644 index 00000000..5b6b06e7 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/NoneCipher.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.NoneCipher.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.NoneCipher.Factory

+
+No usage of net.schmizz.sshj.transport.cipher.NoneCipher.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/NoneCipher.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/NoneCipher.html new file mode 100644 index 00000000..8df96652 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/NoneCipher.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.NoneCipher (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.NoneCipher

+
+No usage of net.schmizz.sshj.transport.cipher.NoneCipher +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/TripleDESCBC.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/TripleDESCBC.Factory.html new file mode 100644 index 00000000..4d1cd048 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/TripleDESCBC.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.TripleDESCBC.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.TripleDESCBC.Factory

+
+No usage of net.schmizz.sshj.transport.cipher.TripleDESCBC.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/TripleDESCBC.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/TripleDESCBC.html new file mode 100644 index 00000000..de629c06 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/class-use/TripleDESCBC.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.cipher.TripleDESCBC (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.cipher.TripleDESCBC

+
+No usage of net.schmizz.sshj.transport.cipher.TripleDESCBC +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/package-frame.html new file mode 100644 index 00000000..d8dfb5ec --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/package-frame.html @@ -0,0 +1,91 @@ + + + + + + + +net.schmizz.sshj.transport.cipher (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.transport.cipher + + + + +
+Interfaces  + +
+Cipher
+ + + + + + +
+Classes  + +
+AES128CBC +
+AES128CBC.Factory +
+AES128CTR +
+AES128CTR.Factory +
+AES192CBC +
+AES192CBC.Factory +
+AES192CTR +
+AES192CTR.Factory +
+AES256CBC +
+AES256CBC.Factory +
+AES256CTR +
+AES256CTR.Factory +
+BaseCipher +
+BlowfishCBC +
+BlowfishCBC.Factory +
+NoneCipher +
+NoneCipher.Factory +
+TripleDESCBC +
+TripleDESCBC.Factory
+ + + + + + +
+Enums  + +
+Cipher.Mode
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/package-summary.html new file mode 100644 index 00000000..7909f920 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/package-summary.html @@ -0,0 +1,258 @@ + + + + + + + +net.schmizz.sshj.transport.cipher (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.transport.cipher +

+ + + + + + + + + +
+Interface Summary
CipherWrapper for a cryptographic cipher, used either for encryption or decryption.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
AES128CBCaes128-cbc cipher
AES128CBC.FactoryNamed factory for AES128CBC Cipher
AES128CTRaes128-ctr cipher
AES128CTR.FactoryNamed factory for AES128CBC Cipher
AES192CBCaes192-cbc cipher
AES192CBC.FactoryNamed factory for AES192CBC Cipher
AES192CTRaes192-ctr cipher
AES192CTR.FactoryNamed factory for AES192CTR Cipher
AES256CBCaes256-ctr cipher
AES256CBC.FactoryNamed factory for AES256CBC Cipher
AES256CTRaes256-ctr cipher
AES256CTR.FactoryNamed factory for AES256CBC Cipher
BaseCipherBase class for all Cipher implementations delegating to the JCE provider.
BlowfishCBCblowfish-ctr cipher
BlowfishCBC.FactoryNamed factory for BlowfishCBC Cipher
NoneCipherRepresents a no-op cipher.
NoneCipher.FactoryNamed factory for the no-op Cipher
TripleDESCBC3des-cbc cipher
TripleDESCBC.FactoryNamed factory for TripleDESCBC Cipher
+  + +

+ + + + + + + + + +
+Enum Summary
Cipher.Mode 
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/package-tree.html new file mode 100644 index 00000000..8cb0aa35 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/package-tree.html @@ -0,0 +1,182 @@ + + + + + + + +net.schmizz.sshj.transport.cipher Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.transport.cipher +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/package-use.html new file mode 100644 index 00000000..edd198e0 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/cipher/package-use.html @@ -0,0 +1,202 @@ + + + + + + + +Uses of Package net.schmizz.sshj.transport.cipher (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.transport.cipher

+
+ + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.transport.cipher
net.schmizz.sshj  
net.schmizz.sshj.transport.cipher  
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.transport.cipher used by net.schmizz.sshj
Cipher + +
+          Wrapper for a cryptographic cipher, used either for encryption or decryption.
+  +

+ + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.transport.cipher used by net.schmizz.sshj.transport.cipher
BaseCipher + +
+          Base class for all Cipher implementations delegating to the JCE provider.
Cipher + +
+          Wrapper for a cryptographic cipher, used either for encryption or decryption.
Cipher.Mode + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/class-use/DisconnectListener.html b/javadoc/0.4.1/net/schmizz/sshj/transport/class-use/DisconnectListener.html new file mode 100644 index 00000000..95a0bb92 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/class-use/DisconnectListener.html @@ -0,0 +1,213 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.transport.DisconnectListener (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.transport.DisconnectListener

+
+ + + + + + + + + +
+Packages that use DisconnectListener
net.schmizz.sshj.transport  
+  +

+ + + + + +
+Uses of DisconnectListener in net.schmizz.sshj.transport
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport that return DisconnectListener
+ DisconnectListenerTransportImpl.getDisconnectListener() + +
+           
+ DisconnectListenerTransport.getDisconnectListener() + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport with parameters of type DisconnectListener
+ voidTransportImpl.setDisconnectListener(DisconnectListener listener) + +
+           
+ voidTransport.setDisconnectListener(DisconnectListener listener) + +
+          Specify a listener that will be notified upon disconnection.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/class-use/NegotiatedAlgorithms.html b/javadoc/0.4.1/net/schmizz/sshj/transport/class-use/NegotiatedAlgorithms.html new file mode 100644 index 00000000..95e7df16 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/class-use/NegotiatedAlgorithms.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.NegotiatedAlgorithms (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.NegotiatedAlgorithms

+
+No usage of net.schmizz.sshj.transport.NegotiatedAlgorithms +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/class-use/Reader.html b/javadoc/0.4.1/net/schmizz/sshj/transport/class-use/Reader.html new file mode 100644 index 00000000..4d3387f2 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/class-use/Reader.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.Reader (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.Reader

+
+No usage of net.schmizz.sshj.transport.Reader +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/class-use/Transport.html b/javadoc/0.4.1/net/schmizz/sshj/transport/class-use/Transport.html new file mode 100644 index 00000000..280439fd --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/class-use/Transport.html @@ -0,0 +1,441 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.transport.Transport (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.transport.Transport

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use Transport
net.schmizz.sshj  
net.schmizz.sshj.connection  
net.schmizz.sshj.connection.channel  
net.schmizz.sshj.transport  
net.schmizz.sshj.transport.kex  
net.schmizz.sshj.userauth  
+  +

+ + + + + +
+Uses of Transport in net.schmizz.sshj
+  +

+ + + + + + + + + + + + + +
Fields in net.schmizz.sshj declared as Transport
+protected  TransportSSHClient.trans + +
+          Transport layer
+protected  TransportAbstractService.trans + +
+          Transport layer
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj that return Transport
+ TransportSSHClient.getTransport() + +
+           
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj with parameters of type Transport
AbstractService(String name, + Transport trans) + +
+           
+  +

+ + + + + +
+Uses of Transport in net.schmizz.sshj.connection
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection that return Transport
+ TransportConnectionImpl.getTransport() + +
+           
+ TransportConnection.getTransport() + +
+           
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.connection with parameters of type Transport
ConnectionImpl(Transport trans) + +
+          Create with an associated Transport.
+  +

+ + + + + +
+Uses of Transport in net.schmizz.sshj.connection.channel
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.connection.channel declared as Transport
+protected  TransportAbstractChannel.trans + +
+          Transport layer
+  +

+ + + + + + + + + + + +
Constructors in net.schmizz.sshj.connection.channel with parameters of type Transport
ChannelInputStream(Channel chan, + Transport trans, + Window.Local win) + +
+           
ChannelOutputStream(Channel chan, + Transport trans, + Window.Remote win) + +
+           
+  +

+ + + + + +
+Uses of Transport in net.schmizz.sshj.transport
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.transport that implement Transport
+ classTransportImpl + +
+          A thread-safe Transport implementation.
+  +

+ + + + + +
+Uses of Transport in net.schmizz.sshj.transport.kex
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.kex with parameters of type Transport
+ voidKeyExchange.init(Transport trans, + String V_S, + String V_C, + byte[] I_S, + byte[] I_C) + +
+          Initialize the key exchange algorithm.
+ voidAbstractDHG.init(Transport trans, + String V_S, + String V_C, + byte[] I_S, + byte[] I_C) + +
+           
+  +

+ + + + + +
+Uses of Transport in net.schmizz.sshj.userauth
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.userauth that return Transport
+ TransportAuthParams.getTransport() + +
+           
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.userauth with parameters of type Transport
UserAuthImpl(Transport trans) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/class-use/TransportException.html b/javadoc/0.4.1/net/schmizz/sshj/transport/class-use/TransportException.html new file mode 100644 index 00000000..c3e5f822 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/class-use/TransportException.html @@ -0,0 +1,1207 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.TransportException (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.TransportException

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use TransportException
net.schmizz.sshj  
net.schmizz.sshj.connection  
net.schmizz.sshj.connection.channel  
net.schmizz.sshj.connection.channel.direct  
net.schmizz.sshj.connection.channel.forwarded  
net.schmizz.sshj.transport  
net.schmizz.sshj.transport.compression  
net.schmizz.sshj.transport.kex  
net.schmizz.sshj.userauth  
net.schmizz.sshj.userauth.method  
+  +

+ + + + + +
+Uses of TransportException in net.schmizz.sshj
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj that throw TransportException
+ voidSSHClient.auth(String username, + AuthMethod... methods) + +
+          Authenticate username using the supplied methods.
+ voidSSHClient.auth(String username, + Iterable<AuthMethod> methods) + +
+          Authenticate username using the supplied methods.
+ voidSSHClient.authPassword(String username, + char[] password) + +
+          Authenticate username using the "password" authentication method and as a fallback basic + challenge-response authentication..
+ voidSSHClient.authPassword(String username, + PasswordFinder pfinder) + +
+          Authenticate username using the "password" authentication method and as a fallback basic + challenge-response authentication.
+ voidSSHClient.authPassword(String username, + String password) + +
+          Authenticate username using the "password" authentication method and as a fallback basic + challenge-response authentication.
+ voidSSHClient.authPublickey(String username) + +
+          Authenticate username using the "publickey" authentication method, with keys from some common + locations on the file system.
+ voidSSHClient.authPublickey(String username, + Iterable<KeyProvider> keyProviders) + +
+          Authenticate username using the "publickey" authentication method.
+ voidSSHClient.authPublickey(String username, + KeyProvider... keyProviders) + +
+          Authenticate username using the "publickey" authentication method.
+ voidSSHClient.authPublickey(String username, + String... locations) + +
+          Authenticate username using the "publickey" authentication method, with keys from one or more + locations in the file system.
+protected  voidSSHClient.doKex() + +
+          Do key exchange.
+ voidSSHClient.rekey() + +
+          Does key re-exchange.
+ voidService.request() + +
+          Request and install this service with the associated transport.
+ voidAbstractService.request() + +
+           
+ SessionSSHClient.startSession() + +
+           
+ voidSSHClient.useCompression() + +
+          Adds zlib compression to preferred compression algorithms.
+  +

+ + + + + +
+Uses of TransportException in net.schmizz.sshj.connection
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection that throw TransportException
+ Promise<SSHPacket,ConnectionException>ConnectionImpl.sendGlobalRequest(String name, + boolean wantReply, + byte[] specifics) + +
+           
+ Promise<SSHPacket,ConnectionException>Connection.sendGlobalRequest(String name, + boolean wantReply, + byte[] specifics) + +
+          Send an SSH global request.
+ voidConnectionImpl.sendOpenFailure(int recipient, + OpenFailException.Reason reason, + String message) + +
+           
+ voidConnection.sendOpenFailure(int recipient, + OpenFailException.Reason reason, + String message) + +
+          Send a SSH_MSG_OPEN_FAILURE for specified Reason and message.
+  +

+ + + + + +
+Uses of TransportException in net.schmizz.sshj.connection.channel
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel that throw TransportException
+ voidChannel.close() + +
+          Close this channel.
+ voidAbstractChannel.close() + +
+           
+ voidChannel.Forwarded.confirm() + +
+          Confirm CHANNEL_OPEN request.
+protected  voidAbstractChannel.gotExtendedData(SSHPacket buf) + +
+           
+protected  voidAbstractChannel.gotUnknown(Message msg, + SSHPacket buf) + +
+           
+ voidAbstractChannel.handle(Message msg, + SSHPacket buf) + +
+           
+protected  voidAbstractChannel.handleRequest(String reqType, + SSHPacket buf) + +
+           
+ voidChannel.Direct.open() + +
+          Request opening this channel from remote end.
+ voidChannelInputStream.receive(byte[] data, + int offset, + int len) + +
+           
+protected  voidAbstractChannel.receiveInto(ChannelInputStream stream, + SSHPacket buf) + +
+           
+ voidChannel.Forwarded.reject(OpenFailException.Reason reason, + String message) + +
+          Indicate rejection to remote end.
+protected  Event<ConnectionException>AbstractChannel.sendChannelRequest(String reqType, + boolean wantReply, + Buffer.PlainBuffer reqSpecific) + +
+           
+protected  voidAbstractChannel.sendClose() + +
+           
+ voidChannel.sendEOF() + +
+          Sends an EOF message to the server for this channel; indicating that no more data will be sent by us.
+ voidAbstractChannel.sendEOF() + +
+           
+  +

+ + + + + +
+Uses of TransportException in net.schmizz.sshj.connection.channel.direct
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.direct that throw TransportException
+ voidSessionChannel.allocateDefaultPTY() + +
+           
+ voidSession.allocateDefaultPTY() + +
+          Allocates a default PTY.
+ voidSessionChannel.allocatePTY(String term, + int cols, + int rows, + int width, + int height, + Map<PTYMode,Integer> modes) + +
+           
+ voidSession.allocatePTY(String term, + int cols, + int rows, + int width, + int height, + Map<PTYMode,Integer> modes) + +
+          Allocate a psuedo-terminal for this session.
+ voidSessionChannel.changeWindowDimensions(int cols, + int rows, + int width, + int height) + +
+           
+ voidSession.Shell.changeWindowDimensions(int cols, + int rows, + int width, + int height) + +
+          Sends a window dimension change message.
+ Session.CommandSessionChannel.exec(String command) + +
+           
+ Session.CommandSession.exec(String command) + +
+          Execute a remote command.
+protected  voidSessionChannel.gotExtendedData(SSHPacket buf) + +
+           
+protected  voidAbstractDirectChannel.gotUnknown(Message cmd, + SSHPacket buf) + +
+           
+ voidSessionChannel.handleRequest(String req, + SSHPacket buf) + +
+           
+ voidAbstractDirectChannel.open() + +
+           
+ voidSessionChannel.reqX11Forwarding(String authProto, + String authCookie, + int screen) + +
+           
+ voidSession.reqX11Forwarding(String authProto, + String authCookie, + int screen) + +
+          Request X11 forwarding.
+ voidSessionChannel.setEnvVar(String name, + String value) + +
+           
+ voidSession.setEnvVar(String name, + String value) + +
+          Set an enviornment variable.
+ voidSessionChannel.signal(Signal sig) + +
+           
+ voidSession.Command.signal(Signal signal) + +
+          Send a signal to the remote command.
+ voidSession.Shell.signal(Signal signal) + +
+          Send a signal.
+ Session.ShellSessionChannel.startShell() + +
+           
+ Session.ShellSession.startShell() + +
+          Request a shell.
+ Session.SubsystemSessionChannel.startSubsystem(String name) + +
+           
+ Session.SubsystemSession.startSubsystem(String name) + +
+          Request a subsystem.
+  +

+ + + + + +
+Uses of TransportException in net.schmizz.sshj.connection.channel.forwarded
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.connection.channel.forwarded that throw TransportException
+ RemotePortForwarder.ForwardRemotePortForwarder.bind(RemotePortForwarder.Forward forward, + ConnectListener listener) + +
+          Request forwarding from the remote host on the specified RemotePortForwarder.Forward.
+ voidRemotePortForwarder.cancel(RemotePortForwarder.Forward forward) + +
+          Request cancellation of some forwarding.
+ voidAbstractForwardedChannel.confirm() + +
+           
+ voidX11Forwarder.handleOpen(SSHPacket buf) + +
+          Internal API
+ voidRemotePortForwarder.handleOpen(SSHPacket buf) + +
+          Internal API.
+ voidForwardedChannelOpener.handleOpen(SSHPacket buf) + +
+          Delegates a SSH_MSG_CHANNEL_OPEN request for the channel type claimed by this opener.
+ voidAbstractForwardedChannel.reject(OpenFailException.Reason reason, + String message) + +
+           
+protected  SSHPacketRemotePortForwarder.req(String reqName, + RemotePortForwarder.Forward forward) + +
+           
+  +

+ + + + + +
+Uses of TransportException in net.schmizz.sshj.transport
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.transport with type parameters of type TransportException
+static ExceptionChainer<TransportException>TransportException.chainer + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport that throw TransportException
+ voidTransportImpl.doKex() + +
+           
+ voidTransport.doKex() + +
+          Do key exchange and algorithm negotiation.
+ voidTransportImpl.init(String remoteHost, + int remotePort, + InputStream in, + OutputStream out) + +
+           
+ voidTransport.init(String host, + int port, + InputStream in, + OutputStream out) + +
+          Sets the host information and the streams to be used by this transport.
+ voidTransportImpl.join() + +
+           
+ voidTransport.join() + +
+          Joins the thread calling this method to the transport's death.
+ voidTransportImpl.join(int timeout, + TimeUnit unit) + +
+           
+ voidTransport.join(int timeout, + TimeUnit unit) + +
+          Joins the thread calling this method to the transport's death.
+ voidTransportImpl.reqService(Service service) + +
+           
+ voidTransport.reqService(Service service) + +
+          Request a SSH service represented by a Service instance.
+ longTransportImpl.sendUnimplemented() + +
+           
+ longTransport.sendUnimplemented() + +
+          Sends SSH_MSG_UNIMPLEMENTED in response to the last packet received.
+ longTransportImpl.write(SSHPacket payload) + +
+           
+ longTransport.write(SSHPacket payload) + +
+          Write a packet over this transport.
+  +

+ + + + + +
+Uses of TransportException in net.schmizz.sshj.transport.compression
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.compression that throw TransportException
+ voidZlibCompression.uncompress(Buffer from, + Buffer to) + +
+           
+ voidCompression.uncompress(Buffer from, + Buffer to) + +
+          Uncompress the data in a buffer into another buffer.
+  +

+ + + + + +
+Uses of TransportException in net.schmizz.sshj.transport.kex
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.kex that throw TransportException
+ voidKeyExchange.init(Transport trans, + String V_S, + String V_C, + byte[] I_S, + byte[] I_C) + +
+          Initialize the key exchange algorithm.
+ voidAbstractDHG.init(Transport trans, + String V_S, + String V_C, + byte[] I_S, + byte[] I_C) + +
+           
+ booleanKeyExchange.next(Message msg, + SSHPacket buffer) + +
+          Process the next packet
+ booleanAbstractDHG.next(Message msg, + SSHPacket packet) + +
+           
+  +

+ + + + + +
+Uses of TransportException in net.schmizz.sshj.userauth
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.userauth that throw TransportException
+ voidUserAuthImpl.authenticate(String username, + Service nextService, + Iterable<AuthMethod> methods) + +
+           
+ voidUserAuth.authenticate(String username, + Service nextService, + Iterable<AuthMethod> methods) + +
+          Attempt to authenticate username using each of methods in order.
+  +

+ + + + + +
+Uses of TransportException in net.schmizz.sshj.userauth.method
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.userauth.method that throw TransportException
+ voidAuthPublickey.handle(Message cmd, + SSHPacket buf) + +
+          Internal use.
+ voidAuthPassword.handle(Message cmd, + SSHPacket buf) + +
+           
+ voidAuthKeyboardInteractive.handle(Message cmd, + SSHPacket buf) + +
+           
+ voidAbstractAuthMethod.handle(Message msg, + SSHPacket buf) + +
+           
+ voidAuthMethod.request() + +
+           
+ voidAbstractAuthMethod.request() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/class-use/TransportImpl.html b/javadoc/0.4.1/net/schmizz/sshj/transport/class-use/TransportImpl.html new file mode 100644 index 00000000..255b95e8 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/class-use/TransportImpl.html @@ -0,0 +1,179 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.TransportImpl (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.TransportImpl

+
+ + + + + + + + + +
+Packages that use TransportImpl
net.schmizz.sshj.transport  
+  +

+ + + + + +
+Uses of TransportImpl in net.schmizz.sshj.transport
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.transport with parameters of type TransportImpl
Reader(TransportImpl trans) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/Compression.Mode.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/Compression.Mode.html new file mode 100644 index 00000000..3c6efea5 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/Compression.Mode.html @@ -0,0 +1,330 @@ + + + + + + + +Compression.Mode (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.compression +
+Enum Compression.Mode

+
+java.lang.Object
+  extended by java.lang.Enum<Compression.Mode>
+      extended by net.schmizz.sshj.transport.compression.Compression.Mode
+
+
+
All Implemented Interfaces:
Serializable, Comparable<Compression.Mode>
+
+
+
Enclosing interface:
Compression
+
+
+
+
public static enum Compression.Mode
extends Enum<Compression.Mode>
+ + +

+Enum identifying if this object will be used to compress or uncompress data. +

+ +

+


+ +

+ + + + + + + + + + + + + +
+Enum Constant Summary
DEFLATE + +
+           
INFLATE + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static Compression.ModevalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static Compression.Mode[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+INFLATE

+
+public static final Compression.Mode INFLATE
+
+
+
+
+
+ +

+DEFLATE

+
+public static final Compression.Mode DEFLATE
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static Compression.Mode[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (Compression.Mode c : Compression.Mode.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static Compression.Mode valueOf(String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/Compression.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/Compression.html new file mode 100644 index 00000000..e75fe22b --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/Compression.html @@ -0,0 +1,306 @@ + + + + + + + +Compression (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.compression +
+Interface Compression

+
+
All Known Implementing Classes:
DelayedZlibCompression, NoneCompression, ZlibCompression
+
+
+
+
public interface Compression
+ + +

+Interface used to compress the stream of data between the SSH server and clients. +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classCompression.Mode + +
+          Enum identifying if this object will be used to compress or uncompress data.
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcompress(Buffer buffer) + +
+          Compress the given buffer in place.
+ voidinit(Compression.Mode mode) + +
+          Initialize this object to either compress or uncompress data.
+ booleanisDelayed() + +
+          Delayed compression is an Open-SSH specific feature which informs both the client and server to not compress data + before the session has been authenticated.
+ voiduncompress(Buffer from, + Buffer to) + +
+          Uncompress the data in a buffer into another buffer.
+  +

+ + + + + + + + +
+Method Detail
+ +

+init

+
+void init(Compression.Mode mode)
+
+
Initialize this object to either compress or uncompress data. This method must be called prior to any calls to + either compress or uncompress. Once the object has been initialized, only one of + compress or uncompress method can be called. +

+

+
Parameters:
mode -
+
+
+
+ +

+isDelayed

+
+boolean isDelayed()
+
+
Delayed compression is an Open-SSH specific feature which informs both the client and server to not compress data + before the session has been authenticated. +

+

+ +
Returns:
if the compression is delayed after authentication or not
+
+
+
+ +

+compress

+
+void compress(Buffer buffer)
+
+
Compress the given buffer in place. +

+

+
Parameters:
buffer - the buffer containing the data to compress s
+
+
+
+ +

+uncompress

+
+void uncompress(Buffer from,
+                Buffer to)
+                throws TransportException
+
+
Uncompress the data in a buffer into another buffer. +

+

+
Parameters:
from - the buffer containing the data to uncompress
to - the buffer receiving the uncompressed data +
Throws: +
TransportException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/DelayedZlibCompression.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/DelayedZlibCompression.Factory.html new file mode 100644 index 00000000..e3d54ed1 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/DelayedZlibCompression.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +DelayedZlibCompression.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.compression +
+Class DelayedZlibCompression.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.compression.DelayedZlibCompression.Factory
+
+
+
All Implemented Interfaces:
Factory<Compression>, Factory.Named<Compression>
+
+
+
Enclosing class:
DelayedZlibCompression
+
+
+
+
public static class DelayedZlibCompression.Factory
extends Object
implements Factory.Named<Compression>
+ + +

+Named factory for the ZLib Delayed Compression. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
DelayedZlibCompression.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Compressioncreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DelayedZlibCompression.Factory

+
+public DelayedZlibCompression.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public Compression create()
+
+
+
Specified by:
create in interface Factory<Compression>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<Compression>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/DelayedZlibCompression.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/DelayedZlibCompression.html new file mode 100644 index 00000000..b39d99d1 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/DelayedZlibCompression.html @@ -0,0 +1,308 @@ + + + + + + + +DelayedZlibCompression (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.compression +
+Class DelayedZlibCompression

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.compression.ZlibCompression
+      extended by net.schmizz.sshj.transport.compression.DelayedZlibCompression
+
+
+
All Implemented Interfaces:
Compression
+
+
+
+
public class DelayedZlibCompression
extends ZlibCompression
+ + +

+ZLib delayed compression. +

+ +

+

+
See Also:
Compression.isDelayed()
+
+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classDelayedZlibCompression.Factory + +
+          Named factory for the ZLib Delayed Compression.
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.transport.compression.Compression
Compression.Mode
+  + + + + + + + + + + + +
+Constructor Summary
DelayedZlibCompression() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ booleanisDelayed() + +
+          Delayed compression is an Open-SSH specific feature which informs both the client and server to not compress data + before the session has been authenticated.
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.compression.ZlibCompression
compress, init, uncompress
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DelayedZlibCompression

+
+public DelayedZlibCompression()
+
+
+ + + + + + + + +
+Method Detail
+ +

+isDelayed

+
+public boolean isDelayed()
+
+
Description copied from interface: Compression
+
Delayed compression is an Open-SSH specific feature which informs both the client and server to not compress data + before the session has been authenticated. +

+

+
Specified by:
isDelayed in interface Compression
Overrides:
isDelayed in class ZlibCompression
+
+
+ +
Returns:
if the compression is delayed after authentication or not
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/NoneCompression.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/NoneCompression.Factory.html new file mode 100644 index 00000000..e79bb7a4 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/NoneCompression.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +NoneCompression.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.compression +
+Class NoneCompression.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.compression.NoneCompression.Factory
+
+
+
All Implemented Interfaces:
Factory<Compression>, Factory.Named<Compression>
+
+
+
Enclosing class:
NoneCompression
+
+
+
+
public static class NoneCompression.Factory
extends Object
implements Factory.Named<Compression>
+ + +

+Named factory for the no-op Compression +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
NoneCompression.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Compressioncreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+NoneCompression.Factory

+
+public NoneCompression.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public Compression create()
+
+
+
Specified by:
create in interface Factory<Compression>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<Compression>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/NoneCompression.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/NoneCompression.html new file mode 100644 index 00000000..38bcb98b --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/NoneCompression.html @@ -0,0 +1,268 @@ + + + + + + + +NoneCompression (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.compression +
+Class NoneCompression

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.compression.NoneCompression
+
+
+
All Implemented Interfaces:
Compression
+
+
+
+
public abstract class NoneCompression
extends Object
implements Compression
+ + +

+No-op Compression. +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classNoneCompression.Factory + +
+          Named factory for the no-op Compression
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.transport.compression.Compression
Compression.Mode
+  + + + + + + + + + + + +
+Constructor Summary
NoneCompression() + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.transport.compression.Compression
compress, init, isDelayed, uncompress
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+NoneCompression

+
+public NoneCompression()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/ZlibCompression.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/ZlibCompression.Factory.html new file mode 100644 index 00000000..5f74d49f --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/ZlibCompression.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +ZlibCompression.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.compression +
+Class ZlibCompression.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.compression.ZlibCompression.Factory
+
+
+
All Implemented Interfaces:
Factory<Compression>, Factory.Named<Compression>
+
+
+
Enclosing class:
ZlibCompression
+
+
+
+
public static class ZlibCompression.Factory
extends Object
implements Factory.Named<Compression>
+ + +

+Named factory for the ZLib Compression. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
ZlibCompression.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Compressioncreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ZlibCompression.Factory

+
+public ZlibCompression.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public Compression create()
+
+
+
Specified by:
create in interface Factory<Compression>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<Compression>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/ZlibCompression.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/ZlibCompression.html new file mode 100644 index 00000000..e0694b9e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/ZlibCompression.html @@ -0,0 +1,381 @@ + + + + + + + +ZlibCompression (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.compression +
+Class ZlibCompression

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.compression.ZlibCompression
+
+
+
All Implemented Interfaces:
Compression
+
+
+
Direct Known Subclasses:
DelayedZlibCompression
+
+
+
+
public class ZlibCompression
extends Object
implements Compression
+ + +

+ZLib based Compression. +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classZlibCompression.Factory + +
+          Named factory for the ZLib Compression.
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.transport.compression.Compression
Compression.Mode
+  + + + + + + + + + + + +
+Constructor Summary
ZlibCompression() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcompress(Buffer buffer) + +
+          Compress the given buffer in place.
+ voidinit(Compression.Mode mode) + +
+          Initialize this object to either compress or uncompress data.
+ booleanisDelayed() + +
+          Delayed compression is an Open-SSH specific feature which informs both the client and server to not compress data + before the session has been authenticated.
+ voiduncompress(Buffer from, + Buffer to) + +
+          Uncompress the data in a buffer into another buffer.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ZlibCompression

+
+public ZlibCompression()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(Compression.Mode mode)
+
+
Description copied from interface: Compression
+
Initialize this object to either compress or uncompress data. This method must be called prior to any calls to + either compress or uncompress. Once the object has been initialized, only one of + compress or uncompress method can be called. +

+

+
Specified by:
init in interface Compression
+
+
+
+
+
+
+ +

+isDelayed

+
+public boolean isDelayed()
+
+
Description copied from interface: Compression
+
Delayed compression is an Open-SSH specific feature which informs both the client and server to not compress data + before the session has been authenticated. +

+

+
Specified by:
isDelayed in interface Compression
+
+
+ +
Returns:
if the compression is delayed after authentication or not
+
+
+
+ +

+compress

+
+public void compress(Buffer buffer)
+
+
Description copied from interface: Compression
+
Compress the given buffer in place. +

+

+
Specified by:
compress in interface Compression
+
+
+
Parameters:
buffer - the buffer containing the data to compress s
+
+
+
+ +

+uncompress

+
+public void uncompress(Buffer from,
+                       Buffer to)
+                throws TransportException
+
+
Description copied from interface: Compression
+
Uncompress the data in a buffer into another buffer. +

+

+
Specified by:
uncompress in interface Compression
+
+
+
Parameters:
from - the buffer containing the data to uncompress
to - the buffer receiving the uncompressed data +
Throws: +
TransportException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/Compression.Mode.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/Compression.Mode.html new file mode 100644 index 00000000..aadea651 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/Compression.Mode.html @@ -0,0 +1,214 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.compression.Compression.Mode (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.compression.Compression.Mode

+
+ + + + + + + + + +
+Packages that use Compression.Mode
net.schmizz.sshj.transport.compression  
+  +

+ + + + + +
+Uses of Compression.Mode in net.schmizz.sshj.transport.compression
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.compression that return Compression.Mode
+static Compression.ModeCompression.Mode.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static Compression.Mode[]Compression.Mode.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.compression with parameters of type Compression.Mode
+ voidZlibCompression.init(Compression.Mode mode) + +
+           
+ voidCompression.init(Compression.Mode mode) + +
+          Initialize this object to either compress or uncompress data.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/Compression.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/Compression.html new file mode 100644 index 00000000..5ee278aa --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/Compression.html @@ -0,0 +1,290 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.transport.compression.Compression (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.transport.compression.Compression

+
+ + + + + + + + + + + + + +
+Packages that use Compression
net.schmizz.sshj  
net.schmizz.sshj.transport.compression  
+  +

+ + + + + +
+Uses of Compression in net.schmizz.sshj
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj that return types with arguments of type Compression
+ List<Factory.Named<Compression>>ConfigImpl.getCompressionFactories() + +
+           
+ List<Factory.Named<Compression>>Config.getCompressionFactories() + +
+          Retrieve the list of named factories for Compression.
+  +

+ + + + + + + + + + + + + +
Method parameters in net.schmizz.sshj with type arguments of type Compression
+ voidConfigImpl.setCompressionFactories(List<Factory.Named<Compression>> compressionFactories) + +
+           
+ voidConfig.setCompressionFactories(List<Factory.Named<Compression>> compressionFactories) + +
+          Set the named factories for Compression.
+  +

+ + + + + +
+Uses of Compression in net.schmizz.sshj.transport.compression
+  +

+ + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.transport.compression that implement Compression
+ classDelayedZlibCompression + +
+          ZLib delayed compression.
+ classNoneCompression + +
+          No-op Compression.
+ classZlibCompression + +
+          ZLib based Compression.
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.compression that return Compression
+ CompressionZlibCompression.Factory.create() + +
+           
+ CompressionNoneCompression.Factory.create() + +
+           
+ CompressionDelayedZlibCompression.Factory.create() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/DelayedZlibCompression.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/DelayedZlibCompression.Factory.html new file mode 100644 index 00000000..e9d0a641 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/DelayedZlibCompression.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.compression.DelayedZlibCompression.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.compression.DelayedZlibCompression.Factory

+
+No usage of net.schmizz.sshj.transport.compression.DelayedZlibCompression.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/DelayedZlibCompression.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/DelayedZlibCompression.html new file mode 100644 index 00000000..88c0d550 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/DelayedZlibCompression.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.compression.DelayedZlibCompression (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.compression.DelayedZlibCompression

+
+No usage of net.schmizz.sshj.transport.compression.DelayedZlibCompression +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/NoneCompression.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/NoneCompression.Factory.html new file mode 100644 index 00000000..85a9591c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/NoneCompression.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.compression.NoneCompression.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.compression.NoneCompression.Factory

+
+No usage of net.schmizz.sshj.transport.compression.NoneCompression.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/NoneCompression.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/NoneCompression.html new file mode 100644 index 00000000..aadc892a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/NoneCompression.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.compression.NoneCompression (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.compression.NoneCompression

+
+No usage of net.schmizz.sshj.transport.compression.NoneCompression +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/ZlibCompression.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/ZlibCompression.Factory.html new file mode 100644 index 00000000..77d33c70 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/ZlibCompression.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.compression.ZlibCompression.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.compression.ZlibCompression.Factory

+
+No usage of net.schmizz.sshj.transport.compression.ZlibCompression.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/ZlibCompression.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/ZlibCompression.html new file mode 100644 index 00000000..80cf029e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/class-use/ZlibCompression.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.compression.ZlibCompression (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.compression.ZlibCompression

+
+ + + + + + + + + +
+Packages that use ZlibCompression
net.schmizz.sshj.transport.compression  
+  +

+ + + + + +
+Uses of ZlibCompression in net.schmizz.sshj.transport.compression
+  +

+ + + + + + + + + +
Subclasses of ZlibCompression in net.schmizz.sshj.transport.compression
+ classDelayedZlibCompression + +
+          ZLib delayed compression.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/package-frame.html new file mode 100644 index 00000000..496d1293 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/package-frame.html @@ -0,0 +1,65 @@ + + + + + + + +net.schmizz.sshj.transport.compression (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.transport.compression + + + + +
+Interfaces  + +
+Compression
+ + + + + + +
+Classes  + +
+DelayedZlibCompression +
+DelayedZlibCompression.Factory +
+NoneCompression +
+NoneCompression.Factory +
+ZlibCompression +
+ZlibCompression.Factory
+ + + + + + +
+Enums  + +
+Compression.Mode
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/package-summary.html new file mode 100644 index 00000000..7efb0ab0 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/package-summary.html @@ -0,0 +1,206 @@ + + + + + + + +net.schmizz.sshj.transport.compression (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.transport.compression +

+ + + + + + + + + +
+Interface Summary
CompressionInterface used to compress the stream of data between the SSH server and clients.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
DelayedZlibCompressionZLib delayed compression.
DelayedZlibCompression.FactoryNamed factory for the ZLib Delayed Compression.
NoneCompressionNo-op Compression.
NoneCompression.FactoryNamed factory for the no-op Compression
ZlibCompressionZLib based Compression.
ZlibCompression.FactoryNamed factory for the ZLib Compression.
+  + +

+ + + + + + + + + +
+Enum Summary
Compression.ModeEnum identifying if this object will be used to compress or uncompress data.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/package-tree.html new file mode 100644 index 00000000..0aaedab3 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/package-tree.html @@ -0,0 +1,176 @@ + + + + + + + +net.schmizz.sshj.transport.compression Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.transport.compression +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/compression/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/package-use.html new file mode 100644 index 00000000..fe4a8ce6 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/compression/package-use.html @@ -0,0 +1,202 @@ + + + + + + + +Uses of Package net.schmizz.sshj.transport.compression (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.transport.compression

+
+ + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.transport.compression
net.schmizz.sshj  
net.schmizz.sshj.transport.compression  
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.transport.compression used by net.schmizz.sshj
Compression + +
+          Interface used to compress the stream of data between the SSH server and clients.
+  +

+ + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.transport.compression used by net.schmizz.sshj.transport.compression
Compression + +
+          Interface used to compress the stream of data between the SSH server and clients.
Compression.Mode + +
+          Enum identifying if this object will be used to compress or uncompress data.
ZlibCompression + +
+          ZLib based Compression.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/digest/BaseDigest.html b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/BaseDigest.html new file mode 100644 index 00000000..267ffc35 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/BaseDigest.html @@ -0,0 +1,365 @@ + + + + + + + +BaseDigest (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.digest +
+Class BaseDigest

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.digest.BaseDigest
+
+
+
All Implemented Interfaces:
Digest
+
+
+
Direct Known Subclasses:
MD5, SHA1
+
+
+
+
public class BaseDigest
extends Object
implements Digest
+ + +

+Base class for Digest algorithms based on the JCE provider. +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
BaseDigest(String algorithm, + int bsize) + +
+          Create a new digest using the given algorithm and block size.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ byte[]digest() + +
+           
+ intgetBlockSize() + +
+           
+ voidinit() + +
+           
+ voidupdate(byte[] foo) + +
+           
+ voidupdate(byte[] foo, + int start, + int len) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+BaseDigest

+
+public BaseDigest(String algorithm,
+                  int bsize)
+
+
Create a new digest using the given algorithm and block size. The initialization and creation of the underlying + MessageDigest object will be done in the init() method. +

+

+
Parameters:
algorithm - the JCE algorithm to use for this digest
bsize - the block size of this digest
+
+ + + + + + + + +
+Method Detail
+ +

+digest

+
+public byte[] digest()
+
+
+
Specified by:
digest in interface Digest
+
+
+
+
+
+
+ +

+getBlockSize

+
+public int getBlockSize()
+
+
+
Specified by:
getBlockSize in interface Digest
+
+
+
+
+
+
+ +

+init

+
+public void init()
+
+
+
Specified by:
init in interface Digest
+
+
+
+
+
+
+ +

+update

+
+public void update(byte[] foo)
+
+
+
Specified by:
update in interface Digest
+
+
+
+
+
+
+ +

+update

+
+public void update(byte[] foo,
+                   int start,
+                   int len)
+
+
+
Specified by:
update in interface Digest
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/digest/Digest.html b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/Digest.html new file mode 100644 index 00000000..d369f831 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/Digest.html @@ -0,0 +1,294 @@ + + + + + + + +Digest (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.digest +
+Interface Digest

+
+
All Known Implementing Classes:
BaseDigest, MD5, SHA1
+
+
+
+
public interface Digest
+ + +

+Interface used to compute digests, based on algorithms such as MD5 or SHA1. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ byte[]digest() + +
+           
+ intgetBlockSize() + +
+           
+ voidinit() + +
+           
+ voidupdate(byte[] foo) + +
+           
+ voidupdate(byte[] foo, + int start, + int len) + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+digest

+
+byte[] digest()
+
+
+
+
+
+
+ +

+getBlockSize

+
+int getBlockSize()
+
+
+
+
+
+
+ +

+init

+
+void init()
+
+
+
+
+
+
+ +

+update

+
+void update(byte[] foo)
+
+
+
+
+
+
+ +

+update

+
+void update(byte[] foo,
+            int start,
+            int len)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/digest/MD5.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/MD5.Factory.html new file mode 100644 index 00000000..83451adf --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/MD5.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +MD5.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.digest +
+Class MD5.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.digest.MD5.Factory
+
+
+
All Implemented Interfaces:
Factory<Digest>, Factory.Named<Digest>
+
+
+
Enclosing class:
MD5
+
+
+
+
public static class MD5.Factory
extends Object
implements Factory.Named<Digest>
+ + +

+Named factory for MD5 digest +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
MD5.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Digestcreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+MD5.Factory

+
+public MD5.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public Digest create()
+
+
+
Specified by:
create in interface Factory<Digest>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<Digest>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/digest/MD5.html b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/MD5.html new file mode 100644 index 00000000..88fd27ea --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/MD5.html @@ -0,0 +1,261 @@ + + + + + + + +MD5 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.digest +
+Class MD5

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.digest.BaseDigest
+      extended by net.schmizz.sshj.transport.digest.MD5
+
+
+
All Implemented Interfaces:
Digest
+
+
+
+
public class MD5
extends BaseDigest
+ + +

+MD5 Digest. +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classMD5.Factory + +
+          Named factory for MD5 digest
+  + + + + + + + + + + +
+Constructor Summary
MD5() + +
+          Create a new instance of a MD5 digest
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.digest.BaseDigest
digest, getBlockSize, init, update, update
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+MD5

+
+public MD5()
+
+
Create a new instance of a MD5 digest +

+

+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/digest/SHA1.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/SHA1.Factory.html new file mode 100644 index 00000000..e67f9c7b --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/SHA1.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +SHA1.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.digest +
+Class SHA1.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.digest.SHA1.Factory
+
+
+
All Implemented Interfaces:
Factory<Digest>, Factory.Named<Digest>
+
+
+
Enclosing class:
SHA1
+
+
+
+
public static class SHA1.Factory
extends Object
implements Factory.Named<Digest>
+ + +

+Named factory for SHA1 digest +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
SHA1.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Digestcreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SHA1.Factory

+
+public SHA1.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public Digest create()
+
+
+
Specified by:
create in interface Factory<Digest>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<Digest>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/digest/SHA1.html b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/SHA1.html new file mode 100644 index 00000000..0bfaf4c8 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/SHA1.html @@ -0,0 +1,261 @@ + + + + + + + +SHA1 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.digest +
+Class SHA1

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.digest.BaseDigest
+      extended by net.schmizz.sshj.transport.digest.SHA1
+
+
+
All Implemented Interfaces:
Digest
+
+
+
+
public class SHA1
extends BaseDigest
+ + +

+SHA1 Digest. +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classSHA1.Factory + +
+          Named factory for SHA1 digest
+  + + + + + + + + + + +
+Constructor Summary
SHA1() + +
+          Create a new instance of a SHA1 digest
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.digest.BaseDigest
digest, getBlockSize, init, update, update
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SHA1

+
+public SHA1()
+
+
Create a new instance of a SHA1 digest +

+

+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/digest/class-use/BaseDigest.html b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/class-use/BaseDigest.html new file mode 100644 index 00000000..6c3c5b92 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/class-use/BaseDigest.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.digest.BaseDigest (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.digest.BaseDigest

+
+ + + + + + + + + +
+Packages that use BaseDigest
net.schmizz.sshj.transport.digest  
+  +

+ + + + + +
+Uses of BaseDigest in net.schmizz.sshj.transport.digest
+  +

+ + + + + + + + + + + + + +
Subclasses of BaseDigest in net.schmizz.sshj.transport.digest
+ classMD5 + +
+          MD5 Digest.
+ classSHA1 + +
+          SHA1 Digest.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/digest/class-use/Digest.html b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/class-use/Digest.html new file mode 100644 index 00000000..21d6c871 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/class-use/Digest.html @@ -0,0 +1,258 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.transport.digest.Digest (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.transport.digest.Digest

+
+ + + + + + + + + + + + + +
+Packages that use Digest
net.schmizz.sshj.transport.digest  
net.schmizz.sshj.transport.kex  
+  +

+ + + + + +
+Uses of Digest in net.schmizz.sshj.transport.digest
+  +

+ + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.transport.digest that implement Digest
+ classBaseDigest + +
+          Base class for Digest algorithms based on the JCE provider.
+ classMD5 + +
+          MD5 Digest.
+ classSHA1 + +
+          SHA1 Digest.
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.digest that return Digest
+ DigestSHA1.Factory.create() + +
+           
+ DigestMD5.Factory.create() + +
+           
+  +

+ + + + + +
+Uses of Digest in net.schmizz.sshj.transport.kex
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.kex that return Digest
+ DigestKeyExchange.getHash() + +
+          The message digest used by this key exchange algorithm.
+ DigestAbstractDHG.getHash() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/digest/class-use/MD5.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/class-use/MD5.Factory.html new file mode 100644 index 00000000..5e16f272 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/class-use/MD5.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.digest.MD5.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.digest.MD5.Factory

+
+No usage of net.schmizz.sshj.transport.digest.MD5.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/digest/class-use/MD5.html b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/class-use/MD5.html new file mode 100644 index 00000000..2fc4ac66 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/class-use/MD5.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.digest.MD5 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.digest.MD5

+
+No usage of net.schmizz.sshj.transport.digest.MD5 +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/digest/class-use/SHA1.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/class-use/SHA1.Factory.html new file mode 100644 index 00000000..88eda2c5 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/class-use/SHA1.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.digest.SHA1.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.digest.SHA1.Factory

+
+No usage of net.schmizz.sshj.transport.digest.SHA1.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/digest/class-use/SHA1.html b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/class-use/SHA1.html new file mode 100644 index 00000000..94c4786c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/class-use/SHA1.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.digest.SHA1 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.digest.SHA1

+
+No usage of net.schmizz.sshj.transport.digest.SHA1 +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/digest/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/package-frame.html new file mode 100644 index 00000000..f63caab3 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/package-frame.html @@ -0,0 +1,52 @@ + + + + + + + +net.schmizz.sshj.transport.digest (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.transport.digest + + + + +
+Interfaces  + +
+Digest
+ + + + + + +
+Classes  + +
+BaseDigest +
+MD5 +
+MD5.Factory +
+SHA1 +
+SHA1.Factory
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/digest/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/package-summary.html new file mode 100644 index 00000000..76a9cbd9 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/package-summary.html @@ -0,0 +1,188 @@ + + + + + + + +net.schmizz.sshj.transport.digest (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.transport.digest +

+ + + + + + + + + +
+Interface Summary
DigestInterface used to compute digests, based on algorithms such as MD5 or SHA1.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
BaseDigestBase class for Digest algorithms based on the JCE provider.
MD5MD5 Digest.
MD5.FactoryNamed factory for MD5 digest
SHA1SHA1 Digest.
SHA1.FactoryNamed factory for SHA1 digest
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/digest/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/package-tree.html new file mode 100644 index 00000000..e8e524ce --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/package-tree.html @@ -0,0 +1,164 @@ + + + + + + + +net.schmizz.sshj.transport.digest Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.transport.digest +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/digest/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/package-use.html new file mode 100644 index 00000000..c3deabf6 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/digest/package-use.html @@ -0,0 +1,196 @@ + + + + + + + +Uses of Package net.schmizz.sshj.transport.digest (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.transport.digest

+
+ + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.transport.digest
net.schmizz.sshj.transport.digest  
net.schmizz.sshj.transport.kex  
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.transport.digest used by net.schmizz.sshj.transport.digest
BaseDigest + +
+          Base class for Digest algorithms based on the JCE provider.
Digest + +
+          Interface used to compute digests, based on algorithms such as MD5 or SHA1.
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.transport.digest used by net.schmizz.sshj.transport.kex
Digest + +
+          Interface used to compute digests, based on algorithms such as MD5 or SHA1.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/AbstractDHG.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/AbstractDHG.html new file mode 100644 index 00000000..2fe762db --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/AbstractDHG.html @@ -0,0 +1,436 @@ + + + + + + + +AbstractDHG (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.kex +
+Class AbstractDHG

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.kex.AbstractDHG
+
+
+
All Implemented Interfaces:
KeyExchange
+
+
+
Direct Known Subclasses:
DHG1, DHG14
+
+
+
+
public abstract class AbstractDHG
extends Object
implements KeyExchange
+ + +

+Base class for DHG key exchange algorithms. Implementations will only have to configure the required data on the + DH class in the +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
AbstractDHG() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ byte[]getH() + +
+           
+ DigestgetHash() + +
+          The message digest used by this key exchange algorithm.
+ PublicKeygetHostKey() + +
+           
+ BigIntegergetK() + +
+           
+ voidinit(Transport trans, + String V_S, + String V_C, + byte[] I_S, + byte[] I_C) + +
+          Initialize the key exchange algorithm.
+protected abstract  voidinitDH(DH dh) + +
+           
+ booleannext(Message msg, + SSHPacket packet) + +
+          Process the next packet
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AbstractDHG

+
+public AbstractDHG()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getH

+
+public byte[] getH()
+
+
+
Specified by:
getH in interface KeyExchange
+
+
+ +
Returns:
the computed H parameter
+
+
+
+ +

+getK

+
+public BigInteger getK()
+
+
+
Specified by:
getK in interface KeyExchange
+
+
+ +
Returns:
the computed K parameter
+
+
+
+ +

+getHash

+
+public Digest getHash()
+
+
Description copied from interface: KeyExchange
+
The message digest used by this key exchange algorithm. +

+

+
Specified by:
getHash in interface KeyExchange
+
+
+ +
Returns:
the message digest
+
+
+
+ +

+getHostKey

+
+public PublicKey getHostKey()
+
+
+
Specified by:
getHostKey in interface KeyExchange
+
+
+ +
Returns:
the host key determined from server's response packets
+
+
+
+ +

+init

+
+public void init(Transport trans,
+                 String V_S,
+                 String V_C,
+                 byte[] I_S,
+                 byte[] I_C)
+          throws GeneralSecurityException,
+                 TransportException
+
+
Description copied from interface: KeyExchange
+
Initialize the key exchange algorithm. +

+

+
Specified by:
init in interface KeyExchange
+
+
+
Parameters:
trans - the transport
V_S - the server identification string
V_C - the client identification string
I_S - the server key init packet
I_C - the client key init packet +
Throws: +
GeneralSecurityException +
TransportException - if there is an error sending a packet
+
+
+
+ +

+next

+
+public boolean next(Message msg,
+                    SSHPacket packet)
+             throws GeneralSecurityException,
+                    TransportException
+
+
Description copied from interface: KeyExchange
+
Process the next packet +

+

+
Specified by:
next in interface KeyExchange
+
+
+
Parameters:
msg - message identifier
packet - the packet +
Returns:
a boolean indicating if the processing is complete or if more packets are to be received +
Throws: +
GeneralSecurityException +
TransportException - if there is an error sending a packet
+
+
+
+ +

+initDH

+
+protected abstract void initDH(DH dh)
+                        throws GeneralSecurityException
+
+
+
+
+
+ +
Throws: +
GeneralSecurityException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/DH.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/DH.html new file mode 100644 index 00000000..44fe463e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/DH.html @@ -0,0 +1,322 @@ + + + + + + + +DH (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.kex +
+Class DH

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.kex.DH
+
+
+
+
public class DH
extends Object
+ + +

+Diffie-Hellman key generator. +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
DH() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcomputeK(BigInteger f) + +
+           
+ BigIntegergetE() + +
+           
+ BigIntegergetK() + +
+           
+ voidinit(BigInteger p, + BigInteger g) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DH

+
+public DH()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init(BigInteger p,
+                 BigInteger g)
+          throws GeneralSecurityException
+
+
+ +
Throws: +
GeneralSecurityException
+
+
+
+ +

+computeK

+
+public void computeK(BigInteger f)
+              throws GeneralSecurityException
+
+
+ +
Throws: +
GeneralSecurityException
+
+
+
+ +

+getE

+
+public BigInteger getE()
+
+
+
+
+
+
+ +

+getK

+
+public BigInteger getK()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/DHG1.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/DHG1.Factory.html new file mode 100644 index 00000000..a8cc48e9 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/DHG1.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +DHG1.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.kex +
+Class DHG1.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.kex.DHG1.Factory
+
+
+
All Implemented Interfaces:
Factory<KeyExchange>, Factory.Named<KeyExchange>
+
+
+
Enclosing class:
DHG1
+
+
+
+
public static class DHG1.Factory
extends Object
implements Factory.Named<KeyExchange>
+ + +

+Named factory for DHG1 key exchange +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
DHG1.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ KeyExchangecreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DHG1.Factory

+
+public DHG1.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public KeyExchange create()
+
+
+
Specified by:
create in interface Factory<KeyExchange>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<KeyExchange>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/DHG1.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/DHG1.html new file mode 100644 index 00000000..68071771 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/DHG1.html @@ -0,0 +1,295 @@ + + + + + + + +DHG1 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.kex +
+Class DHG1

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.kex.AbstractDHG
+      extended by net.schmizz.sshj.transport.kex.DHG1
+
+
+
All Implemented Interfaces:
KeyExchange
+
+
+
+
public class DHG1
extends AbstractDHG
+ + +

+Diffie-Hellman key exchange with SHA-1 and Oakley Group 2 [RFC2409] (1024-bit MODP Group). +

+ +

+

+
See Also:
RFC 4253
+
+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classDHG1.Factory + +
+          Named factory for DHG1 key exchange
+  + + + + + + + + + + +
+Constructor Summary
DHG1() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+protected  voidinitDH(DH dh) + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.kex.AbstractDHG
getH, getHash, getHostKey, getK, init, next
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DHG1

+
+public DHG1()
+
+
+ + + + + + + + +
+Method Detail
+ +

+initDH

+
+protected void initDH(DH dh)
+               throws GeneralSecurityException
+
+
+
Specified by:
initDH in class AbstractDHG
+
+
+ +
Throws: +
GeneralSecurityException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/DHG14.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/DHG14.Factory.html new file mode 100644 index 00000000..5c27f467 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/DHG14.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +DHG14.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.kex +
+Class DHG14.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.kex.DHG14.Factory
+
+
+
All Implemented Interfaces:
Factory<KeyExchange>, Factory.Named<KeyExchange>
+
+
+
Enclosing class:
DHG14
+
+
+
+
public static class DHG14.Factory
extends Object
implements Factory.Named<KeyExchange>
+ + +

+Named factory for DHG14 key exchange +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
DHG14.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ KeyExchangecreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DHG14.Factory

+
+public DHG14.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public KeyExchange create()
+
+
+
Specified by:
create in interface Factory<KeyExchange>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<KeyExchange>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/DHG14.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/DHG14.html new file mode 100644 index 00000000..da30198d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/DHG14.html @@ -0,0 +1,296 @@ + + + + + + + +DHG14 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.kex +
+Class DHG14

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.kex.AbstractDHG
+      extended by net.schmizz.sshj.transport.kex.DHG14
+
+
+
All Implemented Interfaces:
KeyExchange
+
+
+
+
public class DHG14
extends AbstractDHG
+ + +

+Diffie-Hellman key exchange with SHA-1 and Oakley Group 14 [RFC3526] (2048-bit MODP Group). +

+ DHG14 does not work with the default JCE implementation provided by Sun because it does not support 2048 bits + encryption. It requires BouncyCastle to be used. +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classDHG14.Factory + +
+          Named factory for DHG14 key exchange
+  + + + + + + + + + + +
+Constructor Summary
DHG14() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+protected  voidinitDH(DH dh) + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.kex.AbstractDHG
getH, getHash, getHostKey, getK, init, next
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DHG14

+
+public DHG14()
+
+
+ + + + + + + + +
+Method Detail
+ +

+initDH

+
+protected void initDH(DH dh)
+               throws GeneralSecurityException
+
+
+
Specified by:
initDH in class AbstractDHG
+
+
+ +
Throws: +
GeneralSecurityException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/DHGroupData.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/DHGroupData.html new file mode 100644 index 00000000..06980785 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/DHGroupData.html @@ -0,0 +1,301 @@ + + + + + + + +DHGroupData (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.kex +
+Class DHGroupData

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.kex.DHGroupData
+
+
+
+
public final class DHGroupData
extends Object
+ + +

+Simple class holding the data for DH group key exchanges. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + +
+Field Summary
+static BigIntegerG + +
+           
+static BigIntegerP1 + +
+           
+static BigIntegerP14 + +
+           
+  + + + + + + + + + + +
+Constructor Summary
DHGroupData() + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+G

+
+public static final BigInteger G
+
+
+
+
+
+ +

+P1

+
+public static final BigInteger P1
+
+
+
+
+
+ +

+P14

+
+public static final BigInteger P14
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+DHGroupData

+
+public DHGroupData()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/KeyExchange.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/KeyExchange.html new file mode 100644 index 00000000..6ca70f9a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/KeyExchange.html @@ -0,0 +1,340 @@ + + + + + + + +KeyExchange (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.kex +
+Interface KeyExchange

+
+
All Known Implementing Classes:
AbstractDHG, DHG1, DHG14
+
+
+
+
public interface KeyExchange
+ + +

+Key exchange algorithm. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ byte[]getH() + +
+           
+ DigestgetHash() + +
+          The message digest used by this key exchange algorithm.
+ PublicKeygetHostKey() + +
+           
+ BigIntegergetK() + +
+           
+ voidinit(Transport trans, + String V_S, + String V_C, + byte[] I_S, + byte[] I_C) + +
+          Initialize the key exchange algorithm.
+ booleannext(Message msg, + SSHPacket buffer) + +
+          Process the next packet
+  +

+ + + + + + + + +
+Method Detail
+ +

+init

+
+void init(Transport trans,
+          String V_S,
+          String V_C,
+          byte[] I_S,
+          byte[] I_C)
+          throws GeneralSecurityException,
+                 TransportException
+
+
Initialize the key exchange algorithm. +

+

+
Parameters:
trans - the transport
V_S - the server identification string
V_C - the client identification string
I_S - the server key init packet
I_C - the client key init packet +
Throws: +
GeneralSecurityException +
TransportException - if there is an error sending a packet
+
+
+
+ +

+getH

+
+byte[] getH()
+
+
+ +
Returns:
the computed H parameter
+
+
+
+ +

+getK

+
+BigInteger getK()
+
+
+ +
Returns:
the computed K parameter
+
+
+
+ +

+getHash

+
+Digest getHash()
+
+
The message digest used by this key exchange algorithm. +

+

+ +
Returns:
the message digest
+
+
+
+ +

+getHostKey

+
+PublicKey getHostKey()
+
+
+ +
Returns:
the host key determined from server's response packets
+
+
+
+ +

+next

+
+boolean next(Message msg,
+             SSHPacket buffer)
+             throws GeneralSecurityException,
+                    TransportException
+
+
Process the next packet +

+

+
Parameters:
msg - message identifier
buffer - the packet +
Returns:
a boolean indicating if the processing is complete or if more packets are to be received +
Throws: +
GeneralSecurityException +
TransportException - if there is an error sending a packet
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/AbstractDHG.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/AbstractDHG.html new file mode 100644 index 00000000..7c3d8f6a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/AbstractDHG.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.kex.AbstractDHG (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.kex.AbstractDHG

+
+ + + + + + + + + +
+Packages that use AbstractDHG
net.schmizz.sshj.transport.kex  
+  +

+ + + + + +
+Uses of AbstractDHG in net.schmizz.sshj.transport.kex
+  +

+ + + + + + + + + + + + + +
Subclasses of AbstractDHG in net.schmizz.sshj.transport.kex
+ classDHG1 + +
+          Diffie-Hellman key exchange with SHA-1 and Oakley Group 2 [RFC2409] (1024-bit MODP Group).
+ classDHG14 + +
+          Diffie-Hellman key exchange with SHA-1 and Oakley Group 14 [RFC3526] (2048-bit MODP Group).
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/DH.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/DH.html new file mode 100644 index 00000000..16e54649 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/DH.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.kex.DH (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.kex.DH

+
+ + + + + + + + + +
+Packages that use DH
net.schmizz.sshj.transport.kex  
+  +

+ + + + + +
+Uses of DH in net.schmizz.sshj.transport.kex
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.kex with parameters of type DH
+protected  voidDHG14.initDH(DH dh) + +
+           
+protected  voidDHG1.initDH(DH dh) + +
+           
+protected abstract  voidAbstractDHG.initDH(DH dh) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/DHG1.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/DHG1.Factory.html new file mode 100644 index 00000000..0ed174ce --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/DHG1.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.kex.DHG1.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.kex.DHG1.Factory

+
+No usage of net.schmizz.sshj.transport.kex.DHG1.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/DHG1.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/DHG1.html new file mode 100644 index 00000000..9c5d2abd --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/DHG1.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.kex.DHG1 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.kex.DHG1

+
+No usage of net.schmizz.sshj.transport.kex.DHG1 +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/DHG14.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/DHG14.Factory.html new file mode 100644 index 00000000..65eebbe6 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/DHG14.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.kex.DHG14.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.kex.DHG14.Factory

+
+No usage of net.schmizz.sshj.transport.kex.DHG14.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/DHG14.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/DHG14.html new file mode 100644 index 00000000..2f8fa839 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/DHG14.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.kex.DHG14 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.kex.DHG14

+
+No usage of net.schmizz.sshj.transport.kex.DHG14 +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/DHGroupData.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/DHGroupData.html new file mode 100644 index 00000000..124bd1d6 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/DHGroupData.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.kex.DHGroupData (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.kex.DHGroupData

+
+No usage of net.schmizz.sshj.transport.kex.DHGroupData +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/KeyExchange.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/KeyExchange.html new file mode 100644 index 00000000..3b5a10fb --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/class-use/KeyExchange.html @@ -0,0 +1,282 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.transport.kex.KeyExchange (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.transport.kex.KeyExchange

+
+ + + + + + + + + + + + + +
+Packages that use KeyExchange
net.schmizz.sshj  
net.schmizz.sshj.transport.kex  
+  +

+ + + + + +
+Uses of KeyExchange in net.schmizz.sshj
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj that return types with arguments of type KeyExchange
+ List<Factory.Named<KeyExchange>>ConfigImpl.getKeyExchangeFactories() + +
+           
+ List<Factory.Named<KeyExchange>>Config.getKeyExchangeFactories() + +
+          Retrieve the list of named factories for KeyExchange.
+  +

+ + + + + + + + + + + + + +
Method parameters in net.schmizz.sshj with type arguments of type KeyExchange
+ voidConfigImpl.setKeyExchangeFactories(List<Factory.Named<KeyExchange>> kexFactories) + +
+           
+ voidConfig.setKeyExchangeFactories(List<Factory.Named<KeyExchange>> kexFactories) + +
+          Set the named factories for KeyExchange.
+  +

+ + + + + +
+Uses of KeyExchange in net.schmizz.sshj.transport.kex
+  +

+ + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.transport.kex that implement KeyExchange
+ classAbstractDHG + +
+          Base class for DHG key exchange algorithms.
+ classDHG1 + +
+          Diffie-Hellman key exchange with SHA-1 and Oakley Group 2 [RFC2409] (1024-bit MODP Group).
+ classDHG14 + +
+          Diffie-Hellman key exchange with SHA-1 and Oakley Group 14 [RFC3526] (2048-bit MODP Group).
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.kex that return KeyExchange
+ KeyExchangeDHG14.Factory.create() + +
+           
+ KeyExchangeDHG1.Factory.create() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/package-frame.html new file mode 100644 index 00000000..a525aa77 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/package-frame.html @@ -0,0 +1,56 @@ + + + + + + + +net.schmizz.sshj.transport.kex (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.transport.kex + + + + +
+Interfaces  + +
+KeyExchange
+ + + + + + +
+Classes  + +
+AbstractDHG +
+DH +
+DHG1 +
+DHG1.Factory +
+DHG14 +
+DHG14.Factory +
+DHGroupData
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/package-summary.html new file mode 100644 index 00000000..a42ebf3d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/package-summary.html @@ -0,0 +1,196 @@ + + + + + + + +net.schmizz.sshj.transport.kex (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.transport.kex +

+ + + + + + + + + +
+Interface Summary
KeyExchangeKey exchange algorithm.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
AbstractDHGBase class for DHG key exchange algorithms.
DHDiffie-Hellman key generator.
DHG1Diffie-Hellman key exchange with SHA-1 and Oakley Group 2 [RFC2409] (1024-bit MODP Group).
DHG1.FactoryNamed factory for DHG1 key exchange
DHG14Diffie-Hellman key exchange with SHA-1 and Oakley Group 14 [RFC3526] (2048-bit MODP Group).
DHG14.FactoryNamed factory for DHG14 key exchange
DHGroupDataSimple class holding the data for DH group key exchanges.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/package-tree.html new file mode 100644 index 00000000..2297d4b9 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/package-tree.html @@ -0,0 +1,164 @@ + + + + + + + +net.schmizz.sshj.transport.kex Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.transport.kex +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/kex/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/package-use.html new file mode 100644 index 00000000..ee207a74 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/kex/package-use.html @@ -0,0 +1,202 @@ + + + + + + + +Uses of Package net.schmizz.sshj.transport.kex (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.transport.kex

+
+ + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.transport.kex
net.schmizz.sshj  
net.schmizz.sshj.transport.kex  
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.transport.kex used by net.schmizz.sshj
KeyExchange + +
+          Key exchange algorithm.
+  +

+ + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.transport.kex used by net.schmizz.sshj.transport.kex
AbstractDHG + +
+          Base class for DHG key exchange algorithms.
DH + +
+          Diffie-Hellman key generator.
KeyExchange + +
+          Key exchange algorithm.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/BaseMAC.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/BaseMAC.html new file mode 100644 index 00000000..55c2722e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/BaseMAC.html @@ -0,0 +1,430 @@ + + + + + + + +BaseMAC (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.mac +
+Class BaseMAC

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.mac.BaseMAC
+
+
+
All Implemented Interfaces:
MAC
+
+
+
Direct Known Subclasses:
HMACMD5, HMACMD596, HMACSHA1, HMACSHA196
+
+
+
+
public class BaseMAC
extends Object
implements MAC
+ + +

+Base class for MAC implementations based on the JCE provider. +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
BaseMAC(String algorithm, + int bsize, + int defbsize) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ byte[]doFinal() + +
+           
+ byte[]doFinal(byte[] input) + +
+           
+ voiddoFinal(byte[] buf, + int offset) + +
+           
+ intgetBlockSize() + +
+           
+ voidinit(byte[] key) + +
+           
+ voidupdate(byte[] foo) + +
+           
+ voidupdate(byte[] foo, + int s, + int l) + +
+           
+ voidupdate(long i) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+BaseMAC

+
+public BaseMAC(String algorithm,
+               int bsize,
+               int defbsize)
+
+
+ + + + + + + + +
+Method Detail
+ +

+doFinal

+
+public byte[] doFinal()
+
+
+
Specified by:
doFinal in interface MAC
+
+
+
+
+
+
+ +

+doFinal

+
+public byte[] doFinal(byte[] input)
+
+
+
Specified by:
doFinal in interface MAC
+
+
+
+
+
+
+ +

+doFinal

+
+public void doFinal(byte[] buf,
+                    int offset)
+
+
+
Specified by:
doFinal in interface MAC
+
+
+
+
+
+
+ +

+getBlockSize

+
+public int getBlockSize()
+
+
+
Specified by:
getBlockSize in interface MAC
+
+
+
+
+
+
+ +

+init

+
+public void init(byte[] key)
+
+
+
Specified by:
init in interface MAC
+
+
+
+
+
+
+ +

+update

+
+public void update(byte[] foo,
+                   int s,
+                   int l)
+
+
+
Specified by:
update in interface MAC
+
+
+
+
+
+
+ +

+update

+
+public void update(byte[] foo)
+
+
+
Specified by:
update in interface MAC
+
+
+
+
+
+
+ +

+update

+
+public void update(long i)
+
+
+
Specified by:
update in interface MAC
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACMD5.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACMD5.Factory.html new file mode 100644 index 00000000..37de2fa4 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACMD5.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +HMACMD5.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.mac +
+Class HMACMD5.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.mac.HMACMD5.Factory
+
+
+
All Implemented Interfaces:
Factory<MAC>, Factory.Named<MAC>
+
+
+
Enclosing class:
HMACMD5
+
+
+
+
public static class HMACMD5.Factory
extends Object
implements Factory.Named<MAC>
+ + +

+Named factory for the HMACMD5 MAC +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
HMACMD5.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ MACcreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+HMACMD5.Factory

+
+public HMACMD5.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public MAC create()
+
+
+
Specified by:
create in interface Factory<MAC>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<MAC>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACMD5.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACMD5.html new file mode 100644 index 00000000..32fcdee2 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACMD5.html @@ -0,0 +1,259 @@ + + + + + + + +HMACMD5 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.mac +
+Class HMACMD5

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.mac.BaseMAC
+      extended by net.schmizz.sshj.transport.mac.HMACMD5
+
+
+
All Implemented Interfaces:
MAC
+
+
+
+
public class HMACMD5
extends BaseMAC
+ + +

+HMAC-MD5 MAC. +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classHMACMD5.Factory + +
+          Named factory for the HMACMD5 MAC
+  + + + + + + + + + + +
+Constructor Summary
HMACMD5() + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.mac.BaseMAC
doFinal, doFinal, doFinal, getBlockSize, init, update, update, update
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+HMACMD5

+
+public HMACMD5()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACMD596.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACMD596.Factory.html new file mode 100644 index 00000000..5683b3d4 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACMD596.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +HMACMD596.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.mac +
+Class HMACMD596.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.mac.HMACMD596.Factory
+
+
+
All Implemented Interfaces:
Factory<MAC>, Factory.Named<MAC>
+
+
+
Enclosing class:
HMACMD596
+
+
+
+
public static class HMACMD596.Factory
extends Object
implements Factory.Named<MAC>
+ + +

+Named factory for the HMAC-MD5-96 MAC +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
HMACMD596.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ MACcreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+HMACMD596.Factory

+
+public HMACMD596.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public MAC create()
+
+
+
Specified by:
create in interface Factory<MAC>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<MAC>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACMD596.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACMD596.html new file mode 100644 index 00000000..d64388dc --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACMD596.html @@ -0,0 +1,259 @@ + + + + + + + +HMACMD596 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.mac +
+Class HMACMD596

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.mac.BaseMAC
+      extended by net.schmizz.sshj.transport.mac.HMACMD596
+
+
+
All Implemented Interfaces:
MAC
+
+
+
+
public class HMACMD596
extends BaseMAC
+ + +

+HMAC-MD5-96 MAC +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classHMACMD596.Factory + +
+          Named factory for the HMAC-MD5-96 MAC
+  + + + + + + + + + + +
+Constructor Summary
HMACMD596() + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.mac.BaseMAC
doFinal, doFinal, doFinal, getBlockSize, init, update, update, update
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+HMACMD596

+
+public HMACMD596()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACSHA1.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACSHA1.Factory.html new file mode 100644 index 00000000..63e92d5e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACSHA1.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +HMACSHA1.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.mac +
+Class HMACSHA1.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.mac.HMACSHA1.Factory
+
+
+
All Implemented Interfaces:
Factory<MAC>, Factory.Named<MAC>
+
+
+
Enclosing class:
HMACSHA1
+
+
+
+
public static class HMACSHA1.Factory
extends Object
implements Factory.Named<MAC>
+ + +

+Named factory for the HMAC-SHA1 MAC +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
HMACSHA1.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ MACcreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+HMACSHA1.Factory

+
+public HMACSHA1.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public MAC create()
+
+
+
Specified by:
create in interface Factory<MAC>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<MAC>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACSHA1.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACSHA1.html new file mode 100644 index 00000000..7e9e7ac8 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACSHA1.html @@ -0,0 +1,259 @@ + + + + + + + +HMACSHA1 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.mac +
+Class HMACSHA1

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.mac.BaseMAC
+      extended by net.schmizz.sshj.transport.mac.HMACSHA1
+
+
+
All Implemented Interfaces:
MAC
+
+
+
+
public class HMACSHA1
extends BaseMAC
+ + +

+HMAC-SHA1 MAC +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classHMACSHA1.Factory + +
+          Named factory for the HMAC-SHA1 MAC
+  + + + + + + + + + + +
+Constructor Summary
HMACSHA1() + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.mac.BaseMAC
doFinal, doFinal, doFinal, getBlockSize, init, update, update, update
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+HMACSHA1

+
+public HMACSHA1()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACSHA196.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACSHA196.Factory.html new file mode 100644 index 00000000..8caffb87 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACSHA196.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +HMACSHA196.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.mac +
+Class HMACSHA196.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.mac.HMACSHA196.Factory
+
+
+
All Implemented Interfaces:
Factory<MAC>, Factory.Named<MAC>
+
+
+
Enclosing class:
HMACSHA196
+
+
+
+
public static class HMACSHA196.Factory
extends Object
implements Factory.Named<MAC>
+ + +

+Named factory for the HMAC-SHA1-96 MAC +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
HMACSHA196.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ MACcreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+HMACSHA196.Factory

+
+public HMACSHA196.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public MAC create()
+
+
+
Specified by:
create in interface Factory<MAC>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<MAC>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACSHA196.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACSHA196.html new file mode 100644 index 00000000..3188a3de --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/HMACSHA196.html @@ -0,0 +1,259 @@ + + + + + + + +HMACSHA196 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.mac +
+Class HMACSHA196

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.mac.BaseMAC
+      extended by net.schmizz.sshj.transport.mac.HMACSHA196
+
+
+
All Implemented Interfaces:
MAC
+
+
+
+
public class HMACSHA196
extends BaseMAC
+ + +

+HMAC-SHA1-96 MAC +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classHMACSHA196.Factory + +
+          Named factory for the HMAC-SHA1-96 MAC
+  + + + + + + + + + + +
+Constructor Summary
HMACSHA196() + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.mac.BaseMAC
doFinal, doFinal, doFinal, getBlockSize, init, update, update, update
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+HMACSHA196

+
+public HMACSHA196()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/MAC.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/MAC.html new file mode 100644 index 00000000..8bbf70df --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/MAC.html @@ -0,0 +1,353 @@ + + + + + + + +MAC (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.mac +
+Interface MAC

+
+
All Known Implementing Classes:
BaseMAC, HMACMD5, HMACMD596, HMACSHA1, HMACSHA196
+
+
+
+
public interface MAC
+ + +

+Message Authentication Code for use in SSH. It usually wraps a javax.crypto.Mac class. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ byte[]doFinal() + +
+           
+ byte[]doFinal(byte[] input) + +
+           
+ voiddoFinal(byte[] buf, + int offset) + +
+           
+ intgetBlockSize() + +
+           
+ voidinit(byte[] key) + +
+           
+ voidupdate(byte[] foo) + +
+           
+ voidupdate(byte[] foo, + int start, + int len) + +
+           
+ voidupdate(long foo) + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+doFinal

+
+byte[] doFinal()
+
+
+
+
+
+
+ +

+doFinal

+
+byte[] doFinal(byte[] input)
+
+
+
+
+
+
+ +

+doFinal

+
+void doFinal(byte[] buf,
+             int offset)
+
+
+
+
+
+
+ +

+getBlockSize

+
+int getBlockSize()
+
+
+
+
+
+
+ +

+init

+
+void init(byte[] key)
+
+
+
+
+
+
+ +

+update

+
+void update(byte[] foo)
+
+
+
+
+
+
+ +

+update

+
+void update(byte[] foo,
+            int start,
+            int len)
+
+
+
+
+
+
+ +

+update

+
+void update(long foo)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/BaseMAC.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/BaseMAC.html new file mode 100644 index 00000000..be8845ae --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/BaseMAC.html @@ -0,0 +1,205 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.mac.BaseMAC (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.mac.BaseMAC

+
+ + + + + + + + + +
+Packages that use BaseMAC
net.schmizz.sshj.transport.mac  
+  +

+ + + + + +
+Uses of BaseMAC in net.schmizz.sshj.transport.mac
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Subclasses of BaseMAC in net.schmizz.sshj.transport.mac
+ classHMACMD5 + +
+          HMAC-MD5 MAC.
+ classHMACMD596 + +
+          HMAC-MD5-96 MAC
+ classHMACSHA1 + +
+          HMAC-SHA1 MAC
+ classHMACSHA196 + +
+          HMAC-SHA1-96 MAC
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACMD5.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACMD5.Factory.html new file mode 100644 index 00000000..5c64e1f4 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACMD5.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.mac.HMACMD5.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.mac.HMACMD5.Factory

+
+No usage of net.schmizz.sshj.transport.mac.HMACMD5.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACMD5.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACMD5.html new file mode 100644 index 00000000..43f33e62 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACMD5.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.mac.HMACMD5 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.mac.HMACMD5

+
+No usage of net.schmizz.sshj.transport.mac.HMACMD5 +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACMD596.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACMD596.Factory.html new file mode 100644 index 00000000..2c9d8239 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACMD596.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.mac.HMACMD596.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.mac.HMACMD596.Factory

+
+No usage of net.schmizz.sshj.transport.mac.HMACMD596.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACMD596.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACMD596.html new file mode 100644 index 00000000..e0c63403 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACMD596.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.mac.HMACMD596 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.mac.HMACMD596

+
+No usage of net.schmizz.sshj.transport.mac.HMACMD596 +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACSHA1.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACSHA1.Factory.html new file mode 100644 index 00000000..8f8e7048 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACSHA1.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.mac.HMACSHA1.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.mac.HMACSHA1.Factory

+
+No usage of net.schmizz.sshj.transport.mac.HMACSHA1.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACSHA1.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACSHA1.html new file mode 100644 index 00000000..53cb3c6c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACSHA1.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.mac.HMACSHA1 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.mac.HMACSHA1

+
+No usage of net.schmizz.sshj.transport.mac.HMACSHA1 +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACSHA196.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACSHA196.Factory.html new file mode 100644 index 00000000..f41da8af --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACSHA196.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.mac.HMACSHA196.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.mac.HMACSHA196.Factory

+
+No usage of net.schmizz.sshj.transport.mac.HMACSHA196.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACSHA196.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACSHA196.html new file mode 100644 index 00000000..249f1c01 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/HMACSHA196.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.mac.HMACSHA196 (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.mac.HMACSHA196

+
+No usage of net.schmizz.sshj.transport.mac.HMACSHA196 +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/MAC.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/MAC.html new file mode 100644 index 00000000..ffdd468c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/class-use/MAC.html @@ -0,0 +1,314 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.transport.mac.MAC (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.transport.mac.MAC

+
+ + + + + + + + + + + + + +
+Packages that use MAC
net.schmizz.sshj  
net.schmizz.sshj.transport.mac  
+  +

+ + + + + +
+Uses of MAC in net.schmizz.sshj
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj that return types with arguments of type MAC
+ List<Factory.Named<MAC>>ConfigImpl.getMACFactories() + +
+           
+ List<Factory.Named<MAC>>Config.getMACFactories() + +
+          Retrieve the list of named factories for MAC.
+  +

+ + + + + + + + + + + + + +
Method parameters in net.schmizz.sshj with type arguments of type MAC
+ voidConfigImpl.setMACFactories(List<Factory.Named<MAC>> macFactories) + +
+           
+ voidConfig.setMACFactories(List<Factory.Named<MAC>> macFactories) + +
+          Set the named factories for MAC.
+  +

+ + + + + +
+Uses of MAC in net.schmizz.sshj.transport.mac
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.transport.mac that implement MAC
+ classBaseMAC + +
+          Base class for MAC implementations based on the JCE provider.
+ classHMACMD5 + +
+          HMAC-MD5 MAC.
+ classHMACMD596 + +
+          HMAC-MD5-96 MAC
+ classHMACSHA1 + +
+          HMAC-SHA1 MAC
+ classHMACSHA196 + +
+          HMAC-SHA1-96 MAC
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.mac that return MAC
+ MACHMACSHA196.Factory.create() + +
+           
+ MACHMACSHA1.Factory.create() + +
+           
+ MACHMACMD596.Factory.create() + +
+           
+ MACHMACMD5.Factory.create() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/package-frame.html new file mode 100644 index 00000000..fc30300d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/package-frame.html @@ -0,0 +1,60 @@ + + + + + + + +net.schmizz.sshj.transport.mac (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.transport.mac + + + + +
+Interfaces  + +
+MAC
+ + + + + + +
+Classes  + +
+BaseMAC +
+HMACMD5 +
+HMACMD5.Factory +
+HMACMD596 +
+HMACMD596.Factory +
+HMACSHA1 +
+HMACSHA1.Factory +
+HMACSHA196 +
+HMACSHA196.Factory
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/package-summary.html new file mode 100644 index 00000000..d252b538 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/package-summary.html @@ -0,0 +1,204 @@ + + + + + + + +net.schmizz.sshj.transport.mac (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.transport.mac +

+ + + + + + + + + +
+Interface Summary
MACMessage Authentication Code for use in SSH.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
BaseMACBase class for MAC implementations based on the JCE provider.
HMACMD5HMAC-MD5 MAC.
HMACMD5.FactoryNamed factory for the HMACMD5 MAC
HMACMD596HMAC-MD5-96 MAC
HMACMD596.FactoryNamed factory for the HMAC-MD5-96 MAC
HMACSHA1HMAC-SHA1 MAC
HMACSHA1.FactoryNamed factory for the HMAC-SHA1 MAC
HMACSHA196HMAC-SHA1-96 MAC
HMACSHA196.FactoryNamed factory for the HMAC-SHA1-96 MAC
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/package-tree.html new file mode 100644 index 00000000..a5a6be21 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/package-tree.html @@ -0,0 +1,166 @@ + + + + + + + +net.schmizz.sshj.transport.mac Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.transport.mac +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/mac/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/package-use.html new file mode 100644 index 00000000..1b677bd3 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/mac/package-use.html @@ -0,0 +1,196 @@ + + + + + + + +Uses of Package net.schmizz.sshj.transport.mac (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.transport.mac

+
+ + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.transport.mac
net.schmizz.sshj  
net.schmizz.sshj.transport.mac  
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.transport.mac used by net.schmizz.sshj
MAC + +
+          Message Authentication Code for use in SSH.
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.transport.mac used by net.schmizz.sshj.transport.mac
BaseMAC + +
+          Base class for MAC implementations based on the JCE provider.
MAC + +
+          Message Authentication Code for use in SSH.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/transport/package-frame.html new file mode 100644 index 00000000..3a477719 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/package-frame.html @@ -0,0 +1,61 @@ + + + + + + + +net.schmizz.sshj.transport (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.transport + + + + +
+Interfaces  + +
+DisconnectListener +
+Transport
+ + + + + + +
+Classes  + +
+NegotiatedAlgorithms +
+Reader +
+TransportImpl
+ + + + + + +
+Exceptions  + +
+TransportException
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/transport/package-summary.html new file mode 100644 index 00000000..bfd5e241 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/package-summary.html @@ -0,0 +1,198 @@ + + + + + + + +net.schmizz.sshj.transport (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.transport +

+ + + + + + + + + + + + + +
+Interface Summary
DisconnectListener 
TransportTransport layer of the SSH protocol.
+  + +

+ + + + + + + + + + + + + + + + + +
+Class Summary
NegotiatedAlgorithms 
Reader 
TransportImplA thread-safe Transport implementation.
+  + +

+ + + + + + + + + +
+Exception Summary
TransportExceptionTransport-layer exception
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/transport/package-tree.html new file mode 100644 index 00000000..e5472474 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/package-tree.html @@ -0,0 +1,174 @@ + + + + + + + +net.schmizz.sshj.transport Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.transport +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/transport/package-use.html new file mode 100644 index 00000000..64152a61 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/package-use.html @@ -0,0 +1,390 @@ + + + + + + + +Uses of Package net.schmizz.sshj.transport (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.transport

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.transport
net.schmizz.sshj  
net.schmizz.sshj.connection  
net.schmizz.sshj.connection.channel  
net.schmizz.sshj.connection.channel.direct  
net.schmizz.sshj.connection.channel.forwarded  
net.schmizz.sshj.transport  
net.schmizz.sshj.transport.compression  
net.schmizz.sshj.transport.kex  
net.schmizz.sshj.userauth  
net.schmizz.sshj.userauth.method  
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.transport used by net.schmizz.sshj
Transport + +
+          Transport layer of the SSH protocol.
TransportException + +
+          Transport-layer exception
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.transport used by net.schmizz.sshj.connection
Transport + +
+          Transport layer of the SSH protocol.
TransportException + +
+          Transport-layer exception
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.transport used by net.schmizz.sshj.connection.channel
Transport + +
+          Transport layer of the SSH protocol.
TransportException + +
+          Transport-layer exception
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.transport used by net.schmizz.sshj.connection.channel.direct
TransportException + +
+          Transport-layer exception
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.transport used by net.schmizz.sshj.connection.channel.forwarded
TransportException + +
+          Transport-layer exception
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.transport used by net.schmizz.sshj.transport
DisconnectListener + +
+           
Transport + +
+          Transport layer of the SSH protocol.
TransportException + +
+          Transport-layer exception
TransportImpl + +
+          A thread-safe Transport implementation.
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.transport used by net.schmizz.sshj.transport.compression
TransportException + +
+          Transport-layer exception
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.transport used by net.schmizz.sshj.transport.kex
Transport + +
+          Transport layer of the SSH protocol.
TransportException + +
+          Transport-layer exception
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.transport used by net.schmizz.sshj.userauth
Transport + +
+          Transport layer of the SSH protocol.
TransportException + +
+          Transport-layer exception
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.transport used by net.schmizz.sshj.userauth.method
TransportException + +
+          Transport-layer exception
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/random/BouncyCastleRandom.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/random/BouncyCastleRandom.Factory.html new file mode 100644 index 00000000..a3f1317e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/random/BouncyCastleRandom.Factory.html @@ -0,0 +1,286 @@ + + + + + + + +BouncyCastleRandom.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.random +
+Class BouncyCastleRandom.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.random.BouncyCastleRandom.Factory
+
+
+
All Implemented Interfaces:
Factory<Random>
+
+
+
Enclosing class:
BouncyCastleRandom
+
+
+
+
public static class BouncyCastleRandom.Factory
extends Object
implements Factory<Random>
+ + +

+Named factory for the BouncyCastle Random +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
BouncyCastleRandom.Factory() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ Randomcreate() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+BouncyCastleRandom.Factory

+
+public BouncyCastleRandom.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public Random create()
+
+
+
Specified by:
create in interface Factory<Random>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/random/BouncyCastleRandom.html b/javadoc/0.4.1/net/schmizz/sshj/transport/random/BouncyCastleRandom.html new file mode 100644 index 00000000..ed98e40a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/random/BouncyCastleRandom.html @@ -0,0 +1,288 @@ + + + + + + + +BouncyCastleRandom (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.random +
+Class BouncyCastleRandom

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.random.BouncyCastleRandom
+
+
+
All Implemented Interfaces:
Random
+
+
+
+
public class BouncyCastleRandom
extends Object
implements Random
+ + +

+BouncyCastle Random. This pseudo random number generator uses the a very fast PRNG from BouncyCastle. + The JRE random will be used when creating a new generator to add some random data to the seed. +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classBouncyCastleRandom.Factory + +
+          Named factory for the BouncyCastle Random
+  + + + + + + + + + + +
+Constructor Summary
BouncyCastleRandom() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidfill(byte[] bytes, + int start, + int len) + +
+          Fill part of bytes with random values.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+BouncyCastleRandom

+
+public BouncyCastleRandom()
+
+
+ + + + + + + + +
+Method Detail
+ +

+fill

+
+public void fill(byte[] bytes,
+                 int start,
+                 int len)
+
+
Description copied from interface: Random
+
Fill part of bytes with random values. +

+

+
Specified by:
fill in interface Random
+
+
+
Parameters:
bytes - byte array to be filled.
start - index to start filling at.
len - length of segment to fill.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/random/JCERandom.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/random/JCERandom.Factory.html new file mode 100644 index 00000000..b74ea81b --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/random/JCERandom.Factory.html @@ -0,0 +1,319 @@ + + + + + + + +JCERandom.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.random +
+Class JCERandom.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.random.JCERandom.Factory
+
+
+
All Implemented Interfaces:
Factory<Random>, Factory.Named<Random>
+
+
+
Enclosing class:
JCERandom
+
+
+
+
public static class JCERandom.Factory
extends Object
implements Factory.Named<Random>
+ + +

+Named factory for the JCE Random +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
JCERandom.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Randomcreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+JCERandom.Factory

+
+public JCERandom.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public Random create()
+
+
+
Specified by:
create in interface Factory<Random>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<Random>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/random/JCERandom.html b/javadoc/0.4.1/net/schmizz/sshj/transport/random/JCERandom.html new file mode 100644 index 00000000..dc961c28 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/random/JCERandom.html @@ -0,0 +1,286 @@ + + + + + + + +JCERandom (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.random +
+Class JCERandom

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.random.JCERandom
+
+
+
All Implemented Interfaces:
Random
+
+
+
+
public class JCERandom
extends Object
implements Random
+ + +

+A Random implementation using the built-in SecureRandom PRNG. +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classJCERandom.Factory + +
+          Named factory for the JCE Random
+  + + + + + + + + + + +
+Constructor Summary
JCERandom() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidfill(byte[] foo, + int start, + int len) + +
+          Fill the given byte-array with random bytes from this PRNG.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+JCERandom

+
+public JCERandom()
+
+
+ + + + + + + + +
+Method Detail
+ +

+fill

+
+public void fill(byte[] foo,
+                 int start,
+                 int len)
+
+
Fill the given byte-array with random bytes from this PRNG. +

+

+
Specified by:
fill in interface Random
+
+
+
Parameters:
foo - the byte-array
start - the offset to start at
len - the number of bytes to fill
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/random/Random.html b/javadoc/0.4.1/net/schmizz/sshj/transport/random/Random.html new file mode 100644 index 00000000..cd158c3b --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/random/Random.html @@ -0,0 +1,220 @@ + + + + + + + +Random (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.random +
+Interface Random

+
+
All Known Implementing Classes:
BouncyCastleRandom, JCERandom, SingletonRandomFactory
+
+
+
+
public interface Random
+ + +

+A pseudo random number generator. +

+ +

+


+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidfill(byte[] bytes, + int start, + int len) + +
+          Fill part of bytes with random values.
+  +

+ + + + + + + + +
+Method Detail
+ +

+fill

+
+void fill(byte[] bytes,
+          int start,
+          int len)
+
+
Fill part of bytes with random values. +

+

+
Parameters:
bytes - byte array to be filled.
start - index to start filling at.
len - length of segment to fill.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/random/SingletonRandomFactory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/random/SingletonRandomFactory.html new file mode 100644 index 00000000..4528ac6a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/random/SingletonRandomFactory.html @@ -0,0 +1,312 @@ + + + + + + + +SingletonRandomFactory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.random +
+Class SingletonRandomFactory

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.random.SingletonRandomFactory
+
+
+
All Implemented Interfaces:
Factory<Random>, Random
+
+
+
+
public class SingletonRandomFactory
extends Object
implements Random, Factory<Random>
+ + +

+A random factory wrapper that uses a single random instance. The underlying random instance has to be thread safe. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
SingletonRandomFactory(Factory<Random> factory) + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Randomcreate() + +
+           
+ voidfill(byte[] bytes, + int start, + int len) + +
+          Fill part of bytes with random values.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SingletonRandomFactory

+
+public SingletonRandomFactory(Factory<Random> factory)
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public Random create()
+
+
+
Specified by:
create in interface Factory<Random>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+fill

+
+public void fill(byte[] bytes,
+                 int start,
+                 int len)
+
+
Description copied from interface: Random
+
Fill part of bytes with random values. +

+

+
Specified by:
fill in interface Random
+
+
+
Parameters:
bytes - byte array to be filled.
start - index to start filling at.
len - length of segment to fill.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/random/class-use/BouncyCastleRandom.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/random/class-use/BouncyCastleRandom.Factory.html new file mode 100644 index 00000000..14c97e3a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/random/class-use/BouncyCastleRandom.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.random.BouncyCastleRandom.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.random.BouncyCastleRandom.Factory

+
+No usage of net.schmizz.sshj.transport.random.BouncyCastleRandom.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/random/class-use/BouncyCastleRandom.html b/javadoc/0.4.1/net/schmizz/sshj/transport/random/class-use/BouncyCastleRandom.html new file mode 100644 index 00000000..bf827c7f --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/random/class-use/BouncyCastleRandom.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.random.BouncyCastleRandom (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.random.BouncyCastleRandom

+
+No usage of net.schmizz.sshj.transport.random.BouncyCastleRandom +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/random/class-use/JCERandom.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/random/class-use/JCERandom.Factory.html new file mode 100644 index 00000000..c75e9ef8 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/random/class-use/JCERandom.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.random.JCERandom.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.random.JCERandom.Factory

+
+No usage of net.schmizz.sshj.transport.random.JCERandom.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/random/class-use/JCERandom.html b/javadoc/0.4.1/net/schmizz/sshj/transport/random/class-use/JCERandom.html new file mode 100644 index 00000000..36be5eb9 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/random/class-use/JCERandom.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.random.JCERandom (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.random.JCERandom

+
+No usage of net.schmizz.sshj.transport.random.JCERandom +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/random/class-use/Random.html b/javadoc/0.4.1/net/schmizz/sshj/transport/random/class-use/Random.html new file mode 100644 index 00000000..d9416df8 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/random/class-use/Random.html @@ -0,0 +1,304 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.transport.random.Random (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.transport.random.Random

+
+ + + + + + + + + + + + + +
+Packages that use Random
net.schmizz.sshj  
net.schmizz.sshj.transport.random  
+  +

+ + + + + +
+Uses of Random in net.schmizz.sshj
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj that return types with arguments of type Random
+ Factory<Random>ConfigImpl.getRandomFactory() + +
+           
+ Factory<Random>Config.getRandomFactory() + +
+          Retrieve the Random factory.
+  +

+ + + + + + + + + + + + + +
Method parameters in net.schmizz.sshj with type arguments of type Random
+ voidConfigImpl.setRandomFactory(Factory<Random> randomFactory) + +
+           
+ voidConfig.setRandomFactory(Factory<Random> randomFactory) + +
+          Set the factory for Random.
+  +

+ + + + + +
+Uses of Random in net.schmizz.sshj.transport.random
+  +

+ + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.transport.random that implement Random
+ classBouncyCastleRandom + +
+          BouncyCastle Random.
+ classJCERandom + +
+          A Random implementation using the built-in SecureRandom PRNG.
+ classSingletonRandomFactory + +
+          A random factory wrapper that uses a single random instance.
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.random that return Random
+ RandomSingletonRandomFactory.create() + +
+           
+ RandomJCERandom.Factory.create() + +
+           
+ RandomBouncyCastleRandom.Factory.create() + +
+           
+  +

+ + + + + + + + +
Constructor parameters in net.schmizz.sshj.transport.random with type arguments of type Random
SingletonRandomFactory(Factory<Random> factory) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/random/class-use/SingletonRandomFactory.html b/javadoc/0.4.1/net/schmizz/sshj/transport/random/class-use/SingletonRandomFactory.html new file mode 100644 index 00000000..7f2f343c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/random/class-use/SingletonRandomFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.random.SingletonRandomFactory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.random.SingletonRandomFactory

+
+No usage of net.schmizz.sshj.transport.random.SingletonRandomFactory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/random/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/transport/random/package-frame.html new file mode 100644 index 00000000..9465a620 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/random/package-frame.html @@ -0,0 +1,52 @@ + + + + + + + +net.schmizz.sshj.transport.random (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.transport.random + + + + +
+Interfaces  + +
+Random
+ + + + + + +
+Classes  + +
+BouncyCastleRandom +
+BouncyCastleRandom.Factory +
+JCERandom +
+JCERandom.Factory +
+SingletonRandomFactory
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/random/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/transport/random/package-summary.html new file mode 100644 index 00000000..6e2982e9 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/random/package-summary.html @@ -0,0 +1,188 @@ + + + + + + + +net.schmizz.sshj.transport.random (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.transport.random +

+ + + + + + + + + +
+Interface Summary
RandomA pseudo random number generator.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
BouncyCastleRandomBouncyCastle Random.
BouncyCastleRandom.FactoryNamed factory for the BouncyCastle Random
JCERandomA Random implementation using the built-in SecureRandom PRNG.
JCERandom.FactoryNamed factory for the JCE Random
SingletonRandomFactoryA random factory wrapper that uses a single random instance.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/random/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/transport/random/package-tree.html new file mode 100644 index 00000000..ceafb23e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/random/package-tree.html @@ -0,0 +1,164 @@ + + + + + + + +net.schmizz.sshj.transport.random Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.transport.random +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/random/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/transport/random/package-use.html new file mode 100644 index 00000000..39021591 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/random/package-use.html @@ -0,0 +1,190 @@ + + + + + + + +Uses of Package net.schmizz.sshj.transport.random (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.transport.random

+
+ + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.transport.random
net.schmizz.sshj  
net.schmizz.sshj.transport.random  
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.transport.random used by net.schmizz.sshj
Random + +
+          A pseudo random number generator.
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.transport.random used by net.schmizz.sshj.transport.random
Random + +
+          A pseudo random number generator.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/verification/ConsoleKnownHostsVerifier.html b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/ConsoleKnownHostsVerifier.html new file mode 100644 index 00000000..3d66eede --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/ConsoleKnownHostsVerifier.html @@ -0,0 +1,341 @@ + + + + + + + +ConsoleKnownHostsVerifier (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.verification +
+Class ConsoleKnownHostsVerifier

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.verification.OpenSSHKnownHosts
+      extended by net.schmizz.sshj.transport.verification.ConsoleKnownHostsVerifier
+
+
+
All Implemented Interfaces:
HostKeyVerifier
+
+
+
+
public class ConsoleKnownHostsVerifier
extends OpenSSHKnownHosts
+ + +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts
OpenSSHKnownHosts.Entry, OpenSSHKnownHosts.HashedEntry, OpenSSHKnownHosts.SimpleEntry
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts
entries, khFile, log
+  + + + + + + + + + + +
+Constructor Summary
ConsoleKnownHostsVerifier(File khFile, + Console console) + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+protected  booleanhostKeyChangedAction(OpenSSHKnownHosts.Entry entry, + String hostname, + PublicKey key) + +
+           
+protected  booleanhostKeyUnverifiableAction(String hostname, + PublicKey key) + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts
detectSSHDir, entries, getFile, isHashed, verify, write
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ConsoleKnownHostsVerifier

+
+public ConsoleKnownHostsVerifier(File khFile,
+                                 Console console)
+                          throws IOException
+
+
+ +
Throws: +
IOException
+
+ + + + + + + + +
+Method Detail
+ +

+hostKeyUnverifiableAction

+
+protected boolean hostKeyUnverifiableAction(String hostname,
+                                            PublicKey key)
+
+
+
Overrides:
hostKeyUnverifiableAction in class OpenSSHKnownHosts
+
+
+
+
+
+
+ +

+hostKeyChangedAction

+
+protected boolean hostKeyChangedAction(OpenSSHKnownHosts.Entry entry,
+                                       String hostname,
+                                       PublicKey key)
+
+
+
Overrides:
hostKeyChangedAction in class OpenSSHKnownHosts
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/verification/HostKeyVerifier.html b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/HostKeyVerifier.html new file mode 100644 index 00000000..be225bec --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/HostKeyVerifier.html @@ -0,0 +1,225 @@ + + + + + + + +HostKeyVerifier (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.verification +
+Interface HostKeyVerifier

+
+
All Known Implementing Classes:
ConsoleKnownHostsVerifier, OpenSSHKnownHosts, PromiscuousVerifier
+
+
+
+
public interface HostKeyVerifier
+ + +

+Host key verification interface. +

+ +

+


+ +

+ + + + + + + + + + + + +
+Method Summary
+ booleanverify(String hostname, + int port, + PublicKey key) + +
+          This callback is invoked when the server's host key needs to be verified.
+  +

+ + + + + + + + +
+Method Detail
+ +

+verify

+
+boolean verify(String hostname,
+               int port,
+               PublicKey key)
+
+
This callback is invoked when the server's host key needs to be verified. The return value indicates to the + caller whether the SSH connection should proceed. +

+ Note: host key verification is the basis for security in SSH, therefore exercise due caution in + implementing! +

+

+
Parameters:
hostname - remote hostname
port - remote port
key - host key of server +
Returns:
true if key is acceptable, false otherwise
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/verification/OpenSSHKnownHosts.Entry.html b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/OpenSSHKnownHosts.Entry.html new file mode 100644 index 00000000..5e6a3d6e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/OpenSSHKnownHosts.Entry.html @@ -0,0 +1,428 @@ + + + + + + + +OpenSSHKnownHosts.Entry (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.verification +
+Class OpenSSHKnownHosts.Entry

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.Entry
+
+
+
Direct Known Subclasses:
OpenSSHKnownHosts.HashedEntry, OpenSSHKnownHosts.SimpleEntry
+
+
+
Enclosing class:
OpenSSHKnownHosts
+
+
+
+
public abstract static class OpenSSHKnownHosts.Entry
extends Object
+ + +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
OpenSSHKnownHosts.Entry() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+abstract  booleanappliesTo(String host) + +
+           
+protected abstract  StringgetHostPart() + +
+           
+ PublicKeygetKey() + +
+           
+protected  StringgetKeyString() + +
+           
+ StringgetLine() + +
+           
+ KeyTypegetType() + +
+           
+protected  voidinit(PublicKey key) + +
+           
+protected  voidinit(String typeString, + String keyString) + +
+           
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+OpenSSHKnownHosts.Entry

+
+public OpenSSHKnownHosts.Entry()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+protected void init(PublicKey key)
+             throws SSHException
+
+
+ +
Throws: +
SSHException
+
+
+
+ +

+init

+
+protected void init(String typeString,
+                    String keyString)
+             throws SSHException
+
+
+ +
Throws: +
SSHException
+
+
+
+ +

+getType

+
+public KeyType getType()
+
+
+
+
+
+
+ +

+getKey

+
+public PublicKey getKey()
+                 throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+getKeyString

+
+protected String getKeyString()
+
+
+
+
+
+
+ +

+getLine

+
+public String getLine()
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+
+ +

+getHostPart

+
+protected abstract String getHostPart()
+
+
+
+
+
+
+ +

+appliesTo

+
+public abstract boolean appliesTo(String host)
+                           throws IOException
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/verification/OpenSSHKnownHosts.HashedEntry.html b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/OpenSSHKnownHosts.HashedEntry.html new file mode 100644 index 00000000..8f662340 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/OpenSSHKnownHosts.HashedEntry.html @@ -0,0 +1,320 @@ + + + + + + + +OpenSSHKnownHosts.HashedEntry (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.verification +
+Class OpenSSHKnownHosts.HashedEntry

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.Entry
+      extended by net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.HashedEntry
+
+
+
Enclosing class:
OpenSSHKnownHosts
+
+
+
+
public static class OpenSSHKnownHosts.HashedEntry
extends OpenSSHKnownHosts.Entry
+ + +

+


+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
OpenSSHKnownHosts.HashedEntry(String line) + +
+           
OpenSSHKnownHosts.HashedEntry(String host, + PublicKey key) + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ booleanappliesTo(String host) + +
+           
+protected  StringgetHostPart() + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.Entry
getKey, getKeyString, getLine, getType, init, init, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+OpenSSHKnownHosts.HashedEntry

+
+public OpenSSHKnownHosts.HashedEntry(String host,
+                                     PublicKey key)
+                              throws IOException
+
+
+ +
Throws: +
IOException
+
+
+ +

+OpenSSHKnownHosts.HashedEntry

+
+public OpenSSHKnownHosts.HashedEntry(String line)
+                              throws IOException
+
+
+ +
Throws: +
IOException
+
+ + + + + + + + +
+Method Detail
+ +

+appliesTo

+
+public boolean appliesTo(String host)
+                  throws IOException
+
+
+
Specified by:
appliesTo in class OpenSSHKnownHosts.Entry
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+getHostPart

+
+protected String getHostPart()
+
+
+
Specified by:
getHostPart in class OpenSSHKnownHosts.Entry
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/verification/OpenSSHKnownHosts.SimpleEntry.html b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/OpenSSHKnownHosts.SimpleEntry.html new file mode 100644 index 00000000..7ffd1d24 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/OpenSSHKnownHosts.SimpleEntry.html @@ -0,0 +1,338 @@ + + + + + + + +OpenSSHKnownHosts.SimpleEntry (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.verification +
+Class OpenSSHKnownHosts.SimpleEntry

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.Entry
+      extended by net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.SimpleEntry
+
+
+
Enclosing class:
OpenSSHKnownHosts
+
+
+
+
public static class OpenSSHKnownHosts.SimpleEntry
extends OpenSSHKnownHosts.Entry
+ + +

+


+ +

+ + + + + + + + + + + + + + + + + +
+Constructor Summary
OpenSSHKnownHosts.SimpleEntry(List<String> hosts, + PublicKey key) + +
+           
OpenSSHKnownHosts.SimpleEntry(String line) + +
+           
OpenSSHKnownHosts.SimpleEntry(String host, + PublicKey key) + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ booleanappliesTo(String host) + +
+           
+protected  StringgetHostPart() + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.Entry
getKey, getKeyString, getLine, getType, init, init, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+OpenSSHKnownHosts.SimpleEntry

+
+public OpenSSHKnownHosts.SimpleEntry(String host,
+                                     PublicKey key)
+                              throws SSHException
+
+
+ +
Throws: +
SSHException
+
+
+ +

+OpenSSHKnownHosts.SimpleEntry

+
+public OpenSSHKnownHosts.SimpleEntry(List<String> hosts,
+                                     PublicKey key)
+                              throws SSHException
+
+
+ +
Throws: +
SSHException
+
+
+ +

+OpenSSHKnownHosts.SimpleEntry

+
+public OpenSSHKnownHosts.SimpleEntry(String line)
+                              throws SSHException
+
+
+ +
Throws: +
SSHException
+
+ + + + + + + + +
+Method Detail
+ +

+appliesTo

+
+public boolean appliesTo(String host)
+
+
+
Specified by:
appliesTo in class OpenSSHKnownHosts.Entry
+
+
+
+
+
+
+ +

+getHostPart

+
+protected String getHostPart()
+
+
+
Specified by:
getHostPart in class OpenSSHKnownHosts.Entry
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/verification/OpenSSHKnownHosts.html b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/OpenSSHKnownHosts.html new file mode 100644 index 00000000..f3e9efa7 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/OpenSSHKnownHosts.html @@ -0,0 +1,553 @@ + + + + + + + +OpenSSHKnownHosts (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.verification +
+Class OpenSSHKnownHosts

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.verification.OpenSSHKnownHosts
+
+
+
All Implemented Interfaces:
HostKeyVerifier
+
+
+
Direct Known Subclasses:
ConsoleKnownHostsVerifier
+
+
+
+
public class OpenSSHKnownHosts
extends Object
implements HostKeyVerifier
+ + +

+A HostKeyVerifier implementation for a known_hosts file i.e. in the format used by OpenSSH. +

+ +

+

+
See Also:
Hashed hostnames spec
+
+ +

+ + + + + + + + + + + + + + + + + + + +
+Nested Class Summary
+static classOpenSSHKnownHosts.Entry + +
+           
+static classOpenSSHKnownHosts.HashedEntry + +
+           
+static classOpenSSHKnownHosts.SimpleEntry + +
+           
+ + + + + + + + + + + + + + + + + + +
+Field Summary
+protected  List<OpenSSHKnownHosts.Entry>entries + +
+           
+protected  FilekhFile + +
+           
+protected  org.slf4j.Loggerlog + +
+           
+  + + + + + + + + + + +
+Constructor Summary
OpenSSHKnownHosts(File khFile) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static FiledetectSSHDir() + +
+           
+ List<OpenSSHKnownHosts.Entry>entries() + +
+           
+ FilegetFile() + +
+           
+protected  booleanhostKeyChangedAction(OpenSSHKnownHosts.Entry entry, + String hostname, + PublicKey key) + +
+           
+protected  booleanhostKeyUnverifiableAction(String hostname, + PublicKey key) + +
+           
+static booleanisHashed(String line) + +
+           
+ booleanverify(String hostname, + int port, + PublicKey key) + +
+          This callback is invoked when the server's host key needs to be verified.
+ voidwrite() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+protected final org.slf4j.Logger log
+
+
+
+
+
+ +

+khFile

+
+protected final File khFile
+
+
+
+
+
+ +

+entries

+
+protected final List<OpenSSHKnownHosts.Entry> entries
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+OpenSSHKnownHosts

+
+public OpenSSHKnownHosts(File khFile)
+                  throws IOException
+
+
+ +
Throws: +
IOException
+
+ + + + + + + + +
+Method Detail
+ +

+getFile

+
+public File getFile()
+
+
+
+
+
+
+
+
+
+ +

+verify

+
+public boolean verify(String hostname,
+                      int port,
+                      PublicKey key)
+
+
Description copied from interface: HostKeyVerifier
+
This callback is invoked when the server's host key needs to be verified. The return value indicates to the + caller whether the SSH connection should proceed. +

+ Note: host key verification is the basis for security in SSH, therefore exercise due caution in + implementing! +

+

+
Specified by:
verify in interface HostKeyVerifier
+
+
+
Parameters:
hostname - remote hostname
port - remote port
key - host key of server +
Returns:
true if key is acceptable, false otherwise
+
+
+
+ +

+hostKeyUnverifiableAction

+
+protected boolean hostKeyUnverifiableAction(String hostname,
+                                            PublicKey key)
+
+
+
+
+
+
+
+
+
+ +

+hostKeyChangedAction

+
+protected boolean hostKeyChangedAction(OpenSSHKnownHosts.Entry entry,
+                                       String hostname,
+                                       PublicKey key)
+
+
+
+
+
+
+
+
+
+ +

+entries

+
+public List<OpenSSHKnownHosts.Entry> entries()
+
+
+
+
+
+
+
+
+
+ +

+write

+
+public void write()
+           throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+detectSSHDir

+
+public static File detectSSHDir()
+
+
+
+
+
+
+
+
+
+ +

+isHashed

+
+public static boolean isHashed(String line)
+
+
+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/verification/PromiscuousVerifier.html b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/PromiscuousVerifier.html new file mode 100644 index 00000000..a1bb4a65 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/PromiscuousVerifier.html @@ -0,0 +1,271 @@ + + + + + + + +PromiscuousVerifier (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.transport.verification +
+Class PromiscuousVerifier

+
+java.lang.Object
+  extended by net.schmizz.sshj.transport.verification.PromiscuousVerifier
+
+
+
All Implemented Interfaces:
HostKeyVerifier
+
+
+
+
public final class PromiscuousVerifier
extends Object
implements HostKeyVerifier
+ + +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
PromiscuousVerifier() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ booleanverify(String hostname, + int port, + PublicKey key) + +
+          This callback is invoked when the server's host key needs to be verified.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PromiscuousVerifier

+
+public PromiscuousVerifier()
+
+
+ + + + + + + + +
+Method Detail
+ +

+verify

+
+public boolean verify(String hostname,
+                      int port,
+                      PublicKey key)
+
+
Description copied from interface: HostKeyVerifier
+
This callback is invoked when the server's host key needs to be verified. The return value indicates to the + caller whether the SSH connection should proceed. +

+ Note: host key verification is the basis for security in SSH, therefore exercise due caution in + implementing! +

+

+
Specified by:
verify in interface HostKeyVerifier
+
+
+
Parameters:
hostname - remote hostname
port - remote port
key - host key of server +
Returns:
true if key is acceptable, false otherwise
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/ConsoleKnownHostsVerifier.html b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/ConsoleKnownHostsVerifier.html new file mode 100644 index 00000000..6dd99b18 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/ConsoleKnownHostsVerifier.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.verification.ConsoleKnownHostsVerifier (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.verification.ConsoleKnownHostsVerifier

+
+No usage of net.schmizz.sshj.transport.verification.ConsoleKnownHostsVerifier +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/HostKeyVerifier.html b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/HostKeyVerifier.html new file mode 100644 index 00000000..ab8e35d6 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/HostKeyVerifier.html @@ -0,0 +1,264 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.transport.verification.HostKeyVerifier (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.transport.verification.HostKeyVerifier

+
+ + + + + + + + + + + + + + + + + +
+Packages that use HostKeyVerifier
net.schmizz.sshj  
net.schmizz.sshj.transport  
net.schmizz.sshj.transport.verification  
+  +

+ + + + + +
+Uses of HostKeyVerifier in net.schmizz.sshj
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj with parameters of type HostKeyVerifier
+ voidSSHClient.addHostKeyVerifier(HostKeyVerifier hostKeyVerifier) + +
+          Add a HostKeyVerifier which will be invoked for verifying host key during connection establishment and + future key exchanges.
+  +

+ + + + + +
+Uses of HostKeyVerifier in net.schmizz.sshj.transport
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport with parameters of type HostKeyVerifier
+ voidTransportImpl.addHostKeyVerifier(HostKeyVerifier hkv) + +
+           
+ voidTransport.addHostKeyVerifier(HostKeyVerifier hkv) + +
+          Adds the specified verifier.
+  +

+ + + + + +
+Uses of HostKeyVerifier in net.schmizz.sshj.transport.verification
+  +

+ + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.transport.verification that implement HostKeyVerifier
+ classConsoleKnownHostsVerifier + +
+           
+ classOpenSSHKnownHosts + +
+          A HostKeyVerifier implementation for a known_hosts file i.e.
+ classPromiscuousVerifier + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/OpenSSHKnownHosts.Entry.html b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/OpenSSHKnownHosts.Entry.html new file mode 100644 index 00000000..e11338f0 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/OpenSSHKnownHosts.Entry.html @@ -0,0 +1,249 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.Entry (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.Entry

+
+ + + + + + + + + +
+Packages that use OpenSSHKnownHosts.Entry
net.schmizz.sshj.transport.verification  
+  +

+ + + + + +
+Uses of OpenSSHKnownHosts.Entry in net.schmizz.sshj.transport.verification
+  +

+ + + + + + + + + + + + + +
Subclasses of OpenSSHKnownHosts.Entry in net.schmizz.sshj.transport.verification
+static classOpenSSHKnownHosts.HashedEntry + +
+           
+static classOpenSSHKnownHosts.SimpleEntry + +
+           
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.transport.verification with type parameters of type OpenSSHKnownHosts.Entry
+protected  List<OpenSSHKnownHosts.Entry>OpenSSHKnownHosts.entries + +
+           
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.transport.verification that return types with arguments of type OpenSSHKnownHosts.Entry
+ List<OpenSSHKnownHosts.Entry>OpenSSHKnownHosts.entries() + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.transport.verification with parameters of type OpenSSHKnownHosts.Entry
+protected  booleanOpenSSHKnownHosts.hostKeyChangedAction(OpenSSHKnownHosts.Entry entry, + String hostname, + PublicKey key) + +
+           
+protected  booleanConsoleKnownHostsVerifier.hostKeyChangedAction(OpenSSHKnownHosts.Entry entry, + String hostname, + PublicKey key) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/OpenSSHKnownHosts.HashedEntry.html b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/OpenSSHKnownHosts.HashedEntry.html new file mode 100644 index 00000000..c1956eba --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/OpenSSHKnownHosts.HashedEntry.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.HashedEntry (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.HashedEntry

+
+No usage of net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.HashedEntry +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/OpenSSHKnownHosts.SimpleEntry.html b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/OpenSSHKnownHosts.SimpleEntry.html new file mode 100644 index 00000000..1a2d0960 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/OpenSSHKnownHosts.SimpleEntry.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.SimpleEntry (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.SimpleEntry

+
+No usage of net.schmizz.sshj.transport.verification.OpenSSHKnownHosts.SimpleEntry +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/OpenSSHKnownHosts.html b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/OpenSSHKnownHosts.html new file mode 100644 index 00000000..176af7f8 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/OpenSSHKnownHosts.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.verification.OpenSSHKnownHosts (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.verification.OpenSSHKnownHosts

+
+ + + + + + + + + +
+Packages that use OpenSSHKnownHosts
net.schmizz.sshj.transport.verification  
+  +

+ + + + + +
+Uses of OpenSSHKnownHosts in net.schmizz.sshj.transport.verification
+  +

+ + + + + + + + + +
Subclasses of OpenSSHKnownHosts in net.schmizz.sshj.transport.verification
+ classConsoleKnownHostsVerifier + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/PromiscuousVerifier.html b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/PromiscuousVerifier.html new file mode 100644 index 00000000..8193900c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/class-use/PromiscuousVerifier.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.transport.verification.PromiscuousVerifier (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.transport.verification.PromiscuousVerifier

+
+No usage of net.schmizz.sshj.transport.verification.PromiscuousVerifier +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/verification/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/package-frame.html new file mode 100644 index 00000000..2cbae19c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/package-frame.html @@ -0,0 +1,54 @@ + + + + + + + +net.schmizz.sshj.transport.verification (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.transport.verification + + + + +
+Interfaces  + +
+HostKeyVerifier
+ + + + + + +
+Classes  + +
+ConsoleKnownHostsVerifier +
+OpenSSHKnownHosts +
+OpenSSHKnownHosts.Entry +
+OpenSSHKnownHosts.HashedEntry +
+OpenSSHKnownHosts.SimpleEntry +
+PromiscuousVerifier
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/verification/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/package-summary.html new file mode 100644 index 00000000..26c2852e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/package-summary.html @@ -0,0 +1,192 @@ + + + + + + + +net.schmizz.sshj.transport.verification (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.transport.verification +

+ + + + + + + + + +
+Interface Summary
HostKeyVerifierHost key verification interface.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
ConsoleKnownHostsVerifier 
OpenSSHKnownHostsA HostKeyVerifier implementation for a known_hosts file i.e.
OpenSSHKnownHosts.Entry 
OpenSSHKnownHosts.HashedEntry 
OpenSSHKnownHosts.SimpleEntry 
PromiscuousVerifier 
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/verification/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/package-tree.html new file mode 100644 index 00000000..6927214d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/package-tree.html @@ -0,0 +1,165 @@ + + + + + + + +net.schmizz.sshj.transport.verification Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.transport.verification +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/transport/verification/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/package-use.html new file mode 100644 index 00000000..76efb79a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/transport/verification/package-use.html @@ -0,0 +1,221 @@ + + + + + + + +Uses of Package net.schmizz.sshj.transport.verification (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.transport.verification

+
+ + + + + + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.transport.verification
net.schmizz.sshj  
net.schmizz.sshj.transport  
net.schmizz.sshj.transport.verification  
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.transport.verification used by net.schmizz.sshj
HostKeyVerifier + +
+          Host key verification interface.
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.transport.verification used by net.schmizz.sshj.transport
HostKeyVerifier + +
+          Host key verification interface.
+  +

+ + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.transport.verification used by net.schmizz.sshj.transport.verification
HostKeyVerifier + +
+          Host key verification interface.
OpenSSHKnownHosts + +
+          A HostKeyVerifier implementation for a known_hosts file i.e.
OpenSSHKnownHosts.Entry + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/AuthParams.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/AuthParams.html new file mode 100644 index 00000000..060969ba --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/AuthParams.html @@ -0,0 +1,253 @@ + + + + + + + +AuthParams (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth +
+Interface AuthParams

+
+
+
public interface AuthParams
+ + +

+The parameters available to authentication methods. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StringgetNextServiceName() + +
+           
+ TransportgetTransport() + +
+           
+ StringgetUsername() + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+getNextServiceName

+
+String getNextServiceName()
+
+
+ +
Returns:
name of the next service being requested
+
+
+
+ +

+getTransport

+
+Transport getTransport()
+
+
+ +
Returns:
the transport which will allow sending packets; retrieving information like the session-id, remote + host/port etc. which is needed by some method.
+
+
+
+ +

+getUsername

+
+String getUsername()
+
+
+ +
Returns:
all userauth requests need to include the username
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/UserAuth.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/UserAuth.html new file mode 100644 index 00000000..7e9fe93f --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/UserAuth.html @@ -0,0 +1,337 @@ + + + + + + + +UserAuth (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth +
+Interface UserAuth

+
+
All Known Implementing Classes:
UserAuthImpl
+
+
+
+
public interface UserAuth
+ + +

+User authentication API. See RFC 4252. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidauthenticate(String username, + Service nextService, + Iterable<AuthMethod> methods) + +
+          Attempt to authenticate username using each of methods in order.
+ StringgetBanner() + +
+          Returns the authentication banner (if any).
+ Deque<UserAuthException>getSavedExceptions() + +
+           
+ intgetTimeout() + +
+           
+ booleanhadPartialSuccess() + +
+           
+ voidsetTimeout(int timeout) + +
+          Set the timeout for any method to successfully authenticate before it is abandoned.
+  +

+ + + + + + + + +
+Method Detail
+ +

+authenticate

+
+void authenticate(String username,
+                  Service nextService,
+                  Iterable<AuthMethod> methods)
+                  throws UserAuthException,
+                         TransportException
+
+
Attempt to authenticate username using each of methods in order. nextService is the + Service that will be enabled on successful authentication. +

+ Authentication fails if there are no method available, i.e. if all the method failed or there were method + available but could not be attempted because the server did not allow them. In this case, a UserAuthException is thrown with its cause as the last authentication failure. Other UserAuthException's + which may have been ignored may be accessed via getSavedExceptions(). +

+ Further attempts may also be made by catching UserAuthException and retrying with this method. +

+

+
Parameters:
username - the user to authenticate
nextService - the service to set on successful authentication
methods - the AuthMethod's to try +
Throws: +
UserAuthException - in case of authentication failure +
TransportException - if there was a transport-layer error
+
+
+
+ +

+getBanner

+
+String getBanner()
+
+
Returns the authentication banner (if any). In some cases this is available even before the first authentication + request has been made. +

+

+ +
Returns:
the banner, or null if none was received
+
+
+
+ +

+getSavedExceptions

+
+Deque<UserAuthException> getSavedExceptions()
+
+
+ +
Returns:
saved exceptions that might have been ignored because there were more authentication method available.
+
+
+
+ +

+getTimeout

+
+int getTimeout()
+
+
+ +
Returns:
the timeout for a method to successfully authenticate before it is abandoned.
+
+
+
+ +

+hadPartialSuccess

+
+boolean hadPartialSuccess()
+
+
+ +
Returns:
whether authentication was partially successful. Some server's may be configured to require multiple + authentications; and this value will be true if at least one of the method supplied succeeded.
+
+
+
+ +

+setTimeout

+
+void setTimeout(int timeout)
+
+
Set the timeout for any method to successfully authenticate before it is abandoned. +

+

+
Parameters:
timeout - the timeout in seconds
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/UserAuthException.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/UserAuthException.html new file mode 100644 index 00000000..06ce3889 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/UserAuthException.html @@ -0,0 +1,386 @@ + + + + + + + +UserAuthException (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth +
+Class UserAuthException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by net.schmizz.sshj.common.SSHException
+                  extended by net.schmizz.sshj.userauth.UserAuthException
+
+
+
All Implemented Interfaces:
Serializable
+
+
+
+
public class UserAuthException
extends SSHException
+ + +

+User authentication exception +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Field Summary
+static ExceptionChainer<UserAuthException>chainer + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
UserAuthException(DisconnectReason code) + +
+           
UserAuthException(DisconnectReason code, + String message) + +
+           
UserAuthException(DisconnectReason code, + String message, + Throwable cause) + +
+           
UserAuthException(DisconnectReason code, + Throwable cause) + +
+           
UserAuthException(String message) + +
+           
UserAuthException(String message, + Throwable cause) + +
+           
UserAuthException(Throwable cause) + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.common.SSHException
getDisconnectReason, getMessage, toString
+ + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+chainer

+
+public static final ExceptionChainer<UserAuthException> chainer
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+UserAuthException

+
+public UserAuthException(DisconnectReason code)
+
+
+
+ +

+UserAuthException

+
+public UserAuthException(DisconnectReason code,
+                         String message)
+
+
+
+ +

+UserAuthException

+
+public UserAuthException(DisconnectReason code,
+                         String message,
+                         Throwable cause)
+
+
+
+ +

+UserAuthException

+
+public UserAuthException(DisconnectReason code,
+                         Throwable cause)
+
+
+
+ +

+UserAuthException

+
+public UserAuthException(String message)
+
+
+
+ +

+UserAuthException

+
+public UserAuthException(String message,
+                         Throwable cause)
+
+
+
+ +

+UserAuthException

+
+public UserAuthException(Throwable cause)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/UserAuthImpl.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/UserAuthImpl.html new file mode 100644 index 00000000..6e7ed64c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/UserAuthImpl.html @@ -0,0 +1,467 @@ + + + + + + + +UserAuthImpl (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth +
+Class UserAuthImpl

+
+java.lang.Object
+  extended by net.schmizz.sshj.AbstractService
+      extended by net.schmizz.sshj.userauth.UserAuthImpl
+
+
+
All Implemented Interfaces:
ErrorNotifiable, SSHPacketHandler, Service, UserAuth
+
+
+
+
public class UserAuthImpl
extends AbstractService
implements UserAuth
+ + +

+UserAuth implementation. +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable
ErrorNotifiable.Util
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.AbstractService
log, name, timeout, trans
+  + + + + + + + + + + +
+Constructor Summary
UserAuthImpl(Transport trans) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidauthenticate(String username, + Service nextService, + Iterable<AuthMethod> methods) + +
+          Attempt to authenticate username using each of methods in order.
+ StringgetBanner() + +
+          Returns the authentication banner (if any).
+ Deque<UserAuthException>getSavedExceptions() + +
+           
+ booleanhadPartialSuccess() + +
+           
+ voidhandle(Message msg, + SSHPacket buf) + +
+          Delegate handling of some SSH packet to this object.
+ voidnotifyError(SSHException error) + +
+          Notifies this object of an error.
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.AbstractService
getName, getTimeout, notifyUnimplemented, request, setTimeout
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.userauth.UserAuth
getTimeout, setTimeout
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+UserAuthImpl

+
+public UserAuthImpl(Transport trans)
+
+
+ + + + + + + + +
+Method Detail
+ +

+authenticate

+
+public void authenticate(String username,
+                         Service nextService,
+                         Iterable<AuthMethod> methods)
+                  throws UserAuthException,
+                         TransportException
+
+
Description copied from interface: UserAuth
+
Attempt to authenticate username using each of methods in order. nextService is the + Service that will be enabled on successful authentication. +

+ Authentication fails if there are no method available, i.e. if all the method failed or there were method + available but could not be attempted because the server did not allow them. In this case, a UserAuthException is thrown with its cause as the last authentication failure. Other UserAuthException's + which may have been ignored may be accessed via UserAuth.getSavedExceptions(). +

+ Further attempts may also be made by catching UserAuthException and retrying with this method. +

+

+
Specified by:
authenticate in interface UserAuth
+
+
+
Parameters:
username - the user to authenticate
nextService - the service to set on successful authentication
methods - the AuthMethod's to try +
Throws: +
UserAuthException - in case of authentication failure +
TransportException - if there was a transport-layer error
+
+
+
+ +

+getSavedExceptions

+
+public Deque<UserAuthException> getSavedExceptions()
+
+
+
Specified by:
getSavedExceptions in interface UserAuth
+
+
+ +
Returns:
saved exceptions that might have been ignored because there were more authentication method available.
+
+
+
+ +

+getBanner

+
+public String getBanner()
+
+
Description copied from interface: UserAuth
+
Returns the authentication banner (if any). In some cases this is available even before the first authentication + request has been made. +

+

+
Specified by:
getBanner in interface UserAuth
+
+
+ +
Returns:
the banner, or null if none was received
+
+
+
+ +

+hadPartialSuccess

+
+public boolean hadPartialSuccess()
+
+
+
Specified by:
hadPartialSuccess in interface UserAuth
+
+
+ +
Returns:
whether authentication was partially successful. Some server's may be configured to require multiple + authentications; and this value will be true if at least one of the method supplied succeeded.
+
+
+
+ +

+handle

+
+public void handle(Message msg,
+                   SSHPacket buf)
+            throws SSHException
+
+
Description copied from interface: SSHPacketHandler
+
Delegate handling of some SSH packet to this object. +

+

+
Specified by:
handle in interface SSHPacketHandler
Overrides:
handle in class AbstractService
+
+
+
Parameters:
msg - the SSH message identifier
buf - SSHPacket containing rest of the request +
Throws: +
SSHException - if there is a non-recoverable error
+
+
+
+ +

+notifyError

+
+public void notifyError(SSHException error)
+
+
Description copied from interface: ErrorNotifiable
+
Notifies this object of an error. +

+

+
Specified by:
notifyError in interface ErrorNotifiable
Overrides:
notifyError in class AbstractService
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/class-use/AuthParams.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/class-use/AuthParams.html new file mode 100644 index 00000000..fb05c52a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/class-use/AuthParams.html @@ -0,0 +1,205 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.userauth.AuthParams (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.userauth.AuthParams

+
+ + + + + + + + + +
+Packages that use AuthParams
net.schmizz.sshj.userauth.method  
+  +

+ + + + + +
+Uses of AuthParams in net.schmizz.sshj.userauth.method
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.userauth.method declared as AuthParams
+protected  AuthParamsAbstractAuthMethod.params + +
+          AuthParams useful for building request.
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.userauth.method with parameters of type AuthParams
+ voidAuthMethod.init(AuthParams params) + +
+          This method must be called before requesting authentication with this method.
+ voidAbstractAuthMethod.init(AuthParams params) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/class-use/UserAuth.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/class-use/UserAuth.html new file mode 100644 index 00000000..da975ffd --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/class-use/UserAuth.html @@ -0,0 +1,226 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.userauth.UserAuth (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.userauth.UserAuth

+
+ + + + + + + + + + + + + +
+Packages that use UserAuth
net.schmizz.sshj  
net.schmizz.sshj.userauth  
+  +

+ + + + + +
+Uses of UserAuth in net.schmizz.sshj
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj declared as UserAuth
+protected  UserAuthSSHClient.auth + +
+          ssh-userauth service
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj that return UserAuth
+ UserAuthSSHClient.getUserAuth() + +
+           
+  +

+ + + + + +
+Uses of UserAuth in net.schmizz.sshj.userauth
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.userauth that implement UserAuth
+ classUserAuthImpl + +
+          UserAuth implementation.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/class-use/UserAuthException.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/class-use/UserAuthException.html new file mode 100644 index 00000000..ad30e500 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/class-use/UserAuthException.html @@ -0,0 +1,468 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.UserAuthException (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.UserAuthException

+
+ + + + + + + + + + + + + + + + + +
+Packages that use UserAuthException
net.schmizz.sshj  
net.schmizz.sshj.userauth  
net.schmizz.sshj.userauth.method  
+  +

+ + + + + +
+Uses of UserAuthException in net.schmizz.sshj
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj that throw UserAuthException
+ voidSSHClient.auth(String username, + AuthMethod... methods) + +
+          Authenticate username using the supplied methods.
+ voidSSHClient.auth(String username, + Iterable<AuthMethod> methods) + +
+          Authenticate username using the supplied methods.
+ voidSSHClient.authPassword(String username, + char[] password) + +
+          Authenticate username using the "password" authentication method and as a fallback basic + challenge-response authentication..
+ voidSSHClient.authPassword(String username, + PasswordFinder pfinder) + +
+          Authenticate username using the "password" authentication method and as a fallback basic + challenge-response authentication.
+ voidSSHClient.authPassword(String username, + String password) + +
+          Authenticate username using the "password" authentication method and as a fallback basic + challenge-response authentication.
+ voidSSHClient.authPublickey(String username) + +
+          Authenticate username using the "publickey" authentication method, with keys from some common + locations on the file system.
+ voidSSHClient.authPublickey(String username, + Iterable<KeyProvider> keyProviders) + +
+          Authenticate username using the "publickey" authentication method.
+ voidSSHClient.authPublickey(String username, + KeyProvider... keyProviders) + +
+          Authenticate username using the "publickey" authentication method.
+ voidSSHClient.authPublickey(String username, + String... locations) + +
+          Authenticate username using the "publickey" authentication method, with keys from one or more + locations in the file system.
+  +

+ + + + + +
+Uses of UserAuthException in net.schmizz.sshj.userauth
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.userauth with type parameters of type UserAuthException
+static ExceptionChainer<UserAuthException>UserAuthException.chainer + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.userauth that return types with arguments of type UserAuthException
+ Deque<UserAuthException>UserAuthImpl.getSavedExceptions() + +
+           
+ Deque<UserAuthException>UserAuth.getSavedExceptions() + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.userauth that throw UserAuthException
+ voidUserAuthImpl.authenticate(String username, + Service nextService, + Iterable<AuthMethod> methods) + +
+           
+ voidUserAuth.authenticate(String username, + Service nextService, + Iterable<AuthMethod> methods) + +
+          Attempt to authenticate username using each of methods in order.
+  +

+ + + + + +
+Uses of UserAuthException in net.schmizz.sshj.userauth.method
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.userauth.method that throw UserAuthException
+protected  SSHPacketAuthPublickey.buildReq() + +
+          Builds a feeler request (sans signature).
+ SSHPacketAuthPassword.buildReq() + +
+           
+ SSHPacketAuthKeyboardInteractive.buildReq() + +
+           
+protected  SSHPacketAuthHostbased.buildReq() + +
+           
+protected  SSHPacketAbstractAuthMethod.buildReq() + +
+          Builds a SSHPacket containing the fields common to all authentication method.
+ voidAuthPublickey.handle(Message cmd, + SSHPacket buf) + +
+          Internal use.
+ voidAuthPassword.handle(Message cmd, + SSHPacket buf) + +
+           
+ voidAuthKeyboardInteractive.handle(Message cmd, + SSHPacket buf) + +
+           
+ voidAbstractAuthMethod.handle(Message msg, + SSHPacket buf) + +
+           
+protected  SSHPacketKeyedAuthMethod.putPubKey(SSHPacket reqBuf) + +
+           
+protected  SSHPacketKeyedAuthMethod.putSig(SSHPacket reqBuf) + +
+           
+ voidAuthMethod.request() + +
+           
+ voidAbstractAuthMethod.request() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/class-use/UserAuthImpl.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/class-use/UserAuthImpl.html new file mode 100644 index 00000000..a1e91203 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/class-use/UserAuthImpl.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.UserAuthImpl (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.UserAuthImpl

+
+No usage of net.schmizz.sshj.userauth.UserAuthImpl +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/FileKeyProvider.Format.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/FileKeyProvider.Format.html new file mode 100644 index 00000000..83929a05 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/FileKeyProvider.Format.html @@ -0,0 +1,342 @@ + + + + + + + +FileKeyProvider.Format (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.keyprovider +
+Enum FileKeyProvider.Format

+
+java.lang.Object
+  extended by java.lang.Enum<FileKeyProvider.Format>
+      extended by net.schmizz.sshj.userauth.keyprovider.FileKeyProvider.Format
+
+
+
All Implemented Interfaces:
Serializable, Comparable<FileKeyProvider.Format>
+
+
+
Enclosing interface:
FileKeyProvider
+
+
+
+
public static enum FileKeyProvider.Format
extends Enum<FileKeyProvider.Format>
+ + +

+


+ +

+ + + + + + + + + + + + + + + + +
+Enum Constant Summary
OpenSSH + +
+           
PKCS8 + +
+           
Unknown + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static FileKeyProvider.FormatvalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static FileKeyProvider.Format[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+PKCS8

+
+public static final FileKeyProvider.Format PKCS8
+
+
+
+
+
+ +

+OpenSSH

+
+public static final FileKeyProvider.Format OpenSSH
+
+
+
+
+
+ +

+Unknown

+
+public static final FileKeyProvider.Format Unknown
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static FileKeyProvider.Format[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (FileKeyProvider.Format c : FileKeyProvider.Format.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static FileKeyProvider.Format valueOf(String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/FileKeyProvider.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/FileKeyProvider.html new file mode 100644 index 00000000..b8492d5b --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/FileKeyProvider.html @@ -0,0 +1,320 @@ + + + + + + + +FileKeyProvider (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.keyprovider +
+Interface FileKeyProvider

+
+
All Superinterfaces:
KeyProvider
+
+
+
All Known Implementing Classes:
OpenSSHKeyFile, PKCS8KeyFile
+
+
+
+
public interface FileKeyProvider
extends KeyProvider
+ + +

+A file key provider is initialized with a location of +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classFileKeyProvider.Format + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidinit(File location) + +
+           
+ voidinit(File location, + PasswordFinder pwdf) + +
+           
+ voidinit(String privateKey, + String publicKey) + +
+           
+ voidinit(String privateKey, + String publicKey, + PasswordFinder pwdf) + +
+           
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.userauth.keyprovider.KeyProvider
getPrivate, getPublic, getType
+  +

+ + + + + + + + +
+Method Detail
+ +

+init

+
+void init(File location)
+
+
+
+
+
+
+
+
+
+ +

+init

+
+void init(File location,
+          PasswordFinder pwdf)
+
+
+
+
+
+
+
+
+
+ +

+init

+
+void init(String privateKey,
+          String publicKey)
+
+
+
+
+
+
+
+
+
+ +

+init

+
+void init(String privateKey,
+          String publicKey,
+          PasswordFinder pwdf)
+
+
+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/KeyPairWrapper.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/KeyPairWrapper.html new file mode 100644 index 00000000..9bd7c56a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/KeyPairWrapper.html @@ -0,0 +1,326 @@ + + + + + + + +KeyPairWrapper (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.keyprovider +
+Class KeyPairWrapper

+
+java.lang.Object
+  extended by net.schmizz.sshj.userauth.keyprovider.KeyPairWrapper
+
+
+
All Implemented Interfaces:
KeyProvider
+
+
+
+
public class KeyPairWrapper
extends Object
implements KeyProvider
+ + +

+A KeyProvider wrapper around KeyPair +

+ +

+


+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
KeyPairWrapper(KeyPair kp) + +
+           
KeyPairWrapper(PublicKey publicKey, + PrivateKey privateKey) + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ PrivateKeygetPrivate() + +
+           
+ PublicKeygetPublic() + +
+           
+ KeyTypegetType() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+KeyPairWrapper

+
+public KeyPairWrapper(KeyPair kp)
+
+
+
+ +

+KeyPairWrapper

+
+public KeyPairWrapper(PublicKey publicKey,
+                      PrivateKey privateKey)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getPrivate

+
+public PrivateKey getPrivate()
+
+
+
Specified by:
getPrivate in interface KeyProvider
+
+
+ +
Returns:
the private key.
+
+
+
+ +

+getPublic

+
+public PublicKey getPublic()
+
+
+
Specified by:
getPublic in interface KeyProvider
+
+
+ +
Returns:
the public key.
+
+
+
+ +

+getType

+
+public KeyType getType()
+
+
+
Specified by:
getType in interface KeyProvider
+
+
+ +
Returns:
the KeyType.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/KeyProvider.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/KeyProvider.html new file mode 100644 index 00000000..217f8e87 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/KeyProvider.html @@ -0,0 +1,267 @@ + + + + + + + +KeyProvider (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.keyprovider +
+Interface KeyProvider

+
+
All Known Subinterfaces:
FileKeyProvider
+
+
+
All Known Implementing Classes:
KeyPairWrapper, OpenSSHKeyFile, PKCS8KeyFile
+
+
+
+
public interface KeyProvider
+ + +

+A KeyProvider is a container for a public-private keypair. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ PrivateKeygetPrivate() + +
+           
+ PublicKeygetPublic() + +
+           
+ KeyTypegetType() + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+getPrivate

+
+PrivateKey getPrivate()
+                      throws IOException
+
+
+ +
Returns:
the private key. +
Throws: +
IOException - if there is an I/O error retrieving the private key
+
+
+
+ +

+getPublic

+
+PublicKey getPublic()
+                    throws IOException
+
+
+ +
Returns:
the public key. +
Throws: +
IOException - if there is an I/O error retrieving the public key
+
+
+
+ +

+getType

+
+KeyType getType()
+                throws IOException
+
+
+ +
Returns:
the KeyType. +
Throws: +
IOException - if there is an I/O error retrieving the key type
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/KeyProviderUtil.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/KeyProviderUtil.html new file mode 100644 index 00000000..7d0057a1 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/KeyProviderUtil.html @@ -0,0 +1,290 @@ + + + + + + + +KeyProviderUtil (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.keyprovider +
+Class KeyProviderUtil

+
+java.lang.Object
+  extended by net.schmizz.sshj.userauth.keyprovider.KeyProviderUtil
+
+
+
+
public class KeyProviderUtil
extends Object
+ + +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
KeyProviderUtil() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static FileKeyProvider.FormatdetectKeyFileFormat(File location) + +
+          Attempts to detect how a key file is encoded.
+static FileKeyProvider.FormatdetectKeyFileFormat(String privateKey, + boolean separatePubKey) + +
+          Attempts to detect how a key file is encoded.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+KeyProviderUtil

+
+public KeyProviderUtil()
+
+
+ + + + + + + + +
+Method Detail
+ +

+detectKeyFileFormat

+
+public static FileKeyProvider.Format detectKeyFileFormat(File location)
+                                                  throws IOException
+
+
Attempts to detect how a key file is encoded. +

+ Return values are consistent with the NamedFactory implementations in the keyprovider package. +

+

+
Parameters:
location - +
Returns:
name of the key file format +
Throws: +
IOException
+
+
+
+ +

+detectKeyFileFormat

+
+public static FileKeyProvider.Format detectKeyFileFormat(String privateKey,
+                                                         boolean separatePubKey)
+                                                  throws IOException
+
+
Attempts to detect how a key file is encoded. +

+ Return values are consistent with the NamedFactory implementations in the keyprovider package. +

+

+
Parameters:
privateKey - Private key stored in a string
separatePubKey - Is the public key stored separately from the private key +
Returns:
name of the key file format +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/OpenSSHKeyFile.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/OpenSSHKeyFile.Factory.html new file mode 100644 index 00000000..aaf3fa0a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/OpenSSHKeyFile.Factory.html @@ -0,0 +1,315 @@ + + + + + + + +OpenSSHKeyFile.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.keyprovider +
+Class OpenSSHKeyFile.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.userauth.keyprovider.OpenSSHKeyFile.Factory
+
+
+
All Implemented Interfaces:
Factory<FileKeyProvider>, Factory.Named<FileKeyProvider>
+
+
+
Enclosing class:
OpenSSHKeyFile
+
+
+
+
public static class OpenSSHKeyFile.Factory
extends Object
implements Factory.Named<FileKeyProvider>
+ + +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
OpenSSHKeyFile.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ FileKeyProvidercreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+OpenSSHKeyFile.Factory

+
+public OpenSSHKeyFile.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public FileKeyProvider create()
+
+
+
Specified by:
create in interface Factory<FileKeyProvider>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<FileKeyProvider>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/OpenSSHKeyFile.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/OpenSSHKeyFile.html new file mode 100644 index 00000000..396d4b10 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/OpenSSHKeyFile.html @@ -0,0 +1,372 @@ + + + + + + + +OpenSSHKeyFile (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.keyprovider +
+Class OpenSSHKeyFile

+
+java.lang.Object
+  extended by net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile
+      extended by net.schmizz.sshj.userauth.keyprovider.OpenSSHKeyFile
+
+
+
All Implemented Interfaces:
FileKeyProvider, KeyProvider
+
+
+
+
public class OpenSSHKeyFile
extends PKCS8KeyFile
+ + +

+Represents an OpenSSH identity that consists of a PKCS8-encoded private key file and an unencrypted public key file + of the same name with the ".pub" extension. This allows to delay requesting of the passphrase until the + private key is requested. +

+ +

+

+
See Also:
PKCS8KeyFile
+
+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classOpenSSHKeyFile.Factory + +
+           
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.userauth.keyprovider.FileKeyProvider
FileKeyProvider.Format
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile
kp, log, passphrase, pwdf, resource, type
+  + + + + + + + + + + +
+Constructor Summary
OpenSSHKeyFile() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ PublicKeygetPublic() + +
+           
+ voidinit(File location) + +
+           
+ voidinit(String privateKey, + String publicKey) + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile
getPrivate, getType, init, init, makeBouncyPasswordFinder, readKeyPair, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+OpenSSHKeyFile

+
+public OpenSSHKeyFile()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getPublic

+
+public PublicKey getPublic()
+                    throws IOException
+
+
+
Specified by:
getPublic in interface KeyProvider
Overrides:
getPublic in class PKCS8KeyFile
+
+
+ +
Returns:
the public key. +
Throws: +
IOException - if there is an I/O error retrieving the public key
+
+
+
+ +

+init

+
+public void init(File location)
+
+
+
Specified by:
init in interface FileKeyProvider
Overrides:
init in class PKCS8KeyFile
+
+
+
+
+
+
+ +

+init

+
+public void init(String privateKey,
+                 String publicKey)
+
+
+
Specified by:
init in interface FileKeyProvider
Overrides:
init in class PKCS8KeyFile
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/PKCS8KeyFile.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/PKCS8KeyFile.Factory.html new file mode 100644 index 00000000..ea0520db --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/PKCS8KeyFile.Factory.html @@ -0,0 +1,315 @@ + + + + + + + +PKCS8KeyFile.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.keyprovider +
+Class PKCS8KeyFile.Factory

+
+java.lang.Object
+  extended by net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile.Factory
+
+
+
All Implemented Interfaces:
Factory<FileKeyProvider>, Factory.Named<FileKeyProvider>
+
+
+
Enclosing class:
PKCS8KeyFile
+
+
+
+
public static class PKCS8KeyFile.Factory
extends Object
implements Factory.Named<FileKeyProvider>
+ + +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory.Named
Factory.Named.Util
+  + + + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.common.Factory
Factory.Named<T>
+  + + + + + + + + + + + +
+Constructor Summary
PKCS8KeyFile.Factory() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ FileKeyProvidercreate() + +
+           
+ StringgetName() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PKCS8KeyFile.Factory

+
+public PKCS8KeyFile.Factory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+create

+
+public FileKeyProvider create()
+
+
+
Specified by:
create in interface Factory<FileKeyProvider>
+
+
+ +
Returns:
a new object created using this factory.
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface Factory.Named<FileKeyProvider>
+
+
+ +
Returns:
the name of this factory.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/PKCS8KeyFile.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/PKCS8KeyFile.html new file mode 100644 index 00000000..24b661f9 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/PKCS8KeyFile.html @@ -0,0 +1,640 @@ + + + + + + + +PKCS8KeyFile (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.keyprovider +
+Class PKCS8KeyFile

+
+java.lang.Object
+  extended by net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile
+
+
+
All Implemented Interfaces:
FileKeyProvider, KeyProvider
+
+
+
Direct Known Subclasses:
OpenSSHKeyFile
+
+
+
+
public class PKCS8KeyFile
extends Object
implements FileKeyProvider
+ + +

+Represents a PKCS8-encoded key file. This is the format used by OpenSSH and OpenSSL. +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classPKCS8KeyFile.Factory + +
+           
+ + + + + + + +
Nested classes/interfaces inherited from interface net.schmizz.sshj.userauth.keyprovider.FileKeyProvider
FileKeyProvider.Format
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+protected  KeyPairkp + +
+           
+protected  org.slf4j.Loggerlog + +
+           
+protected  char[]passphrase + +
+           
+protected  PasswordFinderpwdf + +
+           
+protected  Resourceresource + +
+           
+protected  KeyTypetype + +
+           
+  + + + + + + + + + + +
+Constructor Summary
PKCS8KeyFile() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ PrivateKeygetPrivate() + +
+           
+ PublicKeygetPublic() + +
+           
+ KeyTypegetType() + +
+           
+ voidinit(File location) + +
+           
+ voidinit(File location, + PasswordFinder pwdf) + +
+           
+ voidinit(String privateKey, + String publicKey) + +
+           
+ voidinit(String privateKey, + String publicKey, + PasswordFinder pwdf) + +
+           
+protected  org.bouncycastle.openssl.PasswordFindermakeBouncyPasswordFinder() + +
+           
+protected  KeyPairreadKeyPair() + +
+           
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+protected final org.slf4j.Logger log
+
+
+
+
+
+ +

+pwdf

+
+protected PasswordFinder pwdf
+
+
+
+
+
+ +

+resource

+
+protected Resource resource
+
+
+
+
+
+ +

+kp

+
+protected KeyPair kp
+
+
+
+
+
+ +

+type

+
+protected KeyType type
+
+
+
+
+
+ +

+passphrase

+
+protected char[] passphrase
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+PKCS8KeyFile

+
+public PKCS8KeyFile()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getPrivate

+
+public PrivateKey getPrivate()
+                      throws IOException
+
+
+
Specified by:
getPrivate in interface KeyProvider
+
+
+ +
Returns:
the private key. +
Throws: +
IOException - if there is an I/O error retrieving the private key
+
+
+
+ +

+getPublic

+
+public PublicKey getPublic()
+                    throws IOException
+
+
+
Specified by:
getPublic in interface KeyProvider
+
+
+ +
Returns:
the public key. +
Throws: +
IOException - if there is an I/O error retrieving the public key
+
+
+
+ +

+getType

+
+public KeyType getType()
+                throws IOException
+
+
+
Specified by:
getType in interface KeyProvider
+
+
+ +
Returns:
the KeyType. +
Throws: +
IOException - if there is an I/O error retrieving the key type
+
+
+
+ +

+init

+
+public void init(File location)
+
+
+
Specified by:
init in interface FileKeyProvider
+
+
+
+
+
+
+ +

+init

+
+public void init(File location,
+                 PasswordFinder pwdf)
+
+
+
Specified by:
init in interface FileKeyProvider
+
+
+
+
+
+
+ +

+init

+
+public void init(String privateKey,
+                 String publicKey)
+
+
+
Specified by:
init in interface FileKeyProvider
+
+
+
+
+
+
+ +

+init

+
+public void init(String privateKey,
+                 String publicKey,
+                 PasswordFinder pwdf)
+
+
+
Specified by:
init in interface FileKeyProvider
+
+
+
+
+
+
+ +

+makeBouncyPasswordFinder

+
+protected org.bouncycastle.openssl.PasswordFinder makeBouncyPasswordFinder()
+
+
+
+
+
+
+
+
+
+ +

+readKeyPair

+
+protected KeyPair readKeyPair()
+                       throws IOException
+
+
+
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/FileKeyProvider.Format.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/FileKeyProvider.Format.html new file mode 100644 index 00000000..12c67870 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/FileKeyProvider.Format.html @@ -0,0 +1,207 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.keyprovider.FileKeyProvider.Format (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.keyprovider.FileKeyProvider.Format

+
+ + + + + + + + + +
+Packages that use FileKeyProvider.Format
net.schmizz.sshj.userauth.keyprovider  
+  +

+ + + + + +
+Uses of FileKeyProvider.Format in net.schmizz.sshj.userauth.keyprovider
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.userauth.keyprovider that return FileKeyProvider.Format
+static FileKeyProvider.FormatKeyProviderUtil.detectKeyFileFormat(File location) + +
+          Attempts to detect how a key file is encoded.
+static FileKeyProvider.FormatKeyProviderUtil.detectKeyFileFormat(String privateKey, + boolean separatePubKey) + +
+          Attempts to detect how a key file is encoded.
+static FileKeyProvider.FormatFileKeyProvider.Format.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static FileKeyProvider.Format[]FileKeyProvider.Format.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/FileKeyProvider.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/FileKeyProvider.html new file mode 100644 index 00000000..8fa579c1 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/FileKeyProvider.html @@ -0,0 +1,275 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.userauth.keyprovider.FileKeyProvider (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.userauth.keyprovider.FileKeyProvider

+
+ + + + + + + + + + + + + +
+Packages that use FileKeyProvider
net.schmizz.sshj  
net.schmizz.sshj.userauth.keyprovider  
+  +

+ + + + + +
+Uses of FileKeyProvider in net.schmizz.sshj
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj that return types with arguments of type FileKeyProvider
+ List<Factory.Named<FileKeyProvider>>ConfigImpl.getFileKeyProviderFactories() + +
+           
+ List<Factory.Named<FileKeyProvider>>Config.getFileKeyProviderFactories() + +
+          Retrieve the list of named factories for FileKeyProvider.
+  +

+ + + + + + + + + + + + + +
Method parameters in net.schmizz.sshj with type arguments of type FileKeyProvider
+ voidConfigImpl.setFileKeyProviderFactories(List<Factory.Named<FileKeyProvider>> fileKeyProviderFactories) + +
+           
+ voidConfig.setFileKeyProviderFactories(List<Factory.Named<FileKeyProvider>> fileKeyProviderFactories) + +
+          Set the named factories for FileKeyProvider.
+  +

+ + + + + +
+Uses of FileKeyProvider in net.schmizz.sshj.userauth.keyprovider
+  +

+ + + + + + + + + + + + + +
Classes in net.schmizz.sshj.userauth.keyprovider that implement FileKeyProvider
+ classOpenSSHKeyFile + +
+          Represents an OpenSSH identity that consists of a PKCS8-encoded private key file and an unencrypted public key file + of the same name with the ".pub" extension.
+ classPKCS8KeyFile + +
+          Represents a PKCS8-encoded key file.
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.userauth.keyprovider that return FileKeyProvider
+ FileKeyProviderPKCS8KeyFile.Factory.create() + +
+           
+ FileKeyProviderOpenSSHKeyFile.Factory.create() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/KeyPairWrapper.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/KeyPairWrapper.html new file mode 100644 index 00000000..5ff21b16 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/KeyPairWrapper.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.keyprovider.KeyPairWrapper (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.keyprovider.KeyPairWrapper

+
+No usage of net.schmizz.sshj.userauth.keyprovider.KeyPairWrapper +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/KeyProvider.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/KeyProvider.html new file mode 100644 index 00000000..3484a5ce --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/KeyProvider.html @@ -0,0 +1,382 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.userauth.keyprovider.KeyProvider (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.userauth.keyprovider.KeyProvider

+
+ + + + + + + + + + + + + + + + + +
+Packages that use KeyProvider
net.schmizz.sshj  
net.schmizz.sshj.userauth.keyprovider  
net.schmizz.sshj.userauth.method  
+  +

+ + + + + +
+Uses of KeyProvider in net.schmizz.sshj
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj that return KeyProvider
+ KeyProviderSSHClient.loadKeys(KeyPair kp) + +
+          Creates a KeyProvider from supplied KeyPair.
+ KeyProviderSSHClient.loadKeys(String location) + +
+          Returns a KeyProvider instance created from a location on the file system where an unencrypted + private key file (does not require a passphrase) can be found.
+ KeyProviderSSHClient.loadKeys(String location, + char[] passphrase) + +
+          Utility function for createing a KeyProvider instance from given location on the file system.
+ KeyProviderSSHClient.loadKeys(String location, + PasswordFinder passwordFinder) + +
+          Creates a KeyProvider instance from given location on the file system.
+ KeyProviderSSHClient.loadKeys(String location, + String passphrase) + +
+          Convenience method for creating a KeyProvider instance from a location where an encrypted + key file is located.
+ KeyProviderSSHClient.loadKeys(String privateKey, + String publicKey, + PasswordFinder passwordFinder) + +
+          Creates a KeyProvider instance from passed strings.
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj with parameters of type KeyProvider
+ voidSSHClient.authPublickey(String username, + KeyProvider... keyProviders) + +
+          Authenticate username using the "publickey" authentication method.
+  +

+ + + + + + + + + +
Method parameters in net.schmizz.sshj with type arguments of type KeyProvider
+ voidSSHClient.authPublickey(String username, + Iterable<KeyProvider> keyProviders) + +
+          Authenticate username using the "publickey" authentication method.
+  +

+ + + + + +
+Uses of KeyProvider in net.schmizz.sshj.userauth.keyprovider
+  +

+ + + + + + + + + +
Subinterfaces of KeyProvider in net.schmizz.sshj.userauth.keyprovider
+ interfaceFileKeyProvider + +
+          A file key provider is initialized with a location of
+  +

+ + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.userauth.keyprovider that implement KeyProvider
+ classKeyPairWrapper + +
+          A KeyProvider wrapper around KeyPair
+ classOpenSSHKeyFile + +
+          Represents an OpenSSH identity that consists of a PKCS8-encoded private key file and an unencrypted public key file + of the same name with the ".pub" extension.
+ classPKCS8KeyFile + +
+          Represents a PKCS8-encoded key file.
+  +

+ + + + + +
+Uses of KeyProvider in net.schmizz.sshj.userauth.method
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.userauth.method declared as KeyProvider
+protected  KeyProviderKeyedAuthMethod.kProv + +
+           
+  +

+ + + + + + + + + + + + + + +
Constructors in net.schmizz.sshj.userauth.method with parameters of type KeyProvider
AuthHostbased(KeyProvider kProv, + String hostname, + String hostuser) + +
+           
AuthPublickey(KeyProvider kProv) + +
+          Initialize this method with the provider for public and private key.
KeyedAuthMethod(String name, + KeyProvider kProv) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/KeyProviderUtil.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/KeyProviderUtil.html new file mode 100644 index 00000000..53e2db88 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/KeyProviderUtil.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.keyprovider.KeyProviderUtil (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.keyprovider.KeyProviderUtil

+
+No usage of net.schmizz.sshj.userauth.keyprovider.KeyProviderUtil +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/OpenSSHKeyFile.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/OpenSSHKeyFile.Factory.html new file mode 100644 index 00000000..1f8e6f62 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/OpenSSHKeyFile.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.keyprovider.OpenSSHKeyFile.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.keyprovider.OpenSSHKeyFile.Factory

+
+No usage of net.schmizz.sshj.userauth.keyprovider.OpenSSHKeyFile.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/OpenSSHKeyFile.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/OpenSSHKeyFile.html new file mode 100644 index 00000000..cf417186 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/OpenSSHKeyFile.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.keyprovider.OpenSSHKeyFile (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.keyprovider.OpenSSHKeyFile

+
+No usage of net.schmizz.sshj.userauth.keyprovider.OpenSSHKeyFile +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/PKCS8KeyFile.Factory.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/PKCS8KeyFile.Factory.html new file mode 100644 index 00000000..f68b9fcd --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/PKCS8KeyFile.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile.Factory (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile.Factory

+
+No usage of net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile.Factory +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/PKCS8KeyFile.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/PKCS8KeyFile.html new file mode 100644 index 00000000..242aa533 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/class-use/PKCS8KeyFile.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.keyprovider.PKCS8KeyFile

+
+ + + + + + + + + +
+Packages that use PKCS8KeyFile
net.schmizz.sshj.userauth.keyprovider  
+  +

+ + + + + +
+Uses of PKCS8KeyFile in net.schmizz.sshj.userauth.keyprovider
+  +

+ + + + + + + + + +
Subclasses of PKCS8KeyFile in net.schmizz.sshj.userauth.keyprovider
+ classOpenSSHKeyFile + +
+          Represents an OpenSSH identity that consists of a PKCS8-encoded private key file and an unencrypted public key file + of the same name with the ".pub" extension.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/package-frame.html new file mode 100644 index 00000000..23fca74c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/package-frame.html @@ -0,0 +1,67 @@ + + + + + + + +net.schmizz.sshj.userauth.keyprovider (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.userauth.keyprovider + + + + +
+Interfaces  + +
+FileKeyProvider +
+KeyProvider
+ + + + + + +
+Classes  + +
+KeyPairWrapper +
+KeyProviderUtil +
+OpenSSHKeyFile +
+OpenSSHKeyFile.Factory +
+PKCS8KeyFile +
+PKCS8KeyFile.Factory
+ + + + + + +
+Enums  + +
+FileKeyProvider.Format
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/package-summary.html new file mode 100644 index 00000000..fc070a90 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/package-summary.html @@ -0,0 +1,211 @@ + + + + + + + +net.schmizz.sshj.userauth.keyprovider (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.userauth.keyprovider +

+ + + + + + + + + + + + + +
+Interface Summary
FileKeyProviderA file key provider is initialized with a location of
KeyProviderA KeyProvider is a container for a public-private keypair.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
KeyPairWrapperA KeyProvider wrapper around KeyPair
KeyProviderUtil 
OpenSSHKeyFileRepresents an OpenSSH identity that consists of a PKCS8-encoded private key file and an unencrypted public key file + of the same name with the ".pub" extension.
OpenSSHKeyFile.Factory 
PKCS8KeyFileRepresents a PKCS8-encoded key file.
PKCS8KeyFile.Factory 
+  + +

+ + + + + + + + + +
+Enum Summary
FileKeyProvider.Format 
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/package-tree.html new file mode 100644 index 00000000..4af97d39 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/package-tree.html @@ -0,0 +1,177 @@ + + + + + + + +net.schmizz.sshj.userauth.keyprovider Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.userauth.keyprovider +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/package-use.html new file mode 100644 index 00000000..d42714ba --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/keyprovider/package-use.html @@ -0,0 +1,233 @@ + + + + + + + +Uses of Package net.schmizz.sshj.userauth.keyprovider (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.userauth.keyprovider

+
+ + + + + + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.userauth.keyprovider
net.schmizz.sshj  
net.schmizz.sshj.userauth.keyprovider  
net.schmizz.sshj.userauth.method  
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.userauth.keyprovider used by net.schmizz.sshj
FileKeyProvider + +
+          A file key provider is initialized with a location of
KeyProvider + +
+          A KeyProvider is a container for a public-private keypair.
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.userauth.keyprovider used by net.schmizz.sshj.userauth.keyprovider
FileKeyProvider + +
+          A file key provider is initialized with a location of
FileKeyProvider.Format + +
+           
KeyProvider + +
+          A KeyProvider is a container for a public-private keypair.
PKCS8KeyFile + +
+          Represents a PKCS8-encoded key file.
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.userauth.keyprovider used by net.schmizz.sshj.userauth.method
KeyProvider + +
+          A KeyProvider is a container for a public-private keypair.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AbstractAuthMethod.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AbstractAuthMethod.html new file mode 100644 index 00000000..2189c024 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AbstractAuthMethod.html @@ -0,0 +1,486 @@ + + + + + + + +AbstractAuthMethod (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.method +
+Class AbstractAuthMethod

+
+java.lang.Object
+  extended by net.schmizz.sshj.userauth.method.AbstractAuthMethod
+
+
+
All Implemented Interfaces:
SSHPacketHandler, AuthMethod
+
+
+
Direct Known Subclasses:
AuthKeyboardInteractive, AuthNone, AuthPassword, KeyedAuthMethod
+
+
+
+
public abstract class AbstractAuthMethod
extends Object
implements AuthMethod
+ + +

+This abstract class for AuthMethod implements common or default functionality. +

+ +

+


+ +

+ + + + + + + + + + + + + + + +
+Field Summary
+protected  org.slf4j.Loggerlog + +
+          Logger
+protected  AuthParamsparams + +
+          AuthParams useful for building request.
+  + + + + + + + + + + + +
+Constructor Summary
+protected AbstractAuthMethod(String name) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+protected  SSHPacketbuildReq() + +
+          Builds a SSHPacket containing the fields common to all authentication method.
+ StringgetName() + +
+           
+ voidhandle(Message msg, + SSHPacket buf) + +
+          Delegate handling of some SSH packet to this object.
+ voidinit(AuthParams params) + +
+          This method must be called before requesting authentication with this method.
+protected  AccountResourcemakeAccountResource() + +
+           
+ voidrequest() + +
+           
+ booleanshouldRetry() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+protected final org.slf4j.Logger log
+
+
Logger +

+

+
+
+
+ +

+params

+
+protected AuthParams params
+
+
AuthParams useful for building request. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+AbstractAuthMethod

+
+protected AbstractAuthMethod(String name)
+
+
+
Parameters:
name - the name of this authentication method.
+
+ + + + + + + + +
+Method Detail
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface AuthMethod
+
+
+ +
Returns:
assigned name of this authentication method
+
+
+
+ +

+handle

+
+public void handle(Message msg,
+                   SSHPacket buf)
+            throws UserAuthException,
+                   TransportException
+
+
Description copied from interface: SSHPacketHandler
+
Delegate handling of some SSH packet to this object. +

+

+
Specified by:
handle in interface SSHPacketHandler
+
+
+
Parameters:
msg - the SSH message identifier
buf - SSHPacket containing rest of the request +
Throws: +
UserAuthException +
TransportException
+
+
+
+ +

+init

+
+public void init(AuthParams params)
+
+
Description copied from interface: AuthMethod
+
This method must be called before requesting authentication with this method. +

+

+
Specified by:
init in interface AuthMethod
+
+
+
Parameters:
params - parameters needed for authentication
+
+
+
+ +

+request

+
+public void request()
+             throws UserAuthException,
+                    TransportException
+
+
+
Specified by:
request in interface AuthMethod
+
+
+ +
Throws: +
UserAuthException - if there is an error with the request +
TransportException - if there is a transport-related error
+
+
+
+ +

+shouldRetry

+
+public boolean shouldRetry()
+
+
+
Specified by:
shouldRetry in interface AuthMethod
+
+
+ +
Returns:
whether authentication should be reattempted if it failed.
+
+
+
+ +

+buildReq

+
+protected SSHPacket buildReq()
+                      throws UserAuthException
+
+
Builds a SSHPacket containing the fields common to all authentication method. Method-specific fields can + further be put into this buffer. +

+

+
+
+
+ +
Throws: +
UserAuthException
+
+
+
+ +

+makeAccountResource

+
+protected AccountResource makeAccountResource()
+
+
+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AuthHostbased.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AuthHostbased.html new file mode 100644 index 00000000..064c14d6 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AuthHostbased.html @@ -0,0 +1,366 @@ + + + + + + + +AuthHostbased (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.method +
+Class AuthHostbased

+
+java.lang.Object
+  extended by net.schmizz.sshj.userauth.method.AbstractAuthMethod
+      extended by net.schmizz.sshj.userauth.method.KeyedAuthMethod
+          extended by net.schmizz.sshj.userauth.method.AuthHostbased
+
+
+
All Implemented Interfaces:
SSHPacketHandler, AuthMethod
+
+
+
+
public class AuthHostbased
extends KeyedAuthMethod
+ + +

+Implements the hostbased SSH authentication method. +

+ +

+


+ +

+ + + + + + + + + + + + + + + +
+Field Summary
+protected  Stringhostname + +
+           
+protected  Stringhostuser + +
+           
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.userauth.method.KeyedAuthMethod
kProv
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.userauth.method.AbstractAuthMethod
log, params
+  + + + + + + + + + + +
+Constructor Summary
AuthHostbased(KeyProvider kProv, + String hostname, + String hostuser) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+protected  SSHPacketbuildReq() + +
+          Builds a SSHPacket containing the fields common to all authentication method.
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.userauth.method.KeyedAuthMethod
putPubKey, putSig
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.userauth.method.AbstractAuthMethod
getName, handle, init, makeAccountResource, request, shouldRetry
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+hostname

+
+protected final String hostname
+
+
+
+
+
+ +

+hostuser

+
+protected final String hostuser
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+AuthHostbased

+
+public AuthHostbased(KeyProvider kProv,
+                     String hostname,
+                     String hostuser)
+
+
+ + + + + + + + +
+Method Detail
+ +

+buildReq

+
+protected SSHPacket buildReq()
+                      throws UserAuthException
+
+
Description copied from class: AbstractAuthMethod
+
Builds a SSHPacket containing the fields common to all authentication method. Method-specific fields can + further be put into this buffer. +

+

+
Overrides:
buildReq in class AbstractAuthMethod
+
+
+ +
Throws: +
UserAuthException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AuthKeyboardInteractive.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AuthKeyboardInteractive.html new file mode 100644 index 00000000..a8a95088 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AuthKeyboardInteractive.html @@ -0,0 +1,353 @@ + + + + + + + +AuthKeyboardInteractive (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.method +
+Class AuthKeyboardInteractive

+
+java.lang.Object
+  extended by net.schmizz.sshj.userauth.method.AbstractAuthMethod
+      extended by net.schmizz.sshj.userauth.method.AuthKeyboardInteractive
+
+
+
All Implemented Interfaces:
SSHPacketHandler, AuthMethod
+
+
+
+
public class AuthKeyboardInteractive
extends AbstractAuthMethod
+ + +

+Implements the keyboard-interactive authentication method. +

+ +

+


+ +

+ + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.userauth.method.AbstractAuthMethod
log, params
+  + + + + + + + + + + +
+Constructor Summary
AuthKeyboardInteractive(ChallengeResponseProvider provider) + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ SSHPacketbuildReq() + +
+          Builds a SSHPacket containing the fields common to all authentication method.
+ voidhandle(Message cmd, + SSHPacket buf) + +
+          Delegate handling of some SSH packet to this object.
+ booleanshouldRetry() + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.userauth.method.AbstractAuthMethod
getName, init, makeAccountResource, request
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AuthKeyboardInteractive

+
+public AuthKeyboardInteractive(ChallengeResponseProvider provider)
+
+
+ + + + + + + + +
+Method Detail
+ +

+buildReq

+
+public SSHPacket buildReq()
+                   throws UserAuthException
+
+
Description copied from class: AbstractAuthMethod
+
Builds a SSHPacket containing the fields common to all authentication method. Method-specific fields can + further be put into this buffer. +

+

+
Overrides:
buildReq in class AbstractAuthMethod
+
+
+ +
Throws: +
UserAuthException
+
+
+
+ +

+handle

+
+public void handle(Message cmd,
+                   SSHPacket buf)
+            throws UserAuthException,
+                   TransportException
+
+
Description copied from interface: SSHPacketHandler
+
Delegate handling of some SSH packet to this object. +

+

+
Specified by:
handle in interface SSHPacketHandler
Overrides:
handle in class AbstractAuthMethod
+
+
+
Parameters:
cmd - the SSH message identifier
buf - SSHPacket containing rest of the request +
Throws: +
UserAuthException +
TransportException
+
+
+
+ +

+shouldRetry

+
+public boolean shouldRetry()
+
+
+
Specified by:
shouldRetry in interface AuthMethod
Overrides:
shouldRetry in class AbstractAuthMethod
+
+
+ +
Returns:
whether authentication should be reattempted if it failed.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AuthMethod.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AuthMethod.html new file mode 100644 index 00000000..9ee878eb --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AuthMethod.html @@ -0,0 +1,304 @@ + + + + + + + +AuthMethod (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.method +
+Interface AuthMethod

+
+
All Superinterfaces:
SSHPacketHandler
+
+
+
All Known Implementing Classes:
AbstractAuthMethod, AuthHostbased, AuthKeyboardInteractive, AuthNone, AuthPassword, AuthPublickey, KeyedAuthMethod
+
+
+
+
public interface AuthMethod
extends SSHPacketHandler
+ + +

+An authentication method of the SSH Authentication Protocol. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StringgetName() + +
+           
+ voidinit(AuthParams params) + +
+          This method must be called before requesting authentication with this method.
+ voidrequest() + +
+           
+ booleanshouldRetry() + +
+           
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.SSHPacketHandler
handle
+  +

+ + + + + + + + +
+Method Detail
+ +

+getName

+
+String getName()
+
+
+
+
+
+ +
Returns:
assigned name of this authentication method
+
+
+
+ +

+init

+
+void init(AuthParams params)
+
+
This method must be called before requesting authentication with this method. +

+

+
+
+
+
Parameters:
params - parameters needed for authentication
+
+
+
+ +

+request

+
+void request()
+             throws UserAuthException,
+                    TransportException
+
+
+
+
+
+ +
Throws: +
UserAuthException - if there is an error with the request +
TransportException - if there is a transport-related error
+
+
+
+ +

+shouldRetry

+
+boolean shouldRetry()
+
+
+
+
+
+ +
Returns:
whether authentication should be reattempted if it failed.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AuthNone.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AuthNone.html new file mode 100644 index 00000000..3ff9e06c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AuthNone.html @@ -0,0 +1,262 @@ + + + + + + + +AuthNone (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.method +
+Class AuthNone

+
+java.lang.Object
+  extended by net.schmizz.sshj.userauth.method.AbstractAuthMethod
+      extended by net.schmizz.sshj.userauth.method.AuthNone
+
+
+
All Implemented Interfaces:
SSHPacketHandler, AuthMethod
+
+
+
+
public class AuthNone
extends AbstractAuthMethod
+ + +

+none auth. No authentication information is exchanged in the request packet save username and the next + service requested. This method generally fails and is typically used to find out the method allowed by an SSH server + (sent as part of the SSH_MSG_USERAUTH_FAILURE packet) +

+ +

+


+ +

+ + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.userauth.method.AbstractAuthMethod
log, params
+  + + + + + + + + + + +
+Constructor Summary
AuthNone() + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.userauth.method.AbstractAuthMethod
buildReq, getName, handle, init, makeAccountResource, request, shouldRetry
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AuthNone

+
+public AuthNone()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AuthPassword.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AuthPassword.html new file mode 100644 index 00000000..ba201cc7 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AuthPassword.html @@ -0,0 +1,357 @@ + + + + + + + +AuthPassword (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.method +
+Class AuthPassword

+
+java.lang.Object
+  extended by net.schmizz.sshj.userauth.method.AbstractAuthMethod
+      extended by net.schmizz.sshj.userauth.method.AuthPassword
+
+
+
All Implemented Interfaces:
SSHPacketHandler, AuthMethod
+
+
+
+
public class AuthPassword
extends AbstractAuthMethod
+ + +

+Implements the password authentication method. Password-change request handling is not currently supported. +

+ +

+


+ +

+ + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.userauth.method.AbstractAuthMethod
log, params
+  + + + + + + + + + + +
+Constructor Summary
AuthPassword(PasswordFinder pwdf) + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ SSHPacketbuildReq() + +
+          Builds a SSHPacket containing the fields common to all authentication method.
+ voidhandle(Message cmd, + SSHPacket buf) + +
+          Delegate handling of some SSH packet to this object.
+ booleanshouldRetry() + +
+          Returns true if the associated PasswordFinder tells that we should retry with a new password that + it will supply.
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.userauth.method.AbstractAuthMethod
getName, init, makeAccountResource, request
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AuthPassword

+
+public AuthPassword(PasswordFinder pwdf)
+
+
+ + + + + + + + +
+Method Detail
+ +

+buildReq

+
+public SSHPacket buildReq()
+                   throws UserAuthException
+
+
Description copied from class: AbstractAuthMethod
+
Builds a SSHPacket containing the fields common to all authentication method. Method-specific fields can + further be put into this buffer. +

+

+
Overrides:
buildReq in class AbstractAuthMethod
+
+
+ +
Throws: +
UserAuthException
+
+
+
+ +

+handle

+
+public void handle(Message cmd,
+                   SSHPacket buf)
+            throws UserAuthException,
+                   TransportException
+
+
Description copied from interface: SSHPacketHandler
+
Delegate handling of some SSH packet to this object. +

+

+
Specified by:
handle in interface SSHPacketHandler
Overrides:
handle in class AbstractAuthMethod
+
+
+
Parameters:
cmd - the SSH message identifier
buf - SSHPacket containing rest of the request +
Throws: +
UserAuthException +
TransportException
+
+
+
+ +

+shouldRetry

+
+public boolean shouldRetry()
+
+
Returns true if the associated PasswordFinder tells that we should retry with a new password that + it will supply. +

+

+
Specified by:
shouldRetry in interface AuthMethod
Overrides:
shouldRetry in class AbstractAuthMethod
+
+
+ +
Returns:
whether authentication should be reattempted if it failed.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AuthPublickey.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AuthPublickey.html new file mode 100644 index 00000000..defae9cc --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/AuthPublickey.html @@ -0,0 +1,352 @@ + + + + + + + +AuthPublickey (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.method +
+Class AuthPublickey

+
+java.lang.Object
+  extended by net.schmizz.sshj.userauth.method.AbstractAuthMethod
+      extended by net.schmizz.sshj.userauth.method.KeyedAuthMethod
+          extended by net.schmizz.sshj.userauth.method.AuthPublickey
+
+
+
All Implemented Interfaces:
SSHPacketHandler, AuthMethod
+
+
+
+
public class AuthPublickey
extends KeyedAuthMethod
+ + +

+Implements the "publickey" SSH authentication method. +

+ Requesteing authentication with this method first sends a "feeler" request with just the public key, and if the + server responds with SSH_MSG_USERAUTH_PK_OK indicating that the key is acceptable, it proceeds to send a + request signed with the private key. Therefore, private keys are not requested from the associated KeyProvider unless needed. +

+ +

+


+ +

+ + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.userauth.method.KeyedAuthMethod
kProv
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.userauth.method.AbstractAuthMethod
log, params
+  + + + + + + + + + + +
+Constructor Summary
AuthPublickey(KeyProvider kProv) + +
+          Initialize this method with the provider for public and private key.
+  + + + + + + + + + + + + + + + +
+Method Summary
+protected  SSHPacketbuildReq() + +
+          Builds a feeler request (sans signature).
+ voidhandle(Message cmd, + SSHPacket buf) + +
+          Internal use.
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.userauth.method.KeyedAuthMethod
putPubKey, putSig
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.userauth.method.AbstractAuthMethod
getName, init, makeAccountResource, request, shouldRetry
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AuthPublickey

+
+public AuthPublickey(KeyProvider kProv)
+
+
Initialize this method with the provider for public and private key. +

+

+ + + + + + + + +
+Method Detail
+ +

+handle

+
+public void handle(Message cmd,
+                   SSHPacket buf)
+            throws UserAuthException,
+                   TransportException
+
+
Internal use. +

+

+
Specified by:
handle in interface SSHPacketHandler
Overrides:
handle in class AbstractAuthMethod
+
+
+
Parameters:
cmd - the SSH message identifier
buf - SSHPacket containing rest of the request +
Throws: +
UserAuthException +
TransportException
+
+
+
+ +

+buildReq

+
+protected SSHPacket buildReq()
+                      throws UserAuthException
+
+
Builds a feeler request (sans signature). +

+

+
Overrides:
buildReq in class AbstractAuthMethod
+
+
+ +
Throws: +
UserAuthException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/ChallengeResponseProvider.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/ChallengeResponseProvider.html new file mode 100644 index 00000000..bf0c956f --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/ChallengeResponseProvider.html @@ -0,0 +1,273 @@ + + + + + + + +ChallengeResponseProvider (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.method +
+Interface ChallengeResponseProvider

+
+
All Known Implementing Classes:
PasswordResponseProvider
+
+
+
+
public interface ChallengeResponseProvider
+ + +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ char[]getResponse(String prompt, + boolean echo) + +
+           
+ List<String>getSubmethods() + +
+           
+ voidinit(Resource resource, + String name, + String instruction) + +
+           
+ booleanshouldRetry() + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+getSubmethods

+
+List<String> getSubmethods()
+
+
+
+
+
+
+ +

+init

+
+void init(Resource resource,
+          String name,
+          String instruction)
+
+
+
+
+
+
+ +

+getResponse

+
+char[] getResponse(String prompt,
+                   boolean echo)
+
+
+
+
+
+
+ +

+shouldRetry

+
+boolean shouldRetry()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/KeyedAuthMethod.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/KeyedAuthMethod.html new file mode 100644 index 00000000..5394db85 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/KeyedAuthMethod.html @@ -0,0 +1,341 @@ + + + + + + + +KeyedAuthMethod (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.method +
+Class KeyedAuthMethod

+
+java.lang.Object
+  extended by net.schmizz.sshj.userauth.method.AbstractAuthMethod
+      extended by net.schmizz.sshj.userauth.method.KeyedAuthMethod
+
+
+
All Implemented Interfaces:
SSHPacketHandler, AuthMethod
+
+
+
Direct Known Subclasses:
AuthHostbased, AuthPublickey
+
+
+
+
public abstract class KeyedAuthMethod
extends AbstractAuthMethod
+ + +

+


+ +

+ + + + + + + + + + + +
+Field Summary
+protected  KeyProviderkProv + +
+           
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.userauth.method.AbstractAuthMethod
log, params
+  + + + + + + + + + + +
+Constructor Summary
KeyedAuthMethod(String name, + KeyProvider kProv) + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+protected  SSHPacketputPubKey(SSHPacket reqBuf) + +
+           
+protected  SSHPacketputSig(SSHPacket reqBuf) + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.userauth.method.AbstractAuthMethod
buildReq, getName, handle, init, makeAccountResource, request, shouldRetry
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+kProv

+
+protected final KeyProvider kProv
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+KeyedAuthMethod

+
+public KeyedAuthMethod(String name,
+                       KeyProvider kProv)
+
+
+ + + + + + + + +
+Method Detail
+ +

+putPubKey

+
+protected SSHPacket putPubKey(SSHPacket reqBuf)
+                       throws UserAuthException
+
+
+ +
Throws: +
UserAuthException
+
+
+
+ +

+putSig

+
+protected SSHPacket putSig(SSHPacket reqBuf)
+                    throws UserAuthException
+
+
+ +
Throws: +
UserAuthException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/PasswordResponseProvider.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/PasswordResponseProvider.html new file mode 100644 index 00000000..74a918ec --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/PasswordResponseProvider.html @@ -0,0 +1,347 @@ + + + + + + + +PasswordResponseProvider (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.method +
+Class PasswordResponseProvider

+
+java.lang.Object
+  extended by net.schmizz.sshj.userauth.method.PasswordResponseProvider
+
+
+
All Implemented Interfaces:
ChallengeResponseProvider
+
+
+
+
public class PasswordResponseProvider
extends Object
implements ChallengeResponseProvider
+ + +

+


+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
PasswordResponseProvider(PasswordFinder pwdf) + +
+           
PasswordResponseProvider(PasswordFinder pwdf, + Collection<String> acceptablePrompts) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ char[]getResponse(String prompt, + boolean echo) + +
+           
+ List<String>getSubmethods() + +
+           
+ voidinit(Resource resource, + String name, + String instruction) + +
+           
+ booleanshouldRetry() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PasswordResponseProvider

+
+public PasswordResponseProvider(PasswordFinder pwdf)
+
+
+
+ +

+PasswordResponseProvider

+
+public PasswordResponseProvider(PasswordFinder pwdf,
+                                Collection<String> acceptablePrompts)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getSubmethods

+
+public List<String> getSubmethods()
+
+
+
Specified by:
getSubmethods in interface ChallengeResponseProvider
+
+
+
+
+
+
+ +

+init

+
+public void init(Resource resource,
+                 String name,
+                 String instruction)
+
+
+
Specified by:
init in interface ChallengeResponseProvider
+
+
+
+
+
+
+ +

+getResponse

+
+public char[] getResponse(String prompt,
+                          boolean echo)
+
+
+
Specified by:
getResponse in interface ChallengeResponseProvider
+
+
+
+
+
+
+ +

+shouldRetry

+
+public boolean shouldRetry()
+
+
+
Specified by:
shouldRetry in interface ChallengeResponseProvider
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AbstractAuthMethod.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AbstractAuthMethod.html new file mode 100644 index 00000000..d495f32d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AbstractAuthMethod.html @@ -0,0 +1,221 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.method.AbstractAuthMethod (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.method.AbstractAuthMethod

+
+ + + + + + + + + +
+Packages that use AbstractAuthMethod
net.schmizz.sshj.userauth.method  
+  +

+ + + + + +
+Uses of AbstractAuthMethod in net.schmizz.sshj.userauth.method
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Subclasses of AbstractAuthMethod in net.schmizz.sshj.userauth.method
+ classAuthHostbased + +
+          Implements the hostbased SSH authentication method.
+ classAuthKeyboardInteractive + +
+          Implements the keyboard-interactive authentication method.
+ classAuthNone + +
+          none auth.
+ classAuthPassword + +
+          Implements the password authentication method.
+ classAuthPublickey + +
+          Implements the "publickey" SSH authentication method.
+ classKeyedAuthMethod + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AuthHostbased.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AuthHostbased.html new file mode 100644 index 00000000..58e3dc22 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AuthHostbased.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.method.AuthHostbased (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.method.AuthHostbased

+
+No usage of net.schmizz.sshj.userauth.method.AuthHostbased +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AuthKeyboardInteractive.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AuthKeyboardInteractive.html new file mode 100644 index 00000000..b64cf7b7 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AuthKeyboardInteractive.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.method.AuthKeyboardInteractive (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.method.AuthKeyboardInteractive

+
+No usage of net.schmizz.sshj.userauth.method.AuthKeyboardInteractive +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AuthMethod.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AuthMethod.html new file mode 100644 index 00000000..a8d7966b --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AuthMethod.html @@ -0,0 +1,317 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.userauth.method.AuthMethod (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.userauth.method.AuthMethod

+
+ + + + + + + + + + + + + + + + + +
+Packages that use AuthMethod
net.schmizz.sshj  
net.schmizz.sshj.userauth  
net.schmizz.sshj.userauth.method  
+  +

+ + + + + +
+Uses of AuthMethod in net.schmizz.sshj
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj with parameters of type AuthMethod
+ voidSSHClient.auth(String username, + AuthMethod... methods) + +
+          Authenticate username using the supplied methods.
+  +

+ + + + + + + + + +
Method parameters in net.schmizz.sshj with type arguments of type AuthMethod
+ voidSSHClient.auth(String username, + Iterable<AuthMethod> methods) + +
+          Authenticate username using the supplied methods.
+  +

+ + + + + +
+Uses of AuthMethod in net.schmizz.sshj.userauth
+  +

+ + + + + + + + + + + + + +
Method parameters in net.schmizz.sshj.userauth with type arguments of type AuthMethod
+ voidUserAuthImpl.authenticate(String username, + Service nextService, + Iterable<AuthMethod> methods) + +
+           
+ voidUserAuth.authenticate(String username, + Service nextService, + Iterable<AuthMethod> methods) + +
+          Attempt to authenticate username using each of methods in order.
+  +

+ + + + + +
+Uses of AuthMethod in net.schmizz.sshj.userauth.method
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Classes in net.schmizz.sshj.userauth.method that implement AuthMethod
+ classAbstractAuthMethod + +
+          This abstract class for AuthMethod implements common or default functionality.
+ classAuthHostbased + +
+          Implements the hostbased SSH authentication method.
+ classAuthKeyboardInteractive + +
+          Implements the keyboard-interactive authentication method.
+ classAuthNone + +
+          none auth.
+ classAuthPassword + +
+          Implements the password authentication method.
+ classAuthPublickey + +
+          Implements the "publickey" SSH authentication method.
+ classKeyedAuthMethod + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AuthNone.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AuthNone.html new file mode 100644 index 00000000..1908e09d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AuthNone.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.method.AuthNone (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.method.AuthNone

+
+No usage of net.schmizz.sshj.userauth.method.AuthNone +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AuthPassword.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AuthPassword.html new file mode 100644 index 00000000..51d44d24 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AuthPassword.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.method.AuthPassword (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.method.AuthPassword

+
+No usage of net.schmizz.sshj.userauth.method.AuthPassword +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AuthPublickey.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AuthPublickey.html new file mode 100644 index 00000000..17e276cd --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/AuthPublickey.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.method.AuthPublickey (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.method.AuthPublickey

+
+No usage of net.schmizz.sshj.userauth.method.AuthPublickey +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/ChallengeResponseProvider.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/ChallengeResponseProvider.html new file mode 100644 index 00000000..5a34fab3 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/ChallengeResponseProvider.html @@ -0,0 +1,195 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.userauth.method.ChallengeResponseProvider (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.userauth.method.ChallengeResponseProvider

+
+ + + + + + + + + +
+Packages that use ChallengeResponseProvider
net.schmizz.sshj.userauth.method  
+  +

+ + + + + +
+Uses of ChallengeResponseProvider in net.schmizz.sshj.userauth.method
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.userauth.method that implement ChallengeResponseProvider
+ classPasswordResponseProvider + +
+           
+  +

+ + + + + + + + +
Constructors in net.schmizz.sshj.userauth.method with parameters of type ChallengeResponseProvider
AuthKeyboardInteractive(ChallengeResponseProvider provider) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/KeyedAuthMethod.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/KeyedAuthMethod.html new file mode 100644 index 00000000..5342475d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/KeyedAuthMethod.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.method.KeyedAuthMethod (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.method.KeyedAuthMethod

+
+ + + + + + + + + +
+Packages that use KeyedAuthMethod
net.schmizz.sshj.userauth.method  
+  +

+ + + + + +
+Uses of KeyedAuthMethod in net.schmizz.sshj.userauth.method
+  +

+ + + + + + + + + + + + + +
Subclasses of KeyedAuthMethod in net.schmizz.sshj.userauth.method
+ classAuthHostbased + +
+          Implements the hostbased SSH authentication method.
+ classAuthPublickey + +
+          Implements the "publickey" SSH authentication method.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/PasswordResponseProvider.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/PasswordResponseProvider.html new file mode 100644 index 00000000..e7725555 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/class-use/PasswordResponseProvider.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.method.PasswordResponseProvider (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.method.PasswordResponseProvider

+
+No usage of net.schmizz.sshj.userauth.method.PasswordResponseProvider +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/package-frame.html new file mode 100644 index 00000000..ee7c95df --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/package-frame.html @@ -0,0 +1,60 @@ + + + + + + + +net.schmizz.sshj.userauth.method (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.userauth.method + + + + +
+Interfaces  + +
+AuthMethod +
+ChallengeResponseProvider
+ + + + + + +
+Classes  + +
+AbstractAuthMethod +
+AuthHostbased +
+AuthKeyboardInteractive +
+AuthNone +
+AuthPassword +
+AuthPublickey +
+KeyedAuthMethod +
+PasswordResponseProvider
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/package-summary.html new file mode 100644 index 00000000..37831a74 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/package-summary.html @@ -0,0 +1,204 @@ + + + + + + + +net.schmizz.sshj.userauth.method (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.userauth.method +

+ + + + + + + + + + + + + +
+Interface Summary
AuthMethodAn authentication method of the SSH Authentication Protocol.
ChallengeResponseProvider 
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
AbstractAuthMethodThis abstract class for AuthMethod implements common or default functionality.
AuthHostbasedImplements the hostbased SSH authentication method.
AuthKeyboardInteractiveImplements the keyboard-interactive authentication method.
AuthNonenone auth.
AuthPasswordImplements the password authentication method.
AuthPublickeyImplements the "publickey" SSH authentication method.
KeyedAuthMethod 
PasswordResponseProvider 
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/package-tree.html new file mode 100644 index 00000000..27a02684 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/package-tree.html @@ -0,0 +1,167 @@ + + + + + + + +net.schmizz.sshj.userauth.method Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.userauth.method +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/method/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/package-use.html new file mode 100644 index 00000000..bccacb17 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/method/package-use.html @@ -0,0 +1,227 @@ + + + + + + + +Uses of Package net.schmizz.sshj.userauth.method (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.userauth.method

+
+ + + + + + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.userauth.method
net.schmizz.sshj  
net.schmizz.sshj.userauth  
net.schmizz.sshj.userauth.method  
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.userauth.method used by net.schmizz.sshj
AuthMethod + +
+          An authentication method of the SSH Authentication Protocol.
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.userauth.method used by net.schmizz.sshj.userauth
AuthMethod + +
+          An authentication method of the SSH Authentication Protocol.
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.userauth.method used by net.schmizz.sshj.userauth.method
AbstractAuthMethod + +
+          This abstract class for AuthMethod implements common or default functionality.
AuthMethod + +
+          An authentication method of the SSH Authentication Protocol.
ChallengeResponseProvider + +
+           
KeyedAuthMethod + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/package-frame.html new file mode 100644 index 00000000..fccc4214 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/package-frame.html @@ -0,0 +1,57 @@ + + + + + + + +net.schmizz.sshj.userauth (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.userauth + + + + +
+Interfaces  + +
+AuthParams +
+UserAuth
+ + + + + + +
+Classes  + +
+UserAuthImpl
+ + + + + + +
+Exceptions  + +
+UserAuthException
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/package-summary.html new file mode 100644 index 00000000..a304cb25 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/package-summary.html @@ -0,0 +1,190 @@ + + + + + + + +net.schmizz.sshj.userauth (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.userauth +

+ + + + + + + + + + + + + +
+Interface Summary
AuthParamsThe parameters available to authentication methods.
UserAuthUser authentication API.
+  + +

+ + + + + + + + + +
+Class Summary
UserAuthImplUserAuth implementation.
+  + +

+ + + + + + + + + +
+Exception Summary
UserAuthExceptionUser authentication exception
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/package-tree.html new file mode 100644 index 00000000..02391cc4 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/package-tree.html @@ -0,0 +1,172 @@ + + + + + + + +net.schmizz.sshj.userauth Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.userauth +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/package-use.html new file mode 100644 index 00000000..0ae45f0a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/package-use.html @@ -0,0 +1,227 @@ + + + + + + + +Uses of Package net.schmizz.sshj.userauth (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.userauth

+
+ + + + + + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.userauth
net.schmizz.sshj  
net.schmizz.sshj.userauth  
net.schmizz.sshj.userauth.method  
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.userauth used by net.schmizz.sshj
UserAuth + +
+          User authentication API.
UserAuthException + +
+          User authentication exception
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.userauth used by net.schmizz.sshj.userauth
UserAuth + +
+          User authentication API.
UserAuthException + +
+          User authentication exception
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.userauth used by net.schmizz.sshj.userauth.method
AuthParams + +
+          The parameters available to authentication methods.
UserAuthException + +
+          User authentication exception
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/password/AccountResource.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/AccountResource.html new file mode 100644 index 00000000..e5106129 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/AccountResource.html @@ -0,0 +1,271 @@ + + + + + + + +AccountResource (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.password +
+Class AccountResource

+
+java.lang.Object
+  extended by net.schmizz.sshj.userauth.password.Resource<String>
+      extended by net.schmizz.sshj.userauth.password.AccountResource
+
+
+
+
public class AccountResource
extends Resource<String>
+ + +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
AccountResource(String user, + String host) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ ReadergetReader() + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.userauth.password.Resource
equals, getDetail, hashCode, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AccountResource

+
+public AccountResource(String user,
+                       String host)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getReader

+
+public Reader getReader()
+                 throws IOException
+
+
+
Specified by:
getReader in class Resource<String>
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/password/PasswordFinder.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/PasswordFinder.html new file mode 100644 index 00000000..cccab454 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/PasswordFinder.html @@ -0,0 +1,243 @@ + + + + + + + +PasswordFinder (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.password +
+Interface PasswordFinder

+
+
+
public interface PasswordFinder
+ + +

+Services requests for plaintext passwords. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ char[]reqPassword(Resource<?> resource) + +
+          Request password for specified resource.
+ booleanshouldRetry(Resource<?> resource) + +
+          If password turns out to be incorrect, indicates whether another call to reqPassword(Resource) should be + made.
+  +

+ + + + + + + + +
+Method Detail
+ +

+reqPassword

+
+char[] reqPassword(Resource<?> resource)
+
+
Request password for specified resource. +

+ This method may return null when the request cannot be serviced, e.g. when the user cancels a password + prompt. +

+

+
Parameters:
resource - the resource for which password is being requested +
Returns:
the password or null
+
+
+
+ +

+shouldRetry

+
+boolean shouldRetry(Resource<?> resource)
+
+
If password turns out to be incorrect, indicates whether another call to reqPassword(Resource) should be + made. +

+ This method is geared at interactive implementations, and stub implementations may simply return false. +

+

+
Parameters:
resource - the resource for which password is being requested +
Returns:
whether to retry requesting password for a particular resource
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/password/PasswordUtils.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/PasswordUtils.html new file mode 100644 index 00000000..e7a27231 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/PasswordUtils.html @@ -0,0 +1,279 @@ + + + + + + + +PasswordUtils (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.password +
+Class PasswordUtils

+
+java.lang.Object
+  extended by net.schmizz.sshj.userauth.password.PasswordUtils
+
+
+
+
public class PasswordUtils
extends Object
+ + +

+Static utility method and factories +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
PasswordUtils() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static voidblankOut(char[] pwd) + +
+          Blank out a character array
+static PasswordFindercreateOneOff(char[] password) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PasswordUtils

+
+public PasswordUtils()
+
+
+ + + + + + + + +
+Method Detail
+ +

+blankOut

+
+public static void blankOut(char[] pwd)
+
+
Blank out a character array +

+

+
Parameters:
pwd - the character array
+
+
+
+ +

+createOneOff

+
+public static PasswordFinder createOneOff(char[] password)
+
+
+
Parameters:
password - the password as a char[] +
Returns:
the constructed PasswordFinder
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/password/PrivateKeyFileResource.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/PrivateKeyFileResource.html new file mode 100644 index 00000000..9170a37c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/PrivateKeyFileResource.html @@ -0,0 +1,269 @@ + + + + + + + +PrivateKeyFileResource (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.password +
+Class PrivateKeyFileResource

+
+java.lang.Object
+  extended by net.schmizz.sshj.userauth.password.Resource<File>
+      extended by net.schmizz.sshj.userauth.password.PrivateKeyFileResource
+
+
+
+
public class PrivateKeyFileResource
extends Resource<File>
+ + +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
PrivateKeyFileResource(File privateKeyFile) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ ReadergetReader() + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.userauth.password.Resource
equals, getDetail, hashCode, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PrivateKeyFileResource

+
+public PrivateKeyFileResource(File privateKeyFile)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getReader

+
+public Reader getReader()
+                 throws IOException
+
+
+
Specified by:
getReader in class Resource<File>
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/password/PrivateKeyStringResource.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/PrivateKeyStringResource.html new file mode 100644 index 00000000..6d6b1425 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/PrivateKeyStringResource.html @@ -0,0 +1,269 @@ + + + + + + + +PrivateKeyStringResource (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.password +
+Class PrivateKeyStringResource

+
+java.lang.Object
+  extended by net.schmizz.sshj.userauth.password.Resource<String>
+      extended by net.schmizz.sshj.userauth.password.PrivateKeyStringResource
+
+
+
+
public class PrivateKeyStringResource
extends Resource<String>
+ + +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
PrivateKeyStringResource(String string) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ ReadergetReader() + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.userauth.password.Resource
equals, getDetail, hashCode, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PrivateKeyStringResource

+
+public PrivateKeyStringResource(String string)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getReader

+
+public Reader getReader()
+                 throws IOException
+
+
+
Specified by:
getReader in class Resource<String>
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/password/Resource.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/Resource.html new file mode 100644 index 00000000..ca232349 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/Resource.html @@ -0,0 +1,348 @@ + + + + + + + +Resource (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.userauth.password +
+Class Resource<H>

+
+java.lang.Object
+  extended by net.schmizz.sshj.userauth.password.Resource<H>
+
+
+
Direct Known Subclasses:
AccountResource, PrivateKeyFileResource, PrivateKeyStringResource
+
+
+
+
public abstract class Resource<H>
extends Object
+ + +

+A password-protected resource +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
Resource(H handle) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(Object o) + +
+           
+ HgetDetail() + +
+           
+abstract  ReadergetReader() + +
+           
+ inthashCode() + +
+           
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Resource

+
+public Resource(H handle)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getDetail

+
+public H getDetail()
+
+
+
+
+
+
+ +

+getReader

+
+public abstract Reader getReader()
+                          throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+equals

+
+public boolean equals(Object o)
+
+
+
Overrides:
equals in class Object
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class Object
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/password/class-use/AccountResource.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/class-use/AccountResource.html new file mode 100644 index 00000000..c7d25caa --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/class-use/AccountResource.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.password.AccountResource (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.password.AccountResource

+
+ + + + + + + + + +
+Packages that use AccountResource
net.schmizz.sshj.userauth.method  
+  +

+ + + + + +
+Uses of AccountResource in net.schmizz.sshj.userauth.method
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.userauth.method that return AccountResource
+protected  AccountResourceAbstractAuthMethod.makeAccountResource() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/password/class-use/PasswordFinder.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/class-use/PasswordFinder.html new file mode 100644 index 00000000..236136e7 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/class-use/PasswordFinder.html @@ -0,0 +1,346 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.userauth.password.PasswordFinder (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.userauth.password.PasswordFinder

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use PasswordFinder
net.schmizz.sshj  
net.schmizz.sshj.userauth.keyprovider  
net.schmizz.sshj.userauth.method  
net.schmizz.sshj.userauth.password  
+  +

+ + + + + +
+Uses of PasswordFinder in net.schmizz.sshj
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj with parameters of type PasswordFinder
+ voidSSHClient.authPassword(String username, + PasswordFinder pfinder) + +
+          Authenticate username using the "password" authentication method and as a fallback basic + challenge-response authentication.
+ KeyProviderSSHClient.loadKeys(String location, + PasswordFinder passwordFinder) + +
+          Creates a KeyProvider instance from given location on the file system.
+ KeyProviderSSHClient.loadKeys(String privateKey, + String publicKey, + PasswordFinder passwordFinder) + +
+          Creates a KeyProvider instance from passed strings.
+  +

+ + + + + +
+Uses of PasswordFinder in net.schmizz.sshj.userauth.keyprovider
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.userauth.keyprovider declared as PasswordFinder
+protected  PasswordFinderPKCS8KeyFile.pwdf + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.userauth.keyprovider with parameters of type PasswordFinder
+ voidPKCS8KeyFile.init(File location, + PasswordFinder pwdf) + +
+           
+ voidFileKeyProvider.init(File location, + PasswordFinder pwdf) + +
+           
+ voidPKCS8KeyFile.init(String privateKey, + String publicKey, + PasswordFinder pwdf) + +
+           
+ voidFileKeyProvider.init(String privateKey, + String publicKey, + PasswordFinder pwdf) + +
+           
+  +

+ + + + + +
+Uses of PasswordFinder in net.schmizz.sshj.userauth.method
+  +

+ + + + + + + + + + + + + + +
Constructors in net.schmizz.sshj.userauth.method with parameters of type PasswordFinder
AuthPassword(PasswordFinder pwdf) + +
+           
PasswordResponseProvider(PasswordFinder pwdf) + +
+           
PasswordResponseProvider(PasswordFinder pwdf, + Collection<String> acceptablePrompts) + +
+           
+  +

+ + + + + +
+Uses of PasswordFinder in net.schmizz.sshj.userauth.password
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.userauth.password that return PasswordFinder
+static PasswordFinderPasswordUtils.createOneOff(char[] password) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/password/class-use/PasswordUtils.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/class-use/PasswordUtils.html new file mode 100644 index 00000000..b8d7e84c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/class-use/PasswordUtils.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.password.PasswordUtils (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.password.PasswordUtils

+
+No usage of net.schmizz.sshj.userauth.password.PasswordUtils +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/password/class-use/PrivateKeyFileResource.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/class-use/PrivateKeyFileResource.html new file mode 100644 index 00000000..fe3bf428 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/class-use/PrivateKeyFileResource.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.password.PrivateKeyFileResource (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.password.PrivateKeyFileResource

+
+No usage of net.schmizz.sshj.userauth.password.PrivateKeyFileResource +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/password/class-use/PrivateKeyStringResource.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/class-use/PrivateKeyStringResource.html new file mode 100644 index 00000000..9f961f74 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/class-use/PrivateKeyStringResource.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.password.PrivateKeyStringResource (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.password.PrivateKeyStringResource

+
+No usage of net.schmizz.sshj.userauth.password.PrivateKeyStringResource +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/password/class-use/Resource.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/class-use/Resource.html new file mode 100644 index 00000000..768b7079 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/class-use/Resource.html @@ -0,0 +1,292 @@ + + + + + + + +Uses of Class net.schmizz.sshj.userauth.password.Resource (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.userauth.password.Resource

+
+ + + + + + + + + + + + + + + + + +
+Packages that use Resource
net.schmizz.sshj.userauth.keyprovider  
net.schmizz.sshj.userauth.method  
net.schmizz.sshj.userauth.password  
+  +

+ + + + + +
+Uses of Resource in net.schmizz.sshj.userauth.keyprovider
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.userauth.keyprovider declared as Resource
+protected  ResourcePKCS8KeyFile.resource + +
+           
+  +

+ + + + + +
+Uses of Resource in net.schmizz.sshj.userauth.method
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.userauth.method with parameters of type Resource
+ voidPasswordResponseProvider.init(Resource resource, + String name, + String instruction) + +
+           
+ voidChallengeResponseProvider.init(Resource resource, + String name, + String instruction) + +
+           
+  +

+ + + + + +
+Uses of Resource in net.schmizz.sshj.userauth.password
+  +

+ + + + + + + + + + + + + + + + + +
Subclasses of Resource in net.schmizz.sshj.userauth.password
+ classAccountResource + +
+           
+ classPrivateKeyFileResource + +
+           
+ classPrivateKeyStringResource + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.userauth.password with parameters of type Resource
+ char[]PasswordFinder.reqPassword(Resource<?> resource) + +
+          Request password for specified resource.
+ booleanPasswordFinder.shouldRetry(Resource<?> resource) + +
+          If password turns out to be incorrect, indicates whether another call to PasswordFinder.reqPassword(Resource) should be + made.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/password/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/package-frame.html new file mode 100644 index 00000000..e4af9fbf --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/package-frame.html @@ -0,0 +1,52 @@ + + + + + + + +net.schmizz.sshj.userauth.password (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.userauth.password + + + + +
+Interfaces  + +
+PasswordFinder
+ + + + + + +
+Classes  + +
+AccountResource +
+PasswordUtils +
+PrivateKeyFileResource +
+PrivateKeyStringResource +
+Resource
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/password/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/package-summary.html new file mode 100644 index 00000000..936e7a9e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/package-summary.html @@ -0,0 +1,188 @@ + + + + + + + +net.schmizz.sshj.userauth.password (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.userauth.password +

+ + + + + + + + + +
+Interface Summary
PasswordFinderServices requests for plaintext passwords.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
AccountResource 
PasswordUtilsStatic utility method and factories
PrivateKeyFileResource 
PrivateKeyStringResource 
Resource<H>A password-protected resource
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/password/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/package-tree.html new file mode 100644 index 00000000..0451221e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/package-tree.html @@ -0,0 +1,161 @@ + + + + + + + +net.schmizz.sshj.userauth.password Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.userauth.password +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/userauth/password/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/package-use.html new file mode 100644 index 00000000..453f78cc --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/userauth/password/package-use.html @@ -0,0 +1,252 @@ + + + + + + + +Uses of Package net.schmizz.sshj.userauth.password (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.userauth.password

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.userauth.password
net.schmizz.sshj  
net.schmizz.sshj.userauth.keyprovider  
net.schmizz.sshj.userauth.method  
net.schmizz.sshj.userauth.password  
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.userauth.password used by net.schmizz.sshj
PasswordFinder + +
+          Services requests for plaintext passwords.
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.userauth.password used by net.schmizz.sshj.userauth.keyprovider
PasswordFinder + +
+          Services requests for plaintext passwords.
Resource + +
+          A password-protected resource
+  +

+ + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.userauth.password used by net.schmizz.sshj.userauth.method
AccountResource + +
+           
PasswordFinder + +
+          Services requests for plaintext passwords.
Resource + +
+          A password-protected resource
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.userauth.password used by net.schmizz.sshj.userauth.password
PasswordFinder + +
+          Services requests for plaintext passwords.
Resource + +
+          A password-protected resource
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/AbstractFileTransfer.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/AbstractFileTransfer.html new file mode 100644 index 00000000..8760590c --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/AbstractFileTransfer.html @@ -0,0 +1,329 @@ + + + + + + + +AbstractFileTransfer (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.xfer +
+Class AbstractFileTransfer

+
+java.lang.Object
+  extended by net.schmizz.sshj.xfer.AbstractFileTransfer
+
+
+
Direct Known Subclasses:
SCPFileTransfer, SFTPFileTransfer
+
+
+
+
public abstract class AbstractFileTransfer
extends Object
+ + +

+


+ +

+ + + + + + + + + + + + + + + +
+Field Summary
+protected  org.slf4j.Loggerlog + +
+           
+static LoggingTransferListenerLOGGING_TRANSFER_LISTENER + +
+           
+  + + + + + + + + + + +
+Constructor Summary
AbstractFileTransfer() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ TransferListenergetTransferListener() + +
+           
+ voidsetTransferListener(TransferListener transferListener) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+protected final org.slf4j.Logger log
+
+
+
+
+
+ +

+LOGGING_TRANSFER_LISTENER

+
+public static final LoggingTransferListener LOGGING_TRANSFER_LISTENER
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+AbstractFileTransfer

+
+public AbstractFileTransfer()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getTransferListener

+
+public TransferListener getTransferListener()
+
+
+
+
+
+
+ +

+setTransferListener

+
+public void setTransferListener(TransferListener transferListener)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/FilePermission.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/FilePermission.html new file mode 100644 index 00000000..3cb68916 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/FilePermission.html @@ -0,0 +1,618 @@ + + + + + + + +FilePermission (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.xfer +
+Enum FilePermission

+
+java.lang.Object
+  extended by java.lang.Enum<FilePermission>
+      extended by net.schmizz.sshj.xfer.FilePermission
+
+
+
All Implemented Interfaces:
Serializable, Comparable<FilePermission>
+
+
+
+
public enum FilePermission
extends Enum<FilePermission>
+ + +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
GRP_R + +
+          read permission, group
GRP_RWX + +
+          read, write, execute/search by group
GRP_W + +
+          write permission, group
GRP_X + +
+          execute/search permission, group
OTH_R + +
+          read permission, others
OTH_RWX + +
+          read, write, execute/search by other
OTH_W + +
+          write permission, others
OTH_X + +
+          execute/search permission, group
SGID + +
+          set-group-ID on execution
STICKY + +
+          on directories, restricted deletion flag
SUID + +
+          set-user-ID on execution
USR_R + +
+          read permission, owner
USR_RWX + +
+          read, write, execute/search by user
USR_W + +
+          write permission, owner
USR_X + +
+          execute/search permission, owner
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static Set<FilePermission>fromMask(int mask) + +
+           
+ booleanisIn(int mask) + +
+           
+static inttoMask(Set<FilePermission> perms) + +
+           
+static FilePermissionvalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static FilePermission[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+USR_R

+
+public static final FilePermission USR_R
+
+
read permission, owner +

+

+
+
+
+ +

+USR_W

+
+public static final FilePermission USR_W
+
+
write permission, owner +

+

+
+
+
+ +

+USR_X

+
+public static final FilePermission USR_X
+
+
execute/search permission, owner +

+

+
+
+
+ +

+GRP_R

+
+public static final FilePermission GRP_R
+
+
read permission, group +

+

+
+
+
+ +

+GRP_W

+
+public static final FilePermission GRP_W
+
+
write permission, group +

+

+
+
+
+ +

+GRP_X

+
+public static final FilePermission GRP_X
+
+
execute/search permission, group +

+

+
+
+
+ +

+OTH_R

+
+public static final FilePermission OTH_R
+
+
read permission, others +

+

+
+
+
+ +

+OTH_W

+
+public static final FilePermission OTH_W
+
+
write permission, others +

+

+
+
+
+ +

+OTH_X

+
+public static final FilePermission OTH_X
+
+
execute/search permission, group +

+

+
+
+
+ +

+SUID

+
+public static final FilePermission SUID
+
+
set-user-ID on execution +

+

+
+
+
+ +

+SGID

+
+public static final FilePermission SGID
+
+
set-group-ID on execution +

+

+
+
+
+ +

+STICKY

+
+public static final FilePermission STICKY
+
+
on directories, restricted deletion flag +

+

+
+
+
+ +

+USR_RWX

+
+public static final FilePermission USR_RWX
+
+
read, write, execute/search by user +

+

+
+
+
+ +

+GRP_RWX

+
+public static final FilePermission GRP_RWX
+
+
read, write, execute/search by group +

+

+
+
+
+ +

+OTH_RWX

+
+public static final FilePermission OTH_RWX
+
+
read, write, execute/search by other +

+

+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static FilePermission[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (FilePermission c : FilePermission.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static FilePermission valueOf(String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+
+
+ +

+isIn

+
+public boolean isIn(int mask)
+
+
+
+
+
+
+ +

+fromMask

+
+public static Set<FilePermission> fromMask(int mask)
+
+
+
+
+
+
+ +

+toMask

+
+public static int toMask(Set<FilePermission> perms)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/FileSystemFile.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/FileSystemFile.html new file mode 100644 index 00000000..3d37cd5f --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/FileSystemFile.html @@ -0,0 +1,814 @@ + + + + + + + +FileSystemFile (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.xfer +
+Class FileSystemFile

+
+java.lang.Object
+  extended by net.schmizz.sshj.xfer.FileSystemFile
+
+
+
All Implemented Interfaces:
LocalDestFile, LocalSourceFile
+
+
+
+
public class FileSystemFile
extends Object
implements LocalSourceFile, LocalDestFile
+ + +

+


+ +

+ + + + + + + + + + + +
+Field Summary
+protected  org.slf4j.Loggerlog + +
+           
+  + + + + + + + + + + + + + +
+Constructor Summary
FileSystemFile(File file) + +
+           
FileSystemFile(String path) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(Object other) + +
+           
+ FileSystemFilegetChild(String name) + +
+           
+ Iterable<FileSystemFile>getChildren(LocalFileFilter filter) + +
+           
+ FilegetFile() + +
+           
+ InputStreamgetInputStream() + +
+           
+ longgetLastAccessTime() + +
+          Returns last access time for the underlying file.
+ longgetLastModifiedTime() + +
+          Returns last access time for the underlying file.
+ longgetLength() + +
+           
+ StringgetName() + +
+           
+ OutputStreamgetOutputStream() + +
+           
+ intgetPermissions() + +
+          Returns the permissions for the underlying file
+ FileSystemFilegetTargetDirectory(String dirname) + +
+          Allows caller to express intent that caller expects to write to directory with dirname.
+ FileSystemFilegetTargetFile(String filename) + +
+          Allows caller to express intent that caller expects to write to file with filename.
+ inthashCode() + +
+           
+ booleanisDirectory() + +
+           
+ booleanisFile() + +
+           
+ booleanprovidesAtimeMtime() + +
+           
+ voidsetLastAccessedTime(long t) + +
+          Set the last access time for the underlying file.
+ voidsetLastModifiedTime(long t) + +
+          Set the last modified time for the underlying file.
+ voidsetPermissions(int perms) + +
+          Set the permissions for the underlying file.
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+protected final org.slf4j.Logger log
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+FileSystemFile

+
+public FileSystemFile(String path)
+
+
+
+ +

+FileSystemFile

+
+public FileSystemFile(File file)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getFile

+
+public File getFile()
+
+
+
+
+
+
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
Specified by:
getName in interface LocalSourceFile
+
+
+
+
+
+
+ +

+isFile

+
+public boolean isFile()
+
+
+
Specified by:
isFile in interface LocalSourceFile
+
+
+
+
+
+
+ +

+isDirectory

+
+public boolean isDirectory()
+
+
+
Specified by:
isDirectory in interface LocalSourceFile
+
+
+
+
+
+
+ +

+getLength

+
+public long getLength()
+
+
+
Specified by:
getLength in interface LocalSourceFile
+
+
+
+
+
+
+ +

+getInputStream

+
+public InputStream getInputStream()
+                           throws IOException
+
+
+
Specified by:
getInputStream in interface LocalSourceFile
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+getOutputStream

+
+public OutputStream getOutputStream()
+                             throws IOException
+
+
+
Specified by:
getOutputStream in interface LocalDestFile
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+getChildren

+
+public Iterable<FileSystemFile> getChildren(LocalFileFilter filter)
+                                     throws IOException
+
+
+
Specified by:
getChildren in interface LocalSourceFile
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+providesAtimeMtime

+
+public boolean providesAtimeMtime()
+
+
+
Specified by:
providesAtimeMtime in interface LocalSourceFile
+
+
+
+
+
+
+ +

+getLastAccessTime

+
+public long getLastAccessTime()
+                       throws IOException
+
+
Description copied from interface: LocalSourceFile
+
Returns last access time for the underlying file. +

+

+
Specified by:
getLastAccessTime in interface LocalSourceFile
+
+
+ +
Returns:
time in seconds since Unix epoch +
Throws: +
IOException
+
+
+
+ +

+getLastModifiedTime

+
+public long getLastModifiedTime()
+                         throws IOException
+
+
Description copied from interface: LocalSourceFile
+
Returns last access time for the underlying file. +

+

+
Specified by:
getLastModifiedTime in interface LocalSourceFile
+
+
+ +
Returns:
time in seconds since Unix epoch +
Throws: +
IOException
+
+
+
+ +

+getPermissions

+
+public int getPermissions()
+                   throws IOException
+
+
Description copied from interface: LocalSourceFile
+
Returns the permissions for the underlying file +

+

+
Specified by:
getPermissions in interface LocalSourceFile
+
+
+ +
Returns:
permissions e.g. 0644 +
Throws: +
IOException
+
+
+
+ +

+setLastAccessedTime

+
+public void setLastAccessedTime(long t)
+                         throws IOException
+
+
Description copied from interface: LocalDestFile
+
Set the last access time for the underlying file. +

+

+
Specified by:
setLastAccessedTime in interface LocalDestFile
+
+
+
Parameters:
t - time in seconds since Unix epoch +
Throws: +
IOException
+
+
+
+ +

+setLastModifiedTime

+
+public void setLastModifiedTime(long t)
+                         throws IOException
+
+
Description copied from interface: LocalDestFile
+
Set the last modified time for the underlying file. +

+

+
Specified by:
setLastModifiedTime in interface LocalDestFile
+
+
+
Parameters:
t - time in seconds since Unix epoch +
Throws: +
IOException
+
+
+
+ +

+setPermissions

+
+public void setPermissions(int perms)
+                    throws IOException
+
+
Description copied from interface: LocalDestFile
+
Set the permissions for the underlying file. +

+

+
Specified by:
setPermissions in interface LocalDestFile
+
+
+
Parameters:
perms - permissions e.g. 0644 +
Throws: +
IOException
+
+
+
+ +

+getChild

+
+public FileSystemFile getChild(String name)
+
+
+
Specified by:
getChild in interface LocalDestFile
+
+
+ +
Returns:
A child file/directory of this directory with given name.
+
+
+
+ +

+getTargetFile

+
+public FileSystemFile getTargetFile(String filename)
+                             throws IOException
+
+
Description copied from interface: LocalDestFile
+
Allows caller to express intent that caller expects to write to file with filename. Based on this + information, an implementation may return an alternate file to write to, which should be respected by the + caller. +

+

+
Specified by:
getTargetFile in interface LocalDestFile
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+getTargetDirectory

+
+public FileSystemFile getTargetDirectory(String dirname)
+                                  throws IOException
+
+
Description copied from interface: LocalDestFile
+
Allows caller to express intent that caller expects to write to directory with dirname. Based on this + information, an implementation may return an alternate directory to write to, which should be respected by the + caller. +

+

+
Specified by:
getTargetDirectory in interface LocalDestFile
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+equals

+
+public boolean equals(Object other)
+
+
+
Overrides:
equals in class Object
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class Object
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/FileTransfer.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/FileTransfer.html new file mode 100644 index 00000000..6493ff2d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/FileTransfer.html @@ -0,0 +1,325 @@ + + + + + + + +FileTransfer (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.xfer +
+Interface FileTransfer

+
+
All Known Implementing Classes:
SCPFileTransfer, SFTPFileTransfer
+
+
+
+
public interface FileTransfer
+ + +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddownload(String remotePath, + LocalDestFile localFile) + +
+           
+ voiddownload(String remotePath, + String localPath) + +
+           
+ TransferListenergetTransferListener() + +
+           
+ voidsetTransferListener(TransferListener listener) + +
+           
+ voidupload(LocalSourceFile localFile, + String remotePath) + +
+           
+ voidupload(String localPath, + String remotePath) + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+upload

+
+void upload(String localPath,
+            String remotePath)
+            throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+download

+
+void download(String remotePath,
+              String localPath)
+              throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+upload

+
+void upload(LocalSourceFile localFile,
+            String remotePath)
+            throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+download

+
+void download(String remotePath,
+              LocalDestFile localFile)
+              throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+getTransferListener

+
+TransferListener getTransferListener()
+
+
+
+
+
+
+ +

+setTransferListener

+
+void setTransferListener(TransferListener listener)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/InMemoryDestFile.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/InMemoryDestFile.html new file mode 100644 index 00000000..46abd568 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/InMemoryDestFile.html @@ -0,0 +1,449 @@ + + + + + + + +InMemoryDestFile (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.xfer +
+Class InMemoryDestFile

+
+java.lang.Object
+  extended by net.schmizz.sshj.xfer.InMemoryDestFile
+
+
+
All Implemented Interfaces:
LocalDestFile
+
+
+
+
public abstract class InMemoryDestFile
extends Object
implements LocalDestFile
+ + +

+


+ +

+ + + + + + + + + + + +
+Field Summary
+protected  org.slf4j.Loggerlog + +
+           
+  + + + + + + + + + + +
+Constructor Summary
InMemoryDestFile() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ LocalDestFilegetChild(String name) + +
+           
+ LocalDestFilegetTargetDirectory(String dirname) + +
+          Allows caller to express intent that caller expects to write to directory with dirname.
+ InMemoryDestFilegetTargetFile(String filename) + +
+          Allows caller to express intent that caller expects to write to file with filename.
+ voidsetLastAccessedTime(long t) + +
+          Set the last access time for the underlying file.
+ voidsetLastModifiedTime(long t) + +
+          Set the last modified time for the underlying file.
+ voidsetPermissions(int perms) + +
+          Set the permissions for the underlying file.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.xfer.LocalDestFile
getOutputStream
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+protected final org.slf4j.Logger log
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+InMemoryDestFile

+
+public InMemoryDestFile()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getTargetFile

+
+public InMemoryDestFile getTargetFile(String filename)
+                               throws IOException
+
+
Description copied from interface: LocalDestFile
+
Allows caller to express intent that caller expects to write to file with filename. Based on this + information, an implementation may return an alternate file to write to, which should be respected by the + caller. +

+

+
Specified by:
getTargetFile in interface LocalDestFile
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+setLastAccessedTime

+
+public void setLastAccessedTime(long t)
+                         throws IOException
+
+
Description copied from interface: LocalDestFile
+
Set the last access time for the underlying file. +

+

+
Specified by:
setLastAccessedTime in interface LocalDestFile
+
+
+
Parameters:
t - time in seconds since Unix epoch +
Throws: +
IOException
+
+
+
+ +

+setLastModifiedTime

+
+public void setLastModifiedTime(long t)
+                         throws IOException
+
+
Description copied from interface: LocalDestFile
+
Set the last modified time for the underlying file. +

+

+
Specified by:
setLastModifiedTime in interface LocalDestFile
+
+
+
Parameters:
t - time in seconds since Unix epoch +
Throws: +
IOException
+
+
+
+ +

+setPermissions

+
+public void setPermissions(int perms)
+                    throws IOException
+
+
Description copied from interface: LocalDestFile
+
Set the permissions for the underlying file. +

+

+
Specified by:
setPermissions in interface LocalDestFile
+
+
+
Parameters:
perms - permissions e.g. 0644 +
Throws: +
IOException
+
+
+
+ +

+getTargetDirectory

+
+public LocalDestFile getTargetDirectory(String dirname)
+                                 throws IOException
+
+
Description copied from interface: LocalDestFile
+
Allows caller to express intent that caller expects to write to directory with dirname. Based on this + information, an implementation may return an alternate directory to write to, which should be respected by the + caller. +

+

+
Specified by:
getTargetDirectory in interface LocalDestFile
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+getChild

+
+public LocalDestFile getChild(String name)
+
+
+
Specified by:
getChild in interface LocalDestFile
+
+
+ +
Returns:
A child file/directory of this directory with given name.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/InMemorySourceFile.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/InMemorySourceFile.html new file mode 100644 index 00000000..a2a63f79 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/InMemorySourceFile.html @@ -0,0 +1,460 @@ + + + + + + + +InMemorySourceFile (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.xfer +
+Class InMemorySourceFile

+
+java.lang.Object
+  extended by net.schmizz.sshj.xfer.InMemorySourceFile
+
+
+
All Implemented Interfaces:
LocalSourceFile
+
+
+
+
public abstract class InMemorySourceFile
extends Object
implements LocalSourceFile
+ + +

+


+ +

+ + + + + + + + + + + +
+Field Summary
+protected  org.slf4j.Loggerlog + +
+           
+  + + + + + + + + + + +
+Constructor Summary
InMemorySourceFile() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Iterable<? extends LocalSourceFile>getChildren(LocalFileFilter filter) + +
+           
+ longgetLastAccessTime() + +
+          Returns last access time for the underlying file.
+ longgetLastModifiedTime() + +
+          Returns last access time for the underlying file.
+ intgetPermissions() + +
+          Returns the permissions for the underlying file
+ booleanisDirectory() + +
+           
+ booleanisFile() + +
+           
+ booleanprovidesAtimeMtime() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.xfer.LocalSourceFile
getInputStream, getLength, getName
+  +

+ + + + + + + + +
+Field Detail
+ +

+log

+
+protected final org.slf4j.Logger log
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+InMemorySourceFile

+
+public InMemorySourceFile()
+
+
+ + + + + + + + +
+Method Detail
+ +

+isFile

+
+public boolean isFile()
+
+
+
Specified by:
isFile in interface LocalSourceFile
+
+
+
+
+
+
+ +

+isDirectory

+
+public boolean isDirectory()
+
+
+
Specified by:
isDirectory in interface LocalSourceFile
+
+
+
+
+
+
+ +

+getPermissions

+
+public int getPermissions()
+                   throws IOException
+
+
Description copied from interface: LocalSourceFile
+
Returns the permissions for the underlying file +

+

+
Specified by:
getPermissions in interface LocalSourceFile
+
+
+ +
Returns:
permissions e.g. 0644 +
Throws: +
IOException
+
+
+
+ +

+providesAtimeMtime

+
+public boolean providesAtimeMtime()
+
+
+
Specified by:
providesAtimeMtime in interface LocalSourceFile
+
+
+
+
+
+
+ +

+getLastAccessTime

+
+public long getLastAccessTime()
+                       throws IOException
+
+
Description copied from interface: LocalSourceFile
+
Returns last access time for the underlying file. +

+

+
Specified by:
getLastAccessTime in interface LocalSourceFile
+
+
+ +
Returns:
time in seconds since Unix epoch +
Throws: +
IOException
+
+
+
+ +

+getLastModifiedTime

+
+public long getLastModifiedTime()
+                         throws IOException
+
+
Description copied from interface: LocalSourceFile
+
Returns last access time for the underlying file. +

+

+
Specified by:
getLastModifiedTime in interface LocalSourceFile
+
+
+ +
Returns:
time in seconds since Unix epoch +
Throws: +
IOException
+
+
+
+ +

+getChildren

+
+public Iterable<? extends LocalSourceFile> getChildren(LocalFileFilter filter)
+                                                throws IOException
+
+
+
Specified by:
getChildren in interface LocalSourceFile
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/LocalDestFile.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/LocalDestFile.html new file mode 100644 index 00000000..4a91626d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/LocalDestFile.html @@ -0,0 +1,357 @@ + + + + + + + +LocalDestFile (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.xfer +
+Interface LocalDestFile

+
+
All Known Implementing Classes:
FileSystemFile, InMemoryDestFile
+
+
+
+
public interface LocalDestFile
+ + +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ LocalDestFilegetChild(String name) + +
+           
+ OutputStreamgetOutputStream() + +
+           
+ LocalDestFilegetTargetDirectory(String dirname) + +
+          Allows caller to express intent that caller expects to write to directory with dirname.
+ LocalDestFilegetTargetFile(String filename) + +
+          Allows caller to express intent that caller expects to write to file with filename.
+ voidsetLastAccessedTime(long t) + +
+          Set the last access time for the underlying file.
+ voidsetLastModifiedTime(long t) + +
+          Set the last modified time for the underlying file.
+ voidsetPermissions(int perms) + +
+          Set the permissions for the underlying file.
+  +

+ + + + + + + + +
+Method Detail
+ +

+getOutputStream

+
+OutputStream getOutputStream()
+                             throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+getChild

+
+LocalDestFile getChild(String name)
+
+
+ +
Returns:
A child file/directory of this directory with given name.
+
+
+
+ +

+getTargetFile

+
+LocalDestFile getTargetFile(String filename)
+                            throws IOException
+
+
Allows caller to express intent that caller expects to write to file with filename. Based on this + information, an implementation may return an alternate file to write to, which should be respected by the + caller. +

+

+ +
Throws: +
IOException
+
+
+
+ +

+getTargetDirectory

+
+LocalDestFile getTargetDirectory(String dirname)
+                                 throws IOException
+
+
Allows caller to express intent that caller expects to write to directory with dirname. Based on this + information, an implementation may return an alternate directory to write to, which should be respected by the + caller. +

+

+ +
Throws: +
IOException
+
+
+
+ +

+setPermissions

+
+void setPermissions(int perms)
+                    throws IOException
+
+
Set the permissions for the underlying file. +

+

+
Parameters:
perms - permissions e.g. 0644 +
Throws: +
IOException
+
+
+
+ +

+setLastAccessedTime

+
+void setLastAccessedTime(long t)
+                         throws IOException
+
+
Set the last access time for the underlying file. +

+

+
Parameters:
t - time in seconds since Unix epoch +
Throws: +
IOException
+
+
+
+ +

+setLastModifiedTime

+
+void setLastModifiedTime(long t)
+                         throws IOException
+
+
Set the last modified time for the underlying file. +

+

+
Parameters:
t - time in seconds since Unix epoch +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/LocalFileFilter.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/LocalFileFilter.html new file mode 100644 index 00000000..5f0d112b --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/LocalFileFilter.html @@ -0,0 +1,207 @@ + + + + + + + +LocalFileFilter (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.xfer +
+Interface LocalFileFilter

+
+
+
public interface LocalFileFilter
+ + +

+


+ +

+ + + + + + + + + + + + +
+Method Summary
+ booleanaccept(LocalSourceFile file) + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+accept

+
+boolean accept(LocalSourceFile file)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/LocalSourceFile.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/LocalSourceFile.html new file mode 100644 index 00000000..304ef0bd --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/LocalSourceFile.html @@ -0,0 +1,405 @@ + + + + + + + +LocalSourceFile (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.xfer +
+Interface LocalSourceFile

+
+
All Known Implementing Classes:
FileSystemFile, InMemorySourceFile
+
+
+
+
public interface LocalSourceFile
+ + +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Iterable<? extends LocalSourceFile>getChildren(LocalFileFilter filter) + +
+           
+ InputStreamgetInputStream() + +
+           
+ longgetLastAccessTime() + +
+          Returns last access time for the underlying file.
+ longgetLastModifiedTime() + +
+          Returns last access time for the underlying file.
+ longgetLength() + +
+           
+ StringgetName() + +
+           
+ intgetPermissions() + +
+          Returns the permissions for the underlying file
+ booleanisDirectory() + +
+           
+ booleanisFile() + +
+           
+ booleanprovidesAtimeMtime() + +
+           
+  +

+ + + + + + + + +
+Method Detail
+ +

+getName

+
+String getName()
+
+
+
+
+
+
+ +

+getLength

+
+long getLength()
+
+
+
+
+
+
+ +

+getInputStream

+
+InputStream getInputStream()
+                           throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+getPermissions

+
+int getPermissions()
+                   throws IOException
+
+
Returns the permissions for the underlying file +

+

+ +
Returns:
permissions e.g. 0644 +
Throws: +
IOException
+
+
+
+ +

+isFile

+
+boolean isFile()
+
+
+
+
+
+
+ +

+isDirectory

+
+boolean isDirectory()
+
+
+
+
+
+
+ +

+getChildren

+
+Iterable<? extends LocalSourceFile> getChildren(LocalFileFilter filter)
+                                                throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+providesAtimeMtime

+
+boolean providesAtimeMtime()
+
+
+
+
+
+
+ +

+getLastAccessTime

+
+long getLastAccessTime()
+                       throws IOException
+
+
Returns last access time for the underlying file. +

+

+ +
Returns:
time in seconds since Unix epoch +
Throws: +
IOException
+
+
+
+ +

+getLastModifiedTime

+
+long getLastModifiedTime()
+                         throws IOException
+
+
Returns last access time for the underlying file. +

+

+ +
Returns:
time in seconds since Unix epoch +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/LoggingTransferListener.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/LoggingTransferListener.html new file mode 100644 index 00000000..8f769d25 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/LoggingTransferListener.html @@ -0,0 +1,349 @@ + + + + + + + +LoggingTransferListener (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.xfer +
+Class LoggingTransferListener

+
+java.lang.Object
+  extended by net.schmizz.sshj.xfer.LoggingTransferListener
+
+
+
All Implemented Interfaces:
StreamCopier.Listener, TransferListener
+
+
+
+
public class LoggingTransferListener
extends Object
implements TransferListener
+ + +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
LoggingTransferListener() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidfinishedDir() + +
+           
+ voidfinishedFile() + +
+           
+ voidreportProgress(long transferred) + +
+           
+ voidstartedDir(String name) + +
+           
+ voidstartedFile(String name, + long size) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+LoggingTransferListener

+
+public LoggingTransferListener()
+
+
+ + + + + + + + +
+Method Detail
+ +

+startedDir

+
+public void startedDir(String name)
+
+
+
Specified by:
startedDir in interface TransferListener
+
+
+
+
+
+
+ +

+startedFile

+
+public void startedFile(String name,
+                        long size)
+
+
+
Specified by:
startedFile in interface TransferListener
+
+
+
+
+
+
+ +

+reportProgress

+
+public void reportProgress(long transferred)
+
+
+
Specified by:
reportProgress in interface StreamCopier.Listener
+
+
+
+
+
+
+ +

+finishedFile

+
+public void finishedFile()
+
+
+
Specified by:
finishedFile in interface TransferListener
+
+
+
+
+
+
+ +

+finishedDir

+
+public void finishedDir()
+
+
+
Specified by:
finishedDir in interface TransferListener
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/TransferListener.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/TransferListener.html new file mode 100644 index 00000000..7ba3faeb --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/TransferListener.html @@ -0,0 +1,293 @@ + + + + + + + +TransferListener (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.xfer +
+Interface TransferListener

+
+
All Superinterfaces:
StreamCopier.Listener
+
+
+
All Known Implementing Classes:
LoggingTransferListener
+
+
+
+
public interface TransferListener
extends StreamCopier.Listener
+ + +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidfinishedDir() + +
+           
+ voidfinishedFile() + +
+           
+ voidstartedDir(String name) + +
+           
+ voidstartedFile(String name, + long size) + +
+           
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.common.StreamCopier.Listener
reportProgress
+  +

+ + + + + + + + +
+Method Detail
+ +

+startedDir

+
+void startedDir(String name)
+
+
+
+
+
+
+
+
+
+ +

+startedFile

+
+void startedFile(String name,
+                 long size)
+
+
+
+
+
+
+
+
+
+ +

+finishedFile

+
+void finishedFile()
+
+
+
+
+
+
+
+
+
+ +

+finishedDir

+
+void finishedDir()
+
+
+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/AbstractFileTransfer.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/AbstractFileTransfer.html new file mode 100644 index 00000000..aff33b6d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/AbstractFileTransfer.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Class net.schmizz.sshj.xfer.AbstractFileTransfer (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.xfer.AbstractFileTransfer

+
+ + + + + + + + + + + + + +
+Packages that use AbstractFileTransfer
net.schmizz.sshj.sftp  
net.schmizz.sshj.xfer.scp  
+  +

+ + + + + +
+Uses of AbstractFileTransfer in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Subclasses of AbstractFileTransfer in net.schmizz.sshj.sftp
+ classSFTPFileTransfer + +
+           
+  +

+ + + + + +
+Uses of AbstractFileTransfer in net.schmizz.sshj.xfer.scp
+  +

+ + + + + + + + + +
Subclasses of AbstractFileTransfer in net.schmizz.sshj.xfer.scp
+ classSCPFileTransfer + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/FilePermission.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/FilePermission.html new file mode 100644 index 00000000..2117c2d0 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/FilePermission.html @@ -0,0 +1,283 @@ + + + + + + + +Uses of Class net.schmizz.sshj.xfer.FilePermission (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.xfer.FilePermission

+
+ + + + + + + + + + + + + +
+Packages that use FilePermission
net.schmizz.sshj.sftp  
net.schmizz.sshj.xfer  
+  +

+ + + + + +
+Uses of FilePermission in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return types with arguments of type FilePermission
+ Set<FilePermission>FileMode.getPermissions() + +
+           
+ Set<FilePermission>FileAttributes.getPermissions() + +
+           
+ Set<FilePermission>SFTPClient.perms(String path) + +
+           
+  +

+ + + + + + + + + +
Method parameters in net.schmizz.sshj.sftp with type arguments of type FilePermission
+ FileAttributes.BuilderFileAttributes.Builder.withPermissions(Set<FilePermission> perms) + +
+           
+  +

+ + + + + +
+Uses of FilePermission in net.schmizz.sshj.xfer
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.xfer that return FilePermission
+static FilePermissionFilePermission.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static FilePermission[]FilePermission.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.xfer that return types with arguments of type FilePermission
+static Set<FilePermission>FilePermission.fromMask(int mask) + +
+           
+  +

+ + + + + + + + + +
Method parameters in net.schmizz.sshj.xfer with type arguments of type FilePermission
+static intFilePermission.toMask(Set<FilePermission> perms) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/FileSystemFile.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/FileSystemFile.html new file mode 100644 index 00000000..849d9b89 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/FileSystemFile.html @@ -0,0 +1,213 @@ + + + + + + + +Uses of Class net.schmizz.sshj.xfer.FileSystemFile (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.xfer.FileSystemFile

+
+ + + + + + + + + +
+Packages that use FileSystemFile
net.schmizz.sshj.xfer  
+  +

+ + + + + +
+Uses of FileSystemFile in net.schmizz.sshj.xfer
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.xfer that return FileSystemFile
+ FileSystemFileFileSystemFile.getChild(String name) + +
+           
+ FileSystemFileFileSystemFile.getTargetDirectory(String dirname) + +
+           
+ FileSystemFileFileSystemFile.getTargetFile(String filename) + +
+           
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.xfer that return types with arguments of type FileSystemFile
+ Iterable<FileSystemFile>FileSystemFile.getChildren(LocalFileFilter filter) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/FileTransfer.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/FileTransfer.html new file mode 100644 index 00000000..03e04a29 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/FileTransfer.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.xfer.FileTransfer (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.xfer.FileTransfer

+
+ + + + + + + + + + + + + +
+Packages that use FileTransfer
net.schmizz.sshj.sftp  
net.schmizz.sshj.xfer.scp  
+  +

+ + + + + +
+Uses of FileTransfer in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.sftp that implement FileTransfer
+ classSFTPFileTransfer + +
+           
+  +

+ + + + + +
+Uses of FileTransfer in net.schmizz.sshj.xfer.scp
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.xfer.scp that implement FileTransfer
+ classSCPFileTransfer + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/InMemoryDestFile.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/InMemoryDestFile.html new file mode 100644 index 00000000..b1df73fc --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/InMemoryDestFile.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class net.schmizz.sshj.xfer.InMemoryDestFile (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.xfer.InMemoryDestFile

+
+ + + + + + + + + +
+Packages that use InMemoryDestFile
net.schmizz.sshj.xfer  
+  +

+ + + + + +
+Uses of InMemoryDestFile in net.schmizz.sshj.xfer
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.xfer that return InMemoryDestFile
+ InMemoryDestFileInMemoryDestFile.getTargetFile(String filename) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/InMemorySourceFile.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/InMemorySourceFile.html new file mode 100644 index 00000000..19e3da52 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/InMemorySourceFile.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.xfer.InMemorySourceFile (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.xfer.InMemorySourceFile

+
+No usage of net.schmizz.sshj.xfer.InMemorySourceFile +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/LocalDestFile.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/LocalDestFile.html new file mode 100644 index 00000000..9414c216 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/LocalDestFile.html @@ -0,0 +1,332 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.xfer.LocalDestFile (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.xfer.LocalDestFile

+
+ + + + + + + + + + + + + + + + + +
+Packages that use LocalDestFile
net.schmizz.sshj.sftp  
net.schmizz.sshj.xfer  
net.schmizz.sshj.xfer.scp  
+  +

+ + + + + +
+Uses of LocalDestFile in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp with parameters of type LocalDestFile
+ voidSFTPFileTransfer.download(String source, + LocalDestFile dest) + +
+           
+ voidSFTPClient.get(String source, + LocalDestFile dest) + +
+           
+  +

+ + + + + +
+Uses of LocalDestFile in net.schmizz.sshj.xfer
+  +

+ + + + + + + + + + + + + +
Classes in net.schmizz.sshj.xfer that implement LocalDestFile
+ classFileSystemFile + +
+           
+ classInMemoryDestFile + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.xfer that return LocalDestFile
+ LocalDestFileLocalDestFile.getChild(String name) + +
+           
+ LocalDestFileInMemoryDestFile.getChild(String name) + +
+           
+ LocalDestFileLocalDestFile.getTargetDirectory(String dirname) + +
+          Allows caller to express intent that caller expects to write to directory with dirname.
+ LocalDestFileInMemoryDestFile.getTargetDirectory(String dirname) + +
+           
+ LocalDestFileLocalDestFile.getTargetFile(String filename) + +
+          Allows caller to express intent that caller expects to write to file with filename.
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.xfer with parameters of type LocalDestFile
+ voidFileTransfer.download(String remotePath, + LocalDestFile localFile) + +
+           
+  +

+ + + + + +
+Uses of LocalDestFile in net.schmizz.sshj.xfer.scp
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.xfer.scp with parameters of type LocalDestFile
+ intSCPDownloadClient.copy(String sourcePath, + LocalDestFile targetFile) + +
+          Download a file from sourcePath on the connected host to targetPath locally.
+ voidSCPFileTransfer.download(String remotePath, + LocalDestFile localFile) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/LocalFileFilter.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/LocalFileFilter.html new file mode 100644 index 00000000..cc759c3a --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/LocalFileFilter.html @@ -0,0 +1,242 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.xfer.LocalFileFilter (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.xfer.LocalFileFilter

+
+ + + + + + + + + + + + + +
+Packages that use LocalFileFilter
net.schmizz.sshj.sftp  
net.schmizz.sshj.xfer  
+  +

+ + + + + +
+Uses of LocalFileFilter in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.sftp that return LocalFileFilter
+ LocalFileFilterSFTPFileTransfer.getUploadFilter() + +
+           
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.sftp with parameters of type LocalFileFilter
+ voidSFTPFileTransfer.setUploadFilter(LocalFileFilter uploadFilter) + +
+           
+  +

+ + + + + +
+Uses of LocalFileFilter in net.schmizz.sshj.xfer
+  +

+ + + + + + + + + + + + + + + + + +
Methods in net.schmizz.sshj.xfer with parameters of type LocalFileFilter
+ Iterable<? extends LocalSourceFile>LocalSourceFile.getChildren(LocalFileFilter filter) + +
+           
+ Iterable<? extends LocalSourceFile>InMemorySourceFile.getChildren(LocalFileFilter filter) + +
+           
+ Iterable<FileSystemFile>FileSystemFile.getChildren(LocalFileFilter filter) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/LocalSourceFile.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/LocalSourceFile.html new file mode 100644 index 00000000..1901b902 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/LocalSourceFile.html @@ -0,0 +1,316 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.xfer.LocalSourceFile (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.xfer.LocalSourceFile

+
+ + + + + + + + + + + + + + + + + +
+Packages that use LocalSourceFile
net.schmizz.sshj.sftp  
net.schmizz.sshj.xfer  
net.schmizz.sshj.xfer.scp  
+  +

+ + + + + +
+Uses of LocalSourceFile in net.schmizz.sshj.sftp
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.sftp with parameters of type LocalSourceFile
+ voidSFTPClient.put(LocalSourceFile source, + String dest) + +
+           
+ voidSFTPFileTransfer.upload(LocalSourceFile localFile, + String remotePath) + +
+           
+  +

+ + + + + +
+Uses of LocalSourceFile in net.schmizz.sshj.xfer
+  +

+ + + + + + + + + + + + + +
Classes in net.schmizz.sshj.xfer that implement LocalSourceFile
+ classFileSystemFile + +
+           
+ classInMemorySourceFile + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.xfer that return types with arguments of type LocalSourceFile
+ Iterable<? extends LocalSourceFile>LocalSourceFile.getChildren(LocalFileFilter filter) + +
+           
+ Iterable<? extends LocalSourceFile>InMemorySourceFile.getChildren(LocalFileFilter filter) + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.xfer with parameters of type LocalSourceFile
+ booleanLocalFileFilter.accept(LocalSourceFile file) + +
+           
+ voidFileTransfer.upload(LocalSourceFile localFile, + String remotePath) + +
+           
+  +

+ + + + + +
+Uses of LocalSourceFile in net.schmizz.sshj.xfer.scp
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.xfer.scp with parameters of type LocalSourceFile
+ intSCPUploadClient.copy(LocalSourceFile sourceFile, + String remotePath) + +
+          Upload a local file from localFile to targetPath on the remote host.
+ voidSCPFileTransfer.upload(LocalSourceFile localFile, + String remotePath) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/LoggingTransferListener.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/LoggingTransferListener.html new file mode 100644 index 00000000..8448ffc1 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/LoggingTransferListener.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class net.schmizz.sshj.xfer.LoggingTransferListener (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.xfer.LoggingTransferListener

+
+ + + + + + + + + +
+Packages that use LoggingTransferListener
net.schmizz.sshj.xfer  
+  +

+ + + + + +
+Uses of LoggingTransferListener in net.schmizz.sshj.xfer
+  +

+ + + + + + + + + +
Fields in net.schmizz.sshj.xfer declared as LoggingTransferListener
+static LoggingTransferListenerAbstractFileTransfer.LOGGING_TRANSFER_LISTENER + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/TransferListener.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/TransferListener.html new file mode 100644 index 00000000..b3768026 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/class-use/TransferListener.html @@ -0,0 +1,229 @@ + + + + + + + +Uses of Interface net.schmizz.sshj.xfer.TransferListener (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
net.schmizz.sshj.xfer.TransferListener

+
+ + + + + + + + + +
+Packages that use TransferListener
net.schmizz.sshj.xfer  
+  +

+ + + + + +
+Uses of TransferListener in net.schmizz.sshj.xfer
+  +

+ + + + + + + + + +
Classes in net.schmizz.sshj.xfer that implement TransferListener
+ classLoggingTransferListener + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.xfer that return TransferListener
+ TransferListenerFileTransfer.getTransferListener() + +
+           
+ TransferListenerAbstractFileTransfer.getTransferListener() + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in net.schmizz.sshj.xfer with parameters of type TransferListener
+ voidFileTransfer.setTransferListener(TransferListener listener) + +
+           
+ voidAbstractFileTransfer.setTransferListener(TransferListener transferListener) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/package-frame.html new file mode 100644 index 00000000..a280dd56 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/package-frame.html @@ -0,0 +1,71 @@ + + + + + + + +net.schmizz.sshj.xfer (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.xfer + + + + +
+Interfaces  + +
+FileTransfer +
+LocalDestFile +
+LocalFileFilter +
+LocalSourceFile +
+TransferListener
+ + + + + + +
+Classes  + +
+AbstractFileTransfer +
+FileSystemFile +
+InMemoryDestFile +
+InMemorySourceFile +
+LoggingTransferListener
+ + + + + + +
+Enums  + +
+FilePermission
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/package-summary.html new file mode 100644 index 00000000..e7bc7ed3 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/package-summary.html @@ -0,0 +1,218 @@ + + + + + + + +net.schmizz.sshj.xfer (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.xfer +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Interface Summary
FileTransfer 
LocalDestFile 
LocalFileFilter 
LocalSourceFile 
TransferListener 
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
AbstractFileTransfer 
FileSystemFile 
InMemoryDestFile 
InMemorySourceFile 
LoggingTransferListener 
+  + +

+ + + + + + + + + +
+Enum Summary
FilePermission 
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/package-tree.html new file mode 100644 index 00000000..61a64885 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/package-tree.html @@ -0,0 +1,175 @@ + + + + + + + +net.schmizz.sshj.xfer Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.xfer +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/package-use.html new file mode 100644 index 00000000..aa3a65e8 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/package-use.html @@ -0,0 +1,299 @@ + + + + + + + +Uses of Package net.schmizz.sshj.xfer (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.xfer

+
+ + + + + + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.xfer
net.schmizz.sshj.sftp  
net.schmizz.sshj.xfer  
net.schmizz.sshj.xfer.scp  
+  +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.xfer used by net.schmizz.sshj.sftp
AbstractFileTransfer + +
+           
FilePermission + +
+           
FileTransfer + +
+           
LocalDestFile + +
+           
LocalFileFilter + +
+           
LocalSourceFile + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.xfer used by net.schmizz.sshj.xfer
FilePermission + +
+           
FileSystemFile + +
+           
InMemoryDestFile + +
+           
LocalDestFile + +
+           
LocalFileFilter + +
+           
LocalSourceFile + +
+           
LoggingTransferListener + +
+           
TransferListener + +
+           
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in net.schmizz.sshj.xfer used by net.schmizz.sshj.xfer.scp
AbstractFileTransfer + +
+           
FileTransfer + +
+           
LocalDestFile + +
+           
LocalSourceFile + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/SCPDownloadClient.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/SCPDownloadClient.html new file mode 100644 index 00000000..cd46ea96 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/SCPDownloadClient.html @@ -0,0 +1,269 @@ + + + + + + + +SCPDownloadClient (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.xfer.scp +
+Class SCPDownloadClient

+
+java.lang.Object
+  extended by net.schmizz.sshj.xfer.scp.SCPDownloadClient
+
+
+
+
public final class SCPDownloadClient
extends Object
+ + +

+Support for uploading files over a connected link using SCP. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intcopy(String sourcePath, + LocalDestFile targetFile) + +
+          Download a file from sourcePath on the connected host to targetPath locally.
+ booleangetRecursiveMode() + +
+           
+ voidsetRecursiveMode(boolean recursive) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Method Detail
+ +

+copy

+
+public int copy(String sourcePath,
+                LocalDestFile targetFile)
+         throws IOException
+
+
Download a file from sourcePath on the connected host to targetPath locally. +

+

+ +
Throws: +
IOException
+
+
+
+ +

+getRecursiveMode

+
+public boolean getRecursiveMode()
+
+
+
+
+
+
+ +

+setRecursiveMode

+
+public void setRecursiveMode(boolean recursive)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/SCPException.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/SCPException.html new file mode 100644 index 00000000..dd3dcfee --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/SCPException.html @@ -0,0 +1,286 @@ + + + + + + + +SCPException (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.xfer.scp +
+Class SCPException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by net.schmizz.sshj.common.SSHException
+                  extended by net.schmizz.sshj.xfer.scp.SCPException
+
+
+
All Implemented Interfaces:
Serializable
+
+
+
+
public class SCPException
extends SSHException
+ + +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.common.SSHException
chainer
+  + + + + + + + + + + + + + +
+Constructor Summary
SCPException(String message) + +
+           
SCPException(String message, + Throwable cause) + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.common.SSHException
getDisconnectReason, getMessage, toString
+ + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SCPException

+
+public SCPException(String message)
+
+
+
+ +

+SCPException

+
+public SCPException(String message,
+                    Throwable cause)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/SCPFileTransfer.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/SCPFileTransfer.html new file mode 100644 index 00000000..3a927187 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/SCPFileTransfer.html @@ -0,0 +1,426 @@ + + + + + + + +SCPFileTransfer (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.xfer.scp +
+Class SCPFileTransfer

+
+java.lang.Object
+  extended by net.schmizz.sshj.xfer.AbstractFileTransfer
+      extended by net.schmizz.sshj.xfer.scp.SCPFileTransfer
+
+
+
All Implemented Interfaces:
FileTransfer
+
+
+
+
public class SCPFileTransfer
extends AbstractFileTransfer
implements FileTransfer
+ + +

+


+ +

+ + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class net.schmizz.sshj.xfer.AbstractFileTransfer
log, LOGGING_TRANSFER_LISTENER
+  + + + + + + + + + + +
+Constructor Summary
SCPFileTransfer(SessionFactory sessionFactory) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddownload(String remotePath, + LocalDestFile localFile) + +
+           
+ voiddownload(String remotePath, + String localPath) + +
+           
+ SCPDownloadClientnewSCPDownloadClient() + +
+           
+ SCPUploadClientnewSCPUploadClient() + +
+           
+ voidupload(LocalSourceFile localFile, + String remotePath) + +
+           
+ voidupload(String localPath, + String remotePath) + +
+           
+ + + + + + + +
Methods inherited from class net.schmizz.sshj.xfer.AbstractFileTransfer
getTransferListener, setTransferListener
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ + + + + + + +
Methods inherited from interface net.schmizz.sshj.xfer.FileTransfer
getTransferListener, setTransferListener
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SCPFileTransfer

+
+public SCPFileTransfer(SessionFactory sessionFactory)
+
+
+ + + + + + + + +
+Method Detail
+ +

+newSCPDownloadClient

+
+public SCPDownloadClient newSCPDownloadClient()
+
+
+
+
+
+
+
+
+
+ +

+newSCPUploadClient

+
+public SCPUploadClient newSCPUploadClient()
+
+
+
+
+
+
+
+
+
+ +

+upload

+
+public void upload(String localPath,
+                   String remotePath)
+            throws IOException
+
+
+
Specified by:
upload in interface FileTransfer
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+download

+
+public void download(String remotePath,
+                     String localPath)
+              throws IOException
+
+
+
Specified by:
download in interface FileTransfer
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+download

+
+public void download(String remotePath,
+                     LocalDestFile localFile)
+              throws IOException
+
+
+
Specified by:
download in interface FileTransfer
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+upload

+
+public void upload(LocalSourceFile localFile,
+                   String remotePath)
+            throws IOException
+
+
+
Specified by:
upload in interface FileTransfer
+
+
+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/SCPUploadClient.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/SCPUploadClient.html new file mode 100644 index 00000000..1d5d3757 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/SCPUploadClient.html @@ -0,0 +1,231 @@ + + + + + + + +SCPUploadClient (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.schmizz.sshj.xfer.scp +
+Class SCPUploadClient

+
+java.lang.Object
+  extended by net.schmizz.sshj.xfer.scp.SCPUploadClient
+
+
+
+
public final class SCPUploadClient
extends Object
+ + +

+Support for uploading files over a connected link using SCP. +

+ +

+


+ +

+ + + + + + + + + + + + +
+Method Summary
+ intcopy(LocalSourceFile sourceFile, + String remotePath) + +
+          Upload a local file from localFile to targetPath on the remote host.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Method Detail
+ +

+copy

+
+public int copy(LocalSourceFile sourceFile,
+                String remotePath)
+         throws IOException
+
+
Upload a local file from localFile to targetPath on the remote host. +

+

+ +
Throws: +
IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/class-use/SCPDownloadClient.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/class-use/SCPDownloadClient.html new file mode 100644 index 00000000..d64ca727 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/class-use/SCPDownloadClient.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class net.schmizz.sshj.xfer.scp.SCPDownloadClient (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.xfer.scp.SCPDownloadClient

+
+ + + + + + + + + +
+Packages that use SCPDownloadClient
net.schmizz.sshj.xfer.scp  
+  +

+ + + + + +
+Uses of SCPDownloadClient in net.schmizz.sshj.xfer.scp
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.xfer.scp that return SCPDownloadClient
+ SCPDownloadClientSCPFileTransfer.newSCPDownloadClient() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/class-use/SCPException.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/class-use/SCPException.html new file mode 100644 index 00000000..7e15eb2e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/class-use/SCPException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class net.schmizz.sshj.xfer.scp.SCPException (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.xfer.scp.SCPException

+
+No usage of net.schmizz.sshj.xfer.scp.SCPException +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/class-use/SCPFileTransfer.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/class-use/SCPFileTransfer.html new file mode 100644 index 00000000..6e56cf39 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/class-use/SCPFileTransfer.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class net.schmizz.sshj.xfer.scp.SCPFileTransfer (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.xfer.scp.SCPFileTransfer

+
+ + + + + + + + + +
+Packages that use SCPFileTransfer
net.schmizz.sshj  
+  +

+ + + + + +
+Uses of SCPFileTransfer in net.schmizz.sshj
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj that return SCPFileTransfer
+ SCPFileTransferSSHClient.newSCPFileTransfer() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/class-use/SCPUploadClient.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/class-use/SCPUploadClient.html new file mode 100644 index 00000000..be85b99d --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/class-use/SCPUploadClient.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class net.schmizz.sshj.xfer.scp.SCPUploadClient (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
net.schmizz.sshj.xfer.scp.SCPUploadClient

+
+ + + + + + + + + +
+Packages that use SCPUploadClient
net.schmizz.sshj.xfer.scp  
+  +

+ + + + + +
+Uses of SCPUploadClient in net.schmizz.sshj.xfer.scp
+  +

+ + + + + + + + + +
Methods in net.schmizz.sshj.xfer.scp that return SCPUploadClient
+ SCPUploadClientSCPFileTransfer.newSCPUploadClient() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/package-frame.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/package-frame.html new file mode 100644 index 00000000..e1d0a53e --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/package-frame.html @@ -0,0 +1,48 @@ + + + + + + + +net.schmizz.sshj.xfer.scp (sshj 0.4.1 API) + + + + + + + + + + + +net.schmizz.sshj.xfer.scp + + + + +
+Classes  + +
+SCPDownloadClient +
+SCPFileTransfer +
+SCPUploadClient
+ + + + + + +
+Exceptions  + +
+SCPException
+ + + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/package-summary.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/package-summary.html new file mode 100644 index 00000000..3c85ebbf --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/package-summary.html @@ -0,0 +1,180 @@ + + + + + + + +net.schmizz.sshj.xfer.scp (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package net.schmizz.sshj.xfer.scp +

+ + + + + + + + + + + + + + + + + +
+Class Summary
SCPDownloadClientSupport for uploading files over a connected link using SCP.
SCPFileTransfer 
SCPUploadClientSupport for uploading files over a connected link using SCP.
+  + +

+ + + + + + + + + +
+Exception Summary
SCPException 
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/package-tree.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/package-tree.html new file mode 100644 index 00000000..2cd2c123 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/package-tree.html @@ -0,0 +1,166 @@ + + + + + + + +net.schmizz.sshj.xfer.scp Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package net.schmizz.sshj.xfer.scp +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/package-use.html b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/package-use.html new file mode 100644 index 00000000..f7cf7065 --- /dev/null +++ b/javadoc/0.4.1/net/schmizz/sshj/xfer/scp/package-use.html @@ -0,0 +1,196 @@ + + + + + + + +Uses of Package net.schmizz.sshj.xfer.scp (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
net.schmizz.sshj.xfer.scp

+
+ + + + + + + + + + + + + +
+Packages that use net.schmizz.sshj.xfer.scp
net.schmizz.sshj  
net.schmizz.sshj.xfer.scp  
+  +

+ + + + + + + + +
+Classes in net.schmizz.sshj.xfer.scp used by net.schmizz.sshj
SCPFileTransfer + +
+           
+  +

+ + + + + + + + + + + +
+Classes in net.schmizz.sshj.xfer.scp used by net.schmizz.sshj.xfer.scp
SCPDownloadClient + +
+          Support for uploading files over a connected link using SCP.
SCPUploadClient + +
+          Support for uploading files over a connected link using SCP.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/overview-frame.html b/javadoc/0.4.1/overview-frame.html new file mode 100644 index 00000000..807ffc6f --- /dev/null +++ b/javadoc/0.4.1/overview-frame.html @@ -0,0 +1,89 @@ + + + + + + + +Overview List (sshj 0.4.1 API) + + + + + + + + + + + + + + + +
+
+ + + + + +
All Classes +

+ +Packages +
+examples +
+net.schmizz.concurrent +
+net.schmizz.sshj +
+net.schmizz.sshj.common +
+net.schmizz.sshj.connection +
+net.schmizz.sshj.connection.channel +
+net.schmizz.sshj.connection.channel.direct +
+net.schmizz.sshj.connection.channel.forwarded +
+net.schmizz.sshj.sftp +
+net.schmizz.sshj.signature +
+net.schmizz.sshj.transport +
+net.schmizz.sshj.transport.cipher +
+net.schmizz.sshj.transport.compression +
+net.schmizz.sshj.transport.digest +
+net.schmizz.sshj.transport.kex +
+net.schmizz.sshj.transport.mac +
+net.schmizz.sshj.transport.random +
+net.schmizz.sshj.transport.verification +
+net.schmizz.sshj.userauth +
+net.schmizz.sshj.userauth.keyprovider +
+net.schmizz.sshj.userauth.method +
+net.schmizz.sshj.userauth.password +
+net.schmizz.sshj.xfer +
+net.schmizz.sshj.xfer.scp +
+

+ +

+  + + diff --git a/javadoc/0.4.1/overview-summary.html b/javadoc/0.4.1/overview-summary.html new file mode 100644 index 00000000..7d4b150a --- /dev/null +++ b/javadoc/0.4.1/overview-summary.html @@ -0,0 +1,249 @@ + + + + + + + +Overview (sshj 0.4.1 API) + + + + + + + + + + + + +


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+sshj 0.4.1 API +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages
examples 
net.schmizz.concurrent 
net.schmizz.sshj 
net.schmizz.sshj.common 
net.schmizz.sshj.connection 
net.schmizz.sshj.connection.channel 
net.schmizz.sshj.connection.channel.direct 
net.schmizz.sshj.connection.channel.forwarded 
net.schmizz.sshj.sftp 
net.schmizz.sshj.signature 
net.schmizz.sshj.transport 
net.schmizz.sshj.transport.cipher 
net.schmizz.sshj.transport.compression 
net.schmizz.sshj.transport.digest 
net.schmizz.sshj.transport.kex 
net.schmizz.sshj.transport.mac 
net.schmizz.sshj.transport.random 
net.schmizz.sshj.transport.verification 
net.schmizz.sshj.userauth 
net.schmizz.sshj.userauth.keyprovider 
net.schmizz.sshj.userauth.method 
net.schmizz.sshj.userauth.password 
net.schmizz.sshj.xfer 
net.schmizz.sshj.xfer.scp 
+ +


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/overview-tree.html b/javadoc/0.4.1/overview-tree.html new file mode 100644 index 00000000..57f929bc --- /dev/null +++ b/javadoc/0.4.1/overview-tree.html @@ -0,0 +1,334 @@ + + + + + + + +Class Hierarchy (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For All Packages

+
+
+
Package Hierarchies:
examples, net.schmizz.concurrent, net.schmizz.sshj, net.schmizz.sshj.common, net.schmizz.sshj.connection, net.schmizz.sshj.connection.channel, net.schmizz.sshj.connection.channel.direct, net.schmizz.sshj.connection.channel.forwarded, net.schmizz.sshj.sftp, net.schmizz.sshj.signature, net.schmizz.sshj.transport, net.schmizz.sshj.transport.cipher, net.schmizz.sshj.transport.compression, net.schmizz.sshj.transport.digest, net.schmizz.sshj.transport.kex, net.schmizz.sshj.transport.mac, net.schmizz.sshj.transport.random, net.schmizz.sshj.transport.verification, net.schmizz.sshj.userauth, net.schmizz.sshj.userauth.keyprovider, net.schmizz.sshj.userauth.method, net.schmizz.sshj.userauth.password, net.schmizz.sshj.xfer, net.schmizz.sshj.xfer.scp
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/package-list b/javadoc/0.4.1/package-list new file mode 100644 index 00000000..6eaeafe7 --- /dev/null +++ b/javadoc/0.4.1/package-list @@ -0,0 +1,24 @@ +examples +net.schmizz.concurrent +net.schmizz.sshj +net.schmizz.sshj.common +net.schmizz.sshj.connection +net.schmizz.sshj.connection.channel +net.schmizz.sshj.connection.channel.direct +net.schmizz.sshj.connection.channel.forwarded +net.schmizz.sshj.sftp +net.schmizz.sshj.signature +net.schmizz.sshj.transport +net.schmizz.sshj.transport.cipher +net.schmizz.sshj.transport.compression +net.schmizz.sshj.transport.digest +net.schmizz.sshj.transport.kex +net.schmizz.sshj.transport.mac +net.schmizz.sshj.transport.random +net.schmizz.sshj.transport.verification +net.schmizz.sshj.userauth +net.schmizz.sshj.userauth.keyprovider +net.schmizz.sshj.userauth.method +net.schmizz.sshj.userauth.password +net.schmizz.sshj.xfer +net.schmizz.sshj.xfer.scp diff --git a/javadoc/0.4.1/resources/inherit.gif b/javadoc/0.4.1/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/javadoc/0.4.1/resources/inherit.gif differ diff --git a/javadoc/0.4.1/serialized-form.html b/javadoc/0.4.1/serialized-form.html new file mode 100644 index 00000000..1ed10355 --- /dev/null +++ b/javadoc/0.4.1/serialized-form.html @@ -0,0 +1,366 @@ + + + + + + + +Serialized Form (sshj 0.4.1 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Serialized Form

+
+
+ + + + + +
+Package net.schmizz.sshj.common
+ +

+ + + + + +
+Class net.schmizz.sshj.common.Buffer.BufferException extends SSHException implements Serializable
+ +

+ +

+ + + + + +
+Class net.schmizz.sshj.common.SSHException extends IOException implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+reason

+
+DisconnectReason reason
+
+
+
+
+ +

+ + + + + +
+Class net.schmizz.sshj.common.SSHRuntimeException extends RuntimeException implements Serializable
+ +

+


+ + + + + +
+Package net.schmizz.sshj.connection
+ +

+ + + + + +
+Class net.schmizz.sshj.connection.ConnectionException extends SSHException implements Serializable
+ +

+


+ + + + + +
+Package net.schmizz.sshj.connection.channel
+ +

+ + + + + +
+Class net.schmizz.sshj.connection.channel.OpenFailException extends ConnectionException implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+channelType

+
+String channelType
+
+
+
+
+
+

+reason

+
+OpenFailException.Reason reason
+
+
+
+
+
+

+message

+
+String message
+
+
+
+
+
+ + + + + +
+Package net.schmizz.sshj.sftp
+ +

+ + + + + +
+Class net.schmizz.sshj.sftp.SFTPException extends SSHException implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+sc

+
+Response.StatusCode sc
+
+
+
+
+
+ + + + + +
+Package net.schmizz.sshj.transport
+ +

+ + + + + +
+Class net.schmizz.sshj.transport.TransportException extends SSHException implements Serializable
+ +

+


+ + + + + +
+Package net.schmizz.sshj.userauth
+ +

+ + + + + +
+Class net.schmizz.sshj.userauth.UserAuthException extends SSHException implements Serializable
+ +

+


+ + + + + +
+Package net.schmizz.sshj.xfer.scp
+ +

+ + + + + +
+Class net.schmizz.sshj.xfer.scp.SCPException extends SSHException implements Serializable
+ +

+ +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2009-2011. All Rights Reserved. + + diff --git a/javadoc/0.4.1/stylesheet.css b/javadoc/0.4.1/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/javadoc/0.4.1/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +