oracle.tmm.tcc

Interface TccTransaction

public interface TccTransaction

TccTransaction - Interface for managing a TCC transaction

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPLICATION_TCC_JSON TCC coordinator endpoints media type
static java.lang.String	HEADER_TCC_LINK_REL_VAL
static java.lang.String	HEADER_TCC_PARTICIPANT_REL_VAL
static java.lang.String	HEADER_TCC_TIME_LIMIT_PARAM_VAL

Method Summary

Modifier and Type	Method and Description
void	addTccParticipant(TccParticipant tccParticipant) Add a participant to the current transaction
CancelResponse	cancel(CancelRequest request) Cancel the TCC transaction optionally adding additional participants
ConfirmResponse	confirm(ConfirmRequest request) Confirm the TCC transaction optionally adding additional participants
java.util.List<TccParticipant>	getTccParticipants() Get a list of participants in the current transaction
long	getTimeLimit() Get the time limit in milliseconds for the current transaction
java.lang.String	getTransactionId() Get the current transaction id
TccTransactionState	getTransactionState() Get the TCC transaction state
java.lang.String	getTransactionUrl() Get the current transaction internal url
void	setTimeLimit(long timeLimit) Set the time limit in milliseconds for the current transaction

Field Detail

APPLICATION_TCC_JSON

static final java.lang.String APPLICATION_TCC_JSON

TCC coordinator endpoints media type

See Also:

Constant Field Values

HEADER_TCC_LINK_REL_VAL

static final java.lang.String HEADER_TCC_LINK_REL_VAL

See Also:

Constant Field Values

HEADER_TCC_PARTICIPANT_REL_VAL

static final java.lang.String HEADER_TCC_PARTICIPANT_REL_VAL

See Also:

Constant Field Values

HEADER_TCC_TIME_LIMIT_PARAM_VAL

static final java.lang.String HEADER_TCC_TIME_LIMIT_PARAM_VAL

See Also:

Constant Field Values

Method Detail

getTransactionUrl

java.lang.String getTransactionUrl()

Get the current transaction internal url

Returns:

transaction URL

getTransactionId

java.lang.String getTransactionId()

Get the current transaction id

Returns:

transaction ID

confirm

ConfirmResponse confirm(ConfirmRequest request)
                 throws TccException,
                        TccUnknownTransactionException,
                        TccHeuristicException

Confirm the TCC transaction optionally adding additional participants

This asks the transaction coordinator to confirm all the participants in the transaction including those added by this call.

Parameters:

request - optional list of TccParticipants to be included in the confirmation of the transaction

Returns:

returns the list of participants with their updated state

Throws:

TccException - some failure occurred communicating with the transaction coordinator

TccUnknownTransactionException - transaction not found or unknown error at coordinator side

TccHeuristicException - not all the participants confirmed

cancel

CancelResponse cancel(CancelRequest request)
               throws TccException,
                      TccUnknownTransactionException,
                      TccHeuristicException

Cancel the TCC transaction optionally adding additional participants

This asks the transaction coordinator to cancel all the participants in the transaction including those added by this call.

Parameters:

request - optional list of TccParticipants to be included in the cancelling of the transaction

Returns:

CancelResponse includes participant and transaction status

Throws:

TccException - some failure occurred communicating with the transaction coordinator

TccUnknownTransactionException - transaction not found or unknown error at coordinator side

TccHeuristicException - not all the participants cancelled

getTransactionState

TccTransactionState getTransactionState()
                                 throws TccException,
                                        TccUnknownTransactionException

Get the TCC transaction state

This asks the transaction coordinator to return the status of the transaction along with participant status

Returns:

transaction state

Throws:

TccException - some failure occurred communicating with the transaction coordinator

TccUnknownTransactionException - transaction not found or unknown error at coordinator side

addTccParticipant

void addTccParticipant(TccParticipant tccParticipant)

Add a participant to the current transaction

Parameters:

tccParticipant - TCC participant to be included in the transaction associated to the current thread

getTccParticipants

java.util.List<TccParticipant> getTccParticipants()

Get a list of participants in the current transaction

Returns:

list of participants

setTimeLimit

void setTimeLimit(long timeLimit)

Set the time limit in milliseconds for the current transaction

Parameters:

timeLimit - time limit in milliseconds

getTimeLimit

long getTimeLimit()

Get the time limit in milliseconds for the current transaction

Returns:

time limit in milliseconds