001: /**
002: * EasyBeans
003: * Copyright (C) 2006 Bull S.A.S.
004: * Contact: easybeans@objectweb.org
005: *
006: * This library is free software; you can redistribute it and/or
007: * modify it under the terms of the GNU Lesser General Public
008: * License as published by the Free Software Foundation; either
009: * version 2.1 of the License, or any later version.
010: *
011: * This library is distributed in the hope that it will be useful,
012: * but WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * Lesser General Public License for more details.
015: *
016: * You should have received a copy of the GNU Lesser General Public
017: * License along with this library; if not, write to the Free Software
018: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
019: * USA
020: *
021: * --------------------------------------------------------------------------
022: * $Id: SessionBean.java 1100 2006-08-16 13:05:31Z benoitf $
023: * --------------------------------------------------------------------------
024: */package javax.ejb;
025:
026: import java.rmi.RemoteException;
027:
028: /**
029: * The SessionBean interface is implemented by every session enterprise Bean
030: * class. The container uses the SessionBean methods to notify the enterprise
031: * Bean instances of the instance's life cycle events.
032: * @see <a href="http://www.jcp.org/en/jsr/detail?id=220">EJB 3.0 specification</a>
033: * @author Florent Benoit
034: */
035: public interface SessionBean extends EnterpriseBean {
036:
037: /**
038: * Set the associated session context. The container calls this method after
039: * the instance creation. The enterprise Bean instance should store the
040: * reference to the context object in an instance variable. This method is
041: * called with no transaction context.
042: * @param ctx A SessionContext interface for the instance.
043: * @throws EJBException Thrown by the method to indicate a failure caused by
044: * a system-level error.
045: * @throws RemoteException This exception is defined in the method signature
046: * to provide backward compatibility for applications written for
047: * the EJB 1.0 specification. Enterprise beans written for the EJB
048: * 1.1 specification should throw the javax.ejb.EJBException instead
049: * of this exception. Enterprise beans written for the EJB2.0 and
050: * higher specifications must throw the javax.ejb.EJBException
051: * instead of this exception.
052: */
053: void setSessionContext(SessionContext ctx) throws EJBException,
054: RemoteException;
055:
056: /**
057: * A container invokes this method before it ends the life of the session
058: * object. This happens as a result of a client's invoking a remove
059: * operation, or when a container decides to terminate the session object
060: * after a timeout. This method is called with no transaction context.
061: * @throws EJBException Thrown by the method to indicate a failure caused by
062: * a system-level error.
063: * @throws RemoteException This exception is defined in the method signature
064: * to provide backward compatibility for enterprise beans written
065: * for the EJB 1.0 specification. Enterprise beans written for the
066: * EJB 1.1 specification should throw the javax.ejb.EJBException
067: * instead of this exception. Enterprise beans written for the
068: * EJB2.0 and higher specifications must throw the
069: * javax.ejb.EJBException instead of this exception.
070: */
071: void ejbRemove() throws EJBException, RemoteException;
072:
073: /**
074: * The activate method is called when the instance is activated from its
075: * "passive" state. The instance should acquire any resource that it has
076: * released earlier in the ejbPassivate() method. This method is called with
077: * no transaction context.
078: * @throws EJBException Thrown by the method to indicate a failure caused by
079: * a system-level error.
080: * @throws RemoteException This exception is defined in the method signature
081: * to provide backward compatibility for enterprise beans written
082: * for the EJB 1.0 specification. Enterprise beans written for the
083: * EJB 1.1 specification should throw the javax.ejb.EJBException
084: * instead of this exception. Enterprise beans written for the
085: * EJB2.0 and higher specifications must throw the
086: * javax.ejb.EJBException instead of this exception.
087: */
088: void ejbActivate() throws EJBException, RemoteException;
089:
090: /**
091: * The passivate method is called before the instance enters the "passive"
092: * state. The instance should release any resources that it can re-acquire
093: * later in the ejbActivate() method. After the passivate method completes,
094: * the instance must be in a state that allows the container to use the Java
095: * Serialization protocol to externalize and store away the instance's
096: * state. This method is called with no transaction context.
097: * @throws EJBException Thrown by the method to indicate a failure caused by
098: * a system-level error.
099: * @throws RemoteException This exception is defined in the method signature
100: * to provide backward compatibility for enterprise beans written
101: * for the EJB 1.0 specification. Enterprise beans written for the
102: * EJB 1.1 specification should throw the javax.ejb.EJBException
103: * instead of this exception. Enterprise beans written for the
104: * EJB2.0 and higher specifications must throw the
105: * javax.ejb.EJBException instead of this exception.
106: */
107: void ejbPassivate() throws EJBException, RemoteException;
108: }
|