restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/streams/listeners/AbstractCommonSubscriber.java

   1 /*
   2  * Copyright (c) 2016 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 package org.opendaylight.restconf.nb.rfc8040.streams.listeners;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkState;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import com.google.common.base.MoreObjects;
  15 import com.google.common.base.MoreObjects.ToStringHelper;
  16 import java.time.Instant;
  17 import java.time.format.DateTimeFormatter;
  18 import java.time.format.DateTimeFormatterBuilder;
  19 import java.time.format.DateTimeParseException;
  20 import java.time.temporal.ChronoField;
  21 import java.time.temporal.TemporalAccessor;
  22 import java.util.HashSet;
  23 import java.util.Iterator;
  24 import java.util.Set;
  25 import java.util.concurrent.ExecutionException;
  26 import javax.xml.xpath.XPathExpressionException;
  27 import org.checkerframework.checker.lock.qual.GuardedBy;
  28 import org.checkerframework.checker.lock.qual.Holding;
  29 import org.eclipse.jdt.annotation.NonNull;
  30 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  31 import org.opendaylight.restconf.nb.rfc8040.NotificationQueryParams;
  32 import org.opendaylight.restconf.nb.rfc8040.streams.StreamSessionHandler;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
  34 import org.opendaylight.yang.gen.v1.urn.sal.restconf.event.subscription.rev140708.NotificationOutputTypeGrouping.NotificationOutputType;
  35 import org.opendaylight.yangtools.concepts.Registration;
  36 import org.opendaylight.yangtools.yang.common.QName;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 /**
  41  * Features of subscribing part of both notifications.
  42  */
  43 abstract class AbstractCommonSubscriber<T> extends AbstractNotificationsData implements BaseListenerInterface {
  44     private static final Logger LOG = LoggerFactory.getLogger(AbstractCommonSubscriber.class);
  45     private static final DateTimeFormatter FORMATTER = new DateTimeFormatterBuilder()
  46         .appendValue(ChronoField.YEAR, 4).appendLiteral('-')
  47         .appendValue(ChronoField.MONTH_OF_YEAR, 2).appendLiteral('-')
  48         .appendValue(ChronoField.DAY_OF_MONTH, 2).appendLiteral('T')
  49         .appendValue(ChronoField.HOUR_OF_DAY, 2).appendLiteral(':')
  50         .appendValue(ChronoField.MINUTE_OF_HOUR, 2).appendLiteral(':')
  51         .appendValue(ChronoField.SECOND_OF_MINUTE, 2)
  52         .appendFraction(ChronoField.NANO_OF_SECOND, 0, 9, true)
  53         .appendOffset("+HH:MM", "Z").toFormatter();
  54
  55     private final EventFormatterFactory<T> formatterFactory;
  56     private final NotificationOutputType outputType;
  57     private final String streamName;
  58
  59     @GuardedBy("this")
  60     private final Set<StreamSessionHandler> subscribers = new HashSet<>();
  61     @GuardedBy("this")
  62     private Registration registration;
  63
  64     // FIXME: these should be final
  65     private Instant start = null;
  66     private Instant stop = null;
  67     private boolean leafNodesOnly = false;
  68     private boolean skipNotificationData = false;
  69     private boolean changedLeafNodesOnly = false;
  70     private EventFormatter<T> formatter;
  71
  72     AbstractCommonSubscriber(final QName lastQName, final String streamName, final NotificationOutputType outputType,
  73             final EventFormatterFactory<T> formatterFactory) {
  74         super(lastQName);
  75         this.streamName = requireNonNull(streamName);
  76         checkArgument(!streamName.isEmpty());
  77
  78         this.outputType = requireNonNull(outputType);
  79         this.formatterFactory = requireNonNull(formatterFactory);
  80         formatter = formatterFactory.getFormatter();
  81     }
  82
  83     @Override
  84     public final String getStreamName() {
  85         return streamName;
  86     }
  87
  88     @Override
  89     public final String getOutputType() {
  90         return outputType.getName();
  91     }
  92
  93     @Override
  94     public final synchronized boolean hasSubscribers() {
  95         return !subscribers.isEmpty();
  96     }
  97
  98     @Override
  99     public final synchronized Set<StreamSessionHandler> getSubscribers() {
 100         return new HashSet<>(subscribers);
 101     }
 102
 103     @Override
 104     public final synchronized void close() throws InterruptedException, ExecutionException {
 105         if (registration != null) {
 106             registration.close();
 107             registration = null;
 108         }
 109         deleteDataInDS().get();
 110         subscribers.clear();
 111     }
 112
 113     @Override
 114     public synchronized void addSubscriber(final StreamSessionHandler subscriber) {
 115         final boolean isConnected = subscriber.isConnected();
 116         checkState(isConnected);
 117         LOG.debug("Subscriber {} is added.", subscriber);
 118         subscribers.add(subscriber);
 119     }
 120
 121     @Override
 122     public synchronized void removeSubscriber(final StreamSessionHandler subscriber) {
 123         final boolean isConnected = subscriber.isConnected();
 124         checkState(isConnected);
 125         LOG.debug("Subscriber {} is removed", subscriber);
 126         subscribers.remove(subscriber);
 127         if (!hasSubscribers()) {
 128             ListenersBroker.getInstance().removeAndCloseListener(this);
 129         }
 130     }
 131
 132     public final Instant getStart() {
 133         return start;
 134     }
 135
 136     /**
 137      * Set query parameters for listener.
 138      *
 139      * @param params NotificationQueryParams to use.
 140      */
 141     public final void setQueryParams(final NotificationQueryParams params) {
 142         final var startTime = params.startTime();
 143         start = startTime == null ? Instant.now() : parseDateAndTime(startTime.value());
 144
 145         final var stopTime = params.stopTime();
 146         stop = stopTime == null ? null : parseDateAndTime(stopTime.value());
 147
 148         final var leafNodes = params.leafNodesOnly();
 149         leafNodesOnly = leafNodes != null && leafNodes.value();
 150
 151         final var skipData = params.skipNotificationData();
 152         skipNotificationData = skipData != null && skipData.value();
 153
 154         final var changedLeafNodes = params.changedLeafNodesOnly();
 155         changedLeafNodesOnly = changedLeafNodes != null && changedLeafNodes.value();
 156
 157         final var filter = params.filter();
 158         final String filterValue = filter == null ? null : filter.paramValue();
 159         if (filterValue != null && !filterValue.isEmpty()) {
 160             try {
 161                 formatter = formatterFactory.getFormatter(filterValue);
 162             } catch (XPathExpressionException e) {
 163                 throw new IllegalArgumentException("Failed to get filter", e);
 164             }
 165         } else {
 166             formatter = formatterFactory.getFormatter();
 167         }
 168     }
 169
 170     /**
 171      * Check whether this query should only notify about leaf node changes.
 172      *
 173      * @return true if this query should only notify about leaf node changes
 174      */
 175     final boolean getLeafNodesOnly() {
 176         return leafNodesOnly;
 177     }
 178
 179     /**
 180      * Check whether this query should only notify about leaf node changes and report only changed nodes.
 181      *
 182      * @return true if this query should only notify about leaf node changes and report only changed nodes
 183      */
 184     final boolean getChangedLeafNodesOnly() {
 185         return changedLeafNodesOnly;
 186     }
 187
 188     /**
 189      * Check whether this query should notify changes without data.
 190      *
 191      * @return true if this query should notify about changes with  data
 192      */
 193     final boolean isSkipNotificationData() {
 194         return skipNotificationData;
 195     }
 196
 197     final EventFormatter<T> formatter() {
 198         return formatter;
 199     }
 200
 201     /**
 202      * Sets {@link Registration} registration.
 203      *
 204      * @param registration a listener registration registration.
 205      */
 206     @Holding("this")
 207     final void setRegistration(final Registration registration) {
 208         this.registration = requireNonNull(registration);
 209     }
 210
 211     /**
 212      * Checks if {@link Registration} registration exists.
 213      *
 214      * @return {@code true} if exists, {@code false} otherwise.
 215      */
 216     @Holding("this")
 217     final boolean isListening() {
 218         return registration != null;
 219     }
 220
 221     /**
 222      * Post data to subscribed SSE session handlers.
 223      *
 224      * @param data Data of incoming notifications.
 225      */
 226     synchronized void post(final String data) {
 227         final Iterator<StreamSessionHandler> iterator = subscribers.iterator();
 228         while (iterator.hasNext()) {
 229             final StreamSessionHandler subscriber = iterator.next();
 230             final boolean isConnected = subscriber.isConnected();
 231             if (isConnected) {
 232                 subscriber.sendDataMessage(data);
 233                 LOG.debug("Data was sent to subscriber {} on connection {}:", this, subscriber);
 234             } else {
 235                 // removal is probably not necessary, because it will be removed explicitly soon after invocation of
 236                 // onWebSocketClosed(..) in handler; but just to be sure ...
 237                 iterator.remove();
 238                 LOG.debug("Subscriber for {} was removed - web-socket session is not open.", this);
 239             }
 240         }
 241     }
 242
 243     @SuppressWarnings("checkstyle:IllegalCatch")
 244     final boolean checkStartStop(final Instant now) {
 245         if (stop != null) {
 246             if (start.compareTo(now) < 0 && stop.compareTo(now) > 0) {
 247                 return true;
 248             }
 249             if (stop.compareTo(now) < 0) {
 250                 try {
 251                     close();
 252                 } catch (final Exception e) {
 253                     throw new RestconfDocumentedException("Problem with unregister listener." + e);
 254                 }
 255             }
 256         } else if (start != null) {
 257             if (start.compareTo(now) < 0) {
 258                 start = null;
 259                 return true;
 260             }
 261         } else {
 262             return true;
 263         }
 264         return false;
 265     }
 266
 267     @Override
 268     public final String toString() {
 269         return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
 270     }
 271
 272     ToStringHelper addToStringAttributes(final ToStringHelper helper) {
 273         return helper.add("stream-name", streamName).add("output-type", getOutputType());
 274     }
 275
 276     /**
 277      * Parse input of query parameters - start-time or stop-time - from {@link DateAndTime} format
 278      * to {@link Instant} format.
 279      *
 280      * @param dateAndTime Start-time or stop-time as {@link DateAndTime} object.
 281      * @return Parsed {@link Instant} by entry.
 282      */
 283     private static @NonNull Instant parseDateAndTime(final DateAndTime dateAndTime) {
 284         final TemporalAccessor accessor;
 285         try {
 286             accessor = FORMATTER.parse(dateAndTime.getValue());
 287         } catch (final DateTimeParseException e) {
 288             throw new RestconfDocumentedException("Cannot parse of value in date: " + dateAndTime, e);
 289         }
 290         return Instant.from(accessor);
 291     }
 292 }