EntityBean


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: EntityBean.java 1100 2006-08-16 13:05:31Z benoitf $
23   * --------------------------------------------------------------------------
24   */
25  
26  package javax.ejb;
27  
28  import java.rmi.RemoteException  ;
29  
30  /**
31   * Each EJB 2.1 Entity bean needs to implement this interface.
32   * @see <a HREF="http://www.jcp.org/en/jsr/detail?id=220">EJB 3.0 specification</a>
33   * @author Florent Benoit
34   */
35  public interface EntityBean extends EnterpriseBean   {
36  
37      /**
38       * Set the associated entity context. The container invokes this method on
39       * an instance after the instance has been created. This method is called in
40       * an unspecified transaction context.
41       * @param ctx An EntityContext interface for the instance. The instance
42       *        should store the reference to the context in an instance variable.
43       * @throws EJBException Thrown by the method to indicate a failure caused by
44       *         a system-level error.
45       * @throws RemoteException This exception is defined in the method signature
46       *         to provide backward compatibility for enterprise beans written
47       *         for the EJB 1.0 specification. Enterprise beans written for the
48       *         EJB 1.1 specification should throw the javax.ejb.EJBException
49       *         instead of this exception. Enterprise beans written for the
50       *         EJB2.0 and higher specifications must throw the
51       *         javax.ejb.EJBException instead of this exception.
52       */
53      void setEntityContext(EntityContext   ctx) throws EJBException  , RemoteException  ;
54  
55      /**
56       * Unset the associated entity context. The container calls this method
57       * before removing the instance. This is the last method that the container
58       * invokes on the instance. The Java garbage collector will eventually
59       * invoke the finalize() method on the instance. This method is called in an
60       * unspecified transaction context.
61       * @throws EJBException Thrown by the method to indicate a failure caused by
62       *         a system-level error.
63       * @throws RemoteException This exception is defined in the method signature
64       *         to provide backward compatibility for enterprise beans written
65       *         for the EJB 1.0 specification. Enterprise beans written for the
66       *         EJB 1.1 specification should throw the javax.ejb.EJBException
67       *         instead of this exception. Enterprise beans written for the
68       *         EJB2.0 and higher specifications must throw the
69       *         javax.ejb.EJBException instead of this exception.
70       */
71      void unsetEntityContext() throws EJBException  , RemoteException  ;
72  
73      /**
74       * A container invokes this method before it removes the EJB object that is
75       * currently associated with the instance. This method is invoked when a
76       * client invokes a remove operation on the enterprise Bean's home interface
77       * or the EJB object's remote interface. This method transitions the
78       * instance from the ready state to the pool of available instances. This
79       * method is called in the transaction context of the remove operation.
80       * @throws RemoveException The enterprise Bean does not allow destruction of
81       *         the object.
82       * @throws EJBException The enterprise Bean does not allow destruction of
83       *         the object.
84       * @throws RemoteException This exception is defined in the method signature
85       *         to provide backward compatibility for enterprise beans written
86       *         for the EJB 1.0 specification. Enterprise beans written for the
87       *         EJB 1.1 specification should throw the javax.ejb.EJBException
88       *         instead of this exception. Enterprise beans written for the
89       *         EJB2.0 and higher specifications must throw the
90       *         javax.ejb.EJBException instead of this exception.
91       */
92      void ejbRemove() throws RemoveException  , EJBException  , RemoteException  ;
93  
94      /**
95       * A container invokes this method when the instance is taken out of the
96       * pool of available instances to become associated with a specific EJB
97       * object. This method transitions the instance to the ready state. This
98       * method executes in an unspecified transaction context.
99       * @throws EJBException Thrown by the method to indicate a failure caused by
100      *         a system-level error.
101      * @throws RemoteException This exception is defined in the method signature
102      *         to provide backward compatibility for enterprise beans written
103      *         for the EJB 1.0 specification. Enterprise beans written for the
104      *         EJB 1.1 specification should throw the javax.ejb.EJBException
105      *         instead of this exception. Enterprise beans written for the
106      *         EJB2.0 and higher specifications must throw the
107      *         javax.ejb.EJBException instead of this exception.
108      */
109     void ejbActivate() throws EJBException  , RemoteException  ;
110 
111     /**
112      * A container invokes this method on an instance before the instance
113      * becomes disassociated with a specific EJB object. After this method
114      * completes, the container will place the instance into the pool of
115      * available instances. This method executes in an unspecified transaction
116      * context.
117      * @throws EJBException Thrown by the method to indicate a failure caused by
118      *         a system-level error.
119      * @throws RemoteException This exception is defined in the method signature
120      *         to provide backward compatibility for enterprise beans written
121      *         for the EJB 1.0 specification. Enterprise beans written for the
122      *         EJB 1.1 specification should throw the javax.ejb.EJBException
123      *         instead of this exception. Enterprise beans written for the
124      *         EJB2.0 and higher specifications must throw the
125      *         javax.ejb.EJBException instead of this exception.
126      */
127     void ejbPassivate() throws EJBException  , RemoteException  ;
128 
129     /**
130      * A container invokes this method to instruct the instance to synchronize
131      * its state by loading it state from the underlying database. This method
132      * always executes in the transaction context determined by the value of the
133      * transaction attribute in the deployment descriptor.
134      * @throws EJBException Thrown by the method to indicate a failure caused by
135      *         a system-level error.
136      * @throws RemoteException This exception is defined in the method signature
137      *         to provide backward compatibility for enterprise beans written
138      *         for the EJB 1.0 specification. Enterprise beans written for the
139      *         EJB 1.1 specification should throw the javax.ejb.EJBException
140      *         instead of this exception. Enterprise beans written for the
141      *         EJB2.0 and higher specifications must throw the
142      *         javax.ejb.EJBException instead of this exception.
143      */
144     void ejbLoad() throws EJBException  , RemoteException  ;
145 
146     /**
147      * A container invokes this method to instruct the instance to synchronize
148      * its state by storing it to the underlying database. This method always
149      * executes in the transaction context determined by the value of the
150      * transaction attribute in the deployment descriptor.
151      * @throws EJBException Thrown by the method to indicate a failure caused by
152      *         a system-level error.
153      * @throws RemoteException This exception is defined in the method signature
154      *         to provide backward compatibility for enterprise beans written
155      *         for the EJB 1.0 specification. Enterprise beans written for the
156      *         EJB 1.1 specification should throw the javax.ejb.EJBException
157      *         instead of this exception. Enterprise beans written for the
158      *         EJB2.0 and higher specifications must throw the
159      *         javax.ejb.EJBException instead of this exception.
160      */
161     void ejbStore() throws EJBException  , RemoteException  ;
162 
163 }
164
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags