Class HttpProxyConnector

java.lang.Object

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

org.apache.sshd.client.session.proxy.HttpProxyConnector

All Implemented Interfaces:

Closeable, AutoCloseable

public class HttpProxyConnector
extends AbstractProxyConnector

Simple HTTP proxy connector supporting Basic and SPNEGO Authentication.

Field Summary

Fields inherited from class AbstractProxyConnector

done, proxyAddress, proxyPassword, proxyUser, remoteAddress

Constructor Summary

Constructors

Constructor	Description
HttpProxyConnector(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 HttpProxyConnector.

Method Summary

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

Methods inherited from class AbstractProxyConnector

clearPassword, isDone, passwordAuthentication, write

Methods inherited from class Object

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

Constructor Details

HttpProxyConnector

public HttpProxyConnector(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 HttpProxyConnector. The connector supports anonymous proxy connections as well as Basic and Negotiate (SPNEGO) authentication.

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

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class AbstractProxyConnector

start

public void start()
           throws IOException

Description copied from class: AbstractProxyConnector

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

Specified by:

start in class AbstractProxyConnector

Throws:

IOException - if the message cannot be sent

received

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

Description copied from class: AbstractProxyConnector

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

Specified by:

received in class AbstractProxyConnector

Parameters:

buffer - the received data

Throws:

Exception - if an error occurs