PermazenTransactionManager (Permazen 4.1.6 API)

java.lang.Object
- org.springframework.transaction.support.AbstractPlatformTransactionManager
- - io.permazen.spring.PermazenTransactionManager

All Implemented Interfaces:

Serializable, InitializingBean, PlatformTransactionManager, ResourceTransactionManager, TransactionManager
```
public class PermazenTransactionManager
extends AbstractPlatformTransactionManager
implements ResourceTransactionManager, InitializingBean
```
Permazen implementation of Spring's PlatformTransactionManager interface, allowing methods annotated with Spring's @Transactional annotation to perform transactions on a Permazen database.
Properly integrates with JTransaction.getCurrent() to participate in existing transactions when appropriate.
For some key/value stores, the value of @Transactional.isolation() is significant; see the documentation for your specific KVDatabase for details.

See Also:

io.permazen.spring, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PermazenTransactionManager.TransactionSynchronizationCallback` Adapter class that wraps a Spring `TransactionSynchronization` in the `Transaction.Callback` interface.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`allowNewSchema` Whether a new schema version is allowed.
`static ValidationMode`	`DEFAULT_VALIDATION_MODE` The default `ValidationMode` to use for transactions (`ValidationMode.AUTOMATIC`).
`static String`	`ISOLATION_OPTION` The name of the transaction option passed to `KVDatabase.createTransaction()` containing the isolation level from the transaction definition.
`protected Permazen`	`jdb` The configured `Permazen` from which transactions are created.
`protected ValidationMode`	`validationMode` The `ValidationMode` to use for transactions.

Fields inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager
logger, SYNCHRONIZATION_ALWAYS, SYNCHRONIZATION_NEVER, SYNCHRONIZATION_ON_ACTUAL_TRANSACTION

Constructor Summary

Constructors
Constructor and Description

PermazenTransactionManager()

Constructors
Constructor and Description
`PermazenTransactionManager()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`protected void`	`configureTransaction(JTransaction jtx, TransactionDefinition txDef)` Configure a new transaction.
`protected JTransaction`	`createTransaction(Map<String,Object> options)` Create the underlying `JTransaction` for a new transaction.
`protected void`	`doBegin(Object txObj, TransactionDefinition txDef)`
`protected void`	`doCleanupAfterCompletion(Object txObj)`
`protected void`	`doCommit(DefaultTransactionStatus status)`
`protected Object`	`doGetTransaction()`
`protected void`	`doResume(Object txObj, Object suspendedResources)` Resume a previously suspended transaction.
`protected void`	`doRollback(DefaultTransactionStatus status)`
`protected void`	`doSetRollbackOnly(DefaultTransactionStatus status)`
`protected Object`	`doSuspend(Object txObj)` Suspend the current transaction.
`protected JTransaction`	`getCurrent()` Like `JTransaction.getCurrent()`, but returns null instead of throwing `IllegalStateException`.
`Object`	`getResourceFactory()`
`protected boolean`	`isExistingTransaction(Object txObj)`
`protected void`	`prepareForCommit(DefaultTransactionStatus status)`
`protected void`	`registerAfterCompletionWithExistingTransaction(Object txObj, List<TransactionSynchronization> synchronizations)`
`void`	`setAllowNewSchema(boolean allowNewSchema)` Configure whether a new schema version may be created.
`void`	`setPermazen(Permazen jdb)` Configure the `Permazen` that this instance will operate on.
`void`	`setValidateBeforeCommit(boolean validateBeforeCommit)` Configure whether to invoke `JTransaction.validate()` just prior to commit (and prior to any synchronization callbacks).
`void`	`setValidationMode(ValidationMode validationMode)` Configure the `ValidationMode` to use for transactions.

Methods inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager
commit, determineTimeout, getDefaultTimeout, getTransaction, getTransactionSynchronization, invokeAfterCompletion, isFailEarlyOnGlobalRollbackOnly, isGlobalRollbackOnParticipationFailure, isNestedTransactionAllowed, isRollbackOnCommitFailure, isValidateExistingTransaction, newTransactionStatus, prepareSynchronization, prepareTransactionStatus, resume, rollback, setDefaultTimeout, setFailEarlyOnGlobalRollbackOnly, setGlobalRollbackOnParticipationFailure, setNestedTransactionAllowed, setRollbackOnCommitFailure, 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.PlatformTransactionManager
commit, getTransaction, rollback

- Field Detail
  - ISOLATION_OPTION
```
public static final String ISOLATION_OPTION
```
    The name of the transaction option passed to KVDatabase.createTransaction() containing the isolation level from the transaction definition. Some key/value databases may interpret this option. The value of this option is an Isolation instance.
  - DEFAULT_VALIDATION_MODE
```
public static final ValidationMode DEFAULT_VALIDATION_MODE
```
    The default ValidationMode to use for transactions (ValidationMode.AUTOMATIC).
  - jdb
```
protected transient Permazen jdb
```
    The configured Permazen from which transactions are created.
  - allowNewSchema
```
protected boolean allowNewSchema
```
    Whether a new schema version is allowed. Default true.
  - validationMode
```
protected ValidationMode validationMode
```
    The ValidationMode to use for transactions.
- Constructor Detail
  - PermazenTransactionManager
```
public PermazenTransactionManager()
```
- Method Detail
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    Specified by:
    
    afterPropertiesSet in interface InitializingBean
    
    Throws:
    
    Exception
  - setPermazen
```
public void setPermazen(Permazen jdb)
```
    Configure the Permazen that this instance will operate on.
    Required property.
    
    Parameters:
    
    jdb - associated database
  - setAllowNewSchema
```
public void setAllowNewSchema(boolean allowNewSchema)
```
    Configure whether a new schema version may be created.
    Default value is false.
    
    Parameters:
    
    allowNewSchema - whether to allow recording new schema versions
  - setValidationMode
```
public void setValidationMode(ValidationMode validationMode)
```
    Configure the ValidationMode to use for transactions.
    Default value is ValidationMode.AUTOMATIC.
    
    Parameters:
    
    validationMode - validation mode for transactions
  - setValidateBeforeCommit
```
public void setValidateBeforeCommit(boolean validateBeforeCommit)
```
    Configure whether to invoke JTransaction.validate() just prior to commit (and prior to any synchronization callbacks). This also causes validation to be performed at the end of each inner transaction that is participating in an outer transaction. If set to false, validation still occurs, but only when the outermost transaction commits.
    Default false.
    
    Parameters:
    
    validateBeforeCommit - whether to validate after inner transactions
  - getResourceFactory
```
public Object getResourceFactory()
```
    Specified by:
    
    getResourceFactory in interface ResourceTransactionManager
  - doGetTransaction
```
protected Object doGetTransaction()
```
    Specified by:
    
    doGetTransaction in class AbstractPlatformTransactionManager
  - isExistingTransaction
```
protected boolean isExistingTransaction(Object txObj)
```
    Overrides:
    
    isExistingTransaction in class AbstractPlatformTransactionManager
  - doBegin
```
protected void doBegin(Object txObj,
                       TransactionDefinition txDef)
```
    Specified by:
    
    doBegin in class AbstractPlatformTransactionManager
  - createTransaction
```
protected JTransaction createTransaction(Map<String,Object> options)
```
    Create the underlying JTransaction for a new transaction.
    The implementation in PermazenTransactionManager just delegates to Permazen.createTransaction(boolean, ValidationMode, Map) using this instance's configured settings for validation mode and allowing new schema versions.
    
    Parameters:
    
    options - transaction options
    
    Returns:
    
    newly created JTransaction
    
    Throws:
    
    DatabaseException - if an error occurs
  - doSuspend
```
protected Object doSuspend(Object txObj)
```
    Suspend the current transaction.
    
    Overrides:
    
    doSuspend in class AbstractPlatformTransactionManager
  - doResume
```
protected void doResume(Object txObj,
                        Object suspendedResources)
```
    Resume a previously suspended transaction.
    
    Overrides:
    
    doResume in class AbstractPlatformTransactionManager
  - configureTransaction
```
protected void configureTransaction(JTransaction jtx,
                                    TransactionDefinition txDef)
```
    Configure a new transaction.
    The implementation in PermazenTransactionManager sets the transaction's timeout and read-only properties.
    
    Parameters:
    
    jtx - transaction to configure
    
    txDef - transaction definition
    
    Throws:
    
    DatabaseException - if an error occurs
  - prepareForCommit
```
protected void prepareForCommit(DefaultTransactionStatus status)
```
    Overrides:
    
    prepareForCommit 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 txObj)
```
    Overrides:
    
    doCleanupAfterCompletion in class AbstractPlatformTransactionManager
  - registerAfterCompletionWithExistingTransaction
```
protected void registerAfterCompletionWithExistingTransaction(Object txObj,
                                                              List<TransactionSynchronization> synchronizations)
```
    Overrides:
    
    registerAfterCompletionWithExistingTransaction in class AbstractPlatformTransactionManager
  - getCurrent
```
protected JTransaction getCurrent()
```
    Like JTransaction.getCurrent(), but returns null instead of throwing IllegalStateException.
    
    Returns:
    
    the transaction associated with the current thread, or null if there is none

Class PermazenTransactionManager

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.transaction.PlatformTransactionManager

Field Detail

ISOLATION_OPTION

DEFAULT_VALIDATION_MODE

jdb

allowNewSchema

validationMode

Constructor Detail

PermazenTransactionManager

Method Detail

afterPropertiesSet

setPermazen

setAllowNewSchema

setValidationMode

setValidateBeforeCommit

getResourceFactory

doGetTransaction

isExistingTransaction

doBegin

createTransaction

doSuspend

doResume

configureTransaction

prepareForCommit

doCommit

doRollback

doSetRollbackOnly

doCleanupAfterCompletion

registerAfterCompletionWithExistingTransaction

getCurrent