ipworksssl
Class Proxy

java.lang.Object
  ipworksssl.Proxy

public class Proxy
extends java.lang.Object

The proxy the bean will connect to.

When connecting through a proxy, this type is used to specify different properties of the proxy such as the Server and the AuthScheme .

AuthScheme: This field is used to tell the bean which type of authorization to perform when connecting to the proxy. This is only used when the User and Password fields are set.

AuthScheme should be set to authNone (3) when no authentication is expected.

By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication.

If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the bean. Look at the configuration file for the bean being used to find more information about manually setting this token.

If AuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this field will clear the values of User and Password .

Password: This field contains a password if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]".

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Port: This field contains the TCP port for the proxy Server (default 80). See the description of the Server field for details.

Server: If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the Server field is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned.

SSL: This field determines when to use SSL for the connection to the proxy. The applicable values are the following:

psAutomatic (0)

Default setting. If the URL is an "https" URL, the bean will use the psTunnel option. If the URL is a "http" URL, the bean will use the psNever option.

psAlways (1)

The connection is always SSL-enabled.

psNever (2)

The connection is not SSL-enabled.

psTunnel (3)

The connection is through a tunneling (HTTP) proxy.

User: This field contains a user name, if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]".

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

See Also:

Atoms, Atoms.Proxy

Field Summary

static int	authBasic
static int	authDigest
static int	authNegotiate
static int	authNone
static int	authNtlm
static int	authProprietary
static int	psAlways
static int	psAutomatic
static int	psNever
static int	psTunnel

Constructor Summary

Proxy()

Proxy(java.lang.String server, int port)

Proxy(java.lang.String server, int port, java.lang.String user, java.lang.String password)

Method Summary

int	getAuthScheme()
java.lang.String	getPassword()
int	getPort()
java.lang.String	getServer()
int	getSSL()
java.lang.String	getUser()
void	setAuthScheme(int value)
void	setPassword(java.lang.String value)
void	setPort(int value)
void	setServer(java.lang.String value)
void	setSSL(int value)
void	setUser(java.lang.String value)

Methods inherited from class java.lang.Object

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

Field Detail

authBasic

public static final int authBasic

See Also:

Constant Field Values

authDigest

public static final int authDigest

See Also:

Constant Field Values

authProprietary

public static final int authProprietary

See Also:

Constant Field Values

authNone

public static final int authNone

See Also:

Constant Field Values

authNtlm

public static final int authNtlm

See Also:

Constant Field Values

authNegotiate

public static final int authNegotiate

See Also:

Constant Field Values

psAutomatic

public static final int psAutomatic

See Also:

Constant Field Values

psAlways

public static final int psAlways

See Also:

Constant Field Values

psNever

public static final int psNever

See Also:

Constant Field Values

psTunnel

public static final int psTunnel

See Also:

Constant Field Values

Constructor Detail

Proxy

public Proxy()

Proxy

public Proxy(java.lang.String server,
             int port)

Proxy

public Proxy(java.lang.String server,
             int port,
             java.lang.String user,
             java.lang.String password)

Method Detail

getAuthScheme

public int getAuthScheme()

setAuthScheme

public void setAuthScheme(int value)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String value)

getPort

public int getPort()

setPort

public void setPort(int value)

getServer

public java.lang.String getServer()

setServer

public void setServer(java.lang.String value)

getSSL

public int getSSL()

setSSL

public void setSSL(int value)

getUser

public java.lang.String getUser()

setUser

public void setUser(java.lang.String value)