KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > appserv > management > j2ee > J2EEServer


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */
23 package com.sun.appserv.management.j2ee;
24
25 import java.util.Map JavaDoc;
26 import java.util.Set JavaDoc;
27
28 import javax.management.ObjectName JavaDoc;
29
30 import com.sun.appserv.management.base.Container;
31
32
33 /**
34  */
35 public interface J2EEServer extends J2EELogicalServer, Container
36 {
37     public final static String JavaDoc J2EE_TYPE = J2EETypes.J2EE_SERVER;
38     
39     /**
40         Restart the server.
41         <b>Enterprise Edition only.</b>
42      */
43     public void restart();
44     
45     /**
46         Note that the Attribute name is case-sensitive
47         "deployedObjects" as defined by JSR 77.
48         
49         @return the ObjectNames as Strings
50      */
51     public String JavaDoc[] getdeployedObjects();
52     
53     /**
54         Return Set of all deployed objects. Possible types include:
55         <ul>
56         <li>{@link com.sun.appserv.management.j2ee.J2EEApplication}</li>
57         <li>{@link com.sun.appserv.management.j2ee.WebModule}</li>
58         <li>{@link com.sun.appserv.management.j2ee.EJBModule}</li>
59         <li>{@link com.sun.appserv.management.j2ee.AppClientModule}</li>
60         <li>{@link com.sun.appserv.management.j2ee.ResourceAdapterModule}</li>
61         </ul>
62         <p>
63         To obtain Resources of a particular type, use
64         {@link Container#getContaineeMap}(j2eeType).
65      */
66     public <T extends J2EEDeployedObject> Set JavaDoc<T> getDeployedObjectsSet();
67     
68     /**
69         In 8.1, there will only ever be one JVM for a J2EEServer.
70         Note that the Attribute name is case-sensitive
71         "javaVMs" as defined by JSR 77.
72         
73         @return the ObjectNames as Strings
74      */
75     public String JavaDoc[] getjavaVMs();
76     
77     /**
78         There is always a single JVM for a J2EEServer.
79         @return JVM
80      */
81     public JVM getJVM();
82     
83     /**
84         Note that the Attribute name is case-sensitive
85         "resources" as defined by JSR 77.
86         
87         @return the ObjectNames as Strings
88      */
89     public String JavaDoc[] getresources();
90     
91     /**
92         Return Set of all resources. Possible types include:
93         <ul>
94         <li>{@link com.sun.appserv.management.j2ee.JDBCResource}</li>
95         <li>{@link com.sun.appserv.management.j2ee.JavaMailResource}</li>
96         <li>{@link com.sun.appserv.management.j2ee.JCAResource}</li>
97         <li>{@link com.sun.appserv.management.j2ee.JMSResource}</li>
98         <li>{@link com.sun.appserv.management.j2ee.JNDIResource}</li>
99         <li>{@link com.sun.appserv.management.j2ee.JTAResource}</li>
100         <li>{@link com.sun.appserv.management.j2ee.RMIIIOPResource}</li>
101         <li>{@link com.sun.appserv.management.j2ee.URLResource}</li>
102         </ul>
103         <p>
104         To obtain Resources of a particular type, use
105         {@link Container#getContaineeMap}(j2eeType).
106      */
107     public <T extends J2EEResource> Set JavaDoc<T> getResourcesSet();
108     
109     /**
110         Note that the Attribute name is case-sensitive
111         "serverVendor" as defined by JSR 77.
112         
113         @return the server vendor, a free-form String
114      */
115     public String JavaDoc getserverVendor();
116     
117     /**
118         Note that the Attribute name is case-sensitive
119         "serverVersion" as defined by JSR 77.
120         
121         @return the server version, a free-form String
122      */
123     public String JavaDoc getserverVersion();
124     
125
126     /**
127         @return true if server configuration has changed such that a restart must
128         be performed.
129      */
130     public boolean getRestartRequired();
131 }
132
133
134
135
Popular Tags