SessionContext (Java 2 Platform Ent. Ed. v1.4) - Java Platform, Enterprise Edition v1.4 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java^TM 2 Platform
Ent. Ed. v1.4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.ejb
Interface SessionContext

All Superinterfaces:: EJBContext

public interface SessionContext
extends EJBContext

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.

Method Summary

EJBLocalObject getEJBLocalObject()
          Obtain a reference to the EJB local object that is associated with the instance.

EJBObject getEJBObject()
          Obtain a reference to the EJB object that is currently associated with the instance.

MessageContext getMessageContext()
          Obtain a reference to the JAX-RPC MessageContext.

Methods inherited from interface javax.ejb.EJBContext

getCallerIdentity, getCallerPrincipal, getEJBHome, getEJBLocalHome, getEnvironment, getRollbackOnly, getTimerService, getUserTransaction, isCallerInRole, isCallerInRole, setRollbackOnly

Method Detail

getEJBLocalObject

public EJBLocalObject getEJBLocalObject()
                                 throws IllegalStateException

Obtain a reference to the EJB local object that is associated with the instance.

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.

An instance can use this method, for example, when it wants to pass a reference to itself in a method argument or result.

Returns:: The EJB local object currently associated with the instance.
Throws:: 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.

getEJBObject

public EJBObject getEJBObject()
                       throws IllegalStateException

Obtain a reference to the EJB object that is currently associated with the instance.