javax.ejb

Interface EntityContext

Contents
  • All Superinterfaces:
    EJBContext

    public interface EntityContext
extends EJBContext
    The EntityContext interface provides an instance with access to the container-provided runtime context of an entity bean instance. The container passes the EntityContext interface to an entity bean instance after the instance has been created.

    The EntityContext interface remains associated with the instance for the lifetime of the instance. Note that the information that the instance obtains using the EntityContext interface (such as the result of the getPrimaryKey() method) may change, as the container assigns the instance to different EJB objects during the instance's life cycle.

    Note: Support for entity beans is optional as of EJB 3.2.

    Since:
    EJB 2.0

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

        EJBObject getEJBObject()
                throws IllegalStateException
        Obtain a reference to the EJB object that is currently associated with the instance.

        An instance of an entity bean can call this method only when the instance is associated with an EJB 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 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.

      • getPrimaryKey

        Object getPrimaryKey()
              throws IllegalStateException
        Obtain the primary key of the EJB object that is currently associated with this instance.

        An instance of an entity bean can call this method only when the instance is associated with an EJB object identity, i.e. in the ejbActivate, ejbPassivate, ejbPostCreate, ejbRemove, ejbLoad, ejbStore, and business methods.

        Note: The result of this method is that same as the result of getEJBObject().getPrimaryKey().

        Returns:
        The primary key 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.

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/ejb/EntityContext.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com, EntityContext (Java(TM) EE 7 Specification APIs)

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.