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

Class BaseBatchTransactionContextWrapper

java.lang.Object

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

All Implemented Interfaces:

BatchTransactionContext

public abstract class BaseBatchTransactionContextWrapper
extends Object
implements BatchTransactionContext

Base implementation of the decorator design pattern for instances of BatchTransactionContext

This implementation delegates all of its methods into a delegate received in the constructor, including equals(Object) and hashCode().

Because this implementation delegates all the methods, implementations only need to override the methods which intercepting is necessary

Since:

3.5.0

Field Summary

Fields

Modifier and Type	Field and Description
protected BatchTransactionContext	delegate

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseBatchTransactionContextWrapper(BatchTransactionContext delegate)

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
boolean	equals(Object obj)
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.
int	hashCode()
boolean	isBlockCompleted() Returns true if the total amount of acknowledged records through the BatchTransactionContext.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

Methods inherited from class java.lang.Object

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

Field Detail

delegate

protected final BatchTransactionContext delegate

Constructor Detail

BaseBatchTransactionContextWrapper

protected BaseBatchTransactionContextWrapper(BatchTransactionContext delegate)

Method Detail

ackProcessedRecords

public void ackProcessedRecords(int howMany)

Description copied from interface: BatchTransactionContext

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 BatchTransactionContext.setBlockSize(int) and BatchTransactionContext.getBlockSize().

Specified by:

ackProcessedRecords in interface BatchTransactionContext

Parameters:

howMany - the number of records that have been acknowledged

ackSingleRecordProcessed

public void ackSingleRecordProcessed()

Description copied from interface: BatchTransactionContext

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 BatchTransactionContext.ackProcessedRecords(int) with the number one as an argument

Specified by:

ackSingleRecordProcessed in interface BatchTransactionContext

isBlockCompleted

public boolean isBlockCompleted()

Description copied from interface: BatchTransactionContext

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

Specified by:

isBlockCompleted in interface BatchTransactionContext

Returns:

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

beginTransaction

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

Description copied from interface: BatchTransactionContext

Starts the transaction

Specified by:

beginTransaction in interface BatchTransactionContext

Throws:

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

commit

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

Description copied from interface: BatchTransactionContext

Commits the transaction

Specified by:

commit in interface BatchTransactionContext

Throws:

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

rollback

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

Description copied from interface: BatchTransactionContext

Rolls the transaction back

Specified by:

rollback in interface BatchTransactionContext

Throws:

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

getId

public Serializable getId()

Description copied from interface: BatchTransactionContext

Returns an unmodifiable id associated to this particular instance

Specified by:

getId in interface BatchTransactionContext

Returns:

a Serializable id

getJob

public BatchJobAdapter getJob()

Description copied from interface: BatchTransactionContext

Returns the BatchJobAdapter for which this context was built

Specified by:

getJob in interface BatchTransactionContext

Returns:

a not null BatchJobAdapter

getJobInstance

public BatchJobInstanceAdapter getJobInstance()

Description copied from interface: BatchTransactionContext

Returns the BatchJobInstanceAdapter for which this context was built

Specified by:

getJobInstance in interface BatchTransactionContext

Returns:

a not null BatchJobInstanceAdapter

getQueue

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

Description copied from interface: BatchTransactionContext

Returns a Queue attached to the current transaction

Specified by:

getQueue in interface BatchTransactionContext

Parameters:

name - the name of the Queue you want

Returns:

a not null Queue

getBlockSize

public int getBlockSize()

Specified by:

getBlockSize in interface BatchTransactionContext

Returns:

the size of the record block this transaction is processing

updateJobInstance

public void updateJobInstance(BatchJobInstanceAdapter jobInstance)

Description copied from interface: BatchTransactionContext

Refreshes the state of the related BatchJobInstanceAdapter

Specified by:

updateJobInstance in interface BatchTransactionContext

Parameters:

jobInstance - a not null BatchJobInstanceAdapter

setBlockSize

public void setBlockSize(int size)

Description copied from interface: BatchTransactionContext

Sets the size of the record block this transaction is processingh

Specified by:

setBlockSize in interface BatchTransactionContext

Parameters:

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

getResolutionCallback

public CompletableFuture<Void> getResolutionCallback()

Description copied from interface: BatchTransactionContext

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 BatchTransactionContext.beginTransaction() is never invoked.

Specified by:

getResolutionCallback in interface BatchTransactionContext

Returns:

a CompletableFuture

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object