001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package javax.ejb;
023:
024: import java.rmi.RemoteException;
025:
026: /**
027: * The EntityBean interface is implemented by every entity enterprise
028: * Bean class. The container uses the EntityBean methods to notify the
029: * enterprise Bean instances of the instance's life cycle events.
030: */
031: public interface EntityBean extends EnterpriseBean {
032:
033: /**
034: * <P>Set the associated entity context. The container invokes this method on an instance
035: * after the instance has been created.</P>
036: *
037: * <P>This method is called in an unspecified transaction context.</P>
038: *
039: * @param ctx - An EntityContext interface for the instance. The instance should store the
040: * reference to the context in an instance variable.
041: * @exception EJBException - Thrown by the method to indicate a failure caused by a system-level error.
042: * @exception java.rmi.RemoteException - This exception is defined in the method signature to provide
043: * backward compatibility for enterprise beans written for the EJB 1.0 specification. Enterprise beans
044: * written for the EJB 1.1 specification should throw the javax.ejb.EJBException instead of this exception.
045: * Enterprise beans written for the EJB2.0 and higher specifications must throw the javax.ejb.EJBException
046: * instead of this exception.
047: */
048: public void setEntityContext(EntityContext ctx)
049: throws EJBException, RemoteException;
050:
051: /**
052: * <P>Unset the associated entity context. The container calls this method before removing the instance.</P>
053: *
054: * <P>This is the last method that the container invokes on the instance. The Java garbage collector
055: * will eventually invoke the finalize() method on the instance.</P>
056: *
057: * <P>This method is called in an unspecified transaction context.</P>
058: *
059: * @exception EJBException - Thrown by the method to indicate a failure caused by a system-level error.
060: * @exception java.rmi.RemoteException - This exception is defined in the method signature to provide
061: * backward compatibility for enterprise beans written for the EJB 1.0 specification. Enterprise beans
062: * written for the EJB 1.1 specification should throw the javax.ejb.EJBException instead of this exception.
063: * Enterprise beans written for the EJB2.0 and higher specifications must throw the javax.ejb.EJBException
064: * instead of this exception.
065: */
066: public void unsetEntityContext() throws EJBException,
067: RemoteException;
068:
069: /**
070: * <P>A container invokes this method before it removes the EJB object that is currently associated
071: * with the instance. This method is invoked when a client invokes a remove operation on the enterprise
072: * Bean's home interface or the EJB object's remote interface. This method transitions the instance from
073: * the ready state to the pool of available instances.</P>
074: *
075: * <P>This method is called in the transaction context of the remove operation.</P>
076: *
077: * @exception EJBException - Thrown by the method to indicate a failure caused by a system-level error.
078: * @exception java.rmi.RemoteException - This exception is defined in the method signature to provide
079: * backward compatibility for enterprise beans written for the EJB 1.0 specification. Enterprise beans
080: * written for the EJB 1.1 specification should throw the javax.ejb.EJBException instead of this exception.
081: * Enterprise beans written for the EJB2.0 and higher specifications must throw the javax.ejb.EJBException
082: * instead of this exception.
083: */
084: public void ejbRemove() throws RemoveException, EJBException,
085: RemoteException;
086:
087: /**
088: * <P>A container invokes this method when the instance is taken out of the pool of available
089: * instances to become associated with a specific EJB object. This method transitions the instance
090: * to the ready state.</P>
091: *
092: * <P>This method executes in an unspecified transaction context.</P>
093: *
094: * @exception EJBException - Thrown by the method to indicate a failure caused by a system-level error.
095: * @exception java.rmi.RemoteException - This exception is defined in the method signature to provide
096: * backward compatibility for enterprise beans written for the EJB 1.0 specification. Enterprise beans
097: * written for the EJB 1.1 specification should throw the javax.ejb.EJBException instead of this exception.
098: * Enterprise beans written for the EJB2.0 and higher specifications must throw the javax.ejb.EJBException
099: * instead of this exception.
100: */
101: public void ejbActivate() throws EJBException, RemoteException;
102:
103: /**
104: * <P>A container invokes this method on an instance before the instance becomes disassociated with
105: * a specific EJB object. After this method completes, the container will place the instance into the
106: * pool of available instances.</P>
107: *
108: * <P>This method executes in an unspecified transaction context.</P>
109: *
110: * @exception EJBException - Thrown by the method to indicate a failure caused by a system-level error.
111: * @exception java.rmi.RemoteException - This exception is defined in the method signature to provide
112: * backward compatibility for enterprise beans written for the EJB 1.0 specification. Enterprise beans
113: * written for the EJB 1.1 specification should throw the javax.ejb.EJBException instead of this exception.
114: * Enterprise beans written for the EJB2.0 and higher specifications must throw the javax.ejb.EJBException
115: * instead of this exception.
116: */
117: public void ejbPassivate() throws EJBException, RemoteException;
118:
119: /**
120: * <P>A container invokes this method to instruct the instance to synchronize its state by loading
121: * it state from the underlying database.</P>
122: *
123: * <P>This method always executes in the transaction context determined by the value of the transaction
124: * attribute in the deployment descriptor.</P>
125: *
126: * @exception EJBException - Thrown by the method to indicate a failure caused by a system-level error.
127: * @exception java.rmi.RemoteException - This exception is defined in the method signature to provide
128: * backward compatibility for enterprise beans written for the EJB 1.0 specification. Enterprise beans
129: * written for the EJB 1.1 specification should throw the javax.ejb.EJBException instead of this exception.
130: * Enterprise beans written for the EJB2.0 and higher specifications must throw the javax.ejb.EJBException
131: * instead of this exception.
132: */
133: public void ejbLoad() throws EJBException, RemoteException;
134:
135: /**
136: * <P>A container invokes this method to instruct the instance to synchronize its state by storing it to
137: * the underlying database.</P>
138: *
139: * <P>This method always executes in the transaction context determined by the value of the transaction
140: * attribute in the deployment descriptor.</P>
141: *
142: * @exception EJBException - Thrown by the method to indicate a failure caused by a system-level error.
143: * @exception java.rmi.RemoteException - This exception is defined in the method signature to provide
144: * backward compatibility for enterprise beans written for the EJB 1.0 specification. Enterprise beans
145: * written for the EJB 1.1 specification should throw the javax.ejb.EJBException instead of this exception.
146: * Enterprise beans written for the EJB2.0 and higher specifications must throw the javax.ejb.EJBException
147: * instead of this exception.
148: */
149: public void ejbStore() throws EJBException, RemoteException;
150:
151: }
|