opendaylight/netconf/mdsal-netconf-connector/src/main/java/org/opendaylight/controller/netconf/mdsal/connector/MdsalNetconfOperationService.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.mdsal.connector;
  10
  11 import com.google.common.base.Optional;
  12 import java.util.Collection;
  13 import java.util.Collections;
  14 import java.util.HashSet;
  15 import java.util.Set;
  16 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  17 import org.opendaylight.controller.netconf.mapping.api.Capability;
  18 import org.opendaylight.controller.netconf.mapping.api.NetconfOperation;
  19 import org.opendaylight.controller.netconf.mapping.api.NetconfOperationService;
  20 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
  21 import org.opendaylight.yangtools.yang.model.api.Module;
  22 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  23 import org.slf4j.Logger;
  24 import org.slf4j.LoggerFactory;
  25
  26 public class MdsalNetconfOperationService implements NetconfOperationService {
  27
  28     private static final Logger LOG = LoggerFactory.getLogger(MdsalNetconfOperationService.class);
  29
  30     private final CurrentSchemaContext schemaContext;
  31     private final String netconfSessionIdForReporting;
  32     private final OperationProvider operationProvider;
  33
  34     public MdsalNetconfOperationService(final CurrentSchemaContext schemaContext, final String netconfSessionIdForReporting,
  35                                         final DOMDataBroker dataBroker) {
  36         this.schemaContext = schemaContext;
  37         // TODO schema contexts are different in data broker and the one we receive here ... the one received here should be updated same way as broker is
  38         this.netconfSessionIdForReporting = netconfSessionIdForReporting;
  39         this.operationProvider = new OperationProvider(netconfSessionIdForReporting, schemaContext, dataBroker);
  40     }
  41
  42     @Override
  43     public void close() {
  44
  45     }
  46
  47     // TODO does this get called dynamically ?
  48     @Override
  49     public Set<Capability> getCapabilities() {
  50         final Set<Capability> capabilities = new HashSet<>();
  51         // [RFC6241] 8.3.  Candidate Configuration Capability
  52         capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:candidate:1.0"));
  53
  54         final SchemaContext currentContext = schemaContext.getCurrentContext();
  55         final Set<Module> modules = currentContext.getModules();
  56         for (final Module module : modules) {
  57             if(currentContext.getModuleSource(module).isPresent()) {
  58                 capabilities.add(new YangStoreCapability(module, currentContext.getModuleSource(module).get()));
  59             } else {
  60                 LOG.warn("Missing source for module {}. This module will not be available from netconf server for session {}",
  61                         module, netconfSessionIdForReporting);
  62             }
  63         }
  64
  65         return capabilities;
  66     }
  67
  68     @Override
  69     public Set<NetconfOperation> getNetconfOperations() {
  70         return operationProvider.getOperations();
  71     }
  72
  73     // TODO reuse from netconf impl
  74     private static class BasicCapability implements Capability {
  75
  76         private final String capability;
  77
  78         private BasicCapability(final String capability) {
  79             this.capability = capability;
  80         }
  81
  82         @Override
  83         public String getCapabilityUri() {
  84             return capability;
  85         }
  86
  87         @Override
  88         public Optional<String> getModuleNamespace() {
  89             return Optional.absent();
  90         }
  91
  92         @Override
  93         public Optional<String> getModuleName() {
  94             return Optional.absent();
  95         }
  96
  97         @Override
  98         public Optional<String> getRevision() {
  99             return Optional.absent();
 100         }
 101
 102         @Override
 103         public Optional<String> getCapabilitySchema() {
 104             return Optional.absent();
 105         }
 106
 107         @Override
 108         public Collection<String> getLocation() {
 109             return Collections.emptyList();
 110         }
 111
 112         @Override
 113         public String toString() {
 114             return capability;
 115         }
 116     }
 117
 118     private static final class YangStoreCapability extends BasicCapability {
 119
 120         private final String content;
 121         private final String revision;
 122         private final String moduleName;
 123         private final String moduleNamespace;
 124
 125         public YangStoreCapability(final Module module, final String moduleContent) {
 126             super(toCapabilityURI(module));
 127             this.content = moduleContent;
 128             this.moduleName = module.getName();
 129             this.moduleNamespace = module.getNamespace().toString();
 130             this.revision = SimpleDateFormatUtil.getRevisionFormat().format(module.getRevision());
 131         }
 132
 133         @Override
 134         public Optional<String> getCapabilitySchema() {
 135             return Optional.of(content);
 136         }
 137
 138         private static String toCapabilityURI(final Module module) {
 139             return String.valueOf(module.getNamespace()) + "?module="
 140                     + module.getName() + "&revision=" + SimpleDateFormatUtil.getRevisionFormat().format(module.getRevision());
 141         }
 142
 143         @Override
 144         public Optional<String> getModuleName() {
 145             return Optional.of(moduleName);
 146         }
 147
 148         @Override
 149         public Optional<String> getModuleNamespace() {
 150             return Optional.of(moduleNamespace);
 151         }
 152
 153         @Override
 154         public Optional<String> getRevision() {
 155             return Optional.of(revision);
 156         }
 157     }
 158 }