FairCom.CtreeDb

Class CTSession

java.lang.Object

FairCom.CtreeDb.CTBase

FairCom.CtreeDb.CTSession

public class CTSession
extends CTBase

Deals with the session concept. A session is required to allow the connection with the databases; it is used for their general management as well. CTSession() is derived from CTBase().

See Also:

CTBase, CTDatabase, CTTable

Field Summary

Fields inherited from class FairCom.CtreeDb.CTBase

m_handle

Constructor Summary

Constructors

Constructor and Description
CTSession() Default constructor for CTSession class
CTSession(int SessionType) Constructor for CTSession class

Method Summary

Modifier and Type	Method and Description
void	AddDatabase(java.lang.String Name, java.lang.String Path) Adds an existing database to session.
void	Attach(boolean isTransactionActive) Attachs an already initialized c-tree ISAM or low-level session to a c-treeDB CTSession object.
void	Attach(CTSession Session) Attachs an already initialized c-tree ISAM or low-level session to a c-treeDB CTSession object.
void	ClearPathPrefix() Clears any previously set path prefix.
void	Create() Creates a new session with the defaut values
void	Create(java.lang.String dbEngine, java.lang.String user, java.lang.String password) Creates a new session
void	CreateDatabase(java.lang.String Name, java.lang.String Path) Creates a new database
void	DeleteDatabase(java.lang.String Name) Drops a database from the session and delete the data and index files.
void	Detach() Detaches a c-treeDB CTSession object.
void	DisconnectAll() Disconnects all databases from the current session
void	DropDatabase(java.lang.String Name) Drops a database from a session.
protected void	finalize() Destroys an allocated CTSession class.
boolean	FindDatabase(java.lang.String Name, java.lang.StringBuffer Path) Locates a database in a session.
boolean	FirstDatabase(java.lang.StringBuffer Name, java.lang.StringBuffer Path) Gets the first database for the session
int	GetAttachMode() Retrieves the current session ATTACH_MODE value.
int	GetDatabaseCount() Retrieves the number of databases in session dictionary
int	GetDatabaseUID(java.lang.String Name) Retrieves a database unique identification by its name
static int	GetDBModel() Gets the c-tree database model in use.
boolean	GetFailOverState() Check if the failover state have been set.
int	GetLibType() Retrieves the current session LIB_TYPE.
boolean	GetLogonOnly() Retrieves the session "logon only" flag.
int	GetMaxConnections() Retrieves the maximum connection count from the server side
int	GetParam(int ParamType) Returns the session parameter based on the parameter type.
java.lang.String	GetPassword() Returns the user password associated with the session.
java.lang.String	GetPath() Gets the path (drive:\directory) of the session dictionary.
java.lang.String	GetPathPrefix() Retrieves the current session wide path prefix.
java.lang.String	GetProductName() Retrieves the product name from the server side
java.lang.String	GetProductVersion() Retrieves the product version from the server side
java.util.Calendar	GetServerDateTime() Retrieve the current server date and time
java.lang.String	GetServerName() Returns the server name associated with the session.
int	GetSessionId() Gets the task ID associated with this session.
int	GetSessionType() Retrieves the current SESSION_TYPE.
java.lang.String	GetUserLogonName() Returns the user name associated with the session.
boolean	IsActive() Checks if the session is active.
boolean	IsExclusive() Retrieves the session exclusive flag.
boolean	IsPrimaryServer() Check if the current server is primary in a pacemaker cluster.
boolean	IsSQLServer() Checks if a session is connected to a SQL server
void	LoadCallbackLib(java.lang.String Libname, java.lang.String Inifile, boolean Registercallbacks) Loads the CallBack library.
void	Logoff() Logs off from a c-tree Server, or a c-tree instance, session.
void	Logon(java.lang.String dbEngine, java.lang.String user, java.lang.String password) Logs on to a c-tree Server, or a c-tree instance, session.
boolean	NextDatabase(java.lang.StringBuffer Name, java.lang.StringBuffer Path) Gets the Next database for the session
void	ResetFailOverState() Resets the value of the failover state to 0.
int	SetCallbackOnRebuild(java.lang.Object Class, java.lang.String FunctionName, int Step) Sets the rebuild callback
static void	SetClientLibraryOption(int Option, java.lang.String Value) Sets client side library option.
static void	SetCommProtocolOption(int Option, java.lang.String Value) Sets communication protocol option.
static int	SetConfigurationFile(java.lang.String ConfigFile) Sets the database engine configuration file name.
void	SetCurrentNodeName(java.lang.String NodeName) Sets a client side node name.
static void	SetDBModel(int model) Sets the c-tree database model to use.
void	SetExclusive() Activates the session exclusive flag.
void	SetExclusive(boolean flag) Sets or clears the session exclusive flag.
static int	SetLicenseFile(java.lang.String LicenseFile) Sets the database engine license file name.
static int	SetLocalDirectory(java.lang.String LocalDirectory) Sets the database engine local (data) directory.
void	SetLogonOnly() Sets the session logon only flag.
void	SetLogonOnly(boolean flag) Sets the session logon only flag.
void	SetLogPath(java.lang.String Path) Set transaction processing control file path for single-user applications
void	SetParam(int ParamType, int value) Sets session parameters values.
void	SetPath(java.lang.String Path) Sets the session dictionary path
void	SetPathPrefix(java.lang.String path) The CTDB path prefix feature is similar to c-tree Server's LOCAL_DIRECTORY configuration keyword.
void	SetSessionId(int sessid) Sets the task ID associated with this session.
void	SetSessionType(int SessionType) Changes the current SESSION_TYPE.
int	SetSqlCallback(java.lang.Object Class, java.lang.String FunctionName) Sets the sqlimport callback
void	SetStatusLogPath(java.lang.String Path) Set status log file path for single-user applications
void	SetTempPath(java.lang.String Path) Set status temporary file path for single-user applications
static int	StartDatabaseEngine() Initializes c-tree's basic features.
static void	StopDatabaseEngine() Shutdown the database Engine.
void	UnLoadCallbackLib(boolean Unregonly) Unloads the CallBack library.

