2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.config.util;
10 import org.opendaylight.controller.config.api.ConflictingVersionException;
11 import org.opendaylight.controller.config.api.ValidationException;
12 import org.opendaylight.controller.config.api.jmx.CommitStatus;
13 import org.opendaylight.controller.config.api.jmx.ConfigRegistryMXBean;
14 import org.opendaylight.controller.config.api.jmx.ObjectNameUtil;
16 import javax.management.AttributeNotFoundException;
17 import javax.management.InstanceNotFoundException;
18 import javax.management.JMException;
19 import javax.management.JMX;
20 import javax.management.MBeanException;
21 import javax.management.MBeanServer;
22 import javax.management.ObjectInstance;
23 import javax.management.ObjectName;
24 import javax.management.ReflectionException;
25 import java.util.Arrays;
26 import java.util.List;
29 import org.opendaylight.controller.config.api.jmx.ServiceReferenceMXBean;
31 public class ConfigRegistryJMXClient implements ConfigRegistryClient {
32 private final ConfigRegistryMXBean configRegistryMXBeanProxy;
33 private final ObjectName configRegistryON;
34 private final MBeanServer configMBeanServer;
36 public ConfigRegistryJMXClient(MBeanServer configMBeanServer) {
37 this.configMBeanServer = configMBeanServer;
38 configRegistryON = OBJECT_NAME;
39 Set<ObjectInstance> searchResult = configMBeanServer.queryMBeans(
40 configRegistryON, null);
41 if (!(searchResult.size() == 1)) {
42 throw new IllegalStateException("Config registry not found");
44 configRegistryMXBeanProxy = JMX.newMXBeanProxy(configMBeanServer, configRegistryON, ConfigRegistryMXBean.class,
49 public ConfigTransactionJMXClient createTransaction() {
50 ObjectName configTransactionControllerON = beginConfig();
51 return getConfigTransactionClient(configTransactionControllerON);
55 public ConfigTransactionJMXClient getConfigTransactionClient(
56 String transactionName) {
57 ObjectName objectName = ObjectNameUtil
58 .createTransactionControllerON(transactionName);
59 return getConfigTransactionClient(objectName);
63 public ConfigTransactionJMXClient getConfigTransactionClient(
64 ObjectName objectName) {
65 return new ConfigTransactionJMXClient(configRegistryMXBeanProxy, objectName,
70 * Usage of this method indicates error as config JMX uses solely MXBeans.
71 * Use {@link #newMXBeanProxy(javax.management.ObjectName, Class)}
72 * or {@link JMX#newMBeanProxy(javax.management.MBeanServerConnection, javax.management.ObjectName, Class)}
73 * This method will be removed soon.
76 public <T> T newMBeanProxy(ObjectName on, Class<T> clazz) {
77 ObjectName onObj = translateServiceRefIfPossible(on, clazz, configMBeanServer);
78 return JMX.newMBeanProxy(configMBeanServer, onObj, clazz);
81 static ObjectName translateServiceRefIfPossible(ObjectName on, Class<?> clazz, MBeanServer configMBeanServer) {
82 ObjectName onObj = on;
83 if (ObjectNameUtil.isServiceReference(onObj) && clazz.equals(ServiceReferenceMXBean.class) == false) {
84 ServiceReferenceMXBean proxy = JMX.newMXBeanProxy(configMBeanServer, onObj, ServiceReferenceMXBean.class);
85 onObj = proxy.getCurrentImplementation();
91 public <T> T newMXBeanProxy(ObjectName on, Class<T> clazz) {
92 return JMX.newMXBeanProxy(configMBeanServer, on, clazz);
96 public ObjectName beginConfig() {
97 return configRegistryMXBeanProxy.beginConfig();
101 public CommitStatus commitConfig(ObjectName transactionControllerON)
102 throws ConflictingVersionException, ValidationException {
103 return configRegistryMXBeanProxy.commitConfig(transactionControllerON);
107 public List<ObjectName> getOpenConfigs() {
108 return configRegistryMXBeanProxy.getOpenConfigs();
112 public long getVersion() {
114 return (Long) configMBeanServer.getAttribute(configRegistryON,
116 } catch (JMException e) {
117 throw new RuntimeException(e);
122 public Set<String> getAvailableModuleNames() {
123 return configRegistryMXBeanProxy.getAvailableModuleNames();
127 public boolean isHealthy() {
128 return configRegistryMXBeanProxy.isHealthy();
132 public Set<ObjectName> lookupConfigBeans() {
133 return configRegistryMXBeanProxy.lookupConfigBeans();
137 public Set<ObjectName> lookupConfigBeans(String moduleName) {
138 return configRegistryMXBeanProxy.lookupConfigBeans(moduleName);
142 public Set<ObjectName> lookupConfigBeans(String moduleName,
143 String instanceName) {
144 return configRegistryMXBeanProxy.lookupConfigBeans(moduleName, instanceName);
148 public ObjectName lookupConfigBean(String moduleName, String instanceName)
149 throws InstanceNotFoundException {
150 return configRegistryMXBeanProxy.lookupConfigBean(moduleName, instanceName);
154 public Set<ObjectName> lookupRuntimeBeans() {
155 return configRegistryMXBeanProxy.lookupRuntimeBeans();
159 public Set<ObjectName> lookupRuntimeBeans(String ifcName,
160 String instanceName) {
161 return configRegistryMXBeanProxy.lookupRuntimeBeans(ifcName, instanceName);
165 public void checkConfigBeanExists(ObjectName objectName) throws InstanceNotFoundException {
166 configRegistryMXBeanProxy.checkConfigBeanExists(objectName);
170 public ObjectName lookupConfigBeanByServiceInterfaceName(String serviceInterfaceQName, String refName) {
171 return configRegistryMXBeanProxy.lookupConfigBeanByServiceInterfaceName(serviceInterfaceQName, refName);
175 public Map<String, Map<String, ObjectName>> getServiceMapping() {
176 return configRegistryMXBeanProxy.getServiceMapping();
180 public Map<String, ObjectName> lookupServiceReferencesByServiceInterfaceName(String serviceInterfaceQName) {
181 return configRegistryMXBeanProxy.lookupServiceReferencesByServiceInterfaceName(serviceInterfaceQName);
185 public Set<String> lookupServiceInterfaceNames(ObjectName objectName) throws InstanceNotFoundException {
186 return configRegistryMXBeanProxy.lookupServiceInterfaceNames(objectName);
190 public String getServiceInterfaceName(String namespace, String localName) {
191 return configRegistryMXBeanProxy.getServiceInterfaceName(namespace, localName);
195 public Object invokeMethod(ObjectName on, String name, Object[] params,
196 String[] signature) {
198 return configMBeanServer.invoke(on, name, params, signature);
199 } catch (InstanceNotFoundException | ReflectionException
200 | MBeanException e) {
201 throw new RuntimeException("Unable to invoke operation " + name
202 + " on " + on + " with attributes "
203 + Arrays.toString(params) + " and signature "
204 + Arrays.toString(signature), e);
209 public Object getAttributeCurrentValue(ObjectName on, String attributeName) {
211 return configMBeanServer.getAttribute(on, attributeName);
212 } catch (AttributeNotFoundException | InstanceNotFoundException
213 | MBeanException | ReflectionException e) {
214 throw new RuntimeException("Unable to get attribute "
215 + attributeName + " for " + on, e);
220 public Set<String> getAvailableModuleFactoryQNames() {
221 return configRegistryMXBeanProxy.getAvailableModuleFactoryQNames();
225 public ObjectName getServiceReference(String serviceInterfaceQName, String refName) throws InstanceNotFoundException {
226 return configRegistryMXBeanProxy.getServiceReference(serviceInterfaceQName, refName);
230 public void checkServiceReferenceExists(ObjectName objectName) throws InstanceNotFoundException {
231 configRegistryMXBeanProxy.checkServiceReferenceExists(objectName);