opendaylight/netconf/config-netconf-connector/src/main/java/org/opendaylight/controller/netconf/confignetconfconnector/mapping/config/Services.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.controller.netconf.confignetconfconnector.mapping.config;
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.collect.Maps;
  14
  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;
  23
  24 import javax.management.ObjectName;
  25
  26 import java.util.List;
  27 import java.util.Map;
  28 import java.util.Map.Entry;
  29 import java.util.regex.Matcher;
  30 import java.util.regex.Pattern;
  31
  32 public final class Services {
  33
  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";
  38
  39     private final Map<String /*Namespace*/, Map<String/* ServiceName */, Map<String/* refName */, ServiceInstance>>> namespaceToServiceNameToRefNameToInstance = Maps
  40             .newHashMap();
  41
  42     /**
  43      *
  44      */
  45     public Map<String, Map<String, Map<String, ServiceInstance>>> getNamespaceToServiceNameToRefNameToInstance() {
  46         return namespaceToServiceNameToRefNameToInstance;
  47     }
  48
  49     private static Services resolveServices(Map<String, Map<String, Map<String, String>>> mappedServices) {
  50         Services tracker = new Services();
  51
  52         for (Entry<String, Map<String, Map<String, String>>> namespaceEntry : mappedServices.entrySet()) {
  53             String namespace = namespaceEntry.getKey();
  54
  55             for (Entry<String, Map<String, String>> serviceEntry : namespaceEntry.getValue().entrySet()) {
  56
  57                 String serviceName = serviceEntry.getKey();
  58                 for (Entry<String, String> refEntry : serviceEntry.getValue().entrySet()) {
  59
  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);
  64                     }
  65
  66                     Map<String, ServiceInstance> refNameToInstance = namespaceToServices
  67                             .get(serviceName);
  68                     if (refNameToInstance == null) {
  69                         refNameToInstance = Maps.newHashMap();
  70                         namespaceToServices.put(serviceName, refNameToInstance);
  71                     }
  72
  73                     String refName = refEntry.getKey();
  74
  75                     ServiceInstance serviceInstance = ServiceInstance.fromString(refEntry.getValue());
  76                     refNameToInstance.put(refName, serviceInstance);
  77
  78                 }
  79             }
  80         }
  81         return tracker;
  82     }
  83
  84     // TODO support edit strategies on services
  85
  86     public static Services fromXml(XmlElement xml) throws NetconfDocumentedException {
  87         Map<String, Map<String, Map<String, String>>> retVal = Maps.newHashMap();
  88
  89         List<XmlElement> services = xml.getChildElements(SERVICE_KEY);
  90         xml.checkUnrecognisedElements(services);
  91
  92         for (XmlElement service : services) {
  93
  94             XmlElement typeElement = service.getOnlyChildElement(TYPE_KEY);
  95             Entry<String, String> prefixNamespace = typeElement.findNamespaceOfTextContent();
  96
  97             Preconditions.checkState(prefixNamespace.getKey()!=null && !prefixNamespace.getKey().equals(""), "Type attribute was not prefixed");
  98
  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);
 103             }
 104
 105             String serviceName =  ObjectNameAttributeReadingStrategy.checkPrefixAndExtractServiceName(typeElement, prefixNamespace);
 106
 107             Map<String, String> innerMap = Maps.newHashMap();
 108             namespaceToServices.put(serviceName, innerMap);
 109
 110             List<XmlElement> instances = service.getChildElements(XmlNetconfConstants.INSTANCE_KEY);
 111             service.checkUnrecognisedElements(instances, typeElement);
 112
 113             for (XmlElement instance : instances) {
 114                 XmlElement nameElement = instance.getOnlyChildElement(NAME_KEY);
 115                 String refName = nameElement.getTextContent();
 116
 117                 XmlElement providerElement = instance.getOnlyChildElement(PROVIDER_KEY);
 118                 String providerName = providerElement.getTextContent();
 119
 120                 instance.checkUnrecognisedElements(nameElement, providerElement);
 121
 122                 innerMap.put(refName, providerName);
 123             }
 124         }
 125
 126         return resolveServices(retVal);
 127     }
 128
 129     public static Element toXml(ServiceRegistryWrapper serviceRegistryWrapper, Document document) {
 130         Element root = XmlUtil.createElement(document, XmlNetconfConstants.SERVICES_KEY, Optional.of(XmlNetconfConstants.URN_OPENDAYLIGHT_PARAMS_XML_NS_YANG_CONTROLLER_CONFIG));
 131
 132         Map<String, Map<String, Map<String, String>>> mappedServices = serviceRegistryWrapper.getMappedServices();
 133         for (String namespace : mappedServices.keySet()) {
 134
 135             for (Entry<String, Map<String, String>> serviceEntry : mappedServices.get(namespace).entrySet()) {
 136                 // service belongs to config.yang namespace
 137                 Element serviceElement = XmlUtil.createElement(document, SERVICE_KEY, Optional.<String>absent());
 138                 root.appendChild(serviceElement);
 139
 140                 // type belongs to config.yang namespace
 141                 String serviceType = serviceEntry.getKey();
 142                 Element typeElement = XmlUtil.createTextElementWithNamespacedContent(document, XmlNetconfConstants.TYPE_KEY,
 143                         XmlNetconfConstants.PREFIX, namespace, serviceType);
 144
 145                 serviceElement.appendChild(typeElement);
 146
 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);
 150
 151                     Element nameElement = XmlUtil.createTextElement(document, NAME_KEY, instanceEntry.getKey(), Optional.<String>absent());
 152                     instanceElement.appendChild(nameElement);
 153
 154                     Element providerElement = XmlUtil.createTextElement(document, PROVIDER_KEY, instanceEntry.getValue(), Optional.<String>absent());
 155                     instanceElement.appendChild(providerElement);
 156                 }
 157             }
 158
 159         }
 160         return root;
 161     }
 162
 163     public static final class ServiceInstance {
 164         public ServiceInstance(String moduleName, String instanceName) {
 165             this.moduleName = moduleName;
 166             this.instanceName = instanceName;
 167         }
 168
 169         public static ServiceInstance fromString(String instanceId) {
 170             instanceId = instanceId.trim();
 171             Matcher matcher = p.matcher(instanceId);
 172             if(!matcher.matches()) {
 173                 matcher = pDeprecated.matcher(instanceId);
 174             }
 175
 176             Preconditions.checkArgument(matcher.matches(), "Unexpected format for provider, expected " + p.toString()
 177                     + " or " + pDeprecated.toString() + " but was " + instanceId);
 178
 179             String factoryName = matcher.group(1);
 180             String instanceName = matcher.group(2);
 181             return new ServiceInstance(factoryName, instanceName);
 182         }
 183
 184         private final String moduleName, instanceName;
 185         private String serviceName;
 186
 187         public String getServiceName() {
 188             return serviceName;
 189         }
 190
 191         public void setServiceName(String serviceName) {
 192             this.serviceName = serviceName;
 193         }
 194
 195         public String getModuleName() {
 196             return moduleName;
 197         }
 198
 199         public String getInstanceName() {
 200             return instanceName;
 201         }
 202
 203         private static final String blueprint = "/"
 204                 + XmlNetconfConstants.MODULES_KEY + "/" + XmlNetconfConstants.MODULE_KEY + "["
 205                 + XmlNetconfConstants.TYPE_KEY + "='%s']["
 206                 + XmlNetconfConstants.NAME_KEY + "='%s']";
 207
 208         // TODO unify with xpath in RuntimeRpc
 209
 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'\\]";
 215
 216         private static final String blueprintR = "/"
 217                 + XmlNetconfConstants.MODULES_KEY + "/" + XmlNetconfConstants.MODULE_KEY + "\\["
 218                 + XmlNetconfConstants.TYPE_KEY + "='%s'\\]\\["
 219                 + XmlNetconfConstants.NAME_KEY + "='%s'\\]";
 220
 221         private static final Pattern pDeprecated = Pattern.compile(String.format(blueprintRDeprecated, "(.+)", "(.+)"));
 222         private static final Pattern p = Pattern.compile(String.format(blueprintR, "(.+)", "(.+)"));
 223
 224         @Override
 225         public String toString() {
 226             return String.format(blueprint, moduleName, instanceName);
 227         }
 228
 229         @Override
 230         public int hashCode() {
 231             final int prime = 31;
 232             int result = 1;
 233             result = prime * result + ((instanceName == null) ? 0 : instanceName.hashCode());
 234             result = prime * result + ((moduleName == null) ? 0 : moduleName.hashCode());
 235             return result;
 236         }
 237
 238         @Override
 239         public boolean equals(Object obj) {
 240             if (this == obj){
 241                 return true;
 242             }
 243             if (obj == null){
 244                 return false;
 245             }
 246             if (getClass() != obj.getClass()){
 247                 return false;
 248             }
 249             ServiceInstance other = (ServiceInstance) obj;
 250             if (instanceName == null) {
 251                 if (other.instanceName != null){
 252                     return false;
 253                 }
 254             } else if (!instanceName.equals(other.instanceName)){
 255                 return false;
 256             }
 257             if (moduleName == null) {
 258                 if (other.moduleName != null){
 259                     return false;
 260                 }
 261             } else if (!moduleName.equals(other.moduleName)){
 262                 return false;
 263             }
 264             return true;
 265         }
 266
 267         public ObjectName getObjectName(String transactionName) {
 268             return ObjectNameUtil.createTransactionModuleON(transactionName, moduleName, instanceName);
 269         }
 270
 271         public static ServiceInstance fromObjectName(ObjectName on) {
 272             return new ServiceInstance(ObjectNameUtil.getFactoryName(on), ObjectNameUtil.getInstanceName(on));
 273         }
 274     }
 275
 276 }