KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > openejb > Container


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: Container.java 1921 2005-06-19 22:40:34Z jlaskowski $
44  */
45
46 package org.openejb;
47
48 import java.util.HashMap JavaDoc;
49 import java.util.Properties JavaDoc;
50
51 /**
52  * The Container manages one or more bean deployments at runtime. There are two
53  * basic types of containers, the RPC container (org.openejb.RpcContainer) and
54  * the Java Message Service container (org.openejb.JmsContainer), both of which
55  * extend the base type org.openejb.Container.
56  * <p>
57  * The Container interface provides methods for accessing the Container's id, its
58  * ContainerManager, and the deployments managed by the container (represented by
59  * org.openejb.DeploymentInfo objects). In addition, the container defines the
60  * getContainerType() method, which will return Container.ENTITY, Container.STATEFUL,
61  * Container.STATELESS, or Container.MESSAGE_DRIVEN, depending on the bean type
62  * managed by the container.
63  *
64  * @author Richard Monson-Haefel
65  * @version 0.1, 3/21/2000
66  * @since JDK 1.2
67  */
68 public interface Container {
69
70     final public static int STATELESS = 1;
71     final public static int STATEFUL = 2;
72     final public static int ENTITY = 3;
73     final public static int MESSAGE_DRIVEN = 4;
74
75
76     /**
77     * This method is used to initalized a new container with its name, deployments and properties.
78     * this method is invoked by the assembler and will throw an exception if invoked after
79     * the container is assembled.
80     */
81     public void init(Object JavaDoc containerId, HashMap JavaDoc deployments, Properties JavaDoc properties)
82     throws OpenEJBException;
83
84
85     /**
86      * Gets the type of container (STATELESS, STATEFUL, ENTITY, or MESSAGE_DRIVEN
87      *
88      * @return id type bean container
89      */
90     public int getContainerType( );
91
92     /**
93      * Gets the id of this container.
94      *
95      * @return the id of this container.
96      */
97     public Object JavaDoc getContainerID();
98
99
100     /**
101      * Gets the <code>DeploymentInfo</code> object for the bean with the specified deployment id.
102      *
103      * @param deploymentID the deployment id of the deployed bean.
104      * @return the DeploymentInfo object associated with the bean.
105      * @see DeploymentInfo
106      * @see DeploymentInfo#getDeploymentID()
107      */
108     public DeploymentInfo getDeploymentInfo(Object JavaDoc deploymentID);
109
110     /**
111      * Gets the <code>DeploymentInfo</code> objects for all the beans deployed in this container.
112      *
113      * @return an array of DeploymentInfo objects
114      * @see DeploymentInfo
115      */
116     public DeploymentInfo [] deployments();
117
118     /**
119      * Adds a bean to this container.
120      * @param deploymentID the deployment id of the bean to deploy.
121      * @param info the DeploymentInfo object associated with the bean.
122      * @throws org.openejb.OpenEJBException
123      * Occurs when the container is not able to deploy the bean for some
124      * reason.
125      */
126     public void deploy(Object JavaDoc deploymentID, DeploymentInfo info) throws OpenEJBException;
127 }
128
Popular Tags