KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > catalina > ant > JMXQueryTask


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18
19 package org.apache.catalina.ant;
20
21
22 import org.apache.tools.ant.BuildException;
23
24
25 /**
26  * Ant task that implements the JMX Query command
27  * (<code>/jmxproxy/?qry</code>) supported by the Tomcat manager application.
28  *
29  * @author Vivek Chopra
30  * @version $Revision: 467222 $
31  */
32 public class JMXQueryTask extends AbstractCatalinaTask {
33
34     // Properties
35
36     /**
37      * The JMX query string
38      * @see #setQuery(String)
39      */
40     protected String JavaDoc query = null;
41
42     // Public Methods
43
44     /**
45      * Get method for the JMX query string
46      * @return Query string
47      */
48     public String JavaDoc getQuery () {
49         return this.query;
50     }
51
52     /**
53      * Set method for the JMX query string.
54     * <P>Examples of query format:
55      * <UL>
56      * <LI>*:*</LI>
57      * <LI>*:type=RequestProcessor,*</LI>
58      * <LI>*:j2eeType=Servlet,*</LI>
59      * <LI>Catalina:type=Environment,resourcetype=Global,name=simpleValue</LI>
60      * </UL>
61      * </P>
62      * @param query JMX Query string
63      */
64     public void setQuery (String JavaDoc query) {
65         this.query = query;
66     }
67
68     /**
69      * Execute the requested operation.
70      *
71      * @exception BuildException if an error occurs
72      */
73     public void execute() throws BuildException {
74         super.execute();
75         String JavaDoc queryString = (query == null) ? "":("?qry="+query);
76         log("Query string is " + queryString);
77         execute ("/jmxproxy/" + queryString);
78     }
79 }
80
Popular Tags