opendaylight/netconf/config-netconf-connector/src/main/java/org/opendaylight/controller/netconf/confignetconfconnector/osgi/NetconfOperationServiceImpl.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.osgi;
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.collect.Sets;
  13 import org.opendaylight.controller.config.util.ConfigRegistryJMXClient;
  14 import org.opendaylight.controller.config.yang.store.api.YangStoreException;
  15 import org.opendaylight.controller.config.yang.store.api.YangStoreService;
  16 import org.opendaylight.controller.config.yang.store.api.YangStoreSnapshot;
  17 import org.opendaylight.controller.netconf.confignetconfconnector.transactions.TransactionProvider;
  18 import org.opendaylight.controller.netconf.confignetconfconnector.util.Util;
  19 import org.opendaylight.controller.netconf.mapping.api.Capability;
  20 import org.opendaylight.controller.netconf.mapping.api.NetconfOperation;
  21 import org.opendaylight.controller.netconf.mapping.api.NetconfOperationFilter;
  22 import org.opendaylight.controller.netconf.mapping.api.NetconfOperationService;
  23 import org.opendaylight.yangtools.yang.model.api.Module;
  24
  25 import java.util.Collection;
  26 import java.util.Collections;
  27 import java.util.List;
  28 import java.util.Map;
  29 import java.util.Set;
  30
  31 /**
  32  * Manages life cycle of {@link YangStoreSnapshot}.
  33  */
  34 public class NetconfOperationServiceImpl implements NetconfOperationService {
  35
  36     private final YangStoreSnapshot yangStoreSnapshot;
  37     private final NetconfOperationProvider operationProvider;
  38     private final Set<Capability> capabilities;
  39     private final TransactionProvider transactionProvider;
  40
  41     public NetconfOperationServiceImpl(YangStoreService yangStoreService, ConfigRegistryJMXClient jmxClient,
  42             String netconfSessionIdForReporting) throws YangStoreException {
  43
  44         yangStoreSnapshot = yangStoreService.getYangStoreSnapshot();
  45         transactionProvider = new TransactionProvider(jmxClient, netconfSessionIdForReporting);
  46         operationProvider = new NetconfOperationProvider(yangStoreSnapshot, jmxClient, transactionProvider,
  47                 netconfSessionIdForReporting);
  48         capabilities = setupCapabilities(yangStoreSnapshot);
  49     }
  50
  51     @Override
  52     public void close() {
  53         yangStoreSnapshot.close();
  54         transactionProvider.close();
  55     }
  56
  57     @Override
  58     public Set<Capability> getCapabilities() {
  59         return capabilities;
  60     }
  61
  62     @Override
  63     public Set<NetconfOperation> getNetconfOperations() {
  64         return operationProvider.getOperations();
  65     }
  66
  67     @Override
  68     public Set<NetconfOperationFilter> getFilters() {
  69         return Collections.emptySet();
  70     }
  71
  72     private static Set<Capability> setupCapabilities(YangStoreSnapshot yangStoreSnapshot) {
  73         Set<Capability> capabilities = Sets.newHashSet();
  74
  75         // [RFC6241] 8.3.  Candidate Configuration Capability
  76         capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:candidate:1.0"));
  77         // [RFC6241] 8.5.  Rollback-on-Error Capability
  78         capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:rollback-on-error:1.0"));
  79
  80         final Collection<Map.Entry<Module, String>> modulesAndContents = yangStoreSnapshot.getModuleMap().values();
  81         for (Map.Entry<Module, String> moduleAndContent : modulesAndContents) {
  82             capabilities.add(new YangStoreCapability(moduleAndContent));
  83         }
  84
  85         return capabilities;
  86     }
  87
  88     private static class BasicCapability implements Capability {
  89
  90         private final String capability;
  91
  92         private BasicCapability(String capability) {
  93             this.capability = capability;
  94         }
  95
  96         @Override
  97         public String getCapabilityUri() {
  98             return capability;
  99         }
 100
 101         @Override
 102         public Optional<String> getModuleNamespace() {
 103             return Optional.absent();
 104         }
 105
 106         @Override
 107         public Optional<String> getModuleName() {
 108             return Optional.absent();
 109         }
 110
 111         @Override
 112         public Optional<String> getRevision() {
 113             return Optional.absent();
 114         }
 115
 116         @Override
 117         public Optional<String> getCapabilitySchema() {
 118             return Optional.absent();
 119         }
 120
 121         @Override
 122         public Optional<List<String>> getLocation() {
 123             return Optional.absent();
 124         }
 125     }
 126
 127     private static class YangStoreCapability extends BasicCapability {
 128
 129         private final String content;
 130         private final String revision;
 131         private final String moduleName;
 132         private final String moduleNamespace;
 133
 134         public YangStoreCapability(Map.Entry<Module, String> moduleAndContent) {
 135             super(getAsString(moduleAndContent.getKey()));
 136             this.content = moduleAndContent.getValue();
 137             Module module = moduleAndContent.getKey();
 138             this.moduleName = module.getName();
 139             this.moduleNamespace = module.getNamespace().toString();
 140             this.revision = Util.writeDate(module.getRevision());
 141         }
 142
 143         @Override
 144         public Optional<String> getCapabilitySchema() {
 145             return Optional.of(content);
 146         }
 147
 148         private static String getAsString(Module module) {
 149             final StringBuffer capabilityContent = new StringBuffer();
 150             capabilityContent.append(module.getNamespace());
 151             capabilityContent.append("?module=");
 152             capabilityContent.append(module.getName());
 153             capabilityContent.append("&revision=");
 154             capabilityContent.append(Util.writeDate(module.getRevision()));
 155             return capabilityContent.toString();
 156         }
 157
 158         @Override
 159         public Optional<String> getModuleName() {
 160             return Optional.of(moduleName);
 161         }
 162
 163         @Override
 164         public Optional<String> getModuleNamespace() {
 165             return Optional.of(moduleNamespace);
 166         }
 167
 168         @Override
 169         public Optional<String> getRevision() {
 170             return Optional.of(revision);
 171         }
 172     }
 173 }