org.eclipse.tptp.trace.arm.internal.transaction
Class ArmTransactionImpl

java.lang.Object
  org.eclipse.tptp.trace.arm.internal.transaction.ArmInterfaceImpl
      org.eclipse.tptp.trace.arm.internal.transaction.ArmTransactionImpl

All Implemented Interfaces:

org.opengroup.arm40.transaction.ArmInterface, org.opengroup.arm40.transaction.ArmTransaction

Direct Known Subclasses:

ArmTransactionWithMetricsImpl

public class ArmTransactionImpl
extends ArmInterfaceImpl
implements org.opengroup.arm40.transaction.ArmTransaction

For most applications, ArmTransaction is the most important of all the ARM classes, and the most frequently used. Instances of ArmTransaction represent transactions when they execute. A "transaction" is any unit of work that has a clearly understood beginning and ending point, and which begins and ends in the same VM. ArmTransaction is created with the newArmTransaction() method of ArmTransactionFactory.

                ArmConstants.STATUS_ABORT - if the transaction was blocked on a thread.
      ArmConstants.STATUS_FAILED - If the transaction failed.
      ArmConstants.STATUS_GOOD - If a transaction has successfully started or has been updated.
      ArmConstants.STATUS_INVALID - When a transaction is instructed to be stopped, the transaction will be marked invlid and it should never execute again.
      ArmConstants.STATUS_UNKNOWN - When a transaction is first created it will be in an unknown state.
 

Field Summary

protected long	_arrivalTime
protected long	_completionTime
protected org.opengroup.arm40.transaction.ArmIdentityProperties	_contextProperties
protected java.lang.String	_contextURIValue
protected long	_currentThreadId
protected long	_durationTime
static ARMLogger	_logger

Fields inherited from class org.eclipse.tptp.trace.arm.internal.transaction.ArmInterfaceImpl

validationPropertyKey

Constructor Summary

ArmTransactionImpl(org.opengroup.arm40.transaction.ArmApplication app, org.opengroup.arm40.transaction.ArmTransactionDefinition definition)
Create the ARM Transaction.

ArmTransactionImpl(org.opengroup.arm40.transaction.ArmApplication app, org.opengroup.arm40.transaction.ArmTransactionDefinition definition, java.lang.String[] contextValues)
Create the ARM Transaction.

Method Summary

int	bindThread()
long	blocked()
org.opengroup.arm40.transaction.ArmApplication	getApplication()
long	getArrivalTime() Returns the arrival time of this transaction, also known as the time when this transaction was started.
long	getCompletionTime() Returns the completion time of this transaction, also known as the time when this transaction was stopped.
java.lang.String	getContextURIValue()
java.lang.String	getContextValue(int index)
org.opengroup.arm40.transaction.ArmCorrelator	getCorrelator()
org.opengroup.arm40.transaction.ArmTransactionDefinition	getDefinition()
org.opengroup.arm40.transaction.ArmCorrelator	getParentCorrelator()
int	getStatus()
org.opengroup.arm40.transaction.ArmUser	getUser()
boolean	isTraceRequested()
int	reset()
int	setArrivalTime()
int	setContextURIValue(java.lang.String value)
int	setContextValue(int index, java.lang.String value)
int	setTraceRequested(boolean traceState)
int	setUser(org.opengroup.arm40.transaction.ArmUser user)
int	start()
int	start(org.opengroup.arm40.transaction.ArmCorrelator parentCorr)
int	start(byte[] parentCorr)
int	start(byte[] parentCorr, int offset)
int	stop(int status)
int	stop(int status, java.lang.String diagnosticDetail)
java.lang.String	toString() Returns a XML string based version of this entity.
int	unbindThread()
int	unblocked(long blockHandle)
int	update()

Methods inherited from class org.eclipse.tptp.trace.arm.internal.transaction.ArmInterfaceImpl

checkValidation, getErrorCode, getErrorMessage, getFactory, setErrorCode, setFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opengroup.arm40.transaction.ArmInterface

getErrorCode, getErrorMessage, setErrorCode

Field Detail

_logger

public static final ARMLogger _logger

_contextProperties

protected org.opengroup.arm40.transaction.ArmIdentityProperties _contextProperties

_arrivalTime

protected long _arrivalTime

_durationTime

protected long _durationTime

_completionTime

protected long _completionTime

_currentThreadId

protected long _currentThreadId

_contextURIValue

protected java.lang.String _contextURIValue

Constructor Detail

ArmTransactionImpl

public ArmTransactionImpl(org.opengroup.arm40.transaction.ArmApplication app,
                          org.opengroup.arm40.transaction.ArmTransactionDefinition definition)

