Module jakarta.ejb

Package jakarta.ejb

Interface MessageDrivenBean

All Superinterfaces:

EnterpriseBean, Serializable

public interface MessageDrivenBean
extends EnterpriseBean

The MessageDrivenBean interface defines methods that the enterprise bean container uses to notify a message driven bean instance of the instance's life cycle events.

As of EJB 3.0 it is no longer required that a message driven bean class implement this interface.

Since:

EJB 2.0

Method Summary

Modifier and Type	Method	Description
void	ejbRemove()	A container invokes this method before it ends the life of the message-driven object.
void	setMessageDrivenContext(MessageDrivenContext ctx)	Set the associated message-driven context.

Method Details

setMessageDrivenContext

void setMessageDrivenContext(MessageDrivenContext ctx)
                      throws EJBException

Set the associated message-driven context. The container calls this method after the instance creation.

The message driven bean instance should store the reference to the context object in an instance variable.

This method is called with no transaction context.

Parameters:

ctx - A MessageDrivenContext interface for the instance.

Throws:

EJBException - Thrown by the method to indicate a failure caused by a system-level error.

ejbRemove

void ejbRemove()
        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.

Throws:

EJBException - Thrown by the method to indicate a failure caused by a system-level error.