2 * Copyright (c) 2015 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.config.facade.xml.mapping.config;
12 import com.google.common.base.Optional;
13 import com.google.common.base.Preconditions;
14 import java.util.HashMap;
15 import java.util.List;
17 import java.util.Map.Entry;
18 import java.util.regex.Matcher;
19 import java.util.regex.Pattern;
20 import javax.management.ObjectName;
21 import org.opendaylight.controller.config.api.jmx.ObjectNameUtil;
22 import org.opendaylight.controller.config.facade.xml.mapping.attributes.fromxml.ObjectNameAttributeReadingStrategy;
23 import org.opendaylight.controller.config.util.xml.DocumentedException;
24 import org.opendaylight.controller.config.util.xml.XmlElement;
25 import org.opendaylight.controller.config.util.xml.XmlMappingConstants;
26 import org.opendaylight.controller.config.util.xml.XmlUtil;
27 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
28 import org.w3c.dom.Document;
29 import org.w3c.dom.Element;
31 public final class Services {
33 private static final String EMPTY_PROVIDER = "";
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>>>
40 namespaceToServiceNameToRefNameToInstance = new HashMap<>();
45 public Map<String, Map<String, Map<String, ServiceInstance>>> getNamespaceToServiceNameToRefNameToInstance() {
46 return namespaceToServiceNameToRefNameToInstance;
49 private static Services resolveServices(final 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 =
61 tracker.namespaceToServiceNameToRefNameToInstance.computeIfAbsent(namespace,
62 k -> new HashMap<>());
64 Map<String, ServiceInstance> refNameToInstance = namespaceToServices
65 .computeIfAbsent(serviceName, k -> new HashMap<>());
67 String refName = refEntry.getKey();
68 //we want to compare reference not value of the provider
69 refNameToInstance.put(refName, refEntry.getValue() == EMPTY_PROVIDER
70 //provider name cannot be EMPTY_PROVIDER instance unless we are executing delete
71 ? ServiceInstance.EMPTY_SERVICE_INSTANCE
72 : ServiceInstance.fromString(refEntry.getValue()));
80 // TODO support edit strategies on services
82 public static Services fromXml(final XmlElement xml) throws DocumentedException {
83 Map<String, Map<String, Map<String, String>>> retVal = new HashMap<>();
85 List<XmlElement> services = xml.getChildElements(SERVICE_KEY);
86 xml.checkUnrecognisedElements(services);
88 for (XmlElement service : services) {
90 XmlElement typeElement = service.getOnlyChildElement(TYPE_KEY);
91 Entry<String, String> prefixNamespace = typeElement.findNamespaceOfTextContent();
93 Preconditions.checkState(prefixNamespace.getKey()!=null && !prefixNamespace.getKey().equals(""), "Type attribute was not prefixed");
95 Map<String, Map<String, String>> namespaceToServices =
96 retVal.computeIfAbsent(prefixNamespace.getValue(), k -> new HashMap<>());
98 String serviceName = ObjectNameAttributeReadingStrategy
99 .checkPrefixAndExtractServiceName(typeElement, prefixNamespace);
101 Map<String, String> innerMap = namespaceToServices.computeIfAbsent(serviceName, k -> new HashMap<>());
103 List<XmlElement> instances = service.getChildElements(XmlMappingConstants.INSTANCE_KEY);
104 service.checkUnrecognisedElements(instances, typeElement);
106 for (XmlElement instance : instances) {
107 XmlElement nameElement = instance.getOnlyChildElement(NAME_KEY);
108 String refName = nameElement.getTextContent();
110 if (!ModifyAction.DELETE.toString().toLowerCase().equals(
111 instance.getAttribute(
112 XmlMappingConstants.OPERATION_ATTR_KEY,
113 XmlMappingConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0)))
115 XmlElement providerElement = instance.getOnlyChildElement(PROVIDER_KEY);
116 String providerName = providerElement.getTextContent();
118 instance.checkUnrecognisedElements(nameElement, providerElement);
120 innerMap.put(refName, providerName);
122 //since this is a delete we dont have a provider name - we want empty service instance
123 innerMap.put(refName, EMPTY_PROVIDER);
128 return resolveServices(retVal);
131 public static Element toXml(final ServiceRegistryWrapper serviceRegistryWrapper, final Document document) {
132 final Optional<String> configNs = Optional.of(XmlMappingConstants.URN_OPENDAYLIGHT_PARAMS_XML_NS_YANG_CONTROLLER_CONFIG);
133 Element root = XmlUtil.createElement(document, XmlMappingConstants.SERVICES_KEY, configNs);
135 Map<String, Map<String, Map<String, String>>> mappedServices = serviceRegistryWrapper.getMappedServices();
136 for (Entry<String, Map<String, Map<String, String>>> namespaceToRefEntry : mappedServices.entrySet()) {
138 for (Entry<String, Map<String, String>> serviceEntry : namespaceToRefEntry.getValue().entrySet()) {
139 // service belongs to config.yang namespace
140 Element serviceElement = XmlUtil.createElement(document, SERVICE_KEY, configNs);
141 root.appendChild(serviceElement);
143 // type belongs to config.yang namespace
144 String serviceType = serviceEntry.getKey();
145 Element typeElement = XmlUtil.createTextElementWithNamespacedContent(
146 document, XmlMappingConstants.TYPE_KEY, XmlMappingConstants.PREFIX,
147 namespaceToRefEntry.getKey(), serviceType, configNs);
149 serviceElement.appendChild(typeElement);
151 for (Entry<String, String> instanceEntry : serviceEntry.getValue().entrySet()) {
152 Element instanceElement = XmlUtil.createElement(
153 document, XmlMappingConstants.INSTANCE_KEY, configNs);
154 serviceElement.appendChild(instanceElement);
156 Element nameElement = XmlUtil.createTextElement(
157 document, NAME_KEY, instanceEntry.getKey(), configNs);
158 instanceElement.appendChild(nameElement);
160 Element providerElement = XmlUtil.createTextElement(
161 document, PROVIDER_KEY, instanceEntry.getValue(), configNs);
162 instanceElement.appendChild(providerElement);
170 public static final class ServiceInstance {
171 public static final ServiceInstance EMPTY_SERVICE_INSTANCE = new ServiceInstance("", "");
173 public ServiceInstance(final String moduleName, final String instanceName) {
174 this.moduleName = moduleName;
175 this.instanceName = instanceName;
178 public static ServiceInstance fromString(String instanceId) {
179 instanceId = instanceId.trim();
180 Matcher matcher = p.matcher(instanceId);
181 if(!matcher.matches()) {
182 matcher = pDeprecated.matcher(instanceId);
185 Preconditions.checkArgument(matcher.matches(), "Unexpected format for provider, expected " + p.toString()
186 + " or " + pDeprecated.toString() + " but was " + instanceId);
188 String factoryName = matcher.group(1);
189 String instanceName = matcher.group(2);
190 return new ServiceInstance(factoryName, instanceName);
193 private final String moduleName, instanceName;
194 private String serviceName;
196 public String getServiceName() {
200 public void setServiceName(final String serviceName) {
201 this.serviceName = serviceName;
204 public String getModuleName() {
208 public String getInstanceName() {
212 private static final String blueprint = "/"
213 + XmlMappingConstants.MODULES_KEY + "/" + XmlMappingConstants.MODULE_KEY + "["
214 + XmlMappingConstants.TYPE_KEY + "='%s']["
215 + XmlMappingConstants.NAME_KEY + "='%s']";
217 // TODO unify with xpath in RuntimeRpc
219 // Previous version of xpath, needs to be supported for backwards compatibility (persisted configs by config-persister)
220 private static final String blueprintRDeprecated = "/" + XmlMappingConstants.CONFIG_KEY + "/"
221 + XmlMappingConstants.MODULES_KEY + "/" + XmlMappingConstants.MODULE_KEY + "\\["
222 + XmlMappingConstants.NAME_KEY + "='%s'\\]/" + XmlMappingConstants.INSTANCE_KEY + "\\["
223 + XmlMappingConstants.NAME_KEY + "='%s'\\]";
225 private static final String blueprintR = "/"
226 + XmlMappingConstants.MODULES_KEY + "/" + XmlMappingConstants.MODULE_KEY + "\\["
227 + XmlMappingConstants.TYPE_KEY + "='%s'\\]\\["
228 + XmlMappingConstants.NAME_KEY + "='%s'\\]";
230 private static final Pattern pDeprecated = Pattern.compile(String.format(blueprintRDeprecated, "(.+)", "(.+)"));
231 private static final Pattern p = Pattern.compile(String.format(blueprintR, "(.+)", "(.+)"));
234 public String toString() {
235 return String.format(blueprint, moduleName, instanceName);
239 public int hashCode() {
240 final int prime = 31;
242 result = prime * result + ((instanceName == null) ? 0 : instanceName.hashCode());
243 result = prime * result + ((moduleName == null) ? 0 : moduleName.hashCode());
248 public boolean equals(final Object obj) {
255 if (getClass() != obj.getClass()){
258 ServiceInstance other = (ServiceInstance) obj;
259 if (instanceName == null) {
260 if (other.instanceName != null){
263 } else if (!instanceName.equals(other.instanceName)){
266 if (moduleName == null) {
267 if (other.moduleName != null){
270 } else if (!moduleName.equals(other.moduleName)){
276 public ObjectName getObjectName(final String transactionName) {
277 return ObjectNameUtil.createTransactionModuleON(transactionName, moduleName, instanceName);
280 public static ServiceInstance fromObjectName(final ObjectName on) {
281 return new ServiceInstance(ObjectNameUtil.getFactoryName(on), ObjectNameUtil.getInstanceName(on));