com.sun.jdo.spi.persistence.support.sqlstore.ejb

Class EJBHelper

java.lang.Object

com.sun.jdo.spi.persistence.support.sqlstore.ejb.EJBHelper

public class EJBHelper
extends Object

Provides helper methods for a Forte for Java implementation with the application server specific information in the distributed transaction environment. Calls corresponding methods on the registered class which implements TransactionHelper interface.

Constructor Summary

Constructors

Constructor and Description
EJBHelper()

Method Summary

Modifier and Type	Method and Description
static Connection	getConnection(Object resource, String username, String password) Called in a managed environment to get a Connection from the application server specific resource.
static String	getDDLNamePrefix(Object info) Returns name prefix for DDL files extracted from the info instance by the application server specific code.
static TransactionManager	getLocalTransactionManager() Called in a managed environment to access a TransactionManager for managing local transaction boundaries and synchronization for local transaction completion.
static Connection	getNonTransactionalConnection(Object resource, String username, String password) Called in a managed environment to get a non-transactional Connection from the application server specific resource.
static Transaction	getTransaction() Returns Transaction instance that can be used to register synchronizations.
static UserTransaction	getUserTransaction() Returns the UserTransaction associated with the calling thread.
static boolean	isManaged() Identifies the managed environment behavior.
static void	notifyApplicationUnloaded(ClassLoader cl) Called to notify a ApplicationLifeCycleEventListeners that an application is unloaded.
static void	postInvoke(Object im) Called in a managed environment at the end of the Transaction.beforeCompletion() to de-register the component with the app server if necessary.
static Object	preInvoke(Object component) Called at the beginning of the Transaction.beforeCompletion() to register the component with the app server if necessary.
static void	registerApplicationLifeCycleEventListener(ApplicationLifeCycleEventListener listener) Called to register a ApplicationLifeCycleEventListener.
static void	registerSynchronization(Transaction jta, Synchronization sync) Called in a managed environment to register internal Synchronization object with the Transaction Synchronization.
static void	registerTransactionHelper(TransactionHelper h) Register class that implements TransactionHelper interface Should be called by a static method at class initialization time.
static PersistenceManagerFactory	replaceInternalPersistenceManagerFactory(PersistenceManagerFactory pmf) Returns the hashed instance of PersistenceManagerFactory that compares equal to the newly created instance or the instance itself if it is not found.
static void	setPersistenceManagerFactoryDefaults(PersistenceManagerFactory pmf) Set environment specific default values for the given PersistenceManagerFactory.
static int	translateStatus(int st) Translates local representation of the Transaction Status to javax.transaction.Status value.
static Statement	unwrapStatement(Statement stmt) This method unwraps given Statement and return the Statement from JDBC driver if possible.

Methods inherited from class java.lang.Object

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

Constructor Detail

EJBHelper

public EJBHelper()

Method Detail

registerTransactionHelper

public static void registerTransactionHelper(TransactionHelper h)

Register class that implements TransactionHelper interface Should be called by a static method at class initialization time. If null is passed, sets the reference to the DefaultTransactionHelper.

Parameters:

h - application server specific implemetation of the TransactionHelper interface.

getTransaction

public static Transaction getTransaction()

Returns Transaction instance that can be used to register synchronizations. In a non-managed environment or if there is no transaction associated with the current thread, this method returns null.

Returns:

the Transaction instance for the calling thread

See Also:

TransactionHelper.getTransaction()

getUserTransaction

public static UserTransaction getUserTransaction()

Returns the UserTransaction associated with the calling thread. In a non-managed environment or if there is no transaction currently in progress, this method returns null.

Returns:

the UserTransaction instance for the calling thread

See Also:

TransactionHelper.getUserTransaction()

isManaged

public static boolean isManaged()

Identifies the managed environment behavior.

Returns:

true if this implementation represents the managed environment.

translateStatus

public static int translateStatus(int st)

Translates local representation of the Transaction Status to javax.transaction.Status value. In a non-managed environment returns the value passed to it as an argument.

Parameters:

st - Status value

Returns:

the javax.transaction.Status value of the status

See Also:

TransactionHelper.translateStatus(int st)

replaceInternalPersistenceManagerFactory

public static PersistenceManagerFactory replaceInternalPersistenceManagerFactory(PersistenceManagerFactory pmf)

Returns the hashed instance of PersistenceManagerFactory that compares equal to the newly created instance or the instance itself if it is not found. In a non-managed environment returns the value passed to it as an argument.

Parameters:

pmf - PersistenceManagerFactory instance to be replaced

Returns:

the PersistenceManagerFactory known to the runtime

See Also:

TransactionHelper.replaceInternalPersistenceManagerFactory( PersistenceManagerFactory pmf)

preInvoke

public static Object preInvoke(Object component)

Called at the beginning of the Transaction.beforeCompletion() to register the component with the app server if necessary. In a non-managed environment or if the postInvoke method does not use the value, this method returns null.

Parameters:

component - an array of Objects

Returns:

implementation-specific Object

See Also:

TransactionHelper.preInvoke(Object component)

postInvoke

public static void postInvoke(Object im)

Called in a managed environment at the end of the Transaction.beforeCompletion() to de-register the component with the app server if necessary.

Parameters:

im - implementation-specific Object

See Also:

TransactionHelper.postInvoke(Object im)

registerSynchronization

public static void registerSynchronization(Transaction jta,
                                           Synchronization sync)
                                    throws RollbackException,
                                           SystemException

Called in a managed environment to register internal Synchronization object with the Transaction Synchronization. If available, this registration provides special handling of the registered instance, calling it after all user defined Synchronization instances.

Parameters:

jta - the Transaction instance for the calling thread.

sync - the internal Synchronization instance to register.

Throws:

javax.transaction.RollbackException.

javax.transaction.SystemException.

RollbackException

SystemException

See Also:

Transaction.registerSynchronization(Synchronization sync), TransactionHelper.registerSynchronization(Transaction jta, Synchronization sync)

getConnection

public static Connection getConnection(Object resource,
                                       String username,
                                       String password)
                                throws SQLException

Called in a managed environment to get a Connection from the application server specific resource. In a non-managed environment throws an Exception as it should not be called.

Parameters:

resource - the application server specific resource.

username - the resource username. If null, Connection is requested without username and password validation.

password - the password for the resource username.

Returns:

a Connection.

Throws:

java.sql.SQLException.

SQLException

getNonTransactionalConnection

public static Connection getNonTransactionalConnection(Object resource,
                                                       String username,
                                                       String password)
                                                throws SQLException

Called in a managed environment to get a non-transactional Connection from the application server specific resource. In a non-managed environment throws an Exception as it should not be called.

Parameters:

resource - the application server specific resource.

username - the resource username. If null, Connection is requested without username and password validation.

password - the password for the resource username.

Returns:

a Connection.

Throws:

java.sql.SQLException.

SQLException

getLocalTransactionManager

public static TransactionManager getLocalTransactionManager()

Called in a managed environment to access a TransactionManager for managing local transaction boundaries and synchronization for local transaction completion.

Returns:

javax.transaction.TransactionManager

unwrapStatement

public static Statement unwrapStatement(Statement stmt)

This method unwraps given Statement and return the Statement from JDBC driver if possible.

setPersistenceManagerFactoryDefaults

public static void setPersistenceManagerFactoryDefaults(PersistenceManagerFactory pmf)

Set environment specific default values for the given PersistenceManagerFactory.

Parameters:

pmf - the PersistenceManagerFactory.

getDDLNamePrefix

public static String getDDLNamePrefix(Object info)

Returns name prefix for DDL files extracted from the info instance by the application server specific code.

Parameters:

info - the instance to use for the name generation.

Returns:

name prefix as String.

registerApplicationLifeCycleEventListener

public static void registerApplicationLifeCycleEventListener(ApplicationLifeCycleEventListener listener)

Called to register a ApplicationLifeCycleEventListener. If ApplicationLifeCycle management is active (typically in managed environment), the registered listener will receive a call back for lifecycle events.

Parameters:

listener - An instance of ApplicationLifeCycleEventListener.

notifyApplicationUnloaded

public static void notifyApplicationUnloaded(ClassLoader cl)

Called to notify a ApplicationLifeCycleEventListeners that an application is unloaded. If ApplicationLifeCycle management is active (typically in managed environment), the registered listener will handle the notification.

Parameters:

cl - An instance of the ClassLoader that loaded the application.