javax.ejb
Interface SessionContext

All Superinterfaces:

EJBContext

public interface SessionContext
extends EJBContext

Context provided by Session Bean.

Author:

Florent Benoit

See Also:

EJB 3.1 specification

Method Summary

<T> T	getBusinessObject(Class<T> businessInterface) Obtain an object that can be used to invoke the current bean through the given business interface.
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.
Class	getInvokedBusinessInterface() Obtain the business interface through which the current business method invocation was made.
javax.xml.rpc.handler.MessageContext	getMessageContext() Obtain a reference to the JAX-RPC MessageContext.
boolean	wasCancelCalled() Check whether a client invoked the cancel() method on the client Future object corresponding to the currently executing asynchronous business method.

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 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

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

javax.xml.rpc.handler.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

Obtain an object that can be used to invoke the current bean through the given business interface.

Type Parameters:

T - the interface of the bean

Parameters:

businessInterface - One of the local business interfaces or remote business interfaces for this session bean.

Returns:

The business object corresponding to the given business interface.

Throws:

IllegalStateException - - Thrown if this method is invoked with an invalid business interface for the current bean.

Since:

EJB 3.0 version.

getInvokedBusinessInterface

Class getInvokedBusinessInterface()
                                  throws IllegalStateException

Obtain the business interface through which the current business method invocation was made.

Returns:

the business interface through which the current business method invocation was made.

Throws:

IllegalStateException - - Thrown if this method is called and the bean has not been invoked through a business interface.

Since:

EJB 3.0 version.

wasCancelCalled

boolean wasCancelCalled()
                        throws IllegalStateException

Check whether a client invoked the cancel() method on the client Future object corresponding to the currently executing asynchronous business method.

Returns:

true if the client has invoked Future.cancel with a value of true for the mayInterruptIfRunning parameter.

Throws:

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