UserTransactionServiceImp (Transactions API 3.7.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.atomikos.icatch.config
Class UserTransactionServiceImp

java.lang.Object
  com.atomikos.icatch.config.UserTransactionServiceImp

All Implemented Interfaces:: UserTransactionService, Serializable

public class UserTransactionServiceImp
extends Object
implements Serializable, UserTransactionService
extends Object
implements Serializable, UserTransactionService

This is the main class for creating a UserTransactionService instance. This class is the client's main entry point into the transaction engine. The creation of a user transaction happens via a UserTransactionServiceFactory which is looked up by this object behind the scenes. Instances can be serialized to disk and re-read at a later time. Note: deserialization will only work in the SAME configuration as the one that did the streaming out. In particular, if no identical Atomikos transaction service is present in the target VM then the process of deserialization will be erroneous.

See Also:: Serialized Form

Field Summary
`static String`	`DEFAULT_PROPERTIES_FILE_NAME` The default file name for the transaction service's init parameters.
`static String`	`FILE_PATH_PROPERTY_NAME` The name of the system property whose value corresponds to the path towards the properties file for initialization of the transaction service.
`static String`	`HIDE_INIT_FILE_PATH_PROPERTY_NAME` The name of the system property to disable printing 'Using init file...' messages to System.err - if this system property to an arbitrary value then no such message will be shown on System.err during startup.
`static String`	`NO_FILE_PROPERTY_NAME` Constant denoting the system property name that suggest NOT to use any configuration file for the transaction service's properties.

Constructor Summary
`UserTransactionServiceImp()` Default constructor.
`UserTransactionServiceImp(Properties properties)` Constructs a new instance and initializes it with the given properties.

Method Summary
`TSInitInfo`	`createTSInitInfo()` Create a TSInitInfo for this transaction service.
`CompositeTransactionManager`	`getCompositeTransactionManager()` Get the composite transaction manager for the config.
`ExportingTransactionManager`	`getExportingTransactionManager()` Get the ExportingTransactionManager instance
`ImportingTransactionManager`	`getImportingTransactionManager()` Get the ImportingTransactionManager instance.
`Enumeration`	`getLogAdministrators()` Get the log administrators.
`Enumeration`	`getResources()` Get the resources registered.
`TransactionManager`	`getTransactionManager()` Get the JTA transaction manager handle for the config.
`TSMetaData`	`getTSMetaData()` Get the meta data for the transaction service.
`UserTransaction`	`getUserTransaction()` Get the JTA user transaction, for client-demarcated transactions.
`void`	`init()` Convenience init method for DI containers like Spring.
`void`	`init(Properties properties)`
`void`	`init(TSInitInfo info)` Initializes the intra-VM transaction manager.
`void`	`registerLogAdministrator(LogAdministrator admin)` Register a LogAdministrator instance for administration.
`void`	`registerResource(RecoverableResource res)` Register a new resource for recovery.
`void`	`registerTSListener(TSListener listener)` Registers a listener with the transaction service.
`void`	`removeLogAdministrator(LogAdministrator admin)` Removes the given log administrator.
`void`	`removeResource(RecoverableResource res)` Removes the given resource.
`void`	`removeTSListener(TSListener listener)` Removes a listener from the transaction service.
`void`	`setInitialLogAdministrators(List administrators)` Dependency injection of all administrators to be added during init.
`void`	`setInitialRecoverableResources(List resources)` Dependency injection of all resources to be added during init.
`void`	`setInitialTSListeners(List listeners)` Dependency injection of all listeners to be added during init.
`void`	`shutdown(boolean force)` Shuts down the TM.
`void`	`shutdownForce()` Convenience shutdown method for DI containers like Spring.
`void`	`shutdownWait()` Convenience shutdown method for DI containers like Spring.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

NO_FILE_PROPERTY_NAME

public static final String NO_FILE_PROPERTY_NAME

Constant denoting the system property name that suggest NOT to use any configuration file for the transaction service's properties. If this a system property with this name is set to an arbitrary value then the transaction service will attempt initialization based on system properties only. In that case, all the parameters that would normally be set through the properties file have to be supplied as system properties with the same name and corresponding value.

See Also:: Constant Field Values

FILE_PATH_PROPERTY_NAME

public static final String FILE_PATH_PROPERTY_NAME

The name of the system property whose value corresponds to the path towards the properties file for initialization of the transaction service. If this system property is set then the corresponding file path will be used to load the initialization parameters for the transaction service. Otherwise, the transaction service will attempt to load the default file from the classpath.

See Also:: Constant Field Values

HIDE_INIT_FILE_PATH_PROPERTY_NAME

public static final String HIDE_INIT_FILE_PATH_PROPERTY_NAME

The name of the system property to disable printing 'Using init file...' messages to System.err - if this system property to an arbitrary value then no such message will be shown on System.err during startup.

See Also:: Constant Field Values

DEFAULT_PROPERTIES_FILE_NAME

public static final String DEFAULT_PROPERTIES_FILE_NAME

The default file name for the transaction service's init parameters.

See Also:: Constant Field Values

Constructor Detail

UserTransactionServiceImp

public UserTransactionServiceImp()

Default constructor.

UserTransactionServiceImp

public UserTransactionServiceImp(Properties properties)

Constructs a new instance and initializes it with the given properties. If this constructor is called, then file-based initialization is overridden. In particular, the given properties will take precedence over the file-based properties (if found).

Parameters:: properties - The properties.

Method Detail