opendaylight/netconf/tools/netconf-testtool/src/main/java/org/opendaylight/netconf/test/tool/MdsalOperationProvider.java

   1 /*
   2  * Copyright (c) 2014 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.netconf.test.tool;
  10
  11 import com.google.common.collect.Maps;
  12 import com.google.common.collect.Sets;
  13 import com.google.common.util.concurrent.MoreExecutors;
  14 import java.util.Collections;
  15 import java.util.EnumMap;
  16 import java.util.Map;
  17 import java.util.Set;
  18 import java.util.concurrent.ExecutorService;
  19 import org.opendaylight.controller.config.util.capability.Capability;
  20 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  21 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  22 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  23 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  24 import org.opendaylight.controller.md.sal.dom.broker.impl.SerializedDOMDataBroker;
  25 import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStoreFactory;
  26 import org.opendaylight.controller.sal.core.api.model.SchemaService;
  27 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
  28 import org.opendaylight.netconf.api.monitoring.CapabilityListener;
  29 import org.opendaylight.netconf.impl.SessionIdProvider;
  30 import org.opendaylight.netconf.mapping.api.NetconfOperation;
  31 import org.opendaylight.netconf.mapping.api.NetconfOperationService;
  32 import org.opendaylight.netconf.mapping.api.NetconfOperationServiceFactory;
  33 import org.opendaylight.netconf.mdsal.connector.CurrentSchemaContext;
  34 import org.opendaylight.netconf.mdsal.connector.TransactionProvider;
  35 import org.opendaylight.netconf.mdsal.connector.ops.Commit;
  36 import org.opendaylight.netconf.mdsal.connector.ops.DiscardChanges;
  37 import org.opendaylight.netconf.mdsal.connector.ops.EditConfig;
  38 import org.opendaylight.netconf.mdsal.connector.ops.Lock;
  39 import org.opendaylight.netconf.mdsal.connector.ops.Unlock;
  40 import org.opendaylight.netconf.mdsal.connector.ops.get.Get;
  41 import org.opendaylight.netconf.mdsal.connector.ops.get.GetConfig;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Yang;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Schemas;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.Schema;
  46 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  47 import org.opendaylight.yangtools.util.concurrent.SpecialExecutors;
  48 import org.opendaylight.yangtools.yang.common.QName;
  49 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  50 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  51 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  52 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  53 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  54 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  55 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  56 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  57 import org.opendaylight.yangtools.yang.model.api.Module;
  58 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  59 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
  60 import org.slf4j.Logger;
  61 import org.slf4j.LoggerFactory;
  62
  63 class MdsalOperationProvider implements NetconfOperationServiceFactory {
  64
  65     private static final Logger LOG = LoggerFactory
  66             .getLogger(MdsalOperationProvider.class);
  67
  68     private final Set<Capability> caps;
  69     private final SchemaContext schemaContext;
  70
  71     public MdsalOperationProvider(final SessionIdProvider idProvider,
  72                                   final Set<Capability> caps,
  73                                   final SchemaContext schemaContext) {
  74         this.caps = caps;
  75         this.schemaContext = schemaContext;
  76     }
  77
  78     @Override
  79     public Set<Capability> getCapabilities() {
  80         return caps;
  81     }
  82
  83     @Override
  84     public AutoCloseable registerCapabilityListener(
  85             CapabilityListener listener) {
  86         listener.onCapabilitiesChanged(caps, Collections.<Capability>emptySet());
  87         return new AutoCloseable() {
  88             @Override
  89             public void close() throws Exception {
  90             }
  91         };
  92     }
  93
  94     @Override
  95     public NetconfOperationService createService(String netconfSessionIdForReporting) {
  96         return new MdsalOperationService(Long.parseLong(netconfSessionIdForReporting), schemaContext, caps);
  97     }
  98
  99     static class MdsalOperationService implements NetconfOperationService {
 100         private final long currentSessionId;
 101         private final SchemaContext schemaContext;
 102         private final Set<Capability> caps;
 103         private final SchemaService schemaService;
 104         private final DOMDataBroker dataBroker;
 105
 106         public MdsalOperationService(final long currentSessionId,
 107                                      final SchemaContext schemaContext,
 108                                      final Set<Capability> caps) {
 109             this.currentSessionId = currentSessionId;
 110             this.schemaContext = schemaContext;
 111             this.caps = caps;
 112             this.schemaService = createSchemaService();
 113
 114             this.dataBroker = createDataStore(schemaService);
 115
 116         }
 117
 118         @Override
 119         public Set<NetconfOperation> getNetconfOperations() {
 120             TransactionProvider transactionProvider = new TransactionProvider(dataBroker, String.valueOf(currentSessionId));
 121             CurrentSchemaContext currentSchemaContext = new CurrentSchemaContext(schemaService);
 122
 123             ContainerNode netconf = createNetconfState();
 124
 125             YangInstanceIdentifier yangInstanceIdentifier = YangInstanceIdentifier.builder().node(NetconfState.QNAME)
 126                     .build();
 127
 128             final DOMDataWriteTransaction tx = dataBroker.newWriteOnlyTransaction();
 129             tx.put(LogicalDatastoreType.OPERATIONAL, yangInstanceIdentifier, netconf);
 130
 131             try {
 132                 tx.submit().checkedGet();
 133                 LOG.debug("Netconf state updated successfully");
 134             } catch (TransactionCommitFailedException e) {
 135                 LOG.warn("Unable to update netconf state", e);
 136             }
 137
 138             final Get get = new Get(String.valueOf(currentSessionId), currentSchemaContext, transactionProvider);
 139             final EditConfig editConfig = new EditConfig(String.valueOf(currentSessionId), currentSchemaContext,
 140                     transactionProvider);
 141             final GetConfig getConfig = new GetConfig(String.valueOf(currentSessionId), currentSchemaContext,
 142                     transactionProvider);
 143             final Commit commit = new Commit(String.valueOf(currentSessionId), transactionProvider);
 144             final Lock lock = new Lock(String.valueOf(currentSessionId));
 145             final Unlock unLock = new Unlock(String.valueOf(currentSessionId));
 146             final DiscardChanges discardChanges = new DiscardChanges(String.valueOf(currentSessionId), transactionProvider);
 147
 148             return Sets.<NetconfOperation>newHashSet(get, getConfig,
 149                     editConfig, commit, lock, unLock, discardChanges);
 150         }
 151
 152         @Override
 153         public void close() {
 154         }
 155
 156         private ContainerNode createNetconfState() {
 157             DummyMonitoringService monitor = new DummyMonitoringService(
 158                     caps);
 159
 160             final QName identifier = QName.create(Schema.QNAME, "identifier");
 161             final QName version = QName.create(Schema.QNAME, "version");
 162             final QName format = QName.create(Schema.QNAME, "format");
 163             final QName location = QName.create(Schema.QNAME, "location");
 164             final QName namespace = QName.create(Schema.QNAME, "namespace");
 165
 166             CollectionNodeBuilder<MapEntryNode, MapNode> schemaMapEntryNodeMapNodeCollectionNodeBuilder = Builders
 167                     .mapBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(Schema.QNAME));
 168             LeafSetEntryNode locationLeafSetEntryNode = Builders.leafSetEntryBuilder().withNodeIdentifier(
 169                             new YangInstanceIdentifier.NodeWithValue(location, "NETCONF")).withValue("NETCONF").build();
 170
 171             Map<QName, Object> keyValues = Maps.newHashMap();
 172             for (final Schema schema : monitor.getSchemas().getSchema()) {
 173                 keyValues.put(identifier, schema.getIdentifier());
 174                 keyValues.put(version, schema.getVersion());
 175                 keyValues.put(format, Yang.QNAME);
 176
 177                 MapEntryNode schemaMapEntryNode = Builders.mapEntryBuilder().withNodeIdentifier(
 178                                 new YangInstanceIdentifier.NodeIdentifierWithPredicates(Schema.QNAME, keyValues))
 179                         .withChild(Builders.leafBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(
 180                                 identifier)).withValue(schema.getIdentifier()).build())
 181                         .withChild(Builders.leafBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(
 182                                                 version)).withValue(schema.getVersion()).build())
 183                         .withChild(Builders.leafBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(
 184                                                 format)).withValue(Yang.QNAME).build())
 185                         .withChild(Builders.leafBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(
 186                                                 namespace)).withValue(schema.getNamespace().getValue()).build())
 187                         .withChild((DataContainerChild<?, ?>) Builders.leafSetBuilder().withNodeIdentifier(
 188                                         new YangInstanceIdentifier.NodeIdentifier(location))
 189                                 .withChild(locationLeafSetEntryNode).build())
 190                         .build();
 191
 192                 schemaMapEntryNodeMapNodeCollectionNodeBuilder.withChild(schemaMapEntryNode);
 193             }
 194
 195             DataContainerChild<?, ?> schemaList = schemaMapEntryNodeMapNodeCollectionNodeBuilder.build();
 196
 197             ContainerNode schemasContainer = Builders.containerBuilder().withNodeIdentifier(
 198                     new YangInstanceIdentifier.NodeIdentifier(Schemas.QNAME)).withChild(schemaList).build();
 199             return (ContainerNode) Builders.containerBuilder().withNodeIdentifier(
 200                     new YangInstanceIdentifier.NodeIdentifier(NetconfState.QNAME)).withChild(schemasContainer).build();
 201         }
 202
 203         private DOMDataBroker createDataStore(SchemaService schemaService) {
 204             final DOMStore operStore = InMemoryDOMDataStoreFactory
 205                     .create("DOM-OPER", schemaService);
 206             final DOMStore configStore = InMemoryDOMDataStoreFactory
 207                     .create("DOM-CFG", schemaService);
 208
 209             ExecutorService listenableFutureExecutor = SpecialExecutors.newBlockingBoundedCachedThreadPool(
 210                     16, 16, "CommitFutures");
 211
 212             final EnumMap<LogicalDatastoreType, DOMStore> datastores = new EnumMap<>(LogicalDatastoreType.class);
 213             datastores.put(LogicalDatastoreType.CONFIGURATION, configStore);
 214             datastores.put(LogicalDatastoreType.OPERATIONAL, operStore);
 215
 216             return new SerializedDOMDataBroker(datastores, MoreExecutors.listeningDecorator(listenableFutureExecutor));
 217         }
 218
 219         private SchemaService createSchemaService() {
 220             return new SchemaService() {
 221
 222                 @Override
 223                 public void addModule(Module module) {
 224                 }
 225
 226                 @Override
 227                 public void removeModule(Module module) {
 228
 229                 }
 230
 231                 @Override
 232                 public SchemaContext getSessionContext() {
 233                     return schemaContext;
 234                 }
 235
 236                 @Override
 237                 public SchemaContext getGlobalContext() {
 238                     return schemaContext;
 239                 }
 240
 241                 @Override
 242                 public ListenerRegistration<SchemaContextListener> registerSchemaContextListener(
 243                         final SchemaContextListener listener) {
 244                     listener.onGlobalContextUpdated(getGlobalContext());
 245                     return new ListenerRegistration<SchemaContextListener>() {
 246                         @Override
 247                         public void close() {
 248
 249                         }
 250
 251                         @Override
 252                         public SchemaContextListener getInstance() {
 253                             return listener;
 254                         }
 255                     };
 256                 }
 257             };
 258         }
 259     }
 260
 261 }