Skip navigation links

com.essbase.eas.server
Interface ISession

All Known Implementing Classes:

EssSession

public interface ISession

ISession This interface defines the methods necessary to identify and manipulate a database session. All mechanics of primitive access are left to the implementation.

Version:

1.00 05/08/2000 1.1.0, 08/04/2000 Upgraded to PW Framework 0.9

Author:

Brendan Gaul

Method Summary

boolean	connect() Method to connect to database will be implementation specific, but will in all cases require username and password.
ISession	createNewSession() Creates a new session
boolean	disconnect() Method to break and discard connection to database.
java.util.ArrayList	getAttributes() Implementations should include a ArrayList that holds all attributes needed for establishing a connection to the database - accessed with this method.
java.util.ArrayList	getErrorMessage() Returns a list of errors for the session
java.lang.String	getPassword()
java.lang.String	getServerName()
java.lang.Object	getSessionID() Implementations should include an Object that identifies an established database connection accessed and mutated with the following methods.
boolean	getSetBusy() Returns true if the session is not busy and the busy flag is set
java.lang.String	getUserName()
boolean	isBusy() Returns true if the session is busy
boolean	isConnected() Method to test an existing connection for state.
boolean	isTemporary() Returns if the session is a temporary one
boolean	isValidConnection() Method to test whether the connection is valid.
boolean	reconnect() Method to reconnect to database will be implementation specific, but will in all cases require username and password.
void	setAttributes(java.util.ArrayList attributes) Set the attributes for the session
void	setBusy(boolean busy) Sets/Reset the busy flag for the session
void	setSessionID(java.lang.Object sessionID) Sets the session id object for the session
void	setTemporary() Sets the session to be a temporary one which may not have a long life span.

Method Detail

connect

boolean connect()
                throws java.lang.Exception

Method to connect to database will be implementation specific, but will in all cases require username and password. Implementation will contact the appropriate primitive class for its session type.

Returns:

true if the session connected

Throws:

java.lang.Exception - for an error while connecting

reconnect

boolean reconnect()
                  throws java.lang.Exception

Method to reconnect to database will be implementation specific, but will in all cases require username and password. Implementation will contact the appropriate primitive class for its session type.

Returns:

true if reconnect was successful

Throws:

java.lang.Exception - for an error while reconnecting

disconnect

boolean disconnect()

Method to break and discard connection to database. Implementation will contact the appropriate primitive class for its session type.

Returns:

true if disconnected

isConnected

boolean isConnected()

Method to test an existing connection for state. Implementation will contact the appropriate primitive class for its session type.

Returns:

true if session is connected

isValidConnection

boolean isValidConnection()

Method to test whether the connection is valid. Default implementation may just return true if a connection is always valid

Returns:

true if connection is valid

getAttributes

java.util.ArrayList getAttributes()

Implementations should include a ArrayList that holds all attributes needed for establishing a connection to the database - accessed with this method.

Returns:

the attributes of the session

setAttributes

void setAttributes(java.util.ArrayList attributes)

Set the attributes for the session

Parameters:

attributes - the session attributes

getSessionID

java.lang.Object getSessionID()

Implementations should include an Object that identifies an established database connection accessed and mutated with the following methods. Implementation will contact the appropriate primitive class for its session type.

setSessionID

void setSessionID(java.lang.Object sessionID)

Sets the session id object for the session

Parameters:

sessionID -

getErrorMessage

java.util.ArrayList getErrorMessage()

Returns a list of errors for the session

Returns:

isBusy

boolean isBusy()

Returns true if the session is busy

Returns:

getSetBusy

boolean getSetBusy()

Returns true if the session is not busy and the busy flag is set

Returns:

setBusy

void setBusy(boolean busy)

Sets/Reset the busy flag for the session

Parameters:

busy -

isTemporary

boolean isTemporary()

Returns if the session is a temporary one

Returns:

setTemporary

void setTemporary()

Sets the session to be a temporary one which may not have a long life span.

createNewSession

ISession createNewSession()

Creates a new session

Returns:

the new session

getServerName

java.lang.String getServerName()

getPassword

java.lang.String getPassword()

getUserName

java.lang.String getUserName()

Skip navigation links