Package com.softwareag.tamino.db.api.connection

Provides classes and interfaces to establish connections and manage transactions.

See:
          Description

Interface Summary
TConnection The TConnection interface represents a connection to a Tamino database.
TConnectionPool TConnectionPool represents a pool of openned connections.
TDarkConnection  
TGlobalTransaction TGlobalTransaction represents a global (2PC) transaction.
TLocalTransaction TLocalTransaction represents a local transaction context.
TTransaction TTransaction is the base interface for Tamino transactions.
 

Class Summary
TAutoCommitTransactionMode TAutoCommitTransactionMode is the implementation of TTransactionMode for auto commit transaction mode.
TConnectionFactory TConnectionFactory is the factory class for the instantiation of TConnection instances.
TConnectionImpl TConnectionImpl is the implementation class for TConnection/TDarkConnection.
TConnectionMessages This class defines constants for the keys of the messages defined in com.softwareag.tamino.db.api.connection.TConnectionMessages.xml.
TConnectionPoolDescriptor TConnectionPoolDescriptor describes all the properties for a connection pool.
TConnectionPoolImpl TConnectionPool represents a pool of openned connections.
TConnectionPoolManager TConnectionPoolManager manages one or more pools of connections.
TConnectionPoolStatistics TConnectionPoolStatistics describes statistical information for a connection pool.
TGlobalTransactionMode TGlobalTransactionMode is the implementation of TTransactionMode for global transaction mode.
TGlobalTransactionSpecifier TGlobalTransactionSpecifier wraps the parameters which are neccessary to initiate a global transaction.
TGlobalTransactionSpecifier.TCompletion Constant class for the completion mode of a global transaction.
TGroupsParameter Represents the groups parameter for the connection.
TIsolationDegree Class representing Tamino specific isolation degrees.
TLocalTransactionMode TLocalTransactionMode is the implementation of TTransactionMode for local transaction mode.
TLockMode Class representing Tamino specific lock modes.
TLockwaitMode Class representing Tamino specific lockwait modes.
TPooledConnection This class is a wrapper around one or two Connections, overriding the close method to just inform the pool that it's available for reuse again, and the isClosed method to return the state of the wrapper instead of the Connection.
TSessionState TSesssionState is the abstraction of the state information of a Tamino session.
TTransactionMode TTransactionMode represents a general abstraction for a specific transaction state.
TTransactionModeCoordinator TTransactionModeCoordinator is responsible for the coordination of the concrete transaction modes that can take place during the lifetime of a database session with Tamino.
TTransactionParameters TTransactionParameters is the collection of the transactional parameters used for either the connection or in a limited way for the accessors.
TTransactionTimeoutParameters TTransactionTimeoutParameters is the collection of the timeout parameters used for the connection.
 

Exception Summary
TConnectionCloseException TConnectionCloseException represents an exception that can occur during the closure of an opened TConnection instance.
TConnectionException TConnectionException
TConnectionNotAvailableException TConnectionNotAvailableException represents a general failure that occurs when one tries to retrieve an openned connection from a connection pool manager.
TServerNotAvailableException TServerNotAvailableException
TSessionStateUpdateException TSessionStateUpdateException represents an exception that can occur during the attempt to update the session state.
TTransactionException TTransactionException represents a general purpose exception for the transaction handling with Tamino.
TTransactionModeChangeException TTransactionModeChangeException represents an exception that can occur during the attempt to change a transaction mode.
TTransactionModeException TTransactionModeException represents a general base exception for error situations that can occur during the lifetime of a transaction mode.
TTransactionModeUpdateException TTransactionModeUpdateException represents an exception that can occur during the attempt to update a transaction mode.
 

Package com.softwareag.tamino.db.api.connection Description

Provides classes and interfaces to establish connections and manage transactions.

This package is the starting point for each user of the Tamino API for Java. The first thing you have to do, is to acquire a TConnection instance via the TConnectionFactory class. A TConnection represents a session to a particula Tamino database indicated by a URL like http://host/tamino/myDB.

A TConnection instance serves as a factory for accessors. An accessor is always bound to a the TConnection instance it was created by, and is therefore also bound to the Tamino database for which the TConnection instance was created.

A TConnection instance is also used to determine the transaction mode in which Tamino database operations will be performed. There are two transaction modes available: the autocommit mode and the local transaction mode. When acquiring a new TConnection instance, it is automatically in autocommit mode. You can switch to local transcation mode by the useLocalTransactionMode method and back to autocommit mode by the useAutoCommitMode method. In autocommit mode, each Tamino database operation is automatically contained in its own transaction and Tamino will automatically commit each transaction if the operation succeeds. In local transaction mode, more than one Tamino database operation can be combined in one transaction. You can set the transaction boundaries explicitly by the TLocalTransaction interface. A local transaction is bound to a TConnection instance. Therefore, if you switch to local transaction mode, all accessors created by that TConnection instance are affected, i.e. the database operations triggered by any of these accessors will be done in the scope of the local transaction.

If a TConnection instance is no longer of use, it should be closed by the close method. All resources required for the database session will be relinquished. Once a TConnection instance is closed it can no longer be used.

The following code snippet shows how you can work with this package:

    
    TConnectionFactory connectionFactory = TConnectionFactory.getInstance();
    TConnection connection = connectionFactory.newConnection( databaseURI , userId , password );
    TXMLObjectAccessor xmlAccessor = connection.newXMLObjectAccessor( accessLocation , TDOMObjectModel.getInstance() );
    TLocalTransaction localTransaction = connection.useLocalTransactionMode();
    // Now the xmlAccessor can be used within a local transactional context
    ...
    localTransaction.commit();
    ...
    connection.close();
    
  



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