com.jcraft.jsch

Interface Proxy

All Known Implementing Classes:

ProxyHTTP, ProxySOCKS4, ProxySOCKS5

public interface Proxy

Allows routing connections through some proxy.

A Proxy object creates a Socket and it's two streams for a remote server. It typically does this by first connecting to a proxy server, negiotiating some conditions (or providing a password) and then returning the streams as the connection will be forwarded to the target host.

The library (i.e. Session) uses a proxy only if given with setProxy before connecting. When connecting, it will use the methods defined in this interface (except close), and it will invoke close() on disconnecting.

Some implementing classes for common proxy types are delivered with the library: ProxyHTTP, ProxySOCKS4, ProxySOCKS5. An application might also create their own implementations and provide these to the session before connecting.

See Also:

Session.setProxy(com.jcraft.jsch.Proxy)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection.
void	connect(SocketFactory socket_factory, String host, int port, int timeout) Opens a connection to the target server.
InputStream	getInputStream() Returns an InputStream to read data from the remote server.
OutputStream	getOutputStream() Returns an OutputStream to write data to the remote server.
Socket	getSocket() Returns the socket used for the connection.

Method Detail

connect

void connect(SocketFactory socket_factory,
             String host,
             int port,
             int timeout)
      throws Exception

Opens a connection to the target server. After successful invocation of this method the other methods can be called to retrieve the results.

Parameters:

socket_factory - a factory for sockets. Might be null, then the implementation will use plain sockets.

host - the SSH server host we want to connect to.

port - the port at the SSH server.

timeout - how long to wait maximally for a connection, in milliseconds. If 0, wait as long as needed.

Throws:

Exception - if it was not possible to create the connection to the target host for some reason.

getInputStream

InputStream getInputStream()

Returns an InputStream to read data from the remote server. If the SSH protocol is tunneled through another protocol for proxying purposes, this InputStream has to do the unwrapping.

getOutputStream

OutputStream getOutputStream()

Returns an OutputStream to write data to the remote server. If the SSH protocol is tunneled through another protocol for proxying purposes, this OutputStream has to do the wrapping.

getSocket

Socket getSocket()

Returns the socket used for the connection. This will only be used for timeout-configurations.

close

void close()

Closes the connection. This should close the underlying socket as well.