1 /**
2 * collectd - bindings/java/org/collectd/java/GenericJMXConfConnection.java
3 * Copyright (C) 2009-2012 Florian octo Forster
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
22 *
23 * Authors:
24 * Florian octo Forster <octo at collectd.org>
25 */
27 package org.collectd.java;
29 import java.util.List;
30 import java.util.Map;
31 import java.util.Iterator;
32 import java.util.ArrayList;
33 import java.util.HashMap;
34 import java.net.InetAddress;
35 import java.net.UnknownHostException;
37 import javax.management.MBeanServerConnection;
38 import javax.management.ObjectName;
39 import javax.management.MalformedObjectNameException;
41 import javax.management.remote.JMXServiceURL;
42 import javax.management.remote.JMXConnector;
43 import javax.management.remote.JMXConnectorFactory;
45 import org.collectd.api.Collectd;
46 import org.collectd.api.PluginData;
47 import org.collectd.api.OConfigValue;
48 import org.collectd.api.OConfigItem;
50 class GenericJMXConfConnection
51 {
52 private String _username = null;
53 private String _password = null;
54 private String _host = null;
55 private String _instance_prefix = null;
56 private String _service_url = null;
57 private MBeanServerConnection _jmx_connection = null;
58 private List<GenericJMXConfMBean> _mbeans = null;
60 /*
61 * private methods
62 */
63 private String getConfigString (OConfigItem ci) /* {{{ */
64 {
65 List<OConfigValue> values;
66 OConfigValue v;
68 values = ci.getValues ();
69 if (values.size () != 1)
70 {
71 Collectd.logError ("GenericJMXConfConnection: The " + ci.getKey ()
72 + " configuration option needs exactly one string argument.");
73 return (null);
74 }
76 v = values.get (0);
77 if (v.getType () != OConfigValue.OCONFIG_TYPE_STRING)
78 {
79 Collectd.logError ("GenericJMXConfConnection: The " + ci.getKey ()
80 + " configuration option needs exactly one string argument.");
81 return (null);
82 }
84 return (v.getString ());
85 } /* }}} String getConfigString */
87 private String getHost () /* {{{ */
88 {
89 if (this._host != null)
90 {
91 return (this._host);
92 }
94 return Collectd.getHostname();
95 } /* }}} String getHost */
97 private void connect () /* {{{ */
98 {
99 JMXServiceURL service_url;
100 JMXConnector connector;
101 Map environment;
103 if (_jmx_connection != null)
104 return;
106 environment = null;
107 if (this._password != null)
108 {
109 String[] credentials;
111 if (this._username == null)
112 this._username = new String ("monitorRole");
114 credentials = new String[] { this._username, this._password };
116 environment = new HashMap ();
117 environment.put (JMXConnector.CREDENTIALS, credentials);
118 environment.put(JMXConnectorFactory.PROTOCOL_PROVIDER_CLASS_LOADER, this.getClass().getClassLoader());
119 }
121 try
122 {
123 service_url = new JMXServiceURL (this._service_url);
124 connector = JMXConnectorFactory.connect (service_url, environment);
125 _jmx_connection = connector.getMBeanServerConnection ();
126 }
127 catch (Exception e)
128 {
129 Collectd.logError ("GenericJMXConfConnection: "
130 + "Creating MBean server connection failed: " + e);
131 return;
132 }
133 } /* }}} void connect */
135 /*
136 * public methods
137 *
138 * <Connection>
139 * Host "tomcat0.mycompany"
140 * ServiceURL "service:jmx:rmi:///jndi/rmi://localhost:17264/jmxrmi"
141 * Collect "java.lang:type=GarbageCollector,name=Copy"
142 * Collect "java.lang:type=Memory"
143 * </Connection>
144 *
145 */
146 public GenericJMXConfConnection (OConfigItem ci) /* {{{ */
147 throws IllegalArgumentException
148 {
149 List<OConfigItem> children;
150 Iterator<OConfigItem> iter;
152 this._mbeans = new ArrayList<GenericJMXConfMBean> ();
154 children = ci.getChildren ();
155 iter = children.iterator ();
156 while (iter.hasNext ())
157 {
158 OConfigItem child = iter.next ();
160 if (child.getKey ().equalsIgnoreCase ("Host"))
161 {
162 String tmp = getConfigString (child);
163 if (tmp != null)
164 this._host = tmp;
165 }
166 else if (child.getKey ().equalsIgnoreCase ("User"))
167 {
168 String tmp = getConfigString (child);
169 if (tmp != null)
170 this._username = tmp;
171 }
172 else if (child.getKey ().equalsIgnoreCase ("Password"))
173 {
174 String tmp = getConfigString (child);
175 if (tmp != null)
176 this._password = tmp;
177 }
178 else if (child.getKey ().equalsIgnoreCase ("ServiceURL"))
179 {
180 String tmp = getConfigString (child);
181 if (tmp != null)
182 this._service_url = tmp;
183 }
184 else if (child.getKey ().equalsIgnoreCase ("InstancePrefix"))
185 {
186 String tmp = getConfigString (child);
187 if (tmp != null)
188 this._instance_prefix = tmp;
189 }
190 else if (child.getKey ().equalsIgnoreCase ("Collect"))
191 {
192 String tmp = getConfigString (child);
193 if (tmp != null)
194 {
195 GenericJMXConfMBean mbean;
197 mbean = GenericJMX.getMBean (tmp);
198 if (mbean == null)
199 throw (new IllegalArgumentException ("No such MBean defined: "
200 + tmp + ". Please make sure all `MBean' blocks appear "
201 + "before (above) all `Connection' blocks."));
202 Collectd.logDebug ("GenericJMXConfConnection: " + this._host + ": Add " + tmp);
203 this._mbeans.add (mbean);
204 }
205 }
206 else
207 throw (new IllegalArgumentException ("Unknown option: "
208 + child.getKey ()));
209 }
211 if (this._service_url == null)
212 throw (new IllegalArgumentException ("No service URL was defined."));
213 if (this._mbeans.size () == 0)
214 throw (new IllegalArgumentException ("No valid collect statement "
215 + "present."));
216 } /* }}} GenericJMXConfConnection (OConfigItem ci) */
218 public void query () /* {{{ */
219 {
220 PluginData pd;
222 connect ();
224 if (this._jmx_connection == null)
225 return;
227 Collectd.logDebug ("GenericJMXConfConnection.query: "
228 + "Reading " + this._mbeans.size () + " mbeans from "
229 + ((this._host != null) ? this._host : "(null)"));
231 pd = new PluginData ();
232 pd.setHost (this.getHost ());
233 pd.setPlugin ("GenericJMX");
235 for (int i = 0; i < this._mbeans.size (); i++)
236 {
237 int status;
239 status = this._mbeans.get (i).query (this._jmx_connection, pd,
240 this._instance_prefix);
241 if (status != 0)
242 {
243 this._jmx_connection = null;
244 return;
245 }
246 } /* for */
247 } /* }}} void query */
249 public String toString ()
250 {
251 return (new String ("host = " + this._host + "; "
252 + "url = " + this._service_url));
253 }
254 }
256 /* vim: set sw=2 sts=2 et fdm=marker : */