SessionContext (Java EE 5 SDK) - Java Platform, Enterprise Edition v5.0 API Specifications
|
Java EE 5 SDK | ||||||||
| 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 | ||
|---|---|---|
|
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. |
|
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, 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
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.
- 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.
getInvokedBusinessInterface
Class getInvokedBusinessInterface() throws IllegalStateException
- Obtain 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.
|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Submit a bug or feature
Copyright 2006 Sun Microsystems, Inc. All rights reserved.