com.softwareag.tamino.db.api.accessor
Interface TSystemAccessor

All Superinterfaces:
TAccessor, TInvalidatableAccessor
All Known Implementing Classes:
TSystemAccessorImpl, TSystemAccessorTimeLoggingImpl

public interface TSystemAccessor
extends TAccessor

TSystemAccessor is the interface for the access of Tamino and Tamino API system information.

Version:
$Revision: 1.7 $
Author:
Stefan Liebig

Method Summary
 java.lang.String getAPIVersion()
          Gets the version number of the Tamino API.
 java.lang.String getFullServerVersion()
          Gets the full version information of the Tamino database server.
 java.lang.String getServerAPIVersion()
          Deprecated. Please use getServerVersion() instead.
 TServerEcho getServerEcho()
          Gets an instance of the TServerEcho instance providing informationon the Tamino database server.
 TServerTime getServerTime()
          Gets an instance of the TServerTime instance providing time information on the Tamino database server up.
 java.lang.String getServerVersion()
          Gets the version of the Tamino database server.
 boolean isServerAlive()
          Checks whether the Tamino database is running by trying to establish a connection.
 
Methods inherited from interface com.softwareag.tamino.db.api.accessor.TAccessor
cancelRequests, getAccessLocation, getApplicationName, getCanBeCancelled, getLockMode, getLockwaitMode, getMaximumRequestDuration, setAccessLocation, setApplicationName, setCanBeCancelled, setLockMode, setLockwaitMode, setMaximumRequestDuration
 
Methods inherited from interface com.softwareag.tamino.db.api.accessor.TInvalidatableAccessor
invalidate
 

Method Detail

isServerAlive

boolean isServerAlive()
                      throws TAccessorException
Checks whether the Tamino database is running by trying to establish a connection. It returns true if this succeeds, false otherwise.

Returns:
true if a connection could be established with the database, false otherwise..
Throws:
TAccessorException - signals an error while attempting to connect to the database.

getServerEcho

TServerEcho getServerEcho()
                          throws TAccessorException
Gets an instance of the TServerEcho instance providing informationon the Tamino database server.

Returns:
a TServerEcho instance.
Throws:
TAccessorException - signals an error while attempting to connect to retrieve the information from the database.

getServerVersion

java.lang.String getServerVersion()
                                  throws TAccessorException
Gets the version of the Tamino database server. The version is returned as a string consisting of 4 numbers each separated by a period, e.g. 3.1.1.12.

Returns:
Tamino server version.
Throws:
TAccessorException - signals an error while attempting to to retrieve the information from the database.

getFullServerVersion

java.lang.String getFullServerVersion()
                                      throws TAccessorException
Gets the full version information of the Tamino database server. The full version is returned as a string consisting of 4 numbers plus additional information each separated by a period, e.g. 4.2.1.293.0.

This feature requires Tamino 4.2

Returns:
Tamino full server version.
Throws:
TAccessorException - signals an error while attempting to to retrieve the information from the database.

getServerAPIVersion

java.lang.String getServerAPIVersion()
                                     throws TAccessorException
Deprecated. Please use getServerVersion() instead.

Gets the version of the Tamino server API. The version is returned as a string consisting of 2 numbers separated by a period, e.g. 1.1.

Returns:
Tamino server API version.
Throws:
TAccessorException - signals an error while attempting to connect to retrieve the information from the database.

getServerTime

TServerTime getServerTime()
                          throws TAccessorException
Gets an instance of the TServerTime instance providing time information on the Tamino database server up.

Returns:
TServerTime instance.
Throws:
TAccessorException - signals an error while attempting to retrieve the information from the database.

getAPIVersion

java.lang.String getAPIVersion()
Gets the version number of the Tamino API. The version is returned as a string consisting of 4 numbers each separated by a period, e.g. 3.1.1.12.

Returns:
API version number or null if not present.


Copyright (c) 2013 Software AG. All Rights Reserved.