javax.ejb.MessageDrivenBean Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jboss-ejb-api_3.1_spec Show documentation

The Java EJB 3.1 API classes

The newest version!

package javax.ejb;

/**
 * The MessageDrivenBean interface is implemented by every message driven
 * enterprise bean class.  The container uses the MessageDrivenBean methods
 * to notify the enterprise bean instances of the instance's life cycle events.
 */
public interface MessageDrivenBean extends EnterpriseBean {

  /**
   * Set the associated message-driven context. The container calls this method after the
   * instance creation.
   *
   * The enterprise Bean instance should store the reference to the context object in an instance
   * variable.
   *
   * This method is called with no transaction context.
   *
   * @param ctx - A MessageDrivenContext interface for the instance.
   * @exception EJBException - Thrown by the method to indicate a failure caused by a system-level error.
   */
  public void setMessageDrivenContext( MessageDrivenContext ctx ) throws EJBException;
   
   /**
    * A container invokes this method before it ends the life of the message-driven object.
    * This happens when a container decides to terminate the message-driven object.
    *
    * This method is called with no transaction context.
    *
    * @exception EJBException - Thrown by the method to indicate a failure caused by a system-level error.
    */
   public void ejbRemove() throws EJBException;
}