001: /*
002: * Copyright (c) 1998-2008 Caucho Technology -- all rights reserved
003: *
004: * This file is part of Resin(R) Open Source
005: *
006: * Each copy or derived work must preserve the copyright notice and this
007: * notice unmodified.
008: *
009: * Resin Open Source is free software; you can redistribute it and/or modify
010: * it under the terms of the GNU General Public License as published by
011: * the Free Software Foundation; either version 2 of the License, or
012: * (at your option) any later version.
013: *
014: * Resin Open Source is distributed in the hope that it will be useful,
015: * but WITHOUT ANY WARRANTY; without even the implied warranty of
016: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
017: * of NON-INFRINGEMENT. See the GNU General Public License for more
018: * details.
019: *
020: * You should have received a copy of the GNU General Public License
021: * along with Resin Open Source; if not, write to the
022: *
023: * Free Software Foundation, Inc.
024: * 59 Temple Place, Suite 330
025: * Boston, MA 02111-1307 USA
026: *
027: * @author Sam
028: */
029:
030: package com.caucho.management.server;
031:
032: import com.caucho.jmx.Description;
033:
034: /**
035: * Management interface for the server.
036: * There is one ResinServer global for the entire JVM.
037: *
038: * <pre>
039: * resin:type=Resin
040: * </pre>
041: */
042: @Description("A single Resin for each JVM provides a global environment for Resin")
043: public interface ResinMXBean extends ManagedObjectMXBean {
044: //
045: // Hierarchy Attributes
046: //
047:
048: /**
049: * Returns the Cluster mbean-names for all clusters managed by Resin.
050: */
051: @Description("The ClusterMBean names managed by Resin")
052: public ClusterMXBean[] getClusters();
053:
054: /**
055: * Returns the server MBean's ObjectName for this instance.
056: */
057: @Description("The current Server instance")
058: public ServerMXBean getServer();
059:
060: //
061: // Configuration Attributes
062: //
063:
064: /**
065: * The Resin home directory used when starting this instance of Resin.
066: * This is the location of the Resin program files.
067: */
068: @Description("The Resin home directory used when starting" + " this instance of Resin. This is the location" + " of the Resin program files")
069: public String getResinHome();
070:
071: /**
072: * The root directory used when starting this instance of Resin.
073: * This is the root directory of the web server files.
074: */
075: @Description("The root directory used when starting" + " this instance of Resin. This is the root" + " directory of the web server files")
076: public String getRootDirectory();
077:
078: /**
079: * Returns the config file, the value of "-conf foo.conf"
080: */
081: @Description("The configuration file used when starting this" + " instance of Resin, the value of `-conf'")
082: public String getConfigFile();
083:
084: /**
085: * Returns the version.
086: */
087: @Description("The Resin Version")
088: public String getVersion();
089:
090: /**
091: * Returns true for the professional version.
092: */
093: @Description("True for Resin Professional")
094: public boolean isProfessional();
095:
096: /**
097: * Returns the ip address or host name of the machine that is running this ResinServer.
098: */
099: @Description("The ip address or host name of the machine that is running" + " this instance of Resin")
100: public String getLocalHost();
101: }
|