Methods inherited from class FairCom.CtreeDb.CTBase

Abort, Begin, ClearSavePoint, Commit, GetAutoCommit, GetHandle, GetKeepLock, GetLockMode, GetOperation, GetTransactionMode, IsLockActive, IsTransActive, IsUnicodeLib, Lock, PrepareCommit, RestoreSavePoint, SetAutoCommit, SetHandle, SetKeepLock, SetOperation, SetSavePoint, SetTransactionMode, Unlock

Methods inherited from class java.lang.Object

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

Constructor Detail

CTSession

public CTSession()
          throws CTException

Default constructor for CTSession class

Throws:

CTException - in case of error

See Also:

CTSession(int), finalize()

CTSession

public CTSession(int SessionType)
          throws CTException

Constructor for CTSession class

Parameters:

SessionType - CTField to be used for the new object

Throws:

CTException - in case of error

See Also:

CTSession(), finalize()

Method Detail

finalize

protected void finalize()

Destroys an allocated CTSession class. This method should be called in order to avoid memory leaks. Release all resources associated with a session.

Overrides:

finalize in class java.lang.Object

See Also:

CTSession(int), CTSession()

SetDBModel

public static void SetDBModel(int model)
                       throws CTException

Sets the c-tree database model to use. By default the model is CTDB_MODEL.CLIENT which is a multi-threaded client. An attempt to call this method when already called or the c-tree library has been already loaded result in exception.

Parameters:

model - CTDB_MODEL the model to use

Throws:

CTException - in case of error

GetDBModel

public static int GetDBModel()

Gets the c-tree database model in use.

Returns:

The c-tree database model in use. CTDB_MODEL can be used for comparision.

Logon

public void Logon(java.lang.String dbEngine,
                  java.lang.String user,
                  java.lang.String password)
           throws CTException

Logs on to a c-tree Server, or a c-tree instance, session. A logon is necessary to work with the CTDatabase. After a session is logged on, its status is active.

Parameters:

dbEngine - Faircom server name or c-tree instance name.

user - User name.

password - User password.

Throws:

CTException - in case of error

See Also:

Logoff(), IsActive()

Logoff

public void Logoff()
            throws CTException

Logs off from a c-tree Server, or a c-tree instance, session.

Throws:

CTException - in case of error

See Also:

Logon(java.lang.String, java.lang.String, java.lang.String)

GetServerName

public java.lang.String GetServerName()

Returns the server name associated with the session.

Returns:

