Package ca.uhn.fhir.jpa.dao.tx

Class HapiTransactionService

java.lang.Object

ca.uhn.fhir.jpa.dao.tx.HapiTransactionService

All Implemented Interfaces:

IHapiTransactionService

Direct Known Subclasses:

NonTransactionalHapiTransactionService

public class HapiTransactionService
extends Object
implements IHapiTransactionService

See Also:

• for an explanation of this class

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	HapiTransactionService.ExecutionBuilder

Nested classes/interfaces inherited from interface ca.uhn.fhir.jpa.dao.tx.IHapiTransactionService

IHapiTransactionService.IExecutionBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final org.springframework.transaction.annotation.Propagation	DEFAULT_TRANSACTION_PROPAGATION_WHEN_CHANGING_PARTITIONS	Default value for setTransactionPropagationWhenChangingPartitions(Propagation)
protected ca.uhn.fhir.interceptor.api.IInterceptorBroadcaster	myInterceptorBroadcaster
protected PartitionSettings	myPartitionSettings
protected IRequestPartitionHelperSvc	myRequestPartitionHelperSvc
protected org.springframework.transaction.PlatformTransactionManager	myTransactionManager
static final String	XACT_USERDATA_KEY_EXISTING_SEARCH_PARAMS
static final String	XACT_USERDATA_KEY_RESOLVED_TAG_DEFINITIONS

Constructor Summary

Constructors

Constructor	Description
HapiTransactionService()

Method Summary

Modifier and Type	Method	Description
protected IHapiTransactionService.IExecutionBuilder	buildExecutionBuilder(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)
protected <T> T	doExecute(HapiTransactionService.ExecutionBuilder theExecutionBuilder, org.springframework.transaction.support.TransactionCallback<T> theCallback)
protected <T> T	doExecuteCallback(HapiTransactionService.ExecutionBuilder theExecutionBuilder, org.springframework.transaction.support.TransactionCallback<T> theCallback)
void	execute(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails, ca.uhn.fhir.rest.api.server.storage.TransactionDetails theTransactionDetails, org.springframework.transaction.annotation.Propagation thePropagation, org.springframework.transaction.annotation.Isolation theIsolation, Runnable theCallback)	Deprecated. Use withRequest(RequestDetails) with fluent call instead
<T> T	execute(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails, ca.uhn.fhir.rest.api.server.storage.TransactionDetails theTransactionDetails, org.springframework.transaction.support.TransactionCallback<T> theCallback)	Deprecated. Use withRequest(RequestDetails) with fluent call instead
<T> T	execute(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails, ca.uhn.fhir.rest.api.server.storage.TransactionDetails theTransactionDetails, org.springframework.transaction.support.TransactionCallback<T> theCallback, Runnable theOnRollback)	Deprecated. Use withRequest(RequestDetails) with fluent call instead
<T> T	execute(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails, ca.uhn.fhir.rest.api.server.storage.TransactionDetails theTransactionDetails, org.springframework.transaction.support.TransactionCallback<T> theCallback, Runnable theOnRollback, org.springframework.transaction.annotation.Propagation thePropagation, org.springframework.transaction.annotation.Isolation theIsolation)	Deprecated. Use withRequest(RequestDetails) with fluent call instead
<T> T	execute(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails, ca.uhn.fhir.rest.api.server.storage.TransactionDetails theTransactionDetails, org.springframework.transaction.support.TransactionCallback<T> theCallback, Runnable theOnRollback, org.springframework.transaction.annotation.Propagation thePropagation, org.springframework.transaction.annotation.Isolation theIsolation, RequestPartitionId theRequestPartitionId)	Deprecated. Use withRequest(RequestDetails) with fluent call instead
static <T> T	executeWithDefaultPartitionInContext(ca.uhn.fhir.util.ICallable<T> theCallback)
static RequestPartitionId	getRequestPartitionAssociatedWithThread()
org.springframework.transaction.PlatformTransactionManager	getTransactionManager()
static <T> T	invokeCallableAndHandleAnyException(Callable<T> theTask)	Invokes Callable.call() and rethrows any exceptions thrown by that method.
boolean	isCompatiblePartition(RequestPartitionId theRequestPartitionId, RequestPartitionId theOtherRequestPartitionId)	Are two RequestPartitionId values compatible within the same transaction?
boolean	isCustomIsolationSupported()
protected boolean	isRequiresNewTransactionWhenChangingPartitions()
static void	noTransactionAllowed()	Throws an IllegalArgumentException if a transaction is active
static void	requireTransaction()	Throws an IllegalArgumentException if no transaction is active
void	setInterceptorBroadcaster(ca.uhn.fhir.interceptor.api.IInterceptorBroadcaster theInterceptorBroadcaster)
void	setPartitionSettingsForUnitTest(PartitionSettings thePartitionSettings)
void	setRequestPartitionSvcForUnitTest(IRequestPartitionHelperSvc theRequestPartitionHelperSvc)
void	setSleepUtil(ca.uhn.fhir.util.SleepUtil theSleepUtil)
void	setTransactionManager(org.springframework.transaction.PlatformTransactionManager theTransactionManager)
void	setTransactionPropagationWhenChangingPartitions(org.springframework.transaction.annotation.Propagation theTransactionPropagationWhenChangingPartitions)
IHapiTransactionService.IExecutionBuilder	withRequest(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)	Fluent builder for creating a transactional callback
<T> T	withRequest(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails, ca.uhn.fhir.rest.api.server.storage.TransactionDetails theTransactionDetails, org.springframework.transaction.annotation.Propagation thePropagation, org.springframework.transaction.annotation.Isolation theIsolation, ca.uhn.fhir.util.ICallable<T> theCallback)	Deprecated. Use withRequest(RequestDetails) with fluent call instead
IHapiTransactionService.IExecutionBuilder	withSystemRequest()	Fluent builder for internal system requests with no external requestdetails associated

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.fhir.jpa.dao.tx.IHapiTransactionService

withSystemRequestOnDefaultPartition, withSystemRequestOnPartition

Field Details

XACT_USERDATA_KEY_RESOLVED_TAG_DEFINITIONS

public static final String XACT_USERDATA_KEY_RESOLVED_TAG_DEFINITIONS

XACT_USERDATA_KEY_EXISTING_SEARCH_PARAMS

public static final String XACT_USERDATA_KEY_EXISTING_SEARCH_PARAMS

DEFAULT_TRANSACTION_PROPAGATION_WHEN_CHANGING_PARTITIONS

public static final org.springframework.transaction.annotation.Propagation DEFAULT_TRANSACTION_PROPAGATION_WHEN_CHANGING_PARTITIONS

Default value for setTransactionPropagationWhenChangingPartitions(Propagation)

Since:

7.6.0

myInterceptorBroadcaster

@Autowired
protected ca.uhn.fhir.interceptor.api.IInterceptorBroadcaster myInterceptorBroadcaster

myTransactionManager

@Autowired
protected org.springframework.transaction.PlatformTransactionManager myTransactionManager

myRequestPartitionHelperSvc

@Autowired
protected IRequestPartitionHelperSvc myRequestPartitionHelperSvc

myPartitionSettings

@Autowired
protected PartitionSettings myPartitionSettings

Constructor Details

HapiTransactionService

public HapiTransactionService()

Method Details

setInterceptorBroadcaster

public void setInterceptorBroadcaster(ca.uhn.fhir.interceptor.api.IInterceptorBroadcaster theInterceptorBroadcaster)

setSleepUtil

public void setSleepUtil(ca.uhn.fhir.util.SleepUtil theSleepUtil)

withRequest

public IHapiTransactionService.IExecutionBuilder withRequest(@Nullable
 ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)

Description copied from interface: IHapiTransactionService

Fluent builder for creating a transactional callback

Method chain must end with a call to IHapiTransactionService.IExecutionBuilder.execute(Runnable) or one of the other overloads of task(...)

Specified by:

withRequest in interface IHapiTransactionService

withSystemRequest

public IHapiTransactionService.IExecutionBuilder withSystemRequest()

Description copied from interface: IHapiTransactionService

Fluent builder for internal system requests with no external requestdetails associated

Specified by:

withSystemRequest in interface IHapiTransactionService

buildExecutionBuilder

protected IHapiTransactionService.IExecutionBuilder buildExecutionBuilder(@Nullable
 ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)

execute

@Deprecated
public <T> T execute(@Nullable
 ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails,
 @Nullable
 ca.uhn.fhir.rest.api.server.storage.TransactionDetails theTransactionDetails,
 @Nonnull
 org.springframework.transaction.support.TransactionCallback<T> theCallback)

Deprecated.

Use withRequest(RequestDetails) with fluent call instead

execute

@Deprecated
public void execute(@Nullable
 ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails,
 @Nullable
 ca.uhn.fhir.rest.api.server.storage.TransactionDetails theTransactionDetails,
 @Nonnull
 org.springframework.transaction.annotation.Propagation thePropagation,
 @Nonnull
 org.springframework.transaction.annotation.Isolation theIsolation,
 @Nonnull
 Runnable theCallback)

Deprecated.

Use withRequest(RequestDetails) with fluent call instead

withRequest

@Deprecated
public <T> T withRequest(@Nullable
 ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails,
 @Nullable
 ca.uhn.fhir.rest.api.server.storage.TransactionDetails theTransactionDetails,
 @Nonnull
 org.springframework.transaction.annotation.Propagation thePropagation,
 @Nonnull
 org.springframework.transaction.annotation.Isolation theIsolation,
 @Nonnull
 ca.uhn.fhir.util.ICallable<T> theCallback)

Deprecated.

Use withRequest(RequestDetails) with fluent call instead

Specified by:

withRequest in interface IHapiTransactionService

execute

@Deprecated
public <T> T execute(@Nullable
 ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails,
 @Nullable
 ca.uhn.fhir.rest.api.server.storage.TransactionDetails theTransactionDetails,
 @Nonnull
 org.springframework.transaction.support.TransactionCallback<T> theCallback,
 @Nullable
 Runnable theOnRollback)

Deprecated.

Use withRequest(RequestDetails) with fluent call instead

execute

@Deprecated
public <T> T execute(@Nullable
 ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails,
 @Nullable
 ca.uhn.fhir.rest.api.server.storage.TransactionDetails theTransactionDetails,
 @Nonnull
 org.springframework.transaction.support.TransactionCallback<T> theCallback,
 @Nullable
 Runnable theOnRollback,
 @Nullable
 org.springframework.transaction.annotation.Propagation thePropagation,
 @Nullable
 org.springframework.transaction.annotation.Isolation theIsolation)

Deprecated.

Use withRequest(RequestDetails) with fluent call instead

execute

@Deprecated
public <T> T execute(@Nullable
 ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails,
 @Nullable
 ca.uhn.fhir.rest.api.server.storage.TransactionDetails theTransactionDetails,
 @Nonnull
 org.springframework.transaction.support.TransactionCallback<T> theCallback,
 @Nullable
 Runnable theOnRollback,
 @Nonnull
 org.springframework.transaction.annotation.Propagation thePropagation,
 @Nonnull
 org.springframework.transaction.annotation.Isolation theIsolation,
 RequestPartitionId theRequestPartitionId)

Deprecated.

Use withRequest(RequestDetails) with fluent call instead

isCustomIsolationSupported

public boolean isCustomIsolationSupported()

setRequestPartitionSvcForUnitTest

public void setRequestPartitionSvcForUnitTest(IRequestPartitionHelperSvc theRequestPartitionHelperSvc)

getTransactionManager

public org.springframework.transaction.PlatformTransactionManager getTransactionManager()

setTransactionManager

public void setTransactionManager(org.springframework.transaction.PlatformTransactionManager theTransactionManager)

setPartitionSettingsForUnitTest

public void setPartitionSettingsForUnitTest(PartitionSettings thePartitionSettings)

doExecute

@Nullable
protected <T> T doExecute(HapiTransactionService.ExecutionBuilder theExecutionBuilder,
 org.springframework.transaction.support.TransactionCallback<T> theCallback)

isRequiresNewTransactionWhenChangingPartitions

protected boolean isRequiresNewTransactionWhenChangingPartitions()

isCompatiblePartition

public boolean isCompatiblePartition(RequestPartitionId theRequestPartitionId,
 RequestPartitionId theOtherRequestPartitionId)

Description copied from interface: IHapiTransactionService

Are two RequestPartitionId values compatible within the same transaction?

This is an experimental API, subject to change in a future release.

Specified by:

isCompatiblePartition in interface IHapiTransactionService

setTransactionPropagationWhenChangingPartitions

public void setTransactionPropagationWhenChangingPartitions(org.springframework.transaction.annotation.Propagation theTransactionPropagationWhenChangingPartitions)

doExecuteCallback

@Nullable
protected <T> T doExecuteCallback(HapiTransactionService.ExecutionBuilder theExecutionBuilder,
 org.springframework.transaction.support.TransactionCallback<T> theCallback)

invokeCallableAndHandleAnyException

public static <T> T invokeCallableAndHandleAnyException(Callable<T> theTask)

Invokes Callable.call() and rethrows any exceptions thrown by that method. If the exception extends BaseServerResponseException it is rethrown unmodified. Otherwise, it's wrapped in a InternalErrorException.

executeWithDefaultPartitionInContext

public static <T> T executeWithDefaultPartitionInContext(@Nonnull
 ca.uhn.fhir.util.ICallable<T> theCallback)

getRequestPartitionAssociatedWithThread

public static RequestPartitionId getRequestPartitionAssociatedWithThread()

noTransactionAllowed

public static void noTransactionAllowed()

Throws an IllegalArgumentException if a transaction is active

requireTransaction

public static void requireTransaction()

Throws an IllegalArgumentException if no transaction is active