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 import java.rmi.RemoteException;
39
40
41 /**
42 * The EntityBean interface is implemented by every entity enterprise Bean
43 * class. The container uses the EntityBean methods to notify the enterprise
44 * Bean instances of the instance's life cycle events.
45 */
46 public interface EntityBean extends EnterpriseBean {
47 /**
48 * Set the associated entity context. The container invokes this method
49 * on an instance after the instance has been created.
50 *
51 * <p> This method is called in an unspecified transaction context.
52 *
53 * @param ctx An EntityContext interface for the instance. The instance
54 * should store the reference to the context in an instance variable.
55 *
56 * @exception EJBException Thrown by the method to indicate a failure
57 * caused by a system-level error.
58 *
59 * @exception RemoteException This exception is defined in the method
60 * signature to provide backward compatibility for enterprise beans
61 * written for the EJB 1.0 specification. Enterprise beans written
62 * for the EJB 1.1 specification should throw the
63 * javax.ejb.EJBException instead of this exception.
64 * Enterprise beans written for the EJB2.0 and higher specifications
65 * must throw the javax.ejb.EJBException instead of this exception.
66 */
67 public void setEntityContext(EntityContext ctx) throws EJBException,
68 RemoteException;
69
70 /**
71 * Unset the associated entity context. The container calls this method
72 * before removing the instance.
73 *
74 * <p> This is the last method that the container invokes on the instance.
75 * The Java garbage collector will eventually invoke the finalize() method
76 * on the instance.
77 *
78 * <p> This method is called in an unspecified transaction context.
79 *
80 * @exception EJBException Thrown by the method to indicate a failure
81 * caused by a system-level error.
82 *
83 * @exception RemoteException This exception is defined in the method
84 * signature to provide backward compatibility for enterprise beans
85 * written for the EJB 1.0 specification. Enterprise beans written
86 * for the EJB 1.1 specification should throw the
87 * javax.ejb.EJBException instead of this exception.
88 * Enterprise beans written for the EJB2.0 and higher specifications
89 * must throw the javax.ejb.EJBException instead of this exception.
90 */
91 public void unsetEntityContext() throws EJBException, RemoteException;
92
93 /**
94 * A container invokes this method before it removes the EJB object
95 * that is currently associated with the instance. This method
96 * is invoked when a client invokes a remove operation on the
97 * enterprise Bean's home interface or the EJB object's remote interface.
98 * This method transitions the instance from the ready state to the pool
99 * of available instances.
100 *
101 * <p> This method is called in the transaction context of the remove
102 * operation.
103 *
104 * @exception RemoveException The enterprise Bean does not allow
105 * destruction of the object.
106 *
107 * @exception EJBException Thrown by the method to indicate a failure
108 * caused by a system-level error.
109 *
110 * @exception RemoteException This exception is defined in the method
111 * signature to provide backward compatibility for enterprise beans
112 * written for the EJB 1.0 specification. Enterprise beans written
113 * for the EJB 1.1 specification should throw the
114 * javax.ejb.EJBException instead of this exception.
115 * Enterprise beans written for the EJB2.0 and higher specifications
116 * must throw the javax.ejb.EJBException instead of this exception.
117 */
118 public void ejbRemove() throws RemoveException, EJBException,
119 RemoteException;
120
121 /**
122 * A container invokes this method when the instance
123 * is taken out of the pool of available instances to become associated
124 * with a specific EJB object. This method transitions the instance to
125 * the ready state.
126 *
127 * <p> This method executes in an unspecified transaction context.
128 *
129 * @exception EJBException Thrown by the method to indicate a failure
130 * caused by a system-level error.
131 *
132 * @exception RemoteException This exception is defined in the method
133 * signature to provide backward compatibility for enterprise beans
134 * written for the EJB 1.0 specification. Enterprise beans written
135 * for the EJB 1.1 specification should throw the
136 * javax.ejb.EJBException instead of this exception.
137 * Enterprise beans written for the EJB2.0 and higher specifications
138 * must throw the javax.ejb.EJBException instead of this exception.
139 */
140 public void ejbActivate() throws EJBException, RemoteException;
141
142 /**
143 * A container invokes this method on an instance before the instance
144 * becomes disassociated with a specific EJB object. After this method
145 * completes, the container will place the instance into the pool of
146 * available instances.
147 *
148 * <p> This method executes in an unspecified transaction context.
149 *
150 * @exception EJBException Thrown by the method to indicate a failure
151 * caused by a system-level error.
152 *
153 * @exception RemoteException This exception is defined in the method
154 * signature to provide backward compatibility for enterprise beans
155 * written for the EJB 1.0 specification. Enterprise beans written
156 * for the EJB 1.1 specification should throw the
157 * javax.ejb.EJBException instead of this exception.
158 * Enterprise beans written for the EJB2.0 and higher specifications
159 * must throw the javax.ejb.EJBException instead of this exception.
160 */
161 public void ejbPassivate() throws EJBException, RemoteException;
162
163 /**
164 * A container invokes this method to instruct the
165 * instance to synchronize its state by loading it state from the
166 * underlying database.
167 *
168 * <p> This method always executes in the transaction context determined
169 * by the value of the transaction attribute in the deployment descriptor.
170 *
171 * @exception EJBException Thrown by the method to indicate a failure
172 * caused by a system-level error.
173 *
174 * @exception RemoteException This exception is defined in the method
175 * signature to provide backward compatibility for enterprise beans
176 * written for the EJB 1.0 specification. Enterprise beans written
177 * for the EJB 1.1 specification should throw the
178 * javax.ejb.EJBException instead of this exception.
179 * Enterprise beans written for the EJB2.0 and higher specifications
180 * must throw the javax.ejb.EJBException instead of this exception.
181 */
182 public void ejbLoad() throws EJBException, RemoteException;
183
184 /**
185 * A container invokes this method to instruct the
186 * instance to synchronize its state by storing it to the underlying
187 * database.
188 *
189 * <p> This method always executes in the transaction context determined
190 * by the value of the transaction attribute in the deployment descriptor.
191 *
192 * @exception EJBException Thrown by the method to indicate a failure
193 * caused by a system-level error.
194 *
195 * @exception RemoteException This exception is defined in the method
196 * signature to provide backward compatibility for enterprise beans
197 * written for the EJB 1.0 specification. Enterprise beans written
198 * for the EJB 1.1 specification should throw the
199 * javax.ejb.EJBException instead of this exception.
200 * Enterprise beans written for the EJB2.0 and higher specifications
201 * must throw the javax.ejb.EJBException instead of this exception.
202 */
203 public void ejbStore() throws EJBException, RemoteException;
204 }
205
206
Save This Page