Create the ARM Transaction.

Parameters:

app -

definition -

ArmTransactionImpl

public ArmTransactionImpl(org.opengroup.arm40.transaction.ArmApplication app,
                          org.opengroup.arm40.transaction.ArmTransactionDefinition definition,
                          java.lang.String[] contextValues)

Create the ARM Transaction.

Parameters:

app -

definition -

Method Detail

bindThread

public int bindThread()

Specified by:

bindThread in interface org.opengroup.arm40.transaction.ArmTransaction

blocked

public long blocked()

Specified by:

blocked in interface org.opengroup.arm40.transaction.ArmTransaction

getApplication

public org.opengroup.arm40.transaction.ArmApplication getApplication()

Specified by:

getApplication in interface org.opengroup.arm40.transaction.ArmTransaction

getContextURIValue

public java.lang.String getContextURIValue()

Specified by:

getContextURIValue in interface org.opengroup.arm40.transaction.ArmTransaction

getContextValue

public java.lang.String getContextValue(int index)

Specified by:

getContextValue in interface org.opengroup.arm40.transaction.ArmTransaction

getCorrelator

public org.opengroup.arm40.transaction.ArmCorrelator getCorrelator()

Specified by:

getCorrelator in interface org.opengroup.arm40.transaction.ArmTransaction

getParentCorrelator

public org.opengroup.arm40.transaction.ArmCorrelator getParentCorrelator()

Specified by:

getParentCorrelator in interface org.opengroup.arm40.transaction.ArmTransaction

getStatus

public int getStatus()

Specified by:

getStatus in interface org.opengroup.arm40.transaction.ArmTransaction

getDefinition

public org.opengroup.arm40.transaction.ArmTransactionDefinition getDefinition()

Specified by:

getDefinition in interface org.opengroup.arm40.transaction.ArmTransaction

getUser

public org.opengroup.arm40.transaction.ArmUser getUser()

Specified by:

getUser in interface org.opengroup.arm40.transaction.ArmTransaction

isTraceRequested

public boolean isTraceRequested()

Specified by:

isTraceRequested in interface org.opengroup.arm40.transaction.ArmTransaction

reset

public int reset()

Specified by:

reset in interface org.opengroup.arm40.transaction.ArmTransaction

setArrivalTime

public int setArrivalTime()

Specified by:

setArrivalTime in interface org.opengroup.arm40.transaction.ArmTransaction

getArrivalTime

public long getArrivalTime()

Returns the arrival time of this transaction, also known as the time when this transaction was started.

Returns:

getCompletionTime

public long getCompletionTime()

Returns the completion time of this transaction, also known as the time when this transaction was stopped.

Returns:

setContextURIValue

public int setContextURIValue(java.lang.String value)

Specified by:

setContextURIValue in interface org.opengroup.arm40.transaction.ArmTransaction

setContextValue

public int setContextValue(int index,
                           java.lang.String value)

Specified by:

setContextValue in interface org.opengroup.arm40.transaction.ArmTransaction

setTraceRequested

public int setTraceRequested(boolean traceState)

Specified by:

setTraceRequested in interface org.opengroup.arm40.transaction.ArmTransaction

setUser

public int setUser(org.opengroup.arm40.transaction.ArmUser user)

Specified by:

setUser in interface org.opengroup.arm40.transaction.ArmTransaction

start

public int start()

Specified by:

start in interface org.opengroup.arm40.transaction.ArmTransaction

start

public int start(byte[] parentCorr)

Specified by:

start in interface org.opengroup.arm40.transaction.ArmTransaction

start

public int start(byte[] parentCorr,
                 int offset)

Specified by:

start in interface org.opengroup.arm40.transaction.ArmTransaction

start

public int start(org.opengroup.arm40.transaction.ArmCorrelator parentCorr)

Specified by:

start in interface org.opengroup.arm40.transaction.ArmTransaction

stop

public int stop(int status)

Specified by:

stop in interface org.opengroup.arm40.transaction.ArmTransaction

stop

public int stop(int status,
                java.lang.String diagnosticDetail)

Specified by:

stop in interface org.opengroup.arm40.transaction.ArmTransaction

unbindThread

public int unbindThread()

Specified by:

unbindThread in interface org.opengroup.arm40.transaction.ArmTransaction

unblocked

public int unblocked(long blockHandle)

Specified by:

unblocked in interface org.opengroup.arm40.transaction.ArmTransaction

update

public int update()

Specified by:

update in interface org.opengroup.arm40.transaction.ArmTransaction

toString

public java.lang.String toString()

Returns a XML string based version of this entity.

Overrides:

toString in class java.lang.Object

Returns:

a XML string based version of this entity.