Modifier and Type	Class and Description
private static class	XATransactionState.CancelXATransactionTask The implementation of TimerTask to cancel a global transaction.
private static class	XATransactionState.CleanupOrCancelMonitor A class used to monitor if the transaction is in the middle of cancelling or cleaning up on an error.

Field Summary

Modifier and Type	Field and Description
private EmbedXAResource	associatedResource
pack-priv int	associationState Association state of the transaction.
pack-priv XATransactionState.CleanupOrCancelMonitor	cleanupOrCancelMonitor
pack-priv final EmbedConnection	conn
pack-priv final EmbedXAResource	creatingResource
pack-priv boolean	isPrepared has this transaction been prepared.
pack-priv boolean	performTimeoutRollback Indicates whether this transaction is supposed to be rolled back by timeout.
pack-priv int	rollbackOnlyCode
pack-priv HashMap<EmbedXAResource, XATransactionState>	suspendedList When an XAResource suspends a transaction (end(TMSUSPEND)) it must be resumed using the same XAConnection.
pack-priv static final int	T0_NOT_ASSOCIATED
pack-priv static final int	T1_ASSOCIATED
pack-priv static final int	TC_COMPLETED
pack-priv XATransactionState.CancelXATransactionTask	timeoutTask A timer task scheduled for the time when the transaction will timeout.
pack-priv static final int	TRO_DEADLOCK Rollback-only due to deadlock
pack-priv static final int	TRO_FAIL Rollback-only due to end(TMFAIL)
pack-priv static final int	TRO_TIMEOUT Rollback-only due to timeout
pack-priv final XAXactId	xid

Constructor Summary

Access	Constructor and Description
pack-priv	XATransactionState(ContextManager cm, EmbedConnection conn, EmbedXAResource resource, XAXactId xid)

Method Summary

Modifier and Type	Method and Description
pack-priv void	cancel(String messageId) This function is called from the timer task when the transaction times out.
public void	cleanupOnError(Throwable The original error t) Implements org.apache.derby.iapi.services.context.Context.cleanupOnError. Contexts will be passed errors that are caught by the outer system when they are serious enough to require corrective action.
pack-priv boolean	end(EmbedXAResource resource, int flags, boolean endingCurrentXid)
private static ModuleFactory	getMonitor() Must be private so that user code can't call this entry point.
private static TimerFactory	getTimerFactory()
pack-priv synchronized void	scheduleTimeoutTask(long The number of milliseconds to be elapsed before the transaction will be rolled back. timeoutMillis) Schedule a timeout task which will rollback the global transaction after the specified time will elapse.
pack-priv void	start(EmbedXAResource resource, int flags)
pack-priv synchronized void	xa_commit(boolean Indicates whether to use one phase commit protocol. Otherwise two phase commit protocol will be used. onePhase) Commit the global transaction and cancel the timeout task.
private void	xa_finalize() This method cancels timeoutTask and assigns 'performTimeoutRollback = false'.
pack-priv synchronized int	xa_prepare() Prepare the global transaction for commit.
pack-priv synchronized void	xa_rollback() Rollback the global transaction and cancel the timeout task.

Inherited from org.apache.derby.iapi.services.context.ContextImpl:: appendErrorInfo getContextManager getIdName isLastHandler popMe pushMe

Field Detail

associatedResource	back to summary
private EmbedXAResource associatedResource

associationState	back to summary
pack-priv int associationState Association state of the transaction.

cleanupOrCancelMonitor	back to summary
pack-priv XATransactionState.CleanupOrCancelMonitor cleanupOrCancelMonitor

conn	back to summary
pack-priv final EmbedConnection conn

creatingResource	back to summary
pack-priv final EmbedXAResource creatingResource

isPrepared	back to summary
pack-priv boolean isPrepared has this transaction been prepared.

performTimeoutRollback	back to summary
pack-priv boolean performTimeoutRollback Indicates whether this transaction is supposed to be rolled back by timeout.

rollbackOnlyCode	back to summary
pack-priv int rollbackOnlyCode

