001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036: package javax.ejb;
037:
038: import java.util.*;
039: import java.security.Identity;
040:
041: /**
042: * The EntityContext interface provides an instance with access to the
043: * container-provided runtime context of an entity enterprise Bean instance.
044: * The container passes the EntityContext interface to an entity enterprise
045: * Bean instance after the instance has been created.
046: *
047: * <p> The EntityContext interface remains associated with the instance for
048: * the lifetime of the instance. Note that the information that the instance
049: * obtains using the EntityContext interface (such as the result of the
050: * getPrimaryKey() method) may change, as the container assigns the instance
051: * to different EJB objects during the instance's life cycle.
052: */
053: public interface EntityContext extends EJBContext {
054: /**
055: * Obtain a reference to the EJB local object that is currently
056: * associated with the instance.
057: *
058: * <p> An instance of an entity enterprise Bean can call this method only
059: * when the instance is associated with an EJB local object identity, i.e.
060: * in the ejbActivate, ejbPassivate, ejbPostCreate, ejbRemove,
061: * ejbLoad, ejbStore, and business methods.
062: *
063: * <p> An instance can use this method, for example, when it wants to
064: * pass a reference to itself in a method argument or result.
065: *
066: * @return The EJB local object currently associated with the instance.
067: *
068: * @exception IllegalStateException if the instance invokes this
069: * method while the instance is in a state that does not allow the
070: * instance to invoke this method, or if the instance does not have
071: * a local interface.
072: */
073: EJBLocalObject getEJBLocalObject() throws IllegalStateException;
074:
075: /**
076: * Obtain a reference to the EJB object that is currently associated with
077: * the instance.
078: *
079: * <p> An instance of an entity enterprise Bean can call this method only
080: * when the instance is associated with an EJB object identity, i.e.
081: * in the ejbActivate, ejbPassivate, ejbPostCreate, ejbRemove,
082: * ejbLoad, ejbStore, and business methods.
083: *
084: * <p> An instance can use this method, for example, when it wants to
085: * pass a reference to itself in a method argument or result.
086: *
087: * @return The EJB object currently associated with the instance.
088: *
089: * @exception IllegalStateException Thrown if the instance invokes this
090: * method while the instance is in a state that does not allow the
091: * instance to invoke this method, or if the instance does not have
092: * a remote interface.
093: */
094: EJBObject getEJBObject() throws IllegalStateException;
095:
096: /**
097: * Obtain the primary key of the EJB object that is currently
098: * associated with this instance.
099: *
100: * <p> An instance of an entity enterprise Bean can call this method only
101: * when the instance is associated with an EJB object identity, i.e.
102: * in the ejbActivate, ejbPassivate, ejbPostCreate, ejbRemove,
103: * ejbLoad, ejbStore, and business methods.
104: *
105: * <p><b>Note</b>: The result of this method is that same as the
106: * result of getEJBObject().getPrimaryKey().
107: *
108: * @return The primary key currently associated with the instance.
109: *
110: * @exception IllegalStateException Thrown if the instance invokes this
111: * method while the instance is in a state that does not allow the
112: * instance to invoke this method.
113: */
114: Object getPrimaryKey() throws IllegalStateException;
115: }
|