JavaEE Web API 8.0.1 · javax.ejb.SessionContext

Method Summary

Modifier and Type	Method and Description
public <T> T	Returns: The business object corresponding to the given business interface or no-interface view. getBusinessObject(Class<T> One of the local business interfaces or remote business interfaces for this session bean. In addition, the bean class type can be used to acquire a reference to the bean's no-interface view. businessInterface) Obtain an object that can be used to invoke the current bean through a particular business interface view or its no-interface view.
public EJBLocalObject	Returns: The EJB local object currently associated with the instance. getEJBLocalObject() Obtain a reference to the EJB local object that is associated with the instance.
public EJBObject	Returns: The EJB object currently associated with the instance. getEJBObject() Obtain a reference to the EJB object that is currently associated with the instance.
public Class<T>	getInvokedBusinessInterface() Obtain the business interface or no-interface view type through which the current business method invocation was made.
public MessageContext	Returns: The MessageContext for this web service invocation. getMessageContext() Obtain a reference to the JAX-RPC MessageContext.
public boolean	Returns: true if the client has invoked `Future.cancel` with a value of true for the `mayInterruptIfRunning` parameter. wasCancelCalled() Check whether a client invoked the `cancel` method on the client `Future` object corresponding to the currently executing asynchronous business method.

Inherited from javax.ejb.EJBContext:: getCallerIdentity getCallerPrincipal getContextData getEJBHome getEJBLocalHome getEnvironment getRollbackOnly getTimerService getUserTransaction isCallerInRole isCallerInRole lookup setRollbackOnly

Method Detail

getBusinessObject	back to summary
public <T> T getBusinessObject(Class<T> businessInterface) throws IllegalStateException Obtain an object that can be used to invoke the current bean through a particular business interface view or its no-interface view. Parameters businessInterface:Class<T> One of the local business interfaces or remote business interfaces for this session bean. In addition, the bean class type can be used to acquire a reference to the bean's no-interface view. Returns:T The business object corresponding to the given business interface or no-interface view. Exceptions IllegalStateException: Thrown if invoked with a parameter that does not correspond to one of the beans' business interfaces or no-interface view. Since EJB 3.0

getBusinessObject

back to summary

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

Obtain an object that can be used to invoke the current bean through a particular business interface view or its no-interface view.

Parameters

businessInterface:Class<T>: One of the local business interfaces or remote business interfaces for this session bean. In addition, the bean class type can be used to acquire a reference to the bean's no-interface view.

Returns:T

The business object corresponding to the given business interface or no-interface view.

Exceptions

IllegalStateException:: Thrown if invoked with a parameter that does not correspond to one of the beans' business interfaces or no-interface view.

Since

EJB 3.0

getEJBLocalObject back to summary

getEJBLocalObject	back to summary
public EJBLocalObject getEJBLocalObject() throws IllegalStateException Obtain a reference to the EJB local object that is associated with the instance. An instance of a session bean can call this method at anytime between the `PostConstruct` or `ejbCreate` and `PreDestroy` or `ejbRemove` methods, including from within these 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:EJBLocalObject The EJB local object currently associated with the instance. Exceptions 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. Since EJB 2.0

public EJBLocalObject getEJBLocalObject() throws IllegalStateException

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

An instance of a session bean can call this method at anytime between the PostConstruct or ejbCreate and PreDestroy or ejbRemove methods, including from within these 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:EJBLocalObject

The EJB local object currently associated with the instance.

Exceptions

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.

Since

EJB 2.0

getEJBObject back to summary

getEJBObject	back to summary
public 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 `PostConstruct` or `ejbCreate` and the `PreDestroy` or `ejbRemove` methods, including from within these 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:EJBObject The EJB object currently associated with the instance. Exceptions 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 EJB object that is currently associated with the instance.

An instance of a session enterprise Bean can call this method at anytime between the PostConstruct or ejbCreate and the PreDestroy or ejbRemove methods, including from within these 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:EJBObject

The EJB object currently associated with the instance.

Exceptions

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.

getInvokedBusinessInterface	back to summary
public Class<T> getInvokedBusinessInterface() throws IllegalStateException Obtain the business interface or no-interface view type through which the current business method invocation was made. Exceptions IllegalStateException: Thrown if this method is called and the bean has not been invoked through a business interface or no-interface view. Since EJB 3.0

getInvokedBusinessInterface

back to summary

public Class<T> getInvokedBusinessInterface() throws IllegalStateException

Obtain the business interface or no-interface view type through which the current business method invocation was made.

Exceptions

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

Since

EJB 3.0

getMessageContext	back to summary
public 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. Note Support for web services invocations using JAX-RPC is optional as of EJB 3.2 Returns:MessageContext The MessageContext for this web service invocation. Exceptions IllegalStateException: Thrown if this method is invoked while the instance is in a state that does not allow access to this method. Since EJB 2.1

getMessageContext

back to summary

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

Note

Support for web services invocations using JAX-RPC is optional as of EJB 3.2

Returns:MessageContext

The MessageContext for this web service invocation.

Exceptions

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

Since

EJB 2.1

wasCancelCalled back to summary

wasCancelCalled	back to summary
public 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:boolean true if the client has invoked `Future.cancel` with a value of true for the `mayInterruptIfRunning` parameter. Exceptions IllegalStateException: Thrown if not invoked from within an asynchronous business method invocation with return type `Future<V>`. Since EJB 3.1

public 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:boolean

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

Exceptions

IllegalStateException:: Thrown if not invoked from within an asynchronous business method invocation with return type Future<V>.

Since

EJB 3.1

public Interface SessionContext

Method Summary

Method Detail