public enum TransactionPhase extends Enum<TransactionPhase>
Distinguishes the various kinds of transactional observer methods from regular observer methods which are notified immediately.
Transactional observer methods are observer methods which receive event notifications during the before or after completion
phase of the transaction in which the event was fired. If no transaction is in progress when the event is fired, they are
notified at the same time as other observers.
If the transaction is in progress, but Synchronization
callback cannot be registered due to the transaction being already
marked for rollback or in state where Synchronization
callbacks cannot be registered, the BEFORE_COMPLETION
,
AFTER_COMPLETION
and AFTER_FAILURE
observer methods are notified at the same time as other observers,
but AFTER_SUCCESS
observer methods get skipped.
Enum Constant and Description |
---|
AFTER_COMPLETION
Identifies an after completion observer method, called during the after completion phase of the transaction.
|
AFTER_FAILURE
Identifies an after failure observer method, called during the after completion phase of the transaction, only when the
transaction fails.
|
AFTER_SUCCESS
Identifies an after success observer method, called during the after completion phase of the transaction, only when the
transaction completes successfully.
|
BEFORE_COMPLETION
Identifies a before completion observer method, called during the before completion phase of the transaction.
|
IN_PROGRESS
Identifies a regular observer method, called when the event is fired.
|
Modifier and Type | Method and Description |
---|---|
static TransactionPhase |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static TransactionPhase[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final TransactionPhase IN_PROGRESS
Identifies a regular observer method, called when the event is fired.
public static final TransactionPhase BEFORE_COMPLETION
Identifies a before completion observer method, called during the before completion phase of the transaction.
Transactional observer will be notified if there is no transaction in progress, or the transaction is in progress,
but Synchronization
callback cannot be registered due to the transaction being already
marked for rollback or in state where Synchronization
callbacks cannot be registered.
public static final TransactionPhase AFTER_COMPLETION
Identifies an after completion observer method, called during the after completion phase of the transaction.
Transactional observer will be notified if there is no transaction in progress, or the transaction is in progress,
but Synchronization
callback cannot be registered due to the transaction being already
marked for rollback or in state where Synchronization
callbacks cannot be registered.
public static final TransactionPhase AFTER_FAILURE
Identifies an after failure observer method, called during the after completion phase of the transaction, only when the transaction fails.
Transactional observer will be notified will also get invoked if there is no transaction in progress, or the transaction is in progress,
but Synchronization
callback cannot be registered due to the transaction being already
marked for rollback or in state where Synchronization
callbacks cannot be registered.
public static final TransactionPhase AFTER_SUCCESS
Identifies an after success observer method, called during the after completion phase of the transaction, only when the transaction completes successfully.
public static TransactionPhase[] values()
for (TransactionPhase c : TransactionPhase.values()) System.out.println(c);
public static TransactionPhase valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullCopyright © 2021 JBoss by Red Hat. All rights reserved.