KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > enterprise > admin > monitor > MonitorCommand


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
24 /**
25  * PROPRIETARY/CONFIDENTIAL. Use of this product is subject to license terms.
26  *
27  * Copyright 2001-2002 by iPlanet/Sun Microsystems, Inc.,
28  * 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
29  * All rights reserved.
30  */
31 package com.sun.enterprise.admin.monitor;
32
33 import java.io.Serializable JavaDoc;
34
35 import javax.management.JMException JavaDoc;
36 import javax.management.ObjectName JavaDoc;
37
38 /**
39  * Monitoring Command. This is the super class of all monitoring commands.
40  */
41 public abstract class MonitorCommand implements Serializable JavaDoc {
42
43     /**
44      * Constant to denote monitoring result attribute in event result.
45      */
46     public static final String JavaDoc MONITOR_RESULT = "monitor.result";
47
48     /**
49      * Object name for the MBean to which command applies.
50      */
51     protected ObjectName JavaDoc objectName;
52
53     /**
54      * Sub-types to which this command applies. If not null, the monitoring
55      * command applies only to child MBeans of this type.
56      */
57     protected String JavaDoc monitoredObjectType;
58
59     /**
60      * Action Code. The sub-classes can use this to branch processing.
61      */
62     protected int actionCode;
63
64     /**
65      * Run this command. The returned object should contain result of running
66      * this command.
67      * @throws JMXException if the command could not be run
68      */
69     abstract Object JavaDoc runCommand() throws JMException JavaDoc;
70
71     /**
72      * Get a string representation
73      */
74     public String JavaDoc toString() {
75         return "MonitorCommand[ObjectName:" + objectName + ";Type:" + monitoredObjectType + ";ActionCode:" + actionCode + "]";
76     }
77 }
78
Popular Tags