SessionContext.java |
/* * JBoss, the OpenSource EJB server * * Distributable under LGPL license. * See terms of license at gnu.org. */ package javax.ejb; import javax.xml.rpc.handler.MessageContext; /** * The SessionContext interface provides access to the runtime session * context that the container provides for a session enterprise Bean * instance. The container passes the SessionContext interface to an * instance after the instance has been created. The session context * remains associated with the instance for the lifetime of the instance. * @version $Revision: 1.4 $ */ public interface SessionContext extends EJBContext { /** * <P>Obtain a reference to the EJB local object that is currently associated with the instance.</P> * * <P>An instance of an entity enterprise Bean can call this method only when the instance is associated * with an EJB local object identity, i.e. in the ejbActivate, ejbPassivate, ejbPostCreate, ejbRemove, ejbLoad, * ejbStore, and business methods.</P> * * <P>An instance can use this method, for example, when it wants to pass a reference to itself in a method * argument or result.</P> * * @return The EJB local object currently associated with the instance. * @exception java.lang.IllegalStateException - Thrown if the instance invokes this method while the instance * is in a state that does not allow the instance to invoke this method, or if the instance does not have a * local interface. */ public EJBLocalObject getEJBLocalObject() throws IllegalStateException; /** * <P>Obtain a reference to the EJB object that is currently associated with the instance.</P> * * <P>An instance of a session enterprise Bean can call this method at anytime between the ejbCreate() * and ejbRemove() methods, including from within the ejbCreate() and ejbRemove() methods.</P> * * <P>An instance can use this method, for example, when it wants to pass a reference to itself in a method * argument or result.</P> * * @return The EJB object currently associated with the instance. * @exception java.lang.IllegalStateException - Thrown if the instance invokes this method while the instance * is in a state that does not allow the instance to invoke this method, or if the instance does not have a * remote interface. */ public EJBObject getEJBObject() throws IllegalStateException; /** Obtain a reference to the JAX-RPC MessageContext. An instance of a * stateless session bean can call this method from any business method * invoked through its web service endpoint interface. * * @return The MessageContext for this web service invocation. * @throws IllegalStateException - Thrown if this method is invoked while * the instance is in a state that does not allow access to this method. */ public MessageContext getMessageContext() throws IllegalStateException; }
SessionContext.java |