com.opendxl.streaming.client

Class HttpProxySettings

java.lang.Object

com.opendxl.streaming.client.HttpProxySettings

public class HttpProxySettings
extends java.lang.Object

The HttpProxySettings class collects all http proxy settings in a single object.

Constructor Summary

Constructors

Constructor and Description
HttpProxySettings(boolean enabled, java.lang.String url, int port, java.lang.String username, java.lang.String password)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPassword() Get the password required to access the Http Proxy
int	getPort() Get the Http Proxy TCP port number
java.lang.String	getUrl() Get the Http Proxy URL
java.lang.String	getUsername() Get the username required to access the Http Proxy
boolean	isEnabled() Indicate whether Http Proxy is enabled or disabled

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpProxySettings

public HttpProxySettings(boolean enabled,
                         java.lang.String url,
                         int port,
                         java.lang.String username,
                         java.lang.String password)
                  throws PermanentError

Parameters:

enabled - whether the Http Proxy settings are applicable or not.

url - http proxy url. Mandatory parameter, it may not be null nor empty.

port - http proxy port. Mandatory parameter, it may not be zero or lower than zero.

username - username to provide to http proxy.

password - user password.

Throws:

PermanentError - if http proxy url is null or empty or if port number is not greater than zero.

Method Detail

isEnabled

public boolean isEnabled()

Indicate whether Http Proxy is enabled or disabled

Returns:

true if http proxy is enabled false otherwise

getUrl

public java.lang.String getUrl()

Get the Http Proxy URL

Returns:

http proxy url

getPort

public int getPort()

Get the Http Proxy TCP port number

Returns:

http proxy port number

getUsername

public java.lang.String getUsername()

Get the username required to access the Http Proxy

Returns:

http proxy username

getPassword

public java.lang.String getPassword()

Get the password required to access the Http Proxy

Returns:

http proxy password