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.

Version:

$Revision:78081 $

Method Summary

Modifier and Type	Method and Description
<T> T	getBusinessObject(Class<T> businessInterface) Returns the session bean�s business interface.
EJBLocalObject	getEJBLocalObject() Obtain a reference to the EJB local object that is currently associated with the instance.
EJBObject	getEJBObject() Obtain a reference to the EJB object that is currently associated with the instance.
Class	getInvokedBusinessInterface() Returns the session bean business interface through which the bean was invoked.
MessageContext	getMessageContext() Obtain a reference to the JAX-RPC MessageContext.
boolean	wasCancelCalled() Check whether a client has requested that the current asynchronous invocation be cancelled.

Methods inherited from interface javax.ejb.EJBContext

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

Method Detail

getEJBLocalObject

EJBLocalObject getEJBLocalObject()
                          throws IllegalStateException

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

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.

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

EJBObject getEJBObject()
                throws IllegalStateException

Obtain a reference to the EJB object that is currently 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 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 remote interface.

getMessageContext

MessageContext getMessageContext()
                          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.

Returns:

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.

getBusinessObject

<T> T getBusinessObject(Class<T> businessInterface)
                 throws IllegalStateException

Returns the session bean�s business interface. Only session beans with an EJB 3.0 business interface can call this method.

Returns:

The business interface associated with the instance.

Throws:

IllegalStateException - - Thrown if this method is invoked while the instance is in a state that does not allow access to this method.

getInvokedBusinessInterface

Class getInvokedBusinessInterface()
                           throws IllegalStateException

Returns the session bean business interface through which the bean was invoked.

Returns:

The business interface through which the bean was invoked.

Throws:

IllegalStateException - - Thrown if this method is invoked while the instance is in a state that does not allow access to this method.

wasCancelCalled

boolean wasCancelCalled()
                 throws IllegalStateException

Check whether a client has requested that the current asynchronous invocation be cancelled.

Returns:

true if the client has invoked Future.cancel()

Throws:

IllegalStateException - Thrown if not invoked from within an asynchronous business method invocation with return type Future.

Since:

3.1