01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package javax.ejb;
23:
24: import java.rmi.RemoteException;
25:
26: /**
27: * The SessionBean interface is implemented by every session enterprise
28: * Bean class. The container uses the SessionBean methods to notify the
29: * enterprise Bean instances of the instance's life cycle events.
30: */
31: public interface SessionBean extends EnterpriseBean {
32:
33: /**
34: * <P>Set the associated session context. The container calls this method after the instance creation.</P>
35: *
36: * <P>The enterprise Bean instance should store the reference to the context object in an instance variable.</P>
37: *
38: * <P>This method is called with no transaction context.</P>
39: *
40: * @param ctx - A SessionContext interface for the instance.
41: * @exception EJBException - Thrown by the method to indicate a failure caused by a system-level error.
42: * @exception java.rmi.RemoteException - This exception is defined in the method signature to provide
43: * backward compatibility for enterprise beans written for the EJB 1.0 specification. Enterprise beans
44: * written for the EJB 1.1 specification should throw the javax.ejb.EJBException instead of this exception.
45: * Enterprise beans written for the EJB2.0 and higher specifications must throw the javax.ejb.EJBException
46: * instead of this exception.
47: */
48: public void setSessionContext(SessionContext ctx)
49: throws EJBException, RemoteException;
50:
51: /**
52: * <P>A container invokes this method before it ends the life of the session object. This happens
53: * as a result of a client's invoking a remove operation, or when a container decides to terminate
54: * the session object after a timeout.</P>
55: *
56: * <P>This method is called with no transaction context.</P>
57: *
58: * @exception EJBException - Thrown by the method to indicate a failure caused by a system-level error.
59: * @exception java.rmi.RemoteException - This exception is defined in the method signature to provide
60: * backward compatibility for enterprise beans written for the EJB 1.0 specification. Enterprise beans
61: * written for the EJB 1.1 specification should throw the javax.ejb.EJBException instead of this exception.
62: * Enterprise beans written for the EJB2.0 and higher specifications must throw the javax.ejb.EJBException
63: * instead of this exception.
64: */
65: public void ejbRemove() throws EJBException, RemoteException;
66:
67: /**
68: * <P>The activate method is called when the instance is activated from its "passive" state.
69: * The instance should acquire any resource that it has released earlier in the ejbPassivate() method.</P>
70: *
71: * <P>This method is called with no transaction context.</P>
72: *
73: * @exception EJBException - Thrown by the method to indicate a failure caused by a system-level error.
74: * @exception java.rmi.RemoteException - This exception is defined in the method signature to provide
75: * backward compatibility for enterprise beans written for the EJB 1.0 specification. Enterprise beans
76: * written for the EJB 1.1 specification should throw the javax.ejb.EJBException instead of this exception.
77: * Enterprise beans written for the EJB2.0 and higher specifications must throw the javax.ejb.EJBException
78: * instead of this exception.
79: */
80: public void ejbActivate() throws EJBException, RemoteException;
81:
82: /**
83: * <P>The passivate method is called before the instance enters the "passive" state. The instance should
84: * release any resources that it can re-acquire later in the ejbActivate() method.</P>
85: *
86: * <P>After the passivate method completes, the instance must be in a state that allows the container to
87: * use the Java Serialization protocol to externalize and store away the instance's state.</P>
88: *
89: * <P>This method is called with no transaction context.</P>
90: *
91: * @exception EJBException - Thrown by the method to indicate a failure caused by a system-level error.
92: * @exception java.rmi.RemoteException - This exception is defined in the method signature to provide
93: * backward compatibility for enterprise beans written for the EJB 1.0 specification. Enterprise beans
94: * written for the EJB 1.1 specification should throw the javax.ejb.EJBException instead of this exception.
95: * Enterprise beans written for the EJB2.0 and higher specifications must throw the javax.ejb.EJBException
96: * instead of this exception.
97: */
98: public void ejbPassivate() throws EJBException, RemoteException;
99: }
|