Current server name.

See Also:

GetUserLogonName(), GetPassword(), GetParam(int)

GetUserLogonName

public java.lang.String GetUserLogonName()

Returns the user name associated with the session.

Returns:

Current user name.

See Also:

GetServerName(), GetPassword(), GetParam(int)

GetPassword

public java.lang.String GetPassword()

Returns the user password associated with the session.

Returns:

Current user password.

See Also:

GetServerName(), GetUserLogonName(), GetParam(int)

GetParam

public int GetParam(int ParamType)

Returns the session parameter based on the parameter type.

Parameters:

ParamType - SESSION_PARAM to be checked

Returns:

Parameter value. If an invalid handle or parameter type is passed, ctdb.GetSessionParams return 0.

See Also:

SetParam(int, int), GetServerName(), GetUserLogonName(), GetPassword()

SetParam

public void SetParam(int ParamType,
                     int value)
              throws CTException

Sets session parameters values.

Parameters:

ParamType - SESSION_PARAM to be set *

value - New parameter value.

Throws:

CTException - in case of error

See Also:

GetParam(int)

IsActive

public boolean IsActive()

Checks if the session is active. A session is active when the session handle has been allocated and the session is logged in to the server.

Returns:

true if the session is active, otherwise false.

See Also:

Logon(java.lang.String, java.lang.String, java.lang.String), Logoff()

GetPath

public java.lang.String GetPath()
                         throws CTException

Gets the path (drive:\directory) of the session dictionary.

Returns:

Current session path.

Throws:

CTException - in case of error

See Also:

SetPath(java.lang.String)

SetPath

public void SetPath(java.lang.String Path)
             throws CTException

Sets the session dictionary path

Parameters:

Path - New session dictionary path

Throws:

CTException - in case of error

See Also:

GetPath()

FirstDatabase

public boolean FirstDatabase(java.lang.StringBuffer Name,
                             java.lang.StringBuffer Path)
                      throws CTException

Gets the first database for the session

Parameters:

Name - Database name (Output)

Path - Database path (Output)

Returns:

true if the first database was found, otherwise false.

Throws:

CTException - in case of error

See Also:

NextDatabase(java.lang.StringBuffer, java.lang.StringBuffer), FindDatabase(java.lang.String, java.lang.StringBuffer), GetDatabaseCount()

NextDatabase

public boolean NextDatabase(java.lang.StringBuffer Name,
                            java.lang.StringBuffer Path)
                     throws CTException

Gets the Next database for the session

Parameters:

Name - Database name (Output)

Path - Database path (Output)

Returns:

true if the next database was found, otherwise false.

Throws:

CTException - in case of error

See Also:

FirstDatabase(java.lang.StringBuffer, java.lang.StringBuffer), FindDatabase(java.lang.String, java.lang.StringBuffer), GetDatabaseCount()

FindDatabase

public boolean FindDatabase(java.lang.String Name,
                            java.lang.StringBuffer Path)
                     throws CTException

Locates a database in a session.

Parameters:

Name - Database name to look for.

Path - If the database name is located, receives the path (Output).

Returns:

true if the next database was found, otherwise false.

Throws:

CTException - in case of error

See Also:

FirstDatabase(java.lang.StringBuffer, java.lang.StringBuffer), NextDatabase(java.lang.StringBuffer, java.lang.StringBuffer), GetDatabaseCount()

Create

public void Create()
            throws CTException

Creates a new session with the defaut values

Throws:

CTException - in case of error

See Also:

Create(java.lang.String, java.lang.String, java.lang.String), CreateDatabase(java.lang.String, java.lang.String)

Create

public void Create(java.lang.String dbEngine,
                   java.lang.String user,
                   java.lang.String password)
            throws CTException

Creates a new session

Parameters:

dbEngine - C-Tree instance or server name.

user - User name

password - user password.

Throws:

CTException - in case of error

See Also:

Create(), CreateDatabase(java.lang.String, java.lang.String)

DisconnectAll

public void DisconnectAll()
                   throws CTException

Disconnects all databases from the current session

Throws:

CTException - in case of error

See Also:

FirstDatabase(java.lang.StringBuffer, java.lang.StringBuffer), NextDatabase(java.lang.StringBuffer, java.lang.StringBuffer), GetDatabaseCount()

CreateDatabase

