com.businessobjects.dsws
Class ProxyParameters

java.lang.Object
  com.businessobjects.dsws.ProxyParameters

All Implemented Interfaces:

java.io.Serializable

public class ProxyParameters
extends java.lang.Object
implements java.io.Serializable

The ProxyParameters object stocks information used to access Web Services via a HTTP proxy. This object is passed to the Connection object.

Example: Create a session object using a HTTP proxy.

URL boConURL = new URL("http://:/dswsbobje/services/session");
com.businessobjects.dsws.Connection boConnection;
boConnection = new Connection(boConURL);
ProxyParameters myParams;
myParams = new ProxyParameters("http://proxy.myserver","8888",null,null);
boConnection.setProxyParameters(m_oPP);
Session mySession = new Session(m_oCon);


See Also:

Connection, ProxyParameters, Session, Serialized Form

Constructor Summary

ProxyParameters()
Instantiate a new blank ProxyParameters object.

ProxyParameters(java.lang.String proxyHost, java.lang.String proxyPort, java.lang.String proxyUser, java.lang.String proxyPassword)
Instantiate a new ProxyParameters object and set all parameters.

Method Summary

ProxyParameters	copy() Internal Use Only.
java.lang.String	getProxyHost() Return the URL of the proxy server.
java.lang.String	getProxyPassword() Return the password of the proxy user.
java.lang.String	getProxyPort() Returns the port used to contact proxy server.
java.lang.String	getProxyUser() Return the name of the proxy user.
void	setProxyHost(java.lang.String proxyHost) Set the URL of the proxy server.
void	setProxyPassword(java.lang.String proxyPassword) Set the password of the proxy user.
void	setProxyPort(java.lang.String proxyPort) Set the port used to contact proxy server.
void	setProxyUser(java.lang.String proxyUser) Set the name of the proxy user.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyParameters

public ProxyParameters()

Instantiate a new blank ProxyParameters object.

ProxyParameters

public ProxyParameters(java.lang.String proxyHost,
                       java.lang.String proxyPort,
                       java.lang.String proxyUser,
                       java.lang.String proxyPassword)

Instantiate a new ProxyParameters object and set all parameters.

Example:

com.businessobjects.dsws.Connection boConnection = new com.businessobjects.dsws.Connection(new URL(aURL));
ProxyParameters boProxyParams = new ProxyParameters( "http://proxy.myserver","8888",null,null);
boConnection.setProxyParameters(boProxyParams);


Parameters:

proxyHost - The URL of the proxy server.

proxyPort - The port number to be used.

proxyUser - The name of the user to be identified.

proxyPassword - The password of the user to be identified.

Method Detail

getProxyHost

public java.lang.String getProxyHost()

Return the URL of the proxy server.

Returns:

a string containing the proxy server URL.

setProxyHost

public void setProxyHost(java.lang.String proxyHost)

Set the URL of the proxy server.

Parameters:

proxyHost - The URL of the proxy server.

getProxyPort

public java.lang.String getProxyPort()

Returns the port used to contact proxy server.

Returns:

a string containing the proxy port number used.

setProxyPort

public void setProxyPort(java.lang.String proxyPort)

Set the port used to contact proxy server.

Parameters:

proxyPort - A string containing the port number to be used.

getProxyUser

public java.lang.String getProxyUser()

Return the name of the proxy user.

Returns:

proxyUser The name of the proxy user.

setProxyUser

public void setProxyUser(java.lang.String proxyUser)

Set the name of the proxy user.

Parameters:

proxyUser - The name of the proxy user.

getProxyPassword

public java.lang.String getProxyPassword()

Return the password of the proxy user.

Returns:

The password of the proxy user

setProxyPassword

public void setProxyPassword(java.lang.String proxyPassword)

Set the password of the proxy user.

Parameters:

proxyPassword - The password of the proxy user.

copy

public ProxyParameters copy()

Internal Use Only.