Package org.springframework.pulsar.transaction

Class PulsarTransactionManager

java.lang.Object

org.springframework.transaction.support.AbstractPlatformTransactionManager

org.springframework.pulsar.transaction.PulsarTransactionManager

All Implemented Interfaces:

Serializable, PulsarAwareTransactionManager, ConfigurableTransactionManager, PlatformTransactionManager, TransactionManager

public class PulsarTransactionManager
extends AbstractPlatformTransactionManager
implements PulsarAwareTransactionManager

Binds a native Pulsar transaction from the specified PulsarClient to the current thread, allowing for one transaction per thread per Pulsar client.

This transaction manager is not able to provide XA transactions, for example in order to share transactions between messaging and database access.

Application code is required to retrieve the transactional Pulsar resources via PulsarTransactionUtils.obtainResourceHolder(org.apache.pulsar.client.api.PulsarClient, java.time.Duration). The PulsarTemplate will auto-detect a thread-bound transaction and automatically participate in it.

Transaction synchronization is turned off by default, as this manager might be used alongside a datastore-based Spring transaction manager such as the JDBC DataSourceTransactionManager, which has stronger needs for synchronization.

Since:

1.1.0

Author:

Chris Bono

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager

AbstractPlatformTransactionManager.SuspendedResourcesHolder

Field Summary

Fields inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager

logger, SYNCHRONIZATION_ALWAYS, SYNCHRONIZATION_NEVER, SYNCHRONIZATION_ON_ACTUAL_TRANSACTION

Constructor Summary

Constructors

Constructor	Description
PulsarTransactionManager(org.apache.pulsar.client.api.PulsarClient pulsarClient)	Create a new transaction manager.

Method Summary

Modifier and Type	Method	Description
protected void	doBegin(Object transaction, TransactionDefinition definition)
protected void	doCleanupAfterCompletion(Object transaction)
protected void	doCommit(DefaultTransactionStatus status)
protected Object	doGetTransaction()
protected void	doResume(Object transaction, Object suspendedResources)
protected void	doRollback(DefaultTransactionStatus status)
protected void	doSetRollbackOnly(DefaultTransactionStatus status)
protected Object	doSuspend(Object transaction)
org.apache.pulsar.client.api.PulsarClient	getPulsarClient()	Get the Pulsar client.
protected boolean	isExistingTransaction(Object transaction)

Methods inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager

commit, determineTimeout, getDefaultTimeout, getTransaction, getTransactionExecutionListeners, getTransactionSynchronization, invokeAfterCompletion, isFailEarlyOnGlobalRollbackOnly, isGlobalRollbackOnParticipationFailure, isNestedTransactionAllowed, isRollbackOnCommitFailure, isValidateExistingTransaction, prepareForCommit, prepareSynchronization, registerAfterCompletionWithExistingTransaction, resume, rollback, setDefaultTimeout, setFailEarlyOnGlobalRollbackOnly, setGlobalRollbackOnParticipationFailure, setNestedTransactionAllowed, setRollbackOnCommitFailure, setTransactionExecutionListeners, setTransactionSynchronization, setTransactionSynchronizationName, setValidateExistingTransaction, shouldCommitOnGlobalRollbackOnly, suspend, triggerBeforeCommit, triggerBeforeCompletion, useSavepointForNestedTransaction

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.transaction.ConfigurableTransactionManager

addListener

Methods inherited from interface org.springframework.transaction.PlatformTransactionManager

commit, getTransaction, rollback

Constructor Details

PulsarTransactionManager

public PulsarTransactionManager(org.apache.pulsar.client.api.PulsarClient pulsarClient)

Create a new transaction manager.

Parameters:

pulsarClient - the pulsar client used to construct the backing Pulsar native transactions.

Method Details

getPulsarClient

public org.apache.pulsar.client.api.PulsarClient getPulsarClient()

Description copied from interface: PulsarAwareTransactionManager

Get the Pulsar client.

Specified by:

getPulsarClient in interface PulsarAwareTransactionManager

Returns:

the Pulsar client

doGetTransaction

protected Object doGetTransaction()

Specified by:

doGetTransaction in class AbstractPlatformTransactionManager

isExistingTransaction

protected boolean isExistingTransaction(Object transaction)

Overrides:

isExistingTransaction in class AbstractPlatformTransactionManager

doBegin

protected void doBegin(Object transaction,
 TransactionDefinition definition)

Specified by:

doBegin in class AbstractPlatformTransactionManager

doSuspend

protected Object doSuspend(Object transaction)

Overrides:

doSuspend in class AbstractPlatformTransactionManager

doResume

protected void doResume(Object transaction,
 Object suspendedResources)

Overrides:

doResume in class AbstractPlatformTransactionManager

doCommit

protected void doCommit(DefaultTransactionStatus status)

Specified by:

doCommit in class AbstractPlatformTransactionManager

doRollback

protected void doRollback(DefaultTransactionStatus status)

Specified by:

doRollback in class AbstractPlatformTransactionManager

doSetRollbackOnly

protected void doSetRollbackOnly(DefaultTransactionStatus status)

Overrides:

doSetRollbackOnly in class AbstractPlatformTransactionManager

doCleanupAfterCompletion

protected void doCleanupAfterCompletion(Object transaction)

Overrides:

doCleanupAfterCompletion in class AbstractPlatformTransactionManager