javax.ejb.SessionSynchronization Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote Jakarta Enterprise Beans and Jakarta Messaging, including all dependencies. It is intended for use by those not using maven, maven users should just import the Jakarta Enterprise Beans and Jakarta Messaging BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

There is a newer version: 35.0.0.Beta1

Show newest version

package javax.ejb;

import java.rmi.RemoteException;

/**
 * The SessionSynchronization interface allows a session Bean instance
 * to be notified by its container of transaction boundaries.
 * 
 * An session Bean class is not required to implement this interface. A
 * session Bean class should implement this interface only if it wishes to
 * synchronize its state with the transactions.
 */
public interface SessionSynchronization {

  /**
   * The afterBegin method notifies a session Bean instance that a new transaction has started, and that
   * the subsequent business methods on the instance will be invoked in the context of the transaction.
   *
   * The instance can use this method, for example, to read data from a database and cache the data in
   * the instance fields.
   *
   * This method executes in the proper transaction context.
   *
   * @exception EJBException - Thrown by the method to indicate a failure caused by a system-level error.
   * @exception java.rmi.RemoteException - This exception is defined in the method signature to provide backward
   * compatibility for enterprise beans written for the EJB 1.0 specification. Enterprise beans written for the
   * EJB 1.1 and higher specifications should throw the javax.ejb.EJBException instead of this exception.
   * Enterprise beans written for the EJB 2.0 and higher specifications must not throw the java.rmi.RemoteException.
   */
  public void afterBegin() throws EJBException, RemoteException;

  /**
   * The beforeCompletion method notifies a session Bean instance that a transaction is about to be committed.
   * The instance can use this method, for example, to write any cached data to a database.
   *
   * This method executes in the proper transaction context.
   *
   * Note: The instance may still cause the container to rollback the transaction by invoking the
   * setRollbackOnly() method on the instance context, or by throwing an exception.
   *
   * @exception EJBException - Thrown by the method to indicate a failure caused by a system-level error.
   * @exception java.rmi.RemoteException - This exception is defined in the method signature to provide backward
   * compatibility for enterprise beans written for the EJB 1.0 specification. Enterprise beans written for the
   * EJB 1.1 and higher specifications should throw the javax.ejb.EJBException instead of this exception.
   * Enterprise beans written for the EJB 2.0 and higher specifications must not throw the java.rmi.RemoteException.
   */
  public void beforeCompletion() throws EJBException, RemoteException;

   /**
    * The afterCompletion method notifies a session Bean instance that a transaction commit protocol has
    * completed, and tells the instance whether the transaction has been committed or rolled back.
    *
    * This method executes with no transaction context.
    *
    * This method executes with no transaction context.
    *
    * @param committed - True if the transaction has been committed, false if is has been rolled back.
    * @exception EJBException - Thrown by the method to indicate a failure caused by a system-level error.
    * @exception java.rmi.RemoteException - This exception is defined in the method signature to provide backward
    * compatibility for enterprise beans written for the EJB 1.0 specification. Enterprise beans written for the
    * EJB 1.1 and higher specifications should throw the javax.ejb.EJBException instead of this exception.
    * Enterprise beans written for the EJB 2.0 and higher specifications must not throw the java.rmi.RemoteException.
    */
   public void afterCompletion(boolean committed) throws EJBException, RemoteException;
}