gerrit.onap Code Review - ccsdk/features.git/blob

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * ONAP : ccsdk features
   4  * ================================================================================
   5  * Copyright (C) 2020 highstreet technologies GmbH Intellectual Property.
   6  * All rights reserved.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *     http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  *
  21  */
  22 package org.onap.ccsdk.features.sdnr.wt.netconfnodestateservice.impl.access.dom;
  23
  24 import static java.util.stream.Collectors.toList;
  25 import com.google.common.util.concurrent.FluentFuture;
  26 import com.google.common.util.concurrent.ListenableFuture;
  27 import java.time.Instant;
  28 import java.time.format.DateTimeFormatter;
  29 import java.util.Arrays;
  30 import java.util.Collection;
  31 import java.util.Collections;
  32 import java.util.List;
  33 import java.util.Map;
  34 import java.util.Map.Entry;
  35 import java.util.Objects;
  36 import java.util.Optional;
  37 import java.util.concurrent.ExecutionException;
  38 import java.util.concurrent.TimeUnit;
  39 import java.util.concurrent.TimeoutException;
  40 import org.eclipse.jdt.annotation.NonNull;
  41 import org.eclipse.jdt.annotation.Nullable;
  42 import org.onap.ccsdk.features.sdnr.wt.netconfnodestateservice.NetconfDomAccessor;
  43 import org.onap.ccsdk.features.sdnr.wt.netconfnodestateservice.impl.access.NetconfAccessorImpl;
  44 import org.onap.ccsdk.features.sdnr.wt.netconfnodestateservice.impl.mdsal.MdsalApi;
  45 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  46 //import org.opendaylight.mdsal.binding.dom.codec.impl.BindingCodecContext;
  47 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  48 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  49 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
  50 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  51 import org.opendaylight.mdsal.dom.api.DOMNotificationListener;
  52 import org.opendaylight.mdsal.dom.api.DOMNotificationService;
  53 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  54 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  55 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionInput;
  56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionInputBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.create.subscription.input.Filter;
  58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.Netconf;
  59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.netconf.Streams;
  60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.netconf.streams.Stream;
  61 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.netconf.streams.StreamKey;
  62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
  63 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  64 import org.opendaylight.yangtools.yang.binding.DataObject;
  65 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  66 import org.opendaylight.yangtools.yang.common.QName;
  67 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  68 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  69 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  70 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  71 import org.slf4j.Logger;
  72 import org.slf4j.LoggerFactory;
  73
  74 public class NetconfDomAccessorImpl extends NetconfAccessorImpl implements NetconfDomAccessor {
  75
  76     private static final Logger LOG = LoggerFactory.getLogger(NetconfDomAccessorImpl.class);
  77
  78     private static final QName CREATE_SUBSCRIPTION = QName.create(CreateSubscriptionInput.QNAME, "create-subscription");
  79     private static final YangInstanceIdentifier STREAMS_PATH =
  80             YangInstanceIdentifier.builder().node(Netconf.QNAME).node(Streams.QNAME).build();
  81
  82     protected final DOMDataBroker dataBroker;
  83     protected final DOMMountPoint mountpoint;
  84     protected final DomContext domContext;
  85     private final DOMNotificationService notificationService;
  86     private final BindingNormalizedNodeSerializer serializer;
  87     private final DOMRpcService rpcService;
  88
  89
  90     public NetconfDomAccessorImpl(NetconfAccessorImpl accessor, DOMDataBroker domDataBroker,
  91             DOMMountPoint mountpoint, DomContext domContext) {
  92         super(accessor);
  93         this.dataBroker = Objects.requireNonNull(domDataBroker);
  94         this.mountpoint = Objects.requireNonNull(mountpoint);
  95         this.domContext = Objects.requireNonNull(domContext);
  96         this.serializer = domContext.getBindingNormalizedNodeSerializer();
  97         this.rpcService = MdsalApi.getMountpointService(mountpoint, DOMRpcService.class);
  98         this.notificationService = MdsalApi.getMountpointService(mountpoint, DOMNotificationService.class);
  99     }
 100
 101     @Override
 102     public DOMDataBroker getDataBroker() {
 103         return dataBroker;
 104     }
 105
 106     @Override
 107     public DOMMountPoint getMountpoint() {
 108         return mountpoint;
 109     }
 110
 111     @Override
 112     public <T extends DataObject> Optional<T> readData(LogicalDatastoreType dataStoreType, YangInstanceIdentifier path,
 113             Class<T> clazz) {
 114         LOG.debug("Read to object datastore:{} path:{}", dataStoreType, path);
 115
 116         try {
 117             return convertNormalizedNode(domContext.getBindingNormalizedNodeSerializer(),
 118                     readDataNode(dataStoreType, path), path, clazz);
 119         } catch (CanNotConvertException e) {
 120             LOG.info("Incomplete read to class transaction {} {}", dataStoreType, path, e);
 121             return Optional.empty();
 122         }
 123     }
 124
 125     @Override
 126     public Optional<NormalizedNode<?, ?>> readDataNode(LogicalDatastoreType dataStoreType,
 127             YangInstanceIdentifier path) {
 128         LOG.debug("Read to node datastore:{} path:{}", dataStoreType, path);
 129
 130         // Don't use try with resource because the implicit close of this construct is not handled
 131         // correctly by underlying opendaylight NETCONF service
 132         DOMDataTreeReadTransaction readOnlyTransaction = dataBroker.newReadOnlyTransaction();
 133         try {
 134             FluentFuture<Optional<NormalizedNode<?, ?>>> foData = readOnlyTransaction.read(dataStoreType, path);
 135
 136             Optional<NormalizedNode<?, ?>> data = foData.get(120, TimeUnit.SECONDS);
 137             LOG.trace("read is done - {} ", foData.isDone());
 138             return data;
 139         } catch (InterruptedException e) {
 140             LOG.debug("Incomplete read to node transaction {} {}", dataStoreType, path, e);
 141             Thread.currentThread().interrupt();
 142             return Optional.empty();
 143         } catch (ExecutionException | TimeoutException e) {
 144             LOG.debug("Incomplete read to node transaction {} {}", dataStoreType, path, e);
 145             return Optional.empty();
 146         }
 147     }
 148
 149     @SuppressWarnings("unchecked")
 150     private static <T extends DataObject> Optional<T> convertNormalizedNode(BindingNormalizedNodeSerializer serializer,
 151             Optional<NormalizedNode<?, ?>> oData, YangInstanceIdentifier path, Class<T> clazz)
 152             throws CanNotConvertException {
 153         if (oData.isPresent()) {
 154             NormalizedNode<?, ?> data = oData.get();
 155             LOG.debug("convertNormalizedNode data identifier: {} data nodetype: {}", data.getIdentifier(),
 156                     data.getNodeType());
 157             @Nullable
 158             Entry<InstanceIdentifier<?>, DataObject> entry = serializer.fromNormalizedNode(path, data);
 159             if (entry != null) {
 160                 LOG.debug("object identifier: {}", entry.getKey());
 161                 DataObject value = entry.getValue();
 162                 if (clazz.isInstance(value)) {
 163                     return Optional.of((T) value);
 164                 } else {
 165                     throw new CanNotConvertException("Unexpected class. Expected:" + clazz.getName() + " provided:"
 166                             + value.getClass().getName() + " Nodetype:" + data.getNodeType());
 167                 }
 168             } else {
 169                 throw new CanNotConvertException(
 170                         "No object created for path:" + path + " Nodetype:" + data.getNodeType());
 171             }
 172         } else {
 173             throw new CanNotConvertException("No data received for path:" + path);
 174         }
 175     }
 176
 177     @Override
 178     public @NonNull <T extends DOMNotificationListener> ListenerRegistration<DOMNotificationListener> doRegisterNotificationListener(
 179             @NonNull T listener, Collection<Absolute> types) {
 180         LOG.info("Begin register listener for Mountpoint {}", mountpoint.getIdentifier().toString());
 181
 182         final ListenerRegistration<DOMNotificationListener> ranListenerRegistration =
 183                 notificationService.registerNotificationListener(listener, types);
 184
 185         LOG.info("End registration listener for Mountpoint {} Listener: {} Result: {}",
 186                 mountpoint.getIdentifier().toString(), notificationService, ranListenerRegistration);
 187
 188         return ranListenerRegistration;
 189     }
 190
 191     @Override
 192     public @NonNull <T extends DOMNotificationListener> ListenerRegistration<DOMNotificationListener> doRegisterNotificationListener(
 193             @NonNull T listener, Absolute[] types) {
 194         return doRegisterNotificationListener(listener, Arrays.asList(types));
 195     }
 196
 197     @Override
 198     public @NonNull <T extends DOMNotificationListener> ListenerRegistration<DOMNotificationListener> doRegisterNotificationListener(
 199             @NonNull T listener, QName[] types) {
 200         List<Absolute> schemaPathList = Arrays.stream(types).map(qname -> Absolute.of(qname)).collect(toList());
 201         return doRegisterNotificationListener(listener, schemaPathList);
 202     }
 203
 204
 205     @Override
 206     public ListenableFuture<? extends DOMRpcResult> invokeCreateSubscription(CreateSubscriptionInput input) {
 207         final ContainerNode nnInput = serializer.toNormalizedNodeRpcData(input);
 208         return rpcService.invokeRpc(CREATE_SUBSCRIPTION, nnInput);
 209     }
 210
 211     @Override
 212     public ListenableFuture<? extends DOMRpcResult> invokeCreateSubscription(Optional<Stream> oStream,
 213             Optional<Filter> filter, Optional<Instant> startTime, Optional<Instant> stopTime) {
 214
 215         CreateSubscriptionInputBuilder inputBuilder = new CreateSubscriptionInputBuilder();
 216         boolean replayIsSupported = false;
 217         if (oStream.isPresent()) {
 218             Stream stream = oStream.get();
 219             if (stream.getName() != null) {
 220                 inputBuilder.setStream(stream.getName());
 221             }
 222             replayIsSupported = Boolean.TRUE.equals(stream.isReplaySupport());
 223
 224         }
 225         filter.ifPresent(inputBuilder::setFilter);
 226         if (startTime.isPresent()) {
 227             if (replayIsSupported) {
 228                 inputBuilder.setStartTime(getDateAndTime(startTime.get()));
 229                 if (stopTime.isPresent()) {
 230                     if (startTime.get().isBefore(stopTime.get())) {
 231                         inputBuilder.setStopTime(getDateAndTime(stopTime.get()));
 232                     } else {
 233                         throw new IllegalArgumentException("stopTime must be later than startTime");
 234                     }
 235                 }
 236             } else {
 237                 throw new IllegalArgumentException("Replay not supported by this stream.");
 238             }
 239         }
 240         return invokeCreateSubscription(inputBuilder.build());
 241     }
 242
 243     @Override
 244     public ListenableFuture<? extends DOMRpcResult> invokeCreateSubscription(Stream... streams) {
 245         ListenableFuture<? extends DOMRpcResult> res;
 246         if (streams.length == 0) {
 247             return invokeCreateSubscription(Optional.empty(), Optional.empty(), Optional.empty(), Optional.empty());
 248         } else if (streams.length == 1) {
 249             return invokeCreateSubscription(Optional.of(streams[0]), Optional.empty(), Optional.empty(),
 250                     Optional.empty());
 251         } else {
 252             for (Stream stream : streams) {
 253                 res = invokeCreateSubscription(Optional.of(stream), Optional.empty(), Optional.empty(),
 254                         Optional.empty());
 255                 try {
 256                     if (!res.get().getErrors().isEmpty()) {
 257                         return res;
 258                     }
 259                 } catch (InterruptedException e) {
 260                     LOG.warn("InterruptedException during rpc call", e);
 261                     Thread.currentThread().interrupt();
 262                     return res;
 263                 } catch (ExecutionException e) {
 264                     LOG.warn("ExecutionException during rpc call", e);
 265                     return res;
 266                 }
 267             }
 268         }
 269         throw new IllegalStateException("Could never be reached"); //avoid eclipse error
 270     }
 271
 272     @Override
 273     public @NonNull Map<StreamKey, Stream> getNotificationStreamsAsMap() {
 274         Optional<Streams> oStreams = readData(LogicalDatastoreType.OPERATIONAL, STREAMS_PATH, Streams.class);
 275         return oStreams.map(Streams::nonnullStream).orElse(Collections.emptyMap());
 276     }
 277
 278     @Override
 279     public BindingNormalizedNodeSerializer getBindingNormalizedNodeSerializer() {
 280         return serializer;
 281     }
 282
 283     private DateAndTime getDateAndTime(Instant dateTime) {
 284         final String formattedDate = DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(dateTime);
 285         return new DateAndTime(formattedDate);
 286     }
 287 }