com.sas.hls.client
Class ProxyInfo

java.lang.Object
  extended by com.sas.hls.client.ProxyInfo

public class ProxyInfo
extends Object

Simple information holder which contains the necessary information to connect to a proxy server.

Since:
1.7
See Also:
SessionFactory.newSessionWithProxy(java.net.URL, String, String, ProxyInfo)

Constructor Summary
ProxyInfo(String proxyHost, int proxyPort)
          Constructs a proxy server information holder containing the proxy server connection parameters.
ProxyInfo(String proxyHost, int proxyPort, String proxyUserId, String proxyPassword)
          Constructs a proxy server information holder containing the proxy server connection parameters as well as the credentials required to connect.
 
Method Summary
 String getProxyHost()
          Returns the proxy server host to use when establishing a Session.
 String getProxyPassword()
          Returns the proxy server password to use when establishing a Session.
 int getProxyPort()
          Returns the proxy server port to use when establishing a Session.
 String getProxyUserId()
          Returns the proxy server user id to use when establishing a Session.
 void setProxyHost(String proxyHost)
          Set the proxy server host to use when establishing a Session.
 void setProxyPassword(String proxyPassword)
          Set the proxy server password to use when establishing a Session.
 void setProxyPort(int proxyPort)
          Set the proxy server port to use when establishing a Session.
 void setProxyUserId(String proxyUserId)
          Set the proxy server user id to use when establishing a Session.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProxyInfo

public ProxyInfo(String proxyHost,
                 int proxyPort)
Constructs a proxy server information holder containing the proxy server connection parameters.

Parameters:
proxyHost - the proxy server host name (IP or DNS name)
proxyPort - the proxy server port

ProxyInfo

public ProxyInfo(String proxyHost,
                 int proxyPort,
                 String proxyUserId,
                 String proxyPassword)
Constructs a proxy server information holder containing the proxy server connection parameters as well as the credentials required to connect. This constructor should only be used if the proxy server requires authentication.

Parameters:
proxyHost - the proxy server host name (IP or DNS name)
proxyPort - the proxy server port
proxyUserId - the proxy server user id if the proxy server requires authentication
proxyPassword - the proxy server password if the proxy server requires authentication
Method Detail

getProxyHost

public String getProxyHost()
Returns the proxy server host to use when establishing a Session.

Returns:
the proxy server host

setProxyHost

public void setProxyHost(String proxyHost)
Set the proxy server host to use when establishing a Session.

Parameters:
proxyHost - the proxy host name (IP or DNS name).

getProxyPort

public int getProxyPort()
Returns the proxy server port to use when establishing a Session.

Returns:
the proxy server port

setProxyPort

public void setProxyPort(int proxyPort)
Set the proxy server port to use when establishing a Session.

Parameters:
proxyPort - the proxy server port

getProxyUserId

public String getProxyUserId()
Returns the proxy server user id to use when establishing a Session.

Returns:
the proxy server user id

setProxyUserId

public void setProxyUserId(String proxyUserId)
Set the proxy server user id to use when establishing a Session. This is required only when the proxy server is configured to require authentication.

Parameters:
proxyUserId - the proxy server user id

getProxyPassword

public String getProxyPassword()
Returns the proxy server password to use when establishing a Session.

Returns:
the proxy server password

setProxyPassword

public void setProxyPassword(String proxyPassword)
Set the proxy server password to use when establishing a Session. This is required only when the proxy server is configured to require authentication.

Parameters:
proxyPassword - the proxy server password


Copyright (c) 2016, SAS Institute Inc., Cary, NC, USA