Package com.jedox.palojlib.main

Class Connection

java.lang.Object

com.jedox.palojlib.main.Connection

All Implemented Interfaces:

IConnection

public class Connection
extends Object
implements IConnection

Field Summary

Fields

Modifier and Type	Field	Description
protected final ConnectionConfiguration	connectionConfiguration
protected boolean	isConnected

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Connection(IConnectionConfiguration connectionConfiguration)

Method Summary

Modifier and Type	Method	Description
IDatabase	addDatabase(String name)	create a new database
IDatabase	addDatabase(String name, IDatabase.DatabaseType type)	create a new database
IDatabase	addDatabase(String name, IDatabase.DatabaseType type, String backupPath)	create a new database
IDatabase	addDatabase(String name, String backupPath)	create a new database
void	changePassword(String user, String password)	Change a user password
String	checkLicense(String required, String optional)
void	close(boolean stop)	close the connection.
ConnectionConfiguration	getConnectionConfiguration()	get the connection configuration of this connection.
Database	getDatabaseByName(String name)	get database using its name
Database[]	getDatabases()	get a list of the databases on this server.
String	getLicenseKey(String id)
IScriptHandler	getScriptHandler()
ConnectionInfo	getServerInfo()	get the server info object of this connection.
SvsInfo	getSvsInfo()	get the info of supervision server SvsInfo
UserInfo	getUserInfo(boolean withPermission)	get User info of the logged user.
boolean	isConnected()	get the server connection status.
String	open()	open the connection.
String	openInternal()
void	removeDatabase(IDatabase db)	delete a database
void	resetCache()
void	save(boolean complete)	saves the server data, i.

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.IConnection

close, save

Field Details

isConnected

protected boolean isConnected

connectionConfiguration

protected final ConnectionConfiguration connectionConfiguration

Constructor Details

Connection

protected Connection(IConnectionConfiguration connectionConfiguration)
              throws PaloException,
PaloJException

Throws:

PaloException

PaloJException

Method Details

getConnectionConfiguration

public ConnectionConfiguration getConnectionConfiguration()

Description copied from interface: IConnection

get the connection configuration of this connection. The configuration includes information like host,port,user name,password and timeout.

Specified by:

getConnectionConfiguration in interface IConnection

Returns:

connection configuration of this connection

isConnected

public boolean isConnected()

Description copied from interface: IConnection

get the server connection status.

Specified by:

isConnected in interface IConnection

Returns:

true if connection is opened, false otherwise

getServerInfo

public ConnectionInfo getServerInfo()

Description copied from interface: IConnection

get the server info object of this connection. Server info object include information like major,minor and bug fix version numbers.

Specified by:

getServerInfo in interface IConnection

Returns:

server info object of this connection

open

public String open()
            throws RuntimeException

Description copied from interface: IConnection

open the connection. This should be called before working on the connection.

Specified by:

open in interface IConnection

Returns:

the olap session

Throws:

PaloException - exception from OLAP server

RuntimeException

openInternal

public String openInternal()
                    throws RuntimeException

Throws:

RuntimeException

close

public void close(boolean stop)
           throws PaloException

Description copied from interface: IConnection

close the connection. This should be done when finished from the connection to expire the olap session.

Specified by:

close in interface IConnection

Parameters:

stop - true will stop any active job for this session will be stopped, false no jobs will be stopped.

Throws:

PaloException - exception from OLAP server

getDatabases

public Database[] getDatabases()
                        throws PaloException,
PaloJException

Description copied from interface: IConnection

get a list of the databases on this server.

Specified by:

getDatabases in interface IConnection

Returns:

list of the databases.

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

addDatabase

public IDatabase addDatabase(String name)
                      throws PaloException,
PaloJException

Description copied from interface: IConnection

create a new database

Specified by:

addDatabase in interface IConnection

Parameters:

name - the name of the database

Returns:

the newly created database

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

addDatabase

public IDatabase addDatabase(String name,
 IDatabase.DatabaseType type)
                      throws PaloException,
PaloJException

Description copied from interface: IConnection

create a new database

Specified by:

addDatabase in interface IConnection

Parameters:

name - the name of the database

type - type of the database (normal, user info) *

Returns:

the newly created database

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getDatabaseByName

public Database getDatabaseByName(String name)
                           throws PaloException,
PaloJException

Description copied from interface: IConnection

get database using its name

Specified by:

getDatabaseByName in interface IConnection

Parameters:

name - database name

Returns:

database object or null if it does not exist

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

save

public void save(boolean complete)
          throws PaloException,
PaloJException

Description copied from interface: IConnection

saves the server data, i. e. identifiers and database names.

Specified by:

save in interface IConnection

Parameters:

complete - when true then also databases and all cubes data will be saved, otherwise false.

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

resetCache

public void resetCache()

getSvsInfo

public SvsInfo getSvsInfo()
                   throws PaloException,
PaloJException

Description copied from interface: IConnection

get the info of supervision server SvsInfo

Specified by:

getSvsInfo in interface IConnection

Returns:

svs info

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getUserInfo

public UserInfo getUserInfo(boolean withPermission)
                     throws PaloException,
PaloJException

Description copied from interface: IConnection

get User info of the logged user.

Specified by:

getUserInfo in interface IConnection

Parameters:

withPermission - whether the right_object should also be returned

Returns:

user info for the logged user UserInfo

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

removeDatabase

public void removeDatabase(IDatabase db)
                    throws PaloException,
PaloJException

Description copied from interface: IConnection

delete a database

Specified by:

removeDatabase in interface IConnection

Parameters:

db - the database to be removed

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

addDatabase

public IDatabase addDatabase(String name,
 IDatabase.DatabaseType type,
 String backupPath)
                      throws PaloException,
PaloJException

Description copied from interface: IConnection

create a new database

Specified by:

addDatabase in interface IConnection

Parameters:

name - the name of the database

type - type of the database (normal, user info) *

backupPath - Path to backup file where the database will be loaded from.

Returns:

the newly created database

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

addDatabase

public IDatabase addDatabase(String name,
 String backupPath)
                      throws PaloException,
PaloJException

Description copied from interface: IConnection

create a new database

Specified by:

addDatabase in interface IConnection

Parameters:

name - the name of the database

backupPath - Path to backup file where the database will be loaded from.

Returns:

the newly created database

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getScriptHandler

public IScriptHandler getScriptHandler()

Specified by:

getScriptHandler in interface IConnection

checkLicense

public String checkLicense(String required,
 String optional)
                    throws RuntimeException

Throws:

RuntimeException

getLicenseKey

public String getLicenseKey(String id)
                     throws PaloException

Throws:

PaloException

changePassword

public void changePassword(String user,
 String password)
                    throws PaloException

Description copied from interface: IConnection

Change a user password

Specified by:

changePassword in interface IConnection

Parameters:

user - The name of the user whose password should be changed. (If null the password is changed for current user)

password - The plain text new password.

Throws:

PaloException