KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > caucho > management > server > ResinMXBean


1 /*
2  * Copyright (c) 1998-2006 Caucho Technology -- all rights reserved
3  *
4  * This file is part of Resin(R) Open Source
5  *
6  * Each copy or derived work must preserve the copyright notice and this
7  * notice unmodified.
8  *
9  * Resin Open Source is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * Resin Open Source is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
17  * of NON-INFRINGEMENT. See the GNU General Public License for more
18  * details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with Resin Open Source; if not, write to the
22  *
23  * Free Software Foundation, Inc.
24  * 59 Temple Place, Suite 330
25  * Boston, MA 02111-1307 USA
26  *
27  * @author Sam
28  */
29
30 package com.caucho.management.server;
31
32 import com.caucho.jmx.Description;
33
34 /**
35  * Management interface for the server.
36  * There is one ResinServer global for the entire JVM.
37  *
38  * <pre>
39  * resin:type=Resin
40  * </pre>
41  */
42 @Description("A single Resin for each JVM provides a global environment for Resin")
43 public interface ResinMXBean extends ManagedObjectMXBean {
44   //
45 // Hierarchy Attributes
46 //
47
48   /**
49    * Returns the Cluster mbean-names for all clusters managed by Resin.
50    */
51   @Description("The ClusterMBean names managed by Resin")
52   public ClusterMXBean []getClusters();
53
54   /**
55    * Returns the server MBean's ObjectName for this instance.
56    */
57   @Description("The current Server instance")
58   public ServerMXBean getServer();
59
60   //
61 // Configuration Attributes
62 //
63
64   /**
65    * The Resin home directory used when starting this instance of Resin.
66    * This is the location of the Resin program files.
67    */
68   @Description("The Resin home directory used when starting"
69                + " this instance of Resin. This is the location"
70                + " of the Resin program files")
71   public String JavaDoc getResinHome();
72   
73   /**
74    * The root directory used when starting this instance of Resin.
75    * This is the root directory of the web server files.
76    */
77   @Description("The root directory used when starting"
78                + " this instance of Resin. This is the root"
79                + " directory of the web server files")
80   public String JavaDoc getRootDirectory();
81
82   /**
83    * Returns the config file, the value of "-conf foo.conf"
84    */
85   @Description("The configuration file used when starting this"
86                + " instance of Resin, the value of `-conf'")
87   public String JavaDoc getConfigFile();
88   
89   /**
90    * Returns the version.
91    */
92   @Description("The Resin Version")
93   public String JavaDoc getVersion();
94
95   /**
96    * Returns true for the professional version.
97    */
98   @Description("True for Resin Professional")
99   public boolean isProfessional();
100
101   /**
102    * Returns the ip address or host name of the machine that is running this ResinServer.
103    */
104   @Description("The ip address or host name of the machine that is running"
105                + " this instance of Resin")
106   public String JavaDoc getLocalHost();
107 }
108
Popular Tags