public void CreateDatabase(java.lang.String Name,
                           java.lang.String Path)
                    throws CTException

Creates a new database

Parameters:

Name - New database name

Path - New database path

Throws:

CTException - in case of error

See Also:

AddDatabase(java.lang.String, java.lang.String), DeleteDatabase(java.lang.String), DropDatabase(java.lang.String), GetDatabaseUID(java.lang.String)

AddDatabase

public void AddDatabase(java.lang.String Name,
                        java.lang.String Path)
                 throws CTException

Adds an existing database to session.

Parameters:

Name - Existing database name

Path - Existing database path

Throws:

CTException - in case of error

See Also:

CreateDatabase(java.lang.String, java.lang.String), DeleteDatabase(java.lang.String), DropDatabase(java.lang.String), GetDatabaseUID(java.lang.String)

DeleteDatabase

public void DeleteDatabase(java.lang.String Name)
                    throws CTException

Drops a database from the session and delete the data and index files.

Parameters:

Name - Database name to be deleted

Throws:

CTException - in case of error

See Also:

CreateDatabase(java.lang.String, java.lang.String), AddDatabase(java.lang.String, java.lang.String), DropDatabase(java.lang.String), GetDatabaseUID(java.lang.String)

DropDatabase

public void DropDatabase(java.lang.String Name)
                  throws CTException

Drops a database from a session.

Parameters:

Name - Database name to be droped

Throws:

CTException - in case of error

See Also:

CreateDatabase(java.lang.String, java.lang.String), AddDatabase(java.lang.String, java.lang.String), DeleteDatabase(java.lang.String), GetDatabaseUID(java.lang.String)

GetDatabaseUID

public int GetDatabaseUID(java.lang.String Name)
                   throws CTException

Retrieves a database unique identification by its name

Parameters:

Name - Database name to be retrieved

Returns:

Database unique identification (UID)

Throws:

CTException - in case of error

See Also:

CreateDatabase(java.lang.String, java.lang.String), AddDatabase(java.lang.String, java.lang.String), DeleteDatabase(java.lang.String), DropDatabase(java.lang.String)

SetExclusive

public void SetExclusive(boolean flag)
                  throws CTException

Sets or clears the session exclusive flag. If a session exclusive flag is set, only one CTDB or SQL session will be allowed. Set the session exlusive flag after allocating the sesion handle, but before performing a logon. Setting the session exclusive flag after a sesison logon is performed, will not have any effect during the current session.

Parameters:

flag - true will set the exclusive flag, while false will clear the exclusive flag.

Throws:

CTException - in case of error

See Also:

SetExclusive(), IsExclusive(), SetLogonOnly()

SetExclusive

public void SetExclusive()
                  throws CTException

Activates the session exclusive flag. If a session exclusive flag is set, only one CTDB or SQL session will be allowed. Set the session exlusive flag after allocating the sesion handle, but before performing a logon. Setting the session exclusive flag after a sesison logon is performed, will not have any effect during the current session.

Throws:

CTException - in case of error

See Also:

SetExclusive(boolean), IsExclusive(), SetLogonOnly()

IsExclusive

public boolean IsExclusive()

Retrieves the session exclusive flag.

Returns:

true if the current session is in exclusive mode, otherwise false.

See Also:

SetExclusive(boolean), SetExclusive(), SetLogonOnly()

IsSQLServer

public boolean IsSQLServer()

Checks if a session is connected to a SQL server

Returns:

true if the session is connected to a SQL server, false otherwise

See Also:

SetSessionType(int), GetSessionType()

SetLogonOnly

public void SetLogonOnly()
                  throws CTException

Sets the session logon only flag. This flag when set to true before the session Logon, will prevent the session from using the session dictionary.

Throws:

CTException - in case of error

See Also:

SetLogonOnly(boolean), GetLogonOnly()

SetLogonOnly

public void SetLogonOnly(boolean flag)
                  throws CTException

Sets the session logon only flag. This flag when set to true before the session Logon, will prevent the session from using the session dictionary.

Parameters:

flag - true will activate the logon only flag while false will clear it

Throws:

CTException - in case of error

See Also:

SetLogonOnly(), GetLogonOnly()

GetLogonOnly

public boolean GetLogonOnly()

Retrieves the session "logon only" flag.

Returns:

true if "logon only" flag is active, false otherwise.

See Also:

SetLogonOnly(), SetLogonOnly(boolean)

GetAttachMode

public int GetAttachMode()

Retrieves the current session ATTACH_MODE value.

Returns:

Current ATTACH_MODE value.

See Also:

Attach(FairCom.CtreeDb.CTSession), Attach(boolean), Detach()

GetDatabaseCount

public int GetDatabaseCount()

Retrieves the number of databases in session dictionary

Returns:

Number of databases managed by the current session.

See Also:

FirstDatabase(java.lang.StringBuffer, java.lang.StringBuffer), NextDatabase(java.lang.StringBuffer, java.lang.StringBuffer), FindDatabase(java.lang.String, java.lang.StringBuffer)

SetSessionType

public void SetSessionType(int SessionType)
                    throws CTException

Changes the current SESSION_TYPE. The session type is initialy set when ctdb.AllocSession() function is called to alocate a new session handle. SetSessionType allow users to change the session type after it has been allocated.

Parameters:

SessionType - New SESSION_TYPE to set to the current session

Throws:

CTException - in case of error

See Also:

GetSessionType(), IsSQLServer()

SetSessionId

public void SetSessionId(int sessid)

Sets the task ID associated with this session.

Parameters:

sessid - New session ID to be assigned to the current session

See Also:

GetSessionId()

GetSessionId

public int GetSessionId()

Gets the task ID associated with this session.

Returns:

the Session ID associted with the current session.

See Also:

SetSessionId(int)

GetSessionType

public int GetSessionType()

Retrieves the current SESSION_TYPE.

Returns:

Current SESSION_TYPE value.

See Also:

SetSessionType(int), IsSQLServer()

GetLibType

public int GetLibType()

Retrieves the current session LIB_TYPE.

Returns:

Current LIB_TYPE value

See Also:

GetSessionType()

SetConfigurationFile

public static int SetConfigurationFile(java.lang.String ConfigFile)
                                throws CTException

Sets the database engine configuration file name.

Parameters:

ConfigFile - Database engine configuration file name.

Returns:

CTDBRET error code

Throws:

CTException - in case of error

See Also:

SetCurrentNodeName(java.lang.String), SetPathPrefix(java.lang.String), SetLicenseFile(java.lang.String)

SetLicenseFile

public static int SetLicenseFile(java.lang.String LicenseFile)
                          throws CTException

Sets the database engine license file name.

Parameters:

LicenseFile - Database engine license file name.

Returns:

CTDBRET error code

Throws:

CTException - in case of error

See Also:

SetCurrentNodeName(java.lang.String), SetPathPrefix(java.lang.String), SetConfigurationFile(java.lang.String), SetLocalDirectory(java.lang.String)

SetLocalDirectory

public static int SetLocalDirectory(java.lang.String LocalDirectory)
                             throws CTException

Sets the database engine local (data) directory.

Parameters:

LocalDirectory - The absolute path of the directory to be used as local directory

Returns:

CTDBRET error code

Throws:

CTException - in case of error

See Also:

SetCurrentNodeName(java.lang.String), SetPathPrefix(java.lang.String), SetConfigurationFile(java.lang.String), SetLicenseFile(java.lang.String)

SetCurrentNodeName

public void SetCurrentNodeName(java.lang.String NodeName)
                        throws CTException

Sets a client side node name. The specified node name appears in the CTADMN utility under the option for "list clients". SetCurrentNodeName must be called after a successfull logon.

Parameters:

NodeName - Client side node name

Throws:

CTException - in case of error

See Also:

SetConfigurationFile(java.lang.String), SetPathPrefix(java.lang.String)

SetPathPrefix

public void SetPathPrefix(java.lang.String path)
                   throws CTException

The CTDB path prefix feature is similar to c-tree Server's LOCAL_DIRECTORY configuration keyword. When ctdbSetPathPrefix is called with a value, this value will be attached to the beginning of any file name that is not absolute. Note that the path prefix does not became a permanent part of the file name. The path prefix is kept by the session handle and it is not persisted to disk. When the session handle is destroyed, the path prefix information is also destroyed. A path prefix can be set anytime after the session handle is allocated. If a path prefix is set before a session logon, the new path prefix will affect the location of the session dictionary file. If a path prefix is set after a session logon, but before a database connect, then the path prefix affect only the database dictionary and any tables that are manipulated during that session. A path prefix can be removed at any time by passing an cleared or empty String as the path prefix.

Parameters:

path - Path prefix or empty string if you wish to remove the current path prefix.

Throws:

CTException - in case of error

See Also:

GetPathPrefix(), ClearPathPrefix()

ClearPathPrefix

public void ClearPathPrefix()
                     throws CTException

Clears any previously set path prefix.

Throws:

CTException - in case of error

See Also:

GetPathPrefix(), SetPathPrefix(java.lang.String)

GetPathPrefix

public java.lang.String GetPathPrefix()

Retrieves the current session wide path prefix. You can use GetPathPrefix to check if a path prefix is set or not. If GetPathPrefix return an empty String, then no path prefix is set.

Returns:

Current path prefix.

See Also:

ClearPathPrefix(), SetPathPrefix(java.lang.String)

Attach

public void Attach(boolean isTransactionActive)
            throws CTException

Attachs an already initialized c-tree ISAM or low-level session to a c-treeDB CTSession object. Attached sessions have no information on server, user name or user password, and these values are set to NULL.

Parameters:

isTransactionActive - Indicate if a transaction is active or not.

Throws:

CTException - in case of error

See Also:

Attach(FairCom.CtreeDb.CTSession), Detach(), GetAttachMode()

Attach

public void Attach(CTSession Session)
            throws CTException

Attachs an already initialized c-tree ISAM or low-level session to a c-treeDB CTSession object. Attached sessions have no information on server, user name or user password, and these values are set to NULL.

Parameters:

Session - Session object to attach to.

Throws:

CTException - in case of error

See Also:

Attach(boolean), Detach(), GetAttachMode()

Detach

public void Detach()
            throws CTException

Detaches a c-treeDB CTSession object. The c-tree ISAM or low-level deinit is not called, but the session object control structures are released and re-initialized.

Throws:

CTException - in case of error

See Also:

Attach(boolean), Attach(FairCom.CtreeDb.CTSession), GetAttachMode()

StartDatabaseEngine

public static int StartDatabaseEngine()
                               throws CTException

Initializes c-tree's basic features. A developer can call StartDatabaseEngine once before making any other c-treeDB or c-tree Plus calls. After processing, a call to method StopDatabaseEngine() will shutdown the database engine. Please note that this is a static method and it can be invoked without the presence of a CTSession object.

Returns:

CTDBRET error code

Throws:

CTException - in case of error

See Also:

StopDatabaseEngine()

StopDatabaseEngine

public static void StopDatabaseEngine()
                               throws CTException

Shutdown the database Engine. StartDatabaseEngine() must be called before any other c-treeDB or c-tree calls are performed. Please note that this is a static method and it can be invoked without the presence of a CTSession object.

Throws:

CTException - in case of error

See Also:

StartDatabaseEngine()

GetProductName

public java.lang.String GetProductName()
                                throws CTException

Retrieves the product name from the server side

Returns:

The product name from the server side

Throws:

CTException - in case of error

See Also:

GetProductVersion(), GetMaxConnections()

GetProductVersion

public java.lang.String GetProductVersion()
                                   throws CTException

Retrieves the product version from the server side

Returns:

The product version from the server side

Throws:

CTException - in case of error

See Also:

GetProductName(), GetMaxConnections()

GetMaxConnections

public int GetMaxConnections()
                      throws CTException

Retrieves the maximum connection count from the server side

Returns:

The maximum connection count from the server side

Throws:

CTException - in case of error

See Also:

GetProductName(), GetProductVersion()

LoadCallbackLib

public void LoadCallbackLib(java.lang.String Libname,
                            java.lang.String Inifile,
                            boolean Registercallbacks)
                     throws CTException

Loads the CallBack library.

Parameters:

Libname - Name of the callback library to be loaded.

Inifile - Name of a INI file (or in general a string) to be passed to the callback register function (ctsqlSetCallback) in the DLL

Registercallbacks - Set to true in order to have the ctdbLoadCallbackLib function automatically call ctsqlSetCallback in the DLL (if present).

Throws:

CTException - in case of error

See Also:

UnLoadCallbackLib(boolean), SetCallbackOnRebuild(java.lang.Object, java.lang.String, int), SetSqlCallback(java.lang.Object, java.lang.String)

UnLoadCallbackLib

public void UnLoadCallbackLib(boolean Unregonly)
                       throws CTException

Unloads the CallBack library.

Parameters:

Unregonly - true if callback should be cleaned but the library not unloaded, otherwise false if it should be cleaned and the library unloaded

Throws:

CTException - in case of error

See Also:

LoadCallbackLib(java.lang.String, java.lang.String, boolean), SetCallbackOnRebuild(java.lang.Object, java.lang.String, int), SetSqlCallback(java.lang.Object, java.lang.String)

SetCallbackOnRebuild

public int SetCallbackOnRebuild(java.lang.Object Class,
                                java.lang.String FunctionName,
                                int Step)

Sets the rebuild callback

Parameters:

Class - Class containing the callback function

FunctionName - Function name that will be called. The function signature MUST be (otherwise the function will not be called) :

public static void function_name(int counter, char event, String message)

If FunctioName is NULL the calback will be removed, a call with NULL is suggested after the rebuild.

Step - The callback function is called each time the internal counter reaches a value that is a multiple of Step. If Step is set to 1, the callback function is called once per record/key.

Returns:

-1 if a callback is already in place, 0 if the function is not found and 1 otherwise.

See Also:

LoadCallbackLib(java.lang.String, java.lang.String, boolean), UnLoadCallbackLib(boolean), SetSqlCallback(java.lang.Object, java.lang.String)

SetSqlCallback

public int SetSqlCallback(java.lang.Object Class,
                          java.lang.String FunctionName)

Sets the sqlimport callback

Parameters:

Class - Class containing the function

FunctionName - Function name that will be called. The function signature MUST be (otherwise the function will not be called) :

public static bool function_name(SQLCB_MODE mode, String msg, boolean def, pVOID extra)

If FunctioName is NULL the calback will be removed, a call with NULL is suggested after the import.

Returns:

-1 if a callback is already in place, 0 if the function is not found and 1 otherwise.

See Also:

LoadCallbackLib(java.lang.String, java.lang.String, boolean), UnLoadCallbackLib(boolean), SetCallbackOnRebuild(java.lang.Object, java.lang.String, int)

GetServerDateTime

public java.util.Calendar GetServerDateTime()
                                     throws CTException

Retrieve the current server date and time

Returns:

return the current server date and time in java calendar format

Throws:

CTException - in case of error

SetLogPath

public void SetLogPath(java.lang.String Path)
                throws CTException

Set transaction processing control file path for single-user applications

Parameters:

Path - transaction processing control file path

Throws:

CTException - in case of error

SetStatusLogPath

public void SetStatusLogPath(java.lang.String Path)
                      throws CTException

Set status log file path for single-user applications

Parameters:

Path - status log file path

Throws:

CTException - in case of error

SetTempPath

public void SetTempPath(java.lang.String Path)
                 throws CTException

Set status temporary file path for single-user applications

Parameters:

Path - temp file path

Throws:

CTException - in case of error

SetCommProtocolOption

public static void SetCommProtocolOption(int Option,
                                         java.lang.String Value)
                                  throws java.lang.Exception

Sets communication protocol option. This function must be called before allocate any session

Parameters:

Option - Option to set use the static members of COMM_PROTOCOL_OPTIONS to pass the proper option

Value - The value for the option to be set passed as string

Throws:

java.lang.Exception - in case of error

SetClientLibraryOption

public static void SetClientLibraryOption(int Option,
                                          java.lang.String Value)
                                   throws CTException

Sets client side library option. This function must be called before allocate any session

Parameters:

Option - Option to set use the static member of FairCom.CtreeDB.Types.CLIENT_OPTIONS to pass the proper option

Value - Option value, refer to the Javadoc of the static members of FairCom.CtreeDB.Types.CLIENT_OPTIONS to know the exact format

Throws:

CTException - in case of error

GetFailOverState

public boolean GetFailOverState()

Check if the failover state have been set.

Returns:

true if the failover state have been set.

ResetFailOverState

public void ResetFailOverState()

Resets the value of the failover state to 0.

IsPrimaryServer

public boolean IsPrimaryServer()
                        throws CTException

Check if the current server is primary in a pacemaker cluster.

Returns:

Returns true if the server is primary false otherwise.

Throws:

CTException - in case of error