com.mulesoft.mule.runtime.module.batch.engine.transaction

Interface BatchTransactionContext

All Known Implementing Classes:

BaseBatchTransactionContextWrapper, DefaultBatchTransactionContext

@NoImplement
public interface BatchTransactionContext

Represents the transaction that batch uses to read/write into its persistent queues. This transaction is completely isolated from whatever transaction the user might start in any of the BatchJob processing blocks.

Each instance of this interface is strongly related to a particular BatchJobInstanceAdapter of one BatchJobAdapter

Each contexts has a unique id. Implementantions are required to have their #equals(Object) and #hashCode() implemented in a way consistent with this id. Every implementation must be able to be used as a key in a hash table

Since:

3.5.0

Method Summary

Modifier and Type	Method and Description
void	ackProcessedRecords(int howMany) reports that howMany records were successfully processed in this context (by successfully I mean without incidents.
void	ackSingleRecordProcessed() reports that one record has been successfully processed in this context (by successfully I mean without incidents.
void	beginTransaction() Starts the transaction
void	commit() Commits the transaction
int	getBlockSize()
Serializable	getId() Returns an unmodifiable id associated to this particular instance
BatchJobAdapter	getJob() Returns the BatchJobAdapter for which this context was built
BatchJobInstanceAdapter	getJobInstance() Returns the BatchJobInstanceAdapter for which this context was built
org.mule.runtime.core.api.util.queue.Queue	getQueue(String name) Returns a Queue attached to the current transaction
CompletableFuture<Void>	getResolutionCallback() A CompletableFuture which is completed when the transaction is resolved.
boolean	isBlockCompleted() Returns true if the total amount of acknowledged records through the ackProcessedRecords(int) matches the block size.
void	rollback() Rolls the transaction back
void	setBlockSize(int size) Sets the size of the record block this transaction is processingh
void	updateJobInstance(BatchJobInstanceAdapter jobInstance) Refreshes the state of the related BatchJobInstanceAdapter

Method Detail

ackProcessedRecords

void ackProcessedRecords(int howMany)

reports that howMany records were successfully processed in this context (by successfully I mean without incidents. The record might have failed or not, we don't care).

This method works in tandem with setBlockSize(int) and getBlockSize().

Parameters:

howMany - the number of records that have been acknowledged

ackSingleRecordProcessed

void ackSingleRecordProcessed()

reports that one record has been successfully processed in this context (by successfully I mean without incidents. The record might have failed or not, we don't care).

This is a convenience method equivalent to invoking ackProcessedRecords(int) with the number one as an argument

isBlockCompleted

boolean isBlockCompleted()

Returns true if the total amount of acknowledged records through the ackProcessedRecords(int) matches the block size. Although it's not mandatory, you should call commit() when this method returns true

Returns:

true if all the Records in the block were acknowledged. false otherwise

beginTransaction

void beginTransaction()
               throws org.mule.runtime.core.api.transaction.xa.ResourceManagerException

Starts the transaction

Throws:

org.mule.runtime.core.api.transaction.xa.ResourceManagerException

commit

void commit()
     throws org.mule.runtime.core.api.transaction.xa.ResourceManagerException

Commits the transaction

Throws:

org.mule.runtime.core.api.transaction.xa.ResourceManagerException

rollback

void rollback()
       throws org.mule.runtime.core.api.transaction.xa.ResourceManagerException

Rolls the transaction back

Throws:

org.mule.runtime.core.api.transaction.xa.ResourceManagerException

getId

Serializable getId()

Returns an unmodifiable id associated to this particular instance

Returns:

a Serializable id

getJob

BatchJobAdapter getJob()

Returns the BatchJobAdapter for which this context was built

Returns:

a not null BatchJobAdapter

getJobInstance

BatchJobInstanceAdapter getJobInstance()

Returns the BatchJobInstanceAdapter for which this context was built

Returns:

a not null BatchJobInstanceAdapter

getQueue

org.mule.runtime.core.api.util.queue.Queue getQueue(String name)

Returns a Queue attached to the current transaction

Parameters:

name - the name of the Queue you want

Returns:

a not null Queue

getBlockSize

int getBlockSize()

Returns:

the size of the record block this transaction is processing

updateJobInstance

void updateJobInstance(BatchJobInstanceAdapter jobInstance)

Refreshes the state of the related BatchJobInstanceAdapter

Parameters:

jobInstance - a not null BatchJobInstanceAdapter

Throws:

IllegalArgumentException - if the given BatchJobInstanceAdapter has a different id than the original one or if it belongs to a different BatchJobAdapter

setBlockSize

void setBlockSize(int size)

Sets the size of the record block this transaction is processingh

Parameters:

size - the size of the record block this transaction is processing

getResolutionCallback

CompletableFuture<Void> getResolutionCallback()

A CompletableFuture which is completed when the transaction is resolved. The future will be completed successfully regardless of the transaction been committed or rolled back.

This will never complete if beginTransaction() is never invoked.

Returns:

a CompletableFuture