001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036: package javax.ejb;
037:
038: import java.rmi.RemoteException;
039:
040: /**
041: * The EntityBean interface is implemented by every entity enterprise Bean
042: * class. The container uses the EntityBean methods to notify the enterprise
043: * Bean instances of the instance's life cycle events.
044: */
045: public interface EntityBean extends EnterpriseBean {
046: /**
047: * Set the associated entity context. The container invokes this method
048: * on an instance after the instance has been created.
049: *
050: * <p> This method is called in an unspecified transaction context.
051: *
052: * @param ctx An EntityContext interface for the instance. The instance
053: * should store the reference to the context in an instance variable.
054: *
055: * @exception EJBException Thrown by the method to indicate a failure
056: * caused by a system-level error.
057: *
058: * @exception RemoteException This exception is defined in the method
059: * signature to provide backward compatibility for enterprise beans
060: * written for the EJB 1.0 specification. Enterprise beans written
061: * for the EJB 1.1 specification should throw the
062: * javax.ejb.EJBException instead of this exception.
063: * Enterprise beans written for the EJB2.0 and higher specifications
064: * must throw the javax.ejb.EJBException instead of this exception.
065: */
066: public void setEntityContext(EntityContext ctx)
067: throws EJBException, RemoteException;
068:
069: /**
070: * Unset the associated entity context. The container calls this method
071: * before removing the instance.
072: *
073: * <p> This is the last method that the container invokes on the instance.
074: * The Java garbage collector will eventually invoke the finalize() method
075: * on the instance.
076: *
077: * <p> This method is called in an unspecified transaction context.
078: *
079: * @exception EJBException Thrown by the method to indicate a failure
080: * caused by a system-level error.
081: *
082: * @exception RemoteException This exception is defined in the method
083: * signature to provide backward compatibility for enterprise beans
084: * written for the EJB 1.0 specification. Enterprise beans written
085: * for the EJB 1.1 specification should throw the
086: * javax.ejb.EJBException instead of this exception.
087: * Enterprise beans written for the EJB2.0 and higher specifications
088: * must throw the javax.ejb.EJBException instead of this exception.
089: */
090: public void unsetEntityContext() throws EJBException,
091: RemoteException;
092:
093: /**
094: * A container invokes this method before it removes the EJB object
095: * that is currently associated with the instance. This method
096: * is invoked when a client invokes a remove operation on the
097: * enterprise Bean's home interface or the EJB object's remote interface.
098: * This method transitions the instance from the ready state to the pool
099: * 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: }
|