KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > ejb > MessageDrivenBean


1 /**
2  * EasyBeans
3  * Copyright (C) 2006 Bull S.A.S.
4  * Contact: easybeans@objectweb.org
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19  * USA
20  *
21  * --------------------------------------------------------------------------
22  * $Id: MessageDrivenBean.java 1100 2006-08-16 13:05:31Z benoitf $
23  * --------------------------------------------------------------------------
24  */

25
26 package javax.ejb;
27
28
29 /**
30  * The MessageDrivenBean interface is implemented by every message-driven
31  * enterprise Bean class. The container uses the MessageDrivenBean methods to
32  * notify the enterprise Bean instances of the instance's life cycle events.
33  * @see <a HREF="http://www.jcp.org/en/jsr/detail?id=220">EJB 3.0 specification</a>
34  * @author Florent Benoit
35  */

36 public interface MessageDrivenBean extends EnterpriseBean JavaDoc {
37
38     /**
39      * Set the associated message-driven context. The container calls this
40      * method after the instance creation. The enterprise Bean instance should
41      * store the reference to the context object in an instance variable. This
42      * method is called with no transaction context.
43      * @param ctx A MessageDrivenContext interface for the instance.
44      * @throws EJBException Thrown by the method to indicate a failure caused by
45      * a system-level error.
46      */

47     void setMessageDrivenContext(MessageDrivenContext JavaDoc ctx) throws EJBException JavaDoc;
48
49     /**
50      * A container invokes this method before it ends the life of the
51      * message-driven object. This happens when a container decides to terminate
52      * the message-driven object. This method is called with no transaction
53      * context.
54      * @throws EJBException Thrown by the method to indicate a failure caused by
55      * a system-level error.
56      */

57     void ejbRemove() throws EJBException JavaDoc;
58
59 }
60
Popular Tags