Package com.oracle.microtx.tcc

Class MicroTxTccClient

java.lang.Object

com.oracle.microtx.tcc.MicroTxTccClient

All Implemented Interfaces:

TccClient

@RequestScope
public class MicroTxTccClient
extends Object
implements TccClient

TccTransaction - Helper class to execute current tcc transactions

Constructor Summary

Constructors

Constructor	Description
MicroTxTccClient()

Method Summary

Modifier and Type	Method	Description
void	addParticipant(String uri)
void	addTccParticipant(String uri)	Add a participant to the current TCC transaction
CancelResponse	cancel()	Cancel the TCC transaction
CancelResponse	cancel(List<TccParticipant> participants)	Cancel the TCC transaction optionally adding additional participants
CancelResponse	cancelTccWithOptionalParticipant(List<TccParticipant> participants)
ConfirmResponse	confirm()	Confirm the TCC transaction
ConfirmResponse	confirm(List<TccParticipant> participants)	Confirm the TCC transaction optionally adding additional participants
ConfirmResponse	confirmTccWithOptionalParticipants(List<TccParticipant> participants)
long	getTccTimeLimit()
String	getTccTransactionId()
long	getTimeLimit()	Get the time limit in milliseconds for the current TCC transaction This value overrides the value set via @TCC annotation
String	getTransactionId()	Get the current transaction id
void	setTccTimeLimit(long timeLimit)
void	setTimeLimit(long timeLimit)	Set the time limit in milliseconds for the current transaction.

Methods inherited from class java.lang.Object

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

Constructor Details

MicroTxTccClient

public MicroTxTccClient()

Method Details

confirm

public ConfirmResponse confirm()
                        throws TccUnknownTransactionException,
TccHeuristicException,
TccException

Confirm the TCC transaction

This asks the transaction coordinator to confirm all the participants in the transaction.

Specified by:

confirm in interface TccClient

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

confirm

public ConfirmResponse confirm(List<TccParticipant> participants)
                        throws TccUnknownTransactionException,
TccHeuristicException,
TccException

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:

participants - 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

public CancelResponse cancel()
                      throws TccUnknownTransactionException,
TccHeuristicException,
TccException

Cancel the TCC transaction

This asks the transaction coordinator to cancel all the participants.

Specified by:

cancel in interface TccClient

Returns:

CancelResponse includes participants 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

cancel

public CancelResponse cancel(List<TccParticipant> participants)
                      throws TccUnknownTransactionException,
TccHeuristicException,
TccException

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:

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

Returns:

CancelResponse includes participants 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

getTransactionId

public String getTransactionId()
                        throws TccUnknownTransactionException

Get the current transaction id

Returns:

transaction id

Throws:

TccUnknownTransactionException - TCC transaction is associated to the current thread

addTccParticipant

public void addTccParticipant(String uri)
                       throws TccUnknownTransactionException

Add a participant to the current TCC transaction

Parameters:

uri - the URI of the participant resource

Throws:

TccUnknownTransactionException - TCC transaction is associated to the current thread

setTimeLimit

public void setTimeLimit(long timeLimit)
                  throws TccUnknownTransactionException

Set the time limit in milliseconds for the current transaction. This will override the time limit set using @TCC annotation

Parameters:

timeLimit - time limit in milliseconds

Throws:

TccUnknownTransactionException - TCC transaction is associated to the current thread

getTimeLimit

public long getTimeLimit()
                  throws TccUnknownTransactionException

Get the time limit in milliseconds for the current TCC transaction This value overrides the value set via @TCC annotation

Returns:

time limit in milliseconds for the current TCC transaction

Throws:

TccUnknownTransactionException - TCC transaction is associated to the current thread

confirmTccWithOptionalParticipants

public ConfirmResponse confirmTccWithOptionalParticipants(List<TccParticipant> participants)
                                                   throws TccUnknownTransactionException,
TccHeuristicException,
TccException

Specified by:

confirmTccWithOptionalParticipants in interface TccClient

Throws:

TccUnknownTransactionException

TccHeuristicException

TccException

cancelTccWithOptionalParticipant

public CancelResponse cancelTccWithOptionalParticipant(List<TccParticipant> participants)
                                                throws TccUnknownTransactionException,
TccHeuristicException,
TccException

Specified by:

cancelTccWithOptionalParticipant in interface TccClient

Throws:

TccUnknownTransactionException

TccHeuristicException

TccException

setTccTimeLimit

public void setTccTimeLimit(long timeLimit)
                     throws TccUnknownTransactionException

Specified by:

setTccTimeLimit in interface TccClient

Throws:

TccUnknownTransactionException

getTccTimeLimit

public long getTccTimeLimit()
                     throws TccUnknownTransactionException

Specified by:

getTccTimeLimit in interface TccClient

Throws:

TccUnknownTransactionException

addParticipant

public void addParticipant(String uri)
                    throws TccUnknownTransactionException

Specified by:

addParticipant in interface TccClient

Throws:

TccUnknownTransactionException

getTccTransactionId

public String getTccTransactionId()
                           throws TccUnknownTransactionException

Specified by:

getTccTransactionId in interface TccClient

Throws:

TccUnknownTransactionException