AbstractUserTransactionService

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.atomikos.icatch.config.imp
Class AbstractUserTransactionService

java.lang.Object
  com.atomikos.icatch.config.imp.AbstractUserTransactionService

All Implemented Interfaces:: UserTransactionService

Direct Known Subclasses:: AbstractJtaUserTransactionService

public abstract class AbstractUserTransactionService
extends Object
implements UserTransactionService
extends Object
implements UserTransactionService

Copyright © 2001, Atomikos. All rights reserved. The user's (client program) view of the transaction manager's configuration, a compact facade with all the information the client program needs. This base class should be overridden for each module (CORBA, trmi,...).

Constructor Summary
`AbstractUserTransactionService()`

Method Summary
`protected static String`	`findOrCreateFolder(String path)` Utility method to find or create a given folder
`CompositeTransactionManager`	`getCompositeTransactionManager()` Get the composite transaction manager for the config.
`protected static String`	`getDefaultName()` Utility method to get a default TM name.
`ExportingTransactionManager`	`getExportingTransactionManager()` Get the ExportingTransactionManager instance
`protected static String`	`getHostAddress()` Utility method to get the local host address.
`ImportingTransactionManager`	`getImportingTransactionManager()` Get the ImportingTransactionManager instance.
`Enumeration`	`getLogAdministrators()` Get the log administrators.
`Enumeration`	`getResources()` Get the resources registered.
`static String`	`getTrimmedProperty(String name, Properties p)` Utility method to get and trim 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`	`setLogAdministrators(List administrators)` Sets a list of administrators to add.
`void`	`setRecoverableResources(List resources)` Sets a list of resources to add for recovery.
`void`	`setTSListeners(List listeners)` Sets the list of listeners to add.
`void`	`shutdown(boolean force)` Shuts down the TM.
`void`	`shutdownForce()` Convenience method for calling shutdown with force option
`void`	`shutdownWait()` Convenience method for calling shutdown with the wait option.

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

Methods inherited from interface com.atomikos.icatch.config.UserTransactionService
`createTSInitInfo, getTransactionManager, getTSMetaData, getUserTransaction`

Constructor Detail

AbstractUserTransactionService

public AbstractUserTransactionService()

Method Detail

getTrimmedProperty

public static String getTrimmedProperty(String name,
                                        Properties p)

Utility method to get and trim properties.

Parameters:: name - The name of the property to get.; p - The properties to look in.
Returns:: String The property without leading or trailing spaces, or null if not found.

getDefaultName

protected static String getDefaultName()

Utility method to get a default TM name.

Returns:: A default TM name based on the local IP.

getHostAddress

protected static String getHostAddress()

Utility method to get the local host address.

Returns:

findOrCreateFolder

protected static String findOrCreateFolder(String path)

Utility method to find or create a given folder

Parameters:: path - The folder path.
Returns:: String The resulting file path, or a default if the given path is not valid as a folder.