javax.ejb.SessionContext Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://glassfish.dev.java.net/public/CDDLv1.0.html or
* glassfish/bootstrap/legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at glassfish/bootstrap/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2006 Sun Microsystems, Inc. All rights reserved.
*/
package javax.ejb;
import java.util.*;
import java.security.Identity;
import javax.xml.rpc.handler.MessageContext;
/**
* 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.
*/
public interface SessionContext extends EJBContext
{
/**
* 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.
*
* @return The EJB local object currently associated with the instance.
*
* @exception 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.
*/
EJBLocalObject getEJBLocalObject() 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.
*
* @return The EJB object currently associated with the instance.
*
* @exception 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.
*/
EJBObject getEJBObject() 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.
*
* @return The MessageContext for this web service invocation.
*
* @exception IllegalStateException Thrown if this method is invoked
* while the instance is in a state that does not allow access
* to this method.
*/
MessageContext getMessageContext() 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.
*
* @param businessInterface 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.
*
* @return The business object corresponding to the given business
* interface or no-interface view.
*
* @exception IllegalStateException Thrown if invoked with a parameter
* that does not correspond to one of the beans' business interfaces
* or no-interface view.
*
*/
T getBusinessObject(Class businessInterface) throws IllegalStateException;
/**
* Obtain the business interface or no-interface view type through which the
* current business method invocation was made.
*
* @exception IllegalStateException Thrown if this method is called
* and the bean has not been invoked through a business interface or
* no-interface view.
*/
Class getInvokedBusinessInterface() throws IllegalStateException;
/**
* Check whether a client invoked the cancel() method on the client Future
* object corresponding to the currently executing asynchronous business method.
*
* @return true if the client has invoked Future.cancel with a value of
* true for the mayInterruptIfRunning parameter.
*
* @exception IllegalStateException Thrown if not invoked from within an
* asynchronous business method invocation with return type Future.
*
*/
boolean wasCancelCalled() throws IllegalStateException;
}