01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package javax.ejb;
23:
24: /**
25: * The MessageDrivenBean interface is implemented by every message driven
26: * enterprise bean class. The container uses the MessageDrivenBean methods
27: * to notify the enterprise bean instances of the instance's life cycle events.
28: */
29: public interface MessageDrivenBean extends EnterpriseBean {
30:
31: /**
32: * <P>Set the associated message-driven context. The container calls this method after the
33: * instance creation.</P>
34: *
35: * <P>The enterprise Bean instance should store the reference to the context object in an instance
36: * variable.</P>
37: *
38: * <P>This method is called with no transaction context.</P>
39: *
40: * @param ctx - A MessageDrivenContext interface for the instance.
41: * @exception EJBException - Thrown by the method to indicate a failure caused by a system-level error.
42: */
43: public void setMessageDrivenContext(MessageDrivenContext ctx)
44: throws EJBException;
45:
46: /**
47: * <P>A container invokes this method before it ends the life of the message-driven object.
48: * This happens when a container decides to terminate the message-driven object.</P>
49: *
50: * <P>This method is called with no transaction context.</P>
51: *
52: * @exception EJBException - Thrown by the method to indicate a failure caused by a system-level error.
53: */
54: public void ejbRemove() throws EJBException;
55: }
|