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
9 package org.opendaylight.controller.netconf.confignetconfconnector.mapping.config;
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
13 import com.google.common.collect.Maps;
15 import org.opendaylight.controller.config.api.jmx.ObjectNameUtil;
16 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
17 import org.opendaylight.controller.netconf.api.xml.XmlNetconfConstants;
18 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.attributes.fromxml.ObjectNameAttributeReadingStrategy;
19 import org.opendaylight.controller.netconf.util.xml.XmlElement;
20 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
21 import org.w3c.dom.Document;
22 import org.w3c.dom.Element;
24 import javax.management.ObjectName;
26 import java.util.List;
28 import java.util.Map.Entry;
29 import java.util.regex.Matcher;
30 import java.util.regex.Pattern;
32 public final class Services {
34 private static final String PROVIDER_KEY = "provider";
35 private static final String NAME_KEY = "name";
36 public static final String TYPE_KEY = "type";
37 public static final String SERVICE_KEY = "service";
39 private final Map<String /*Namespace*/, Map<String/* ServiceName */, Map<String/* refName */, ServiceInstance>>> namespaceToServiceNameToRefNameToInstance = Maps
45 public Map<String, Map<String, Map<String, ServiceInstance>>> getNamespaceToServiceNameToRefNameToInstance() {
46 return namespaceToServiceNameToRefNameToInstance;
49 private static Services resolveServices(Map<String, Map<String, Map<String, String>>> mappedServices) {
50 Services tracker = new Services();
52 for (Entry<String, Map<String, Map<String, String>>> namespaceEntry : mappedServices.entrySet()) {
53 String namespace = namespaceEntry.getKey();
55 for (Entry<String, Map<String, String>> serviceEntry : namespaceEntry.getValue().entrySet()) {
57 String serviceName = serviceEntry.getKey();
58 for (Entry<String, String> refEntry : serviceEntry.getValue().entrySet()) {
60 Map<String, Map<String, ServiceInstance>> namespaceToServices = tracker.namespaceToServiceNameToRefNameToInstance.get(namespace);
61 if (namespaceToServices == null) {
62 namespaceToServices = Maps.newHashMap();
63 tracker.namespaceToServiceNameToRefNameToInstance.put(namespace, namespaceToServices);
66 Map<String, ServiceInstance> refNameToInstance = namespaceToServices
68 if (refNameToInstance == null) {
69 refNameToInstance = Maps.newHashMap();
70 namespaceToServices.put(serviceName, refNameToInstance);
73 String refName = refEntry.getKey();
75 ServiceInstance serviceInstance = ServiceInstance.fromString(refEntry.getValue());
76 refNameToInstance.put(refName, serviceInstance);
84 // TODO support edit strategies on services
86 public static Services fromXml(XmlElement xml) throws NetconfDocumentedException {
87 Map<String, Map<String, Map<String, String>>> retVal = Maps.newHashMap();
89 List<XmlElement> services = xml.getChildElements(SERVICE_KEY);
90 xml.checkUnrecognisedElements(services);
92 for (XmlElement service : services) {
94 XmlElement typeElement = service.getOnlyChildElement(TYPE_KEY);
95 Entry<String, String> prefixNamespace = typeElement.findNamespaceOfTextContent();
97 Preconditions.checkState(prefixNamespace.getKey()!=null && !prefixNamespace.getKey().equals(""), "Type attribute was not prefixed");
99 Map<String, Map<String, String>> namespaceToServices = retVal.get(prefixNamespace.getValue());
100 if(namespaceToServices == null) {
101 namespaceToServices = Maps.newHashMap();
102 retVal.put(prefixNamespace.getValue(), namespaceToServices);
105 String serviceName = ObjectNameAttributeReadingStrategy.checkPrefixAndExtractServiceName(typeElement, prefixNamespace);
107 Map<String, String> innerMap = namespaceToServices.get(serviceName);
108 if (innerMap == null) {
109 innerMap = Maps.newHashMap();
110 namespaceToServices.put(serviceName, innerMap);
113 List<XmlElement> instances = service.getChildElements(XmlNetconfConstants.INSTANCE_KEY);
114 service.checkUnrecognisedElements(instances, typeElement);
116 for (XmlElement instance : instances) {
117 XmlElement nameElement = instance.getOnlyChildElement(NAME_KEY);
118 String refName = nameElement.getTextContent();
120 XmlElement providerElement = instance.getOnlyChildElement(PROVIDER_KEY);
121 String providerName = providerElement.getTextContent();
123 instance.checkUnrecognisedElements(nameElement, providerElement);
125 innerMap.put(refName, providerName);
129 return resolveServices(retVal);
132 public static Element toXml(ServiceRegistryWrapper serviceRegistryWrapper, Document document) {
133 Element root = XmlUtil.createElement(document, XmlNetconfConstants.SERVICES_KEY, Optional.of(XmlNetconfConstants.URN_OPENDAYLIGHT_PARAMS_XML_NS_YANG_CONTROLLER_CONFIG));
135 Map<String, Map<String, Map<String, String>>> mappedServices = serviceRegistryWrapper.getMappedServices();
136 for (String namespace : mappedServices.keySet()) {
138 for (Entry<String, Map<String, String>> serviceEntry : mappedServices.get(namespace).entrySet()) {
139 // service belongs to config.yang namespace
140 Element serviceElement = XmlUtil.createElement(document, SERVICE_KEY, Optional.<String>absent());
141 root.appendChild(serviceElement);
143 // type belongs to config.yang namespace
144 String serviceType = serviceEntry.getKey();
145 Element typeElement = XmlUtil.createTextElementWithNamespacedContent(document, XmlNetconfConstants.TYPE_KEY,
146 XmlNetconfConstants.PREFIX, namespace, serviceType);
148 serviceElement.appendChild(typeElement);
150 for (Entry<String, String> instanceEntry : serviceEntry.getValue().entrySet()) {
151 Element instanceElement = XmlUtil.createElement(document, XmlNetconfConstants.INSTANCE_KEY, Optional.<String>absent());
152 serviceElement.appendChild(instanceElement);
154 Element nameElement = XmlUtil.createTextElement(document, NAME_KEY, instanceEntry.getKey(), Optional.<String>absent());
155 instanceElement.appendChild(nameElement);
157 Element providerElement = XmlUtil.createTextElement(document, PROVIDER_KEY, instanceEntry.getValue(), Optional.<String>absent());
158 instanceElement.appendChild(providerElement);
166 public static final class ServiceInstance {
167 public ServiceInstance(String moduleName, String instanceName) {
168 this.moduleName = moduleName;
169 this.instanceName = instanceName;
172 public static ServiceInstance fromString(String instanceId) {
173 instanceId = instanceId.trim();
174 Matcher matcher = p.matcher(instanceId);
175 if(!matcher.matches()) {
176 matcher = pDeprecated.matcher(instanceId);
179 Preconditions.checkArgument(matcher.matches(), "Unexpected format for provider, expected " + p.toString()
180 + " or " + pDeprecated.toString() + " but was " + instanceId);
182 String factoryName = matcher.group(1);
183 String instanceName = matcher.group(2);
184 return new ServiceInstance(factoryName, instanceName);
187 private final String moduleName, instanceName;
188 private String serviceName;
190 public String getServiceName() {
194 public void setServiceName(String serviceName) {
195 this.serviceName = serviceName;
198 public String getModuleName() {
202 public String getInstanceName() {
206 private static final String blueprint = "/"
207 + XmlNetconfConstants.MODULES_KEY + "/" + XmlNetconfConstants.MODULE_KEY + "["
208 + XmlNetconfConstants.TYPE_KEY + "='%s']["
209 + XmlNetconfConstants.NAME_KEY + "='%s']";
211 // TODO unify with xpath in RuntimeRpc
213 // Previous version of xpath, needs to be supported for backwards compatibility (persisted configs by config-persister)
214 private static final String blueprintRDeprecated = "/" + XmlNetconfConstants.CONFIG_KEY + "/"
215 + XmlNetconfConstants.MODULES_KEY + "/" + XmlNetconfConstants.MODULE_KEY + "\\["
216 + XmlNetconfConstants.NAME_KEY + "='%s'\\]/" + XmlNetconfConstants.INSTANCE_KEY + "\\["
217 + XmlNetconfConstants.NAME_KEY + "='%s'\\]";
219 private static final String blueprintR = "/"
220 + XmlNetconfConstants.MODULES_KEY + "/" + XmlNetconfConstants.MODULE_KEY + "\\["
221 + XmlNetconfConstants.TYPE_KEY + "='%s'\\]\\["
222 + XmlNetconfConstants.NAME_KEY + "='%s'\\]";
224 private static final Pattern pDeprecated = Pattern.compile(String.format(blueprintRDeprecated, "(.+)", "(.+)"));
225 private static final Pattern p = Pattern.compile(String.format(blueprintR, "(.+)", "(.+)"));
228 public String toString() {
229 return String.format(blueprint, moduleName, instanceName);
233 public int hashCode() {
234 final int prime = 31;
236 result = prime * result + ((instanceName == null) ? 0 : instanceName.hashCode());
237 result = prime * result + ((moduleName == null) ? 0 : moduleName.hashCode());
242 public boolean equals(Object obj) {
249 if (getClass() != obj.getClass()){
252 ServiceInstance other = (ServiceInstance) obj;
253 if (instanceName == null) {
254 if (other.instanceName != null){
257 } else if (!instanceName.equals(other.instanceName)){
260 if (moduleName == null) {
261 if (other.moduleName != null){
264 } else if (!moduleName.equals(other.moduleName)){
270 public ObjectName getObjectName(String transactionName) {
271 return ObjectNameUtil.createTransactionModuleON(transactionName, moduleName, instanceName);
274 public static ServiceInstance fromObjectName(ObjectName on) {
275 return new ServiceInstance(ObjectNameUtil.getFactoryName(on), ObjectNameUtil.getInstanceName(on));