suspendedList	back to summary
pack-priv HashMap<EmbedXAResource, XATransactionState> suspendedList When an XAResource suspends a transaction (end(TMSUSPEND)) it must be resumed using the same XAConnection. This has been the traditional Cloudscape/Derby behaviour, though there does not seem to be a specific reference to this behaviour in the JTA spec. Note that while the transaction is suspended by this XAResource, another XAResource may join the transaction and suspend it after the join.

suspendedList

back to summary

pack-priv HashMap<EmbedXAResource, XATransactionState> suspendedList

When an XAResource suspends a transaction (end(TMSUSPEND)) it must be resumed using the same XAConnection. This has been the traditional Cloudscape/Derby behaviour, though there does not seem to be a specific reference to this behaviour in the JTA spec. Note that while the transaction is suspended by this XAResource, another XAResource may join the transaction and suspend it after the join.

T0_NOT_ASSOCIATED	back to summary
pack-priv static final int T0_NOT_ASSOCIATED

T1_ASSOCIATED	back to summary
pack-priv static final int T1_ASSOCIATED

TC_COMPLETED	back to summary
pack-priv static final int TC_COMPLETED

timeoutTask	back to summary
pack-priv XATransactionState.CancelXATransactionTask timeoutTask A timer task scheduled for the time when the transaction will timeout.

TRO_DEADLOCK	back to summary
pack-priv static final int TRO_DEADLOCK Rollback-only due to deadlock

TRO_FAIL	back to summary
pack-priv static final int TRO_FAIL Rollback-only due to end(TMFAIL)

TRO_TIMEOUT	back to summary
pack-priv static final int TRO_TIMEOUT Rollback-only due to timeout

xid	back to summary
pack-priv final XAXactId xid

Constructor Detail

XATransactionState	back to summary
pack-priv XATransactionState(ContextManager cm, EmbedConnection conn, EmbedXAResource resource, XAXactId xid)

Method Detail

cancel back to summary

cancel	back to summary
pack-priv void cancel(String messageId) throws XAException This function is called from the timer task when the transaction times out. See Also `CancelXATransactionTask`

pack-priv void cancel(String messageId) throws XAException

This function is called from the timer task when the transaction times out.

See Also: CancelXATransactionTask

cleanupOnError	back to summary
public void cleanupOnError(Throwable t) Implements org.apache.derby.iapi.services.context.Context.cleanupOnError. Doc from org.apache.derby.iapi.services.context.Context.cleanupOnError. Contexts will be passed errors that are caught by the outer system when they are serious enough to require corrective action. They will be told what the error is, so that they can react appropriately. Most of the time, the contexts will react by either doing nothing or by removing themselves from the context manager. If there are no other references to the context, removing itself from the manager equates to freeing it. On an exception that is session severity or greater the Context must push itself off the stack. This is to ensure that after a session has been closed there are no Contexts on the stack that potentially hold references to objects, thus delaying their garbage collection. Contexts must release all their resources before removing themselves from their context manager. The context manager will "unwind" the contexts during cleanup in the reverse order they were placed on its global stack. If error is an instance of StandardException then an implementation of this method may throw a new exception if and only if the new exception is an instance of StandardException that is more severe than the original error or the new exception is a not an instance of StandardException (e.g java.lang.NullPointerException). Parameters t:Throwable The original error

cleanupOnError

back to summary

public void cleanupOnError(Throwable t)

Implements org.apache.derby.iapi.services.context.Context.cleanupOnError.

Doc from org.apache.derby.iapi.services.context.Context.cleanupOnError.

Contexts will be passed errors that are caught by the outer system when they are serious enough to require corrective action. They will be told what the error is, so that they can react appropriately. Most of the time, the contexts will react by either doing nothing or by removing themselves from the context manager. If there are no other references to the context, removing itself from the manager equates to freeing it.
On an exception that is session severity or greater the Context must push itself off the stack. This is to ensure that after a session has been closed there are no Contexts on the stack that potentially hold references to objects, thus delaying their garbage collection.

Contexts must release all their resources before removing themselves from their context manager.

The context manager will "unwind" the contexts during cleanup in the reverse order they were placed on its global stack.

If error is an instance of StandardException then an implementation of this method may throw a new exception if and only if the new exception is an instance of StandardException that is more severe than the original error or the new exception is a not an instance of StandardException (e.g java.lang.NullPointerException).

Parameters

t:Throwable: The original error

end	back to summary
pack-priv boolean end(EmbedXAResource resource, int flags, boolean endingCurrentXid) throws XAException

getMonitor	back to summary
private static ModuleFactory getMonitor() Must be private so that user code can't call this entry point.

getTimerFactory	back to summary
private static TimerFactory getTimerFactory()

scheduleTimeoutTask	back to summary
pack-priv synchronized void scheduleTimeoutTask(long timeoutMillis) Schedule a timeout task which will rollback the global transaction after the specified time will elapse. Parameters timeoutMillis:long The number of milliseconds to be elapsed before the transaction will be rolled back.

scheduleTimeoutTask

back to summary

pack-priv synchronized void scheduleTimeoutTask(long timeoutMillis)

Schedule a timeout task which will rollback the global transaction after the specified time will elapse.

Parameters

timeoutMillis:long: The number of milliseconds to be elapsed before the transaction will be rolled back.

start	back to summary
pack-priv void start(EmbedXAResource resource, int flags) throws XAException

xa_commit	back to summary
pack-priv synchronized void xa_commit(boolean onePhase) throws SQLException Commit the global transaction and cancel the timeout task. Parameters onePhase:boolean Indicates whether to use one phase commit protocol. Otherwise two phase commit protocol will be used.

xa_commit

back to summary

pack-priv synchronized void xa_commit(boolean onePhase) throws SQLException

Commit the global transaction and cancel the timeout task.

Parameters

onePhase:boolean: Indicates whether to use one phase commit protocol. Otherwise two phase commit protocol will be used.

xa_finalize	back to summary
private void xa_finalize() This method cancels timeoutTask and assigns 'performTimeoutRollback = false'.

xa_prepare	back to summary
pack-priv synchronized int xa_prepare() throws SQLException Prepare the global transaction for commit.

xa_rollback	back to summary
pack-priv synchronized void xa_rollback() throws SQLException Rollback the global transaction and cancel the timeout task.

org.apache.derby.impl.jdbc back to summary

private Class XATransactionState.CancelXATransactionTask

Class Inheritance

extends TimerTask

java.lang.Object
java.util.TimerTask
org.apache.derby.impl.jdbc.XATransactionState.CancelXATransactionTask

The implementation of TimerTask to cancel a global transaction.

Field Summary

Modifier and Type	Field and Description
private XATransactionState	xaState

Constructor Summary

Access	Constructor and Description
public	CancelXATransactionTask(XATransactionState the XA state object for the transaction to cancel xaState) Creates the cancellation task to be passed to a timer.

Method Summary

Modifier and Type	Method and Description
public synchronized boolean	cancel() Overrides java.util.TimerTask.cancel. Cancels this timer task.
public synchronized void	run() Implements abstract java.util.TimerTask.run. Implements java.lang.Runnable.run. Runs the cancel task of the global transaction

Inherited from java.util.TimerTask:: scheduledExecutionTime

Field Detail

xaState	back to summary
private XATransactionState xaState

Constructor Detail

CancelXATransactionTask	back to summary
public CancelXATransactionTask(XATransactionState xaState) Creates the cancellation task to be passed to a timer. Parameters xaState:XATransactionState the XA state object for the transaction to cancel

CancelXATransactionTask

back to summary

public CancelXATransactionTask(XATransactionState xaState)

Creates the cancellation task to be passed to a timer.

Parameters

xaState:XATransactionState: the XA state object for the transaction to cancel

Method Detail

cancel back to summary

cancel	back to summary
public synchronized boolean cancel() Overrides java.util.TimerTask.cancel. Doc from java.util.TimerTask.cancel. Cancels this timer task. If the task has been scheduled for one-time execution and has not yet run, or has not yet been scheduled, it will never run. If the task has been scheduled for repeated execution, it will never run again. (If the task is running when this call occurs, the task will run to completion, but will never run again.) Note that calling this method from within the `run` method of a repeating timer task absolutely guarantees that the timer task will not run again. This method may be called repeatedly; the second and subsequent calls have no effect. Returns:boolean true if this task is scheduled for one-time execution and has not yet run, or this task is scheduled for repeated execution. Returns false if the task was scheduled for one-time execution and has already run, or if the task was never scheduled, or if the task was already cancelled. (Loosely speaking, this method returns `true` if it prevents one or more scheduled executions from taking place.)

public synchronized boolean cancel()

Overrides java.util.TimerTask.cancel.

Doc from java.util.TimerTask.cancel.

Cancels this timer task. If the task has been scheduled for one-time execution and has not yet run, or has not yet been scheduled, it will never run. If the task has been scheduled for repeated execution, it will never run again. (If the task is running when this call occurs, the task will run to completion, but will never run again.)

Note that calling this method from within the run method of a repeating timer task absolutely guarantees that the timer task will not run again.

This method may be called repeatedly; the second and subsequent calls have no effect.

Returns:boolean: true if this task is scheduled for one-time execution and has not yet run, or this task is scheduled for repeated execution. Returns false if the task was scheduled for one-time execution and has already run, or if the task was never scheduled, or if the task was already cancelled. (Loosely speaking, this method returns true if it prevents one or more scheduled executions from taking place.)

run	back to summary
public synchronized void run() Implements abstract java.util.TimerTask.run. Implements java.lang.Runnable.run. Runs the cancel task of the global transaction

run

back to summary

public synchronized void run()

Implements abstract java.util.TimerTask.run.

Implements java.lang.Runnable.run.

Runs the cancel task of the global transaction

org.apache.derby.impl.jdbc back to summary

private Class XATransactionState.CleanupOrCancelMonitor

Class Inheritance

extends Object

java.lang.Object
org.apache.derby.impl.jdbc.XATransactionState.CleanupOrCancelMonitor

A class used to monitor if the transaction is in the middle of cancelling or cleaning up on an error. See DERBY-6879

Field Summary

Modifier and Type	Field and Description
private Long	cancelThreadId
private Long	cleanupThreadId

Constructor Summary

Access	Constructor and Description
private	CleanupOrCancelMonitor()

Method Summary

Modifier and Type	Method and Description
public synchronized boolean	Returns: `true` if it is okay to cancel. okToCancel() See if it is ok to cancel.
private synchronized boolean	Returns: `true` if it is okay to cleanup. okToCleanup() See if it is ok to cleanup.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cancelThreadId	back to summary
private Long cancelThreadId

cleanupThreadId	back to summary
private Long cleanupThreadId

Constructor Detail

CleanupOrCancelMonitor	back to summary
private CleanupOrCancelMonitor()

Method Detail

okToCancel back to summary

okToCancel	back to summary
public synchronized boolean okToCancel() See if it is ok to cancel. It is okay to cancel if the transaction is not cleaning up from an error. The assumption is that if the cleanUpOnError is/has been invoked, then there is no reason for the cancel to be processed as the transaction is going to end (ab)normally. Returns:boolean `true` if it is okay to cancel.

public synchronized boolean okToCancel()

See if it is ok to cancel. It is okay to cancel if the transaction is not cleaning up from an error. The assumption is that if the cleanUpOnError is/has been invoked, then there is no reason for the cancel to be processed as the transaction is going to end (ab)normally.

Returns:boolean: true if it is okay to cancel.

okToCleanup back to summary

okToCleanup	back to summary
private synchronized boolean okToCleanup() See if it is ok to cleanup. It is okay to cleanup if the transaction is not cancelling. The assumption is that if the cancel is/has been invoked, then there is no reason to try to mark the transaction as being in error. The transaction will be cancelled in any case. Returns:boolean `true` if it is okay to cleanup.

private synchronized boolean okToCleanup()

See if it is ok to cleanup. It is okay to cleanup if the transaction is not cancelling. The assumption is that if the cancel is/has been invoked, then there is no reason to try to mark the transaction as being in error. The transaction will be cancelled in any case.

Returns:boolean: true if it is okay to cleanup.

pack-priv final Class XATransactionState

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class XATransactionState.CancelXATransactionTask

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class XATransactionState.CleanupOrCancelMonitor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail