KickJava   Java API By Example, From Geeks To Geeks.

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


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 Scott Ferguson
28  */
29
30 package com.caucho.management.server;
31
32 import com.caucho.jmx.Description;
33
34 /**
35  * Management interface for the host.
36  *
37  * <pre>
38  * resin:type=Host,name=foo.com
39  * </pre>
40  */
41 @Description("")
42 public interface HostMXBean extends DeployControllerMXBean
43 {
44   /**
45    * Returns the host name.
46    */
47   @Description("The configured canonical host name")
48   public String JavaDoc getHostName();
49
50   /**
51    * Returns the URL
52    */
53   @Description("The configured canonical URL")
54   public String JavaDoc getURL();
55
56   //
57 // Relation attributes
58 //
59
60   /**
61    * Returns an array of the webapps
62    */
63   @Description("The configured webapps for the virtual host")
64   public WebAppMXBean []getWebApps();
65
66   //
67 // Configuration
68 //
69
70   /**
71    * Returns the root directory.
72    */
73   @Description("The configured root directory for the virtual host")
74   public String JavaDoc getRootDirectory();
75
76   /**
77    * Returns the primary war directory.
78    */
79   public String JavaDoc getWarDirectory();
80
81   /**
82    * Returns the primary war expand directory.
83    */
84   public String JavaDoc getWarExpandDirectory();
85
86   //
87 // Operations
88 //
89
90   /**
91    * Updates a web-app entry from the deployment directories.
92    */
93   public void updateWebAppDeploy(String JavaDoc name)
94     throws Exception JavaDoc;
95
96   /**
97    * Updates an ear entry from the deployment directories.
98    */
99   public void updateEarDeploy(String JavaDoc name)
100     throws Exception JavaDoc;
101
102   /**
103    * Expand an ear entry from the deployment directories.
104    */
105   public void expandEarDeploy(String JavaDoc name);
106
107   /**
108    * Start an ear entry from the deployment directories.
109    */
110   public void startEarDeploy(String JavaDoc name);
111 }
112
Popular Tags