KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > openejb > ProxyInfo


1 /**
2  * Redistribution and use of this software and associated documentation
3  * ("Software"), with or without modification, are permitted provided
4  * that the following conditions are met:
5  *
6  * 1. Redistributions of source code must retain copyright
7  * statements and notices. Redistributions must also contain a
8  * copy of this document.
9  *
10  * 2. Redistributions in binary form must reproduce the
11  * above copyright notice, this list of conditions and the
12  * following disclaimer in the documentation and/or other
13  * materials provided with the distribution.
14  *
15  * 3. The name "Exolab" must not be used to endorse or promote
16  * products derived from this Software without prior written
17  * permission of Exoffice Technologies. For written permission,
18  * please contact info@exolab.org.
19  *
20  * 4. Products derived from this Software may not be called "Exolab"
21  * nor may "Exolab" appear in their names without prior written
22  * permission of Exoffice Technologies. Exolab is a registered
23  * trademark of Exoffice Technologies.
24  *
25  * 5. Due credit should be given to the Exolab Project
26  * (http://www.exolab.org/).
27  *
28  * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29  * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30  * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32  * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39  * OF THE POSSIBILITY OF SUCH DAMAGE.
40  *
41  * Copyright 1999 (C) Exoffice Technologies Inc. All Rights Reserved.
42  *
43  * $Id: ProxyInfo.java 1323 2004-08-26 07:20:26Z dblevins $
44  */
45
46
47 package org.openejb;
48
49 /**
50  * The ProxyInfo object is returned by the Container.createEJBObject() and Container.createEJBHome( ) method
51  * These method are invoked in response to client requests for EJBHome and EJBobject references.
52  * The ProxyInfo is used by the application server to create a remote stubs that represent the EJBObject
53  * and EJBHome on the client.
54  * <p>
55  * The implementation of the remote stub is application server specific, but the ProxyInfo object provides
56  * the application server with helpful information including: The Remote interface to implement
57  * (EJBHome or EJBObject types) the primary key, DeploymentInfo object, and container reference.
58  * <p>
59  * @author Richard Monson-Haefel
60  * @version 0.1, 3/21/2000
61  * @since JDK 1.2
62  */
63 public class ProxyInfo {
64     
65     protected DeploymentInfo deploymentInfo;
66     protected Object JavaDoc primaryKey;
67     protected Class JavaDoc type;
68     protected RpcContainer beanContainer;
69     
70     /**
71      * Create an instance of ProxyInfo. For use in subclassing.
72      */
73     protected ProxyInfo(){}
74         
75     /**
76      * Creates a ProxyInfo to represent an EJBHome or EJBObject for a deployed bean in the container system.
77      *
78      * @param depInfo the DeploymentInfo object connected to the EJBObject or EJBHome that this proxy will represent
79      * @param pk the primary key class of the bean or null if the bean does not need a primary key
80      * @param intrfc the bean's remote interface if this proxy represents an EJBObject or the bean's home interface if this proxy represents an EJBHome
81      * @param cntnr the Container that the deployed bean lives in
82      * @see DeploymentInfo
83      * @see Container
84      */
85     public ProxyInfo(DeploymentInfo depInfo, Object JavaDoc pk, Class JavaDoc intrfc, RpcContainer cntnr){
86         deploymentInfo = depInfo;
87         primaryKey = pk;
88         type = intrfc;
89         beanContainer = cntnr;
90     }
91
92     public ProxyInfo(DeploymentInfo depInfo, Object JavaDoc pk, boolean isLocalInterface, RpcContainer cntnr){
93         this.deploymentInfo = depInfo;
94         this.primaryKey = pk;
95         this.beanContainer = cntnr;
96         if (isLocalInterface){
97             this.type = deploymentInfo.getLocalInterface();
98         } else {
99             this.type = deploymentInfo.getRemoteInterface();
100         }
101     }
102     /**
103      * Gets the DeploymentInfo object of the bean that this proxy represents.
104      *
105      * @return the DeploymentInfo of the bean deployment
106      * @see DeploymentInfo
107      */
108     public DeploymentInfo getDeploymentInfo() { return deploymentInfo; }
109
110     /**
111      * Gets the primary key class of the bean or null if the bean does not need a primary key
112      *
113      * @return the primary key class of the bean or null if the bean does not need a primary key
114      */
115     public Object JavaDoc getPrimaryKey() { return primaryKey; }
116
117     /**
118      * Gets the bean's remote interface if this proxy represents an EJBObject or the bean's home interface if this proxy represents an EJBHome.
119      *
120      * @return the class of the bean's remote or home interface
121      */
122     public Class JavaDoc getInterface() { return type; }
123     
124     /**
125      * Gets the Container that the deployed bean lives in.
126      *
127      * @return the Container that the bean deployment lives in
128      * @see Container
129      */
130     public RpcContainer getBeanContainer() { return beanContainer; }
131 }
132
Popular Tags