1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12 * language governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16 * Sun designates this particular file as subject to the "Classpath" exception
17 * as provided by Sun in the GPL Version 2 section of the License file that
18 * accompanied this code. If applicable, add the following below the License
19 * Header, with the fields enclosed by brackets [] replaced by your own
20 * identifying information: "Portions Copyrighted [year]
21 * [name of copyright owner]"
22 *
23 * Contributor(s):
24 *
25 * If you wish your version of this file to be governed by only the CDDL or
26 * only the GPL Version 2, indicate your decision by adding "[Contributor]
27 * elects to include this software in this distribution under the [CDDL or GPL
28 * Version 2] license." If you don't indicate a single choice of license, a
29 * recipient has the option to distribute your version of this file under
30 * either the CDDL, the GPL Version 2 or to extend the choice of license to
31 * its licensees as provided above. However, if you add GPL Version 2 code
32 * and therefore, elected the GPL Version 2 license, then the option applies
33 * only if the new code is made subject to such option by the copyright
34 * holder.
35 */
36 package javax.ejb;
37
38 /**
39 * The MessageDrivenBean interface is implemented by every message-driven
40 * enterprise Bean class. The container uses the MessageDrivenBean methods
41 * to notify the enterprise Bean instances of the instance's life cycle
42 * events.
43 */
44 public interface MessageDrivenBean extends EnterpriseBean {
45 /**
46 * Set the associated message-driven context. The container calls
47 * this method after the instance creation.
48 *
49 * <p> The enterprise Bean instance should store the reference to the
50 * context object in an instance variable.
51 *
52 * <p> This method is called with no transaction context.
53 *
54 * @param ctx A MessageDrivenContext interface for the instance.
55 *
56 * @exception EJBException Thrown by the method to indicate a failure
57 * caused by a system-level error.
58 *
59 */
60 void setMessageDrivenContext(MessageDrivenContext ctx) throws EJBException;
61
62 /**
63 * A container invokes this method before it ends the life of the
64 * message-driven object. This happens when a container decides to
65 * terminate the message-driven object.
66 *
67 * <p> This method is called with no transaction context.
68 *
69 * @exception EJBException Thrown by the method to indicate a failure
70 * caused by a system-level error.
71 *
72 */
73 void ejbRemove() throws EJBException;
74
75 }
Save This Page