1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12 * language governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16 * Sun designates this particular file as subject to the "Classpath" exception
17 * as provided by Sun in the GPL Version 2 section of the License file that
18 * accompanied this code. If applicable, add the following below the License
19 * Header, with the fields enclosed by brackets [] replaced by your own
20 * identifying information: "Portions Copyrighted [year]
21 * [name of copyright owner]"
22 *
23 * Contributor(s):
24 *
25 * If you wish your version of this file to be governed by only the CDDL or
26 * only the GPL Version 2, indicate your decision by adding "[Contributor]
27 * elects to include this software in this distribution under the [CDDL or GPL
28 * Version 2] license." If you don't indicate a single choice of license, a
29 * recipient has the option to distribute your version of this file under
30 * either the CDDL, the GPL Version 2 or to extend the choice of license to
31 * its licensees as provided above. However, if you add GPL Version 2 code
32 * and therefore, elected the GPL Version 2 license, then the option applies
33 * only if the new code is made subject to such option by the copyright
34 * holder.
35 */
36 package javax.ejb;
37
38 import java.rmi.RemoteException;
39
40 /**
41 * The EJBObject interface is extended by all enterprise Beans' remote
42 * interfaces. An enterprise Bean's remote interface provides the remote
43 * client view
44 * of an EJB object. An enterprise Bean's remote interface defines
45 * the business methods callable by a remote client.
46 *
47 * <p> The remote interface must
48 * extend the javax.ejb.EJBObject interface, and define the enterprise Bean
49 * specific business methods.
50 *
51 * <p> The enterprise Bean's remote interface is defined by the enterprise
52 * Bean provider and implemented by the enterprise Bean container.
53 */
54 public interface EJBObject extends java.rmi.Remote {
55 /**
56 * Obtain the enterprise Bean's remote home interface. The remote home
57 * interface defines the enterprise Bean's create, finder, remove,
58 * and home business methods.
59 *
60 * @return A reference to the enterprise Bean's home interface.
61 *
62 * @exception RemoteException Thrown when the method failed due to a
63 * system-level failure.
64 */
65 public EJBHome getEJBHome() throws RemoteException;
66
67 /**
68 * Obtain the primary key of the EJB object.
69 *
70 * <p> This method can be called on an entity bean. An attempt to invoke
71 * this method on a session bean will result in RemoteException.
72 *
73 * @return The EJB object's primary key.
74 *
75 * @exception RemoteException Thrown when the method failed due to a
76 * system-level failure or when invoked on a session bean.
77 */
78 public Object getPrimaryKey() throws RemoteException;
79
80 /**
81 * Remove the EJB object.
82 *
83 * @exception RemoteException Thrown when the method failed due to a
84 * system-level failure.
85 *
86 * @exception RemoveException The enterprise Bean or the container
87 * does not allow destruction of the object.
88 */
89 public void remove() throws RemoteException, RemoveException;
90
91 /**
92 * Obtain a handle for the EJB object. The handle can be used at later
93 * time to re-obtain a reference to the EJB object, possibly in a
94 * different Java Virtual Machine.
95 *
96 * @return A handle for the EJB object.
97 *
98 * @exception RemoteException Thrown when the method failed due to a
99 * system-level failure.
100 */
101 public Handle getHandle() throws RemoteException;
102
103 /**
104 * Test if a given EJB object is identical to the invoked EJB object.
105 *
106 * @param obj An object to test for identity with the invoked object.
107 *
108 * @return True if the given EJB object is identical to the invoked object,
109 * false otherwise.
110 *
111 * @exception RemoteException Thrown when the method failed due to a
112 * system-level failure.
113 */
114 boolean isIdentical(EJBObject obj) throws RemoteException;
115 }
Save This Page