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 java.util.List;
13 import java.util.Map.Entry;
14 import java.util.regex.Matcher;
15 import java.util.regex.Pattern;
17 import javax.management.ObjectName;
19 import org.opendaylight.controller.config.api.jmx.ObjectNameUtil;
20 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
21 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.attributes.fromxml.ObjectNameAttributeReadingStrategy;
22 import org.opendaylight.controller.netconf.util.xml.XmlElement;
23 import org.opendaylight.controller.netconf.util.xml.XmlNetconfConstants;
24 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
25 import org.slf4j.Logger;
26 import org.slf4j.LoggerFactory;
27 import org.w3c.dom.Document;
28 import org.w3c.dom.Element;
30 import com.google.common.base.Optional;
31 import com.google.common.base.Preconditions;
32 import com.google.common.collect.Maps;
34 public final class Services {
36 private static final Logger logger = LoggerFactory.getLogger(Services.class);
38 private static final String PROVIDER_KEY = "provider";
39 private static final String NAME_KEY = "name";
40 public static final String TYPE_KEY = "type";
41 public static final String SERVICE_KEY = "service";
43 private final Map<String /*Namespace*/, Map<String/* ServiceName */, Map<String/* refName */, ServiceInstance>>> namespaceToServiceNameToRefNameToInstance = Maps
49 public Map<String, Map<String, Map<String, ServiceInstance>>> getNamespaceToServiceNameToRefNameToInstance() {
50 return namespaceToServiceNameToRefNameToInstance;
53 private static Services resolveServices(Map<String, Map<String, Map<String, String>>> mappedServices) {
54 Services tracker = new Services();
56 for (Entry<String, Map<String, Map<String, String>>> namespaceEntry : mappedServices.entrySet()) {
57 String namespace = namespaceEntry.getKey();
59 for (Entry<String, Map<String, String>> serviceEntry : namespaceEntry.getValue().entrySet()) {
61 String serviceName = serviceEntry.getKey();
62 for (Entry<String, String> refEntry : serviceEntry.getValue().entrySet()) {
64 Map<String, Map<String, ServiceInstance>> namespaceToServices = tracker.namespaceToServiceNameToRefNameToInstance.get(namespace);
65 if (namespaceToServices == null) {
66 namespaceToServices = Maps.newHashMap();
67 tracker.namespaceToServiceNameToRefNameToInstance.put(namespace, namespaceToServices);
70 Map<String, ServiceInstance> refNameToInstance = namespaceToServices
72 if (refNameToInstance == null) {
73 refNameToInstance = Maps.newHashMap();
74 namespaceToServices.put(serviceName, refNameToInstance);
77 String refName = refEntry.getKey();
79 ServiceInstance serviceInstance = ServiceInstance.fromString(refEntry.getValue());
80 refNameToInstance.put(refName, serviceInstance);
88 // TODO support edit strategies on services
90 public static Services fromXml(XmlElement xml) throws NetconfDocumentedException {
91 Map<String, Map<String, Map<String, String>>> retVal = Maps.newHashMap();
93 List<XmlElement> services = xml.getChildElements(SERVICE_KEY);
94 xml.checkUnrecognisedElements(services);
96 for (XmlElement service : services) {
98 XmlElement typeElement = service.getOnlyChildElement(TYPE_KEY);
99 Entry<String, String> prefixNamespace = typeElement.findNamespaceOfTextContent();
101 Preconditions.checkState(prefixNamespace.getKey()!=null && prefixNamespace.getKey().equals("") == false, "Type attribute was not prefixed");
103 Map<String, Map<String, String>> namespaceToServices = retVal.get(prefixNamespace.getValue());
104 if(namespaceToServices == null) {
105 namespaceToServices = Maps.newHashMap();
106 retVal.put(prefixNamespace.getValue(), namespaceToServices);
109 String serviceName = ObjectNameAttributeReadingStrategy.checkPrefixAndExtractServiceName(typeElement, prefixNamespace);
111 Map<String, String> innerMap = Maps.newHashMap();
112 namespaceToServices.put(serviceName, innerMap);
114 List<XmlElement> instances = service.getChildElements(XmlNetconfConstants.INSTANCE_KEY);
115 service.checkUnrecognisedElements(instances, typeElement);
117 for (XmlElement instance : instances) {
118 XmlElement nameElement = instance.getOnlyChildElement(NAME_KEY);
119 String refName = nameElement.getTextContent();
121 XmlElement providerElement = instance.getOnlyChildElement(PROVIDER_KEY);
122 String providerName = providerElement.getTextContent();
124 instance.checkUnrecognisedElements(nameElement, providerElement);
126 innerMap.put(refName, providerName);
130 return resolveServices(retVal);
133 public static Element toXml(ServiceRegistryWrapper serviceRegistryWrapper, Document document) {
134 Element root = XmlUtil.createElement(document, XmlNetconfConstants.SERVICES_KEY, Optional.of(XmlNetconfConstants.URN_OPENDAYLIGHT_PARAMS_XML_NS_YANG_CONTROLLER_CONFIG));
136 Map<String, Map<String, Map<String, String>>> mappedServices = serviceRegistryWrapper.getMappedServices();
137 for (String namespace : mappedServices.keySet()) {
139 for (Entry<String, Map<String, String>> serviceEntry : mappedServices.get(namespace).entrySet()) {
140 Element serviceElement = XmlUtil.createElement(document, SERVICE_KEY, Optional.<String>absent());
141 root.appendChild(serviceElement);
143 Element typeElement = XmlUtil.createPrefixedTextElement(document, XmlUtil.createPrefixedValue(XmlNetconfConstants.PREFIX, TYPE_KEY), XmlNetconfConstants.PREFIX,
144 serviceEntry.getKey(), Optional.of(namespace));
145 serviceElement.appendChild(typeElement);
147 for (Entry<String, String> instanceEntry : serviceEntry.getValue().entrySet()) {
148 Element instanceElement = XmlUtil.createElement(document, XmlNetconfConstants.INSTANCE_KEY, Optional.<String>absent());
149 serviceElement.appendChild(instanceElement);
151 Element nameElement = XmlUtil.createTextElement(document, NAME_KEY, instanceEntry.getKey(), Optional.<String>absent());
152 instanceElement.appendChild(nameElement);
154 Element providerElement = XmlUtil.createTextElement(document, PROVIDER_KEY, instanceEntry.getValue(), Optional.<String>absent());
155 instanceElement.appendChild(providerElement);
163 public static final class ServiceInstance {
164 public ServiceInstance(String moduleName, String instanceName) {
165 this.moduleName = moduleName;
166 this.instanceName = instanceName;
169 public static ServiceInstance fromString(String instanceId) {
170 instanceId = instanceId.trim();
171 Matcher matcher = p.matcher(instanceId);
172 if(matcher.matches() == false) {
173 matcher = pDeprecated.matcher(instanceId);
176 Preconditions.checkArgument(matcher.matches(), "Unexpected format for provider, expected " + p.toString()
177 + " or " + pDeprecated.toString() + " but was " + instanceId);
179 String factoryName = matcher.group(1);
180 String instanceName = matcher.group(2);
181 return new ServiceInstance(factoryName, instanceName);
184 private final String moduleName, instanceName;
185 private String serviceName;
187 public String getServiceName() {
191 public void setServiceName(String serviceName) {
192 this.serviceName = serviceName;
195 public String getModuleName() {
199 public String getInstanceName() {
203 private static final String blueprint = "/"
204 + XmlNetconfConstants.MODULES_KEY + "/" + XmlNetconfConstants.MODULE_KEY + "["
205 + XmlNetconfConstants.TYPE_KEY + "='%s']["
206 + XmlNetconfConstants.NAME_KEY + "='%s']";
208 // TODO unify with xpath in RuntimeRpc
210 // Previous version of xpath, needs to be supported for backwards compatibility (persisted configs by config-persister)
211 private static final String blueprintRDeprecated = "/" + XmlNetconfConstants.CONFIG_KEY + "/"
212 + XmlNetconfConstants.MODULES_KEY + "/" + XmlNetconfConstants.MODULE_KEY + "\\["
213 + XmlNetconfConstants.NAME_KEY + "='%s'\\]/" + XmlNetconfConstants.INSTANCE_KEY + "\\["
214 + XmlNetconfConstants.NAME_KEY + "='%s'\\]";
216 private static final String blueprintR = "/"
217 + XmlNetconfConstants.MODULES_KEY + "/" + XmlNetconfConstants.MODULE_KEY + "\\["
218 + XmlNetconfConstants.TYPE_KEY + "='%s'\\]\\["
219 + XmlNetconfConstants.NAME_KEY + "='%s'\\]";
221 private static final Pattern pDeprecated = Pattern.compile(String.format(blueprintRDeprecated, "(.+)", "(.+)"));
222 private static final Pattern p = Pattern.compile(String.format(blueprintR, "(.+)", "(.+)"));
225 public String toString() {
226 return String.format(blueprint, moduleName, instanceName);
230 public int hashCode() {
231 final int prime = 31;
233 result = prime * result + ((instanceName == null) ? 0 : instanceName.hashCode());
234 result = prime * result + ((moduleName == null) ? 0 : moduleName.hashCode());
239 public boolean equals(Object obj) {
244 if (getClass() != obj.getClass())
246 ServiceInstance other = (ServiceInstance) obj;
247 if (instanceName == null) {
248 if (other.instanceName != null)
250 } else if (!instanceName.equals(other.instanceName))
252 if (moduleName == null) {
253 if (other.moduleName != null)
255 } else if (!moduleName.equals(other.moduleName))
260 public ObjectName getObjectName(String transactionName) {
261 return ObjectNameUtil.createTransactionModuleON(transactionName, moduleName, instanceName);
264 public static ServiceInstance fromObjectName(ObjectName on) {
265 return new ServiceInstance(ObjectNameUtil.getFactoryName(on), ObjectNameUtil.getInstanceName(on));