Package com.jedox.palojlib.main

Class ConnectionConfiguration

java.lang.Object

com.jedox.palojlib.main.ConnectionConfiguration

All Implemented Interfaces:

IConnectionConfiguration

Direct Known Subclasses:

HttpHandlerInfo, SessionConfiguration

public class ConnectionConfiguration
extends Object
implements IConnectionConfiguration

Nested Class Summary

Nested classes/interfaces inherited from interface com.jedox.palojlib.interfaces.IConnectionConfiguration

IConnectionConfiguration.IClientInfo

Constructor Summary

Constructors

Constructor	Description
ConnectionConfiguration()

Method Summary

Modifier and Type	Method	Description
ConnectionConfiguration	copyOf()
IConnectionConfiguration.IClientInfo	getClientInfo()	get the client information of this connection ClientInfo
String	getEncodedPassword()
String	getEncodedUsername()
String	getHost()	get the olap server host
String	getPassword()	get the username's password
String	getPort()	get the olap server port
String	getSession()
int	getTimeout()	get the amount of time to wait for response before firing a timeout exception.
String	getUsername()	get the username
boolean	isHttpEnforced()	Returns true if not using TLS/SSL has been enforced by prefixing host with scheme http://, false otherwise.
boolean	isHttpsEnforced()	Returns true if using TLS/SSL has been enforced by prefixing host with scheme https:// or by setting port to 443, false otherwise.
boolean	isSslPreferred()	get whether ssl connection is preferred or not.
void	overwrite(IConnectionConfiguration config)
void	setClientInfo(IConnectionConfiguration.IClientInfo info)	set the client information of this connection ClientInfo
void	setHost(String host)	set the host of the olap server.
void	setPassword(String password)	set the password of the user in olap server.
void	setPort(String port)	set the port of the olap connection.
void	setSession(String session)
void	setSslPreferred(boolean sslPreferred)	set whether ssl connection is preferred or not.
void	setTimeout(int timeout)	set the amount of time in milliseconds to wait for response before firing a timeout exception.
void	setUsername(String username)	set the user name in olap server.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jedox.palojlib.interfaces.IConnectionConfiguration

hasSession

Constructor Details

ConnectionConfiguration

public ConnectionConfiguration()

Method Details

getHost

public String getHost()

Description copied from interface: IConnectionConfiguration

get the olap server host

Specified by:

getHost in interface IConnectionConfiguration

Returns:

host olap host

getPort

public String getPort()

Description copied from interface: IConnectionConfiguration

get the olap server port

Specified by:

getPort in interface IConnectionConfiguration

Returns:

port olap port

getUsername

public String getUsername()

Description copied from interface: IConnectionConfiguration

get the username

Specified by:

getUsername in interface IConnectionConfiguration

Returns:

username olap password

getEncodedUsername

public String getEncodedUsername()

getPassword

public String getPassword()

Description copied from interface: IConnectionConfiguration

get the username's password

Specified by:

getPassword in interface IConnectionConfiguration

Returns:

password olap user password

getEncodedPassword

public String getEncodedPassword()

getTimeout

public int getTimeout()

Description copied from interface: IConnectionConfiguration

get the amount of time to wait for response before firing a timeout exception.

Specified by:

getTimeout in interface IConnectionConfiguration

Returns:

timeout connection timeout

isSslPreferred

public boolean isSslPreferred()

Description copied from interface: IConnectionConfiguration

get whether ssl connection is preferred or not. It only has an effect if olap server ssl mode is optional IConnectionInfo.EncryptionType.ENCRYPTION_OPTIONAL

Specified by:

isSslPreferred in interface IConnectionConfiguration

Returns:

sslPreferred if true ssl connection will be used when olap encryption mode is optional, otherwise false.

setHost

public void setHost(String host)

Description copied from interface: IConnectionConfiguration

set the host of the olap server.

Specified by:

setHost in interface IConnectionConfiguration

Parameters:

host - olap host

setPort

public void setPort(String port)

Description copied from interface: IConnectionConfiguration

set the port of the olap connection.

Specified by:

setPort in interface IConnectionConfiguration

Parameters:

port - olap port

setUsername

public void setUsername(String username)

Description copied from interface: IConnectionConfiguration

set the user name in olap server.

Specified by:

setUsername in interface IConnectionConfiguration

Parameters:

username - user name

setPassword

public void setPassword(String password)

Description copied from interface: IConnectionConfiguration

set the password of the user in olap server.

Specified by:

setPassword in interface IConnectionConfiguration

Parameters:

password - olap user password

setTimeout

public void setTimeout(int timeout)

Description copied from interface: IConnectionConfiguration

set the amount of time in milliseconds to wait for response before firing a timeout exception.

Specified by:

setTimeout in interface IConnectionConfiguration

Parameters:

timeout - connection timeout

setSslPreferred

public void setSslPreferred(boolean sslPreferred)

Description copied from interface: IConnectionConfiguration

set whether ssl connection is preferred or not. It only has an effect if olap server ssl mode is optional IConnectionInfo.EncryptionType.ENCRYPTION_OPTIONAL

Specified by:

setSslPreferred in interface IConnectionConfiguration

Parameters:

sslPreferred - true ssl connection will be used when olap encryption mode is optional, otherwise false.

getClientInfo

public IConnectionConfiguration.IClientInfo getClientInfo()

Description copied from interface: IConnectionConfiguration

get the client information of this connection ClientInfo

Specified by:

getClientInfo in interface IConnectionConfiguration

Returns:

client client info

setClientInfo

public void setClientInfo(IConnectionConfiguration.IClientInfo info)

Description copied from interface: IConnectionConfiguration

set the client information of this connection ClientInfo

Specified by:

setClientInfo in interface IConnectionConfiguration

Parameters:

info - client info

isHttpsEnforced

public boolean isHttpsEnforced()

Description copied from interface: IConnectionConfiguration

Returns true if using TLS/SSL has been enforced by prefixing host with scheme https:// or by setting port to 443, false otherwise.

Specified by:

isHttpsEnforced in interface IConnectionConfiguration

Returns:

true if using TLS/SSL has been enforced by prefixing host with scheme https:// or by setting port to 443, false otherwise

isHttpEnforced

public boolean isHttpEnforced()

Description copied from interface: IConnectionConfiguration

Returns true if not using TLS/SSL has been enforced by prefixing host with scheme http://, false otherwise.

Specified by:

isHttpEnforced in interface IConnectionConfiguration

Returns:

true if not using TLS/SSL has been enforced by prefixing host with scheme http://, false otherwise

copyOf

public ConnectionConfiguration copyOf()

Specified by:

copyOf in interface IConnectionConfiguration

overwrite

public void overwrite(IConnectionConfiguration config)

Specified by:

overwrite in interface IConnectionConfiguration

getSession

public String getSession()

Specified by:

getSession in interface IConnectionConfiguration

setSession

public void setSession(String session)

Specified by:

setSession in interface IConnectionConfiguration