Skip navigation links

com.essbase.eas.essbase.server
Class EssSessionPrimitives

java.lang.Object
com.essbase.eas.essbase.server.EssSessionPrimitives

public final class EssSessionPrimitives

extends java.lang.Object

This class provides the primitive operations for an Essbase Session Object. In the current implementation, no instances of this class should ever be instantiated.

Version:

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

Author:

Hank Cox

See Also:

EssSession, EssSessionMessage

Method Summary

static boolean	connect(ISession session) Connects an EssSession object to the server by calling the appropriate MaxL commands.
static ISession	create(java.lang.String sessionType, java.lang.String serverName) Instantiates an EssSession object tied to the requested server
static boolean	disconnect(ISession session) Determines that the sessionparameter is of the appropriate type, then calls MaxL.
static java.util.ArrayList	getMessages(ISession session) Retrieves the MaxL messages for the given session.
static boolean	isConnected(ISession session) Determines that the session parameter is of the appropriate type, then calls MaxL.
static boolean	isValidConnection(ContextHandle contextHandle)
static boolean	isValidConnection(EssSession session) Validates whether a connection is still valid by checking the ContextHandle
static boolean	reconnect(ISession session) Determines that the session parameter is of the appropriate type, then calls MaxL.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ISession create(java.lang.String sessionType,
                              java.lang.String serverName)

Instantiates an EssSession object tied to the requested server

Parameters:

sessionType - the type of session being requested.

serverName - the server name the user is requesting a connection for.

Returns:

an EssSession object.

Throws:

###

connect

public static boolean connect(ISession session)
                       throws java.lang.Exception

Connects an EssSession object to the server by calling the appropriate MaxL commands.

Parameters:

session - Session object; must be of type EssSession

Returns:

true if connection is made, false otherwise.

Throws:

java.lang.Exception

reconnect

public static boolean reconnect(ISession session)
                         throws java.lang.Exception

Determines that the session parameter is of the appropriate type, then calls MaxL.

Parameters:

session - Session object; must be of type EssSession

Returns:

true if reconnection completed (or not necessary), false otherwise.

Throws:

java.lang.Exception

isConnected

public static boolean isConnected(ISession session)

Determines that the session parameter is of the appropriate type, then calls MaxL.

Warning(###):This method needs to be fixed as soon as MaxL supports this functionality.

Parameters:

session - Session object; must be of type EssSession

Returns:

true if session object is connected to Essbase; false otherwise.

disconnect

public static boolean disconnect(ISession session)

Determines that the sessionparameter is of the appropriate type, then calls MaxL.

Parameters:

session - Session object; must be of type EssSession

Returns:

true if disconnect successful, false otherwise

isValidConnection

public static boolean isValidConnection(EssSession session)

Validates whether a connection is still valid by checking the ContextHandle

isValidConnection

public static boolean isValidConnection(ContextHandle contextHandle)

getMessages

public static java.util.ArrayList getMessages(ISession session)

Retrieves the MaxL messages for the given session.

Parameters:

session - Session object; must be of type EssSession

Returns:

vector of EssSessionMessage objects.

Skip navigation links