Class AbstractProxyConnector

java.lang.Object

org.apache.sshd.client.session.proxy.AbstractProxyConnector

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

HttpProxyConnector, Socks5ProxyConnector

public abstract class AbstractProxyConnector
extends Object
implements Closeable

Basic common functionality for tunneling through to a proxy.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	done
protected final InetSocketAddress	proxyAddress	The proxy address.
protected char[]	proxyPassword
protected String	proxyUser
protected final InetSocketAddress	remoteAddress	The ultimate remote address to connect to.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractProxyConnector(ProxyData proxy, InetSocketAddress remoteAddress, org.apache.sshd.common.util.io.functors.IOFunction<org.apache.sshd.common.util.buffer.Buffer, org.apache.sshd.common.io.IoWriteFuture> send, Function<InetSocketAddress, PasswordAuthentication> passwordAuth)	Creates a new AbstractProxyConnector.

Method Summary

Modifier and Type	Method	Description
protected void	clearPassword()
void	close()
boolean	isDone()
protected PasswordAuthentication	passwordAuthentication()
abstract org.apache.sshd.common.util.buffer.Buffer	received(org.apache.sshd.common.util.Readable message)	Processes incoming data, and returns a Buffer containing any extra data from message that was not yet processed.
abstract void	start()	Starts the proxy protocol by sending the initial connection request message to the proxy.
protected org.apache.sshd.common.io.IoWriteFuture	write(org.apache.sshd.common.util.buffer.Buffer message)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

proxyAddress

protected final InetSocketAddress proxyAddress

The proxy address.

remoteAddress

protected final InetSocketAddress remoteAddress

The ultimate remote address to connect to.

proxyUser

protected String proxyUser

proxyPassword

protected char[] proxyPassword

done

protected boolean done

Constructor Details

AbstractProxyConnector

protected AbstractProxyConnector(ProxyData proxy,
 InetSocketAddress remoteAddress,
 org.apache.sshd.common.util.io.functors.IOFunction<org.apache.sshd.common.util.buffer.Buffer, org.apache.sshd.common.io.IoWriteFuture> send,
 Function<InetSocketAddress, PasswordAuthentication> passwordAuth)

Creates a new AbstractProxyConnector.

Parameters:

proxy - ProxyData of the proxy we're connected to

remoteAddress - InetSocketAddress of the target server to connect to

send - a function to send data and returning an IoWriteFuture

passwordAuth - a function to query the user for proxy credentials, if needed, and returning a PasswordAuthentication

Method Details

write

protected org.apache.sshd.common.io.IoWriteFuture write(org.apache.sshd.common.util.buffer.Buffer message)
                                                 throws IOException

Throws:

IOException

passwordAuthentication

protected PasswordAuthentication passwordAuthentication()

clearPassword

protected void clearPassword()

isDone

public boolean isDone()

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

received

public abstract org.apache.sshd.common.util.buffer.Buffer received(org.apache.sshd.common.util.Readable message)
                                                            throws Exception

Processes incoming data, and returns a Buffer containing any extra data from message that was not yet processed.

Parameters:

message - the received data

Throws:

Exception - if an error occurs

start

public abstract void start()
                    throws IOException

Starts the proxy protocol by sending the initial connection request message to the proxy.

Throws:

IOException - if the message cannot be sent