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 Scott Ferguson
028: */
029:
030: package com.caucho.management.server;
031:
032: import com.caucho.jmx.Description;
033:
034: /**
035: * Management interface for the host.
036: *
037: * <pre>
038: * resin:type=Host,name=foo.com
039: * </pre>
040: */
041: @Description("")
042: public interface HostMXBean extends DeployControllerMXBean {
043: /**
044: * Returns the host name.
045: */
046: @Description("The configured canonical host name")
047: public String getHostName();
048:
049: /**
050: * Returns the URL
051: */
052: @Description("The configured canonical URL")
053: public String getURL();
054:
055: //
056: // Relation attributes
057: //
058:
059: /**
060: * Returns an array of the webapps
061: */
062: @Description("The configured webapps for the virtual host")
063: public WebAppMXBean[] getWebApps();
064:
065: //
066: // Configuration
067: //
068:
069: /**
070: * Returns the root directory.
071: */
072: @Description("The configured root directory for the virtual host")
073: public String getRootDirectory();
074:
075: /**
076: * Returns the primary war directory.
077: */
078: public String getWarDirectory();
079:
080: /**
081: * Returns the primary war expand directory.
082: */
083: public String getWarExpandDirectory();
084:
085: //
086: // Operations
087: //
088:
089: /**
090: * Updates a web-app entry from the deployment directories.
091: */
092: public void updateWebAppDeploy(String name) throws Exception;
093:
094: /**
095: * Updates an ear entry from the deployment directories.
096: */
097: public void updateEarDeploy(String name) throws Exception;
098:
099: /**
100: * Expand an ear entry from the deployment directories.
101: */
102: public void expandEarDeploy(String name);
103:
104: /**
105: * Start an ear entry from the deployment directories.
106: */
107: public void startEarDeploy(String name);
108: }
|