public class

HTTPProxyData

extends Object
implements ProxyData
java.lang.Object
   ↳ com.trilead.ssh2.HTTPProxyData

Class Overview

A HTTPProxyData object is used to specify the needed connection data to connect through a HTTP proxy.

See Also

Summary

Fields
public final String proxyHost
public final String proxyPass
public final int proxyPort
public final String proxyUser
public final String[] requestHeaderLines
Public Constructors
HTTPProxyData(String proxyHost, int proxyPort)
Same as calling HTTPProxyData(proxyHost, proxyPort, null, null)
HTTPProxyData(String proxyHost, int proxyPort, String proxyUser, String proxyPass)
Same as calling HTTPProxyData(proxyHost, proxyPort, null, null, null)
HTTPProxyData(String proxyHost, int proxyPort, String proxyUser, String proxyPass, String[] requestHeaderLines)
Connection data for a HTTP proxy.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public final String proxyHost

public final String proxyPass

public final int proxyPort

public final String proxyUser

public final String[] requestHeaderLines

Public Constructors

public HTTPProxyData (String proxyHost, int proxyPort)

Same as calling HTTPProxyData(proxyHost, proxyPort, null, null)

Parameters
proxyHost Proxy hostname.
proxyPort Proxy port.

public HTTPProxyData (String proxyHost, int proxyPort, String proxyUser, String proxyPass)

Same as calling HTTPProxyData(proxyHost, proxyPort, null, null, null)

Parameters
proxyHost Proxy hostname.
proxyPort Proxy port.
proxyUser Username for basic authentication (null if no authentication is needed).
proxyPass Password for basic authentication (null if no authentication is needed).

public HTTPProxyData (String proxyHost, int proxyPort, String proxyUser, String proxyPass, String[] requestHeaderLines)

Connection data for a HTTP proxy. It is possible to specify a username and password if the proxy requires basic authentication. Also, additional request header lines can be specified (e.g., "User-Agent: CERN-LineMode/2.15 libwww/2.17b3").

Please note: if you want to use basic authentication, then both proxyUser and proxyPass must be non-null.

Here is an example:

new HTTPProxyData("192.168.1.1", "3128", "proxyuser", "secret", new String[] {"User-Agent: TrileadBasedClient/1.0", "X-My-Proxy-Option: something"});

Parameters
proxyHost Proxy hostname.
proxyPort Proxy port.
proxyUser Username for basic authentication (null if no authentication is needed).
proxyPass Password for basic authentication (null if no authentication is needed).
requestHeaderLines An array with additional request header lines (without end-of-line markers) that have to be sent to the server. May be null.