Package ca.uhn.fhir.jpa.util

Class TransactionSemanticsHeader

java.lang.Object

ca.uhn.fhir.jpa.util.TransactionSemanticsHeader

public class TransactionSemanticsHeader
extends Object

This class parses and serializes the X-Transaction-Semantics header, which is a custom HAPI FHIR extension affecting the way that FHIR transactions are processed.

Since:

8.2.0

See Also:

• BaseTransactionProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TransactionSemanticsHeader.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final TransactionSemanticsHeader	DEFAULT
static final String	HEADER_NAME
static final String	MAX_DELAY
static final String	MIN_DELAY
static final String	RETRY_COUNT
static final String	TRY_BATCH_AS_TRANSACTION_FIRST

Method Summary

Modifier and Type	Method	Description
Integer	getMaxRetryDelay()	When automatically retrying a failed transaction, the system will first sleep for a minimum of this number of milliseconds.
Integer	getMinRetryDelay()	When automatically retrying a failed transaction, the system will first sleep for a minimum of this number of milliseconds.
Integer	getRetryCount()	Specifies the number of retry attempts which should be attempted if the initial transaction processing fails with any kind of error.
boolean	isTryBatchAsTransactionFirst()	When processing a FHIR Batch bundle, try it as a FHIR transaction first, and only switch to batch mode on the first retry.
static TransactionSemanticsHeader.Builder	newBuilder()	Begin building a new TransactionSemanticsHeader instance
static TransactionSemanticsHeader	parse(String theHeaderValue)	Parses a header value (not including the header name) into a new TransactionSemanticsHeader instance.
String	toHeaderValue()	Serializes the values as a header value (not including the header name)

Methods inherited from class java.lang.Object

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

Field Details

RETRY_COUNT

public static final String RETRY_COUNT

See Also:

• Constant Field Values

MIN_DELAY

public static final String MIN_DELAY

See Also:

• Constant Field Values

MAX_DELAY

public static final String MAX_DELAY

See Also:

• Constant Field Values

TRY_BATCH_AS_TRANSACTION_FIRST

public static final String TRY_BATCH_AS_TRANSACTION_FIRST

See Also:

• Constant Field Values

DEFAULT

public static final TransactionSemanticsHeader DEFAULT

HEADER_NAME

public static final String HEADER_NAME

See Also:

• Constant Field Values

Method Details

getRetryCount

public Integer getRetryCount()

Specifies the number of retry attempts which should be attempted if the initial transaction processing fails with any kind of error. A value of 0 (or null) means that the transaction will be attempted only once (i.e. the default behaviour). A value of 2 means that the transaction will be attempted once, and if it fails, up to two more attempts will be made before giving up.

getMinRetryDelay

public Integer getMinRetryDelay()

When automatically retrying a failed transaction, the system will first sleep for a minimum of this number of milliseconds.

getMaxRetryDelay

public Integer getMaxRetryDelay()

When automatically retrying a failed transaction, the system will first sleep for a minimum of this number of milliseconds.

isTryBatchAsTransactionFirst

public boolean isTryBatchAsTransactionFirst()

When processing a FHIR Batch bundle, try it as a FHIR transaction first, and only switch to batch mode on the first retry. This option is useful in cases where data can safely be ingested as a FHIR Batch, since FHIR Transaction processing is generally significantly faster. However, FHIR transactions exhibit an all-or-nothing failure mode which is not always desirable for batch ingestion, so this option provides an easy fallback which brings the benefits of both approaches.

toHeaderValue

public String toHeaderValue()

Serializes the values as a header value (not including the header name)

parse

public static TransactionSemanticsHeader parse(@Nonnull
 String theHeaderValue)

Parses a header value (not including the header name) into a new TransactionSemanticsHeader instance.

newBuilder

public static TransactionSemanticsHeader.Builder newBuilder()

Begin building a new TransactionSemanticsHeader instance