javax.ejb API 3.2.2 · javax.ejb.TransactionAttributeType

The enum TransactionAttributeType is used with the TransactionAttribute annotation to specify whether the methods of a session bean or message driven bean are called with a valid transaction context.

For a message-driven bean's message listener methods (or interface), only the REQUIRED and NOT_SUPPORTED values may be used.

For an enterprise bean's timeout callback methods, only the REQUIRED, REQUIRES_NEW and NOT_SUPPORTED values may be used.

For a session bean's asynchronous business methods, only the REQUIRED, REQUIRES_NEW, and NOT_SUPPORTED values may be used.

For a singleton session bean's PostConstruct and PreDestroy lifecycle callback interceptor methods, only the REQUIRED, REQUIRES_NEW, and NOT_SUPPORTED values may be used.

If an enterprise bean implements the SessionSynchronization interface or uses any of the session synchronization annotations, only the following values may be used for the transaction attributes of the bean's methods: REQUIRED, REQUIRES_NEW, MANDATORY.

Field Summary

Modifier and Type	Field and Description
public static final TransactionAttributeType	MANDATORY If a client invokes the enterprise bean's method while the client is associated with a transaction context, the container invokes the enterprise bean's method in the client's transaction context.
public static final TransactionAttributeType	NEVER The client is required to call without a transaction context, otherwise an exception is thrown.
public static final TransactionAttributeType	NOT_SUPPORTED The container invokes an enterprise bean method whose transaction attribute `NOT_SUPPORTED` with an unspecified transaction context.
public static final TransactionAttributeType	REQUIRED If a client invokes the enterprise bean's method while the client is associated with a transaction context, the container invokes the enterprise bean's method in the client's transaction context.
public static final TransactionAttributeType	REQUIRES_NEW The container must invoke an enterprise bean method whose transaction attribute is set to `REQUIRES_NEW` with a new transaction context.
public static final TransactionAttributeType	SUPPORTS If the client calls with a transaction context, the container performs the same steps as described in the `REQUIRED` case.

Access	Constructor and Description
private	TransactionAttributeType()

Method Summary

Modifier and Type	Method and Description
public static TransactionAttributeType	valueOf(String name)
public static TransactionAttributeType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

MANDATORY	back to summary
public static final TransactionAttributeType MANDATORY If a client invokes the enterprise bean's method while the client is associated with a transaction context, the container invokes the enterprise bean's method in the client's transaction context. If there is no existing transaction, an exception is thrown.

MANDATORY

back to summary

public static final TransactionAttributeType MANDATORY

If a client invokes the enterprise bean's method while the client is associated with a transaction context, the container invokes the enterprise bean's method in the client's transaction context.

If there is no existing transaction, an exception is thrown.

NEVER	back to summary
public static final TransactionAttributeType NEVER The client is required to call without a transaction context, otherwise an exception is thrown.

NOT_SUPPORTED back to summary

NOT_SUPPORTED	back to summary
public static final TransactionAttributeType NOT_SUPPORTED The container invokes an enterprise bean method whose transaction attribute `NOT_SUPPORTED` with an unspecified transaction context. If a client calls with a transaction context, the container suspends the association of the transaction context with the current thread before invoking the enterprise bean's business method. The container resumes the suspended association when the business method has completed.

public static final TransactionAttributeType NOT_SUPPORTED

The container invokes an enterprise bean method whose transaction attribute NOT_SUPPORTED with an unspecified transaction context.

If a client calls with a transaction context, the container suspends the association of the transaction context with the current thread before invoking the enterprise bean's business method. The container resumes the suspended association when the business method has completed.

REQUIRED	back to summary
public static final TransactionAttributeType REQUIRED If a client invokes the enterprise bean's method while the client is associated with a transaction context, the container invokes the enterprise bean's method in the client's transaction context. If the client invokes the enterprise bean's method while the client is not associated with a transaction context, the container automatically starts a new transaction before delegating a method call to the enterprise bean method.

REQUIRED

back to summary

public static final TransactionAttributeType REQUIRED

If a client invokes the enterprise bean's method while the client is associated with a transaction context, the container invokes the enterprise bean's method in the client's transaction context.

If the client invokes the enterprise bean's method while the client is not associated with a transaction context, the container automatically starts a new transaction before delegating a method call to the enterprise bean method.

REQUIRES_NEW back to summary

REQUIRES_NEW	back to summary
public static final TransactionAttributeType REQUIRES_NEW The container must invoke an enterprise bean method whose transaction attribute is set to `REQUIRES_NEW` with a new transaction context. If the client invokes the enterprise bean's method while the client is not associated with a transaction context, the container automatically starts a new transaction before delegating a method call to the enterprise bean business method. If a client calls with a transaction context, the container suspends the association of the transaction context with the current thread before starting the new transaction and invoking the method. The container resumes the suspended transaction association after the method and the new transaction have been completed.

public static final TransactionAttributeType REQUIRES_NEW

The container must invoke an enterprise bean method whose transaction attribute is set to REQUIRES_NEW with a new transaction context.

If a client calls with a transaction context, the container suspends the association of the transaction context with the current thread before starting the new transaction and invoking the method. The container resumes the suspended transaction association after the method and the new transaction have been completed.

SUPPORTS back to summary

SUPPORTS	back to summary
public static final TransactionAttributeType SUPPORTS If the client calls with a transaction context, the container performs the same steps as described in the `REQUIRED` case. If the client calls without a transaction context, the container performs the same steps as described in the `NOT_SUPPORTED` case. The `SUPPORTS` transaction attribute must be used with caution. This is because of the different transactional semantics provided by the two possible modes of execution. Only enterprise beans that will execute correctly in both modes should use the `SUPPORTS` transaction attribute.

public static final TransactionAttributeType SUPPORTS

If the client calls with a transaction context, the container performs the same steps as described in the REQUIRED case.

If the client calls without a transaction context, the container performs the same steps as described in the NOT_SUPPORTED case.

The SUPPORTS transaction attribute must be used with caution. This is because of the different transactional semantics provided by the two possible modes of execution. Only enterprise beans that will execute correctly in both modes should use the SUPPORTS transaction attribute.

public final Enum TransactionAttributeType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail