2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.restconf.nb.rfc8040.streams.listeners;
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;
14 import com.google.common.base.MoreObjects;
15 import java.time.Instant;
16 import java.time.format.DateTimeFormatter;
17 import java.time.format.DateTimeFormatterBuilder;
18 import java.time.format.DateTimeParseException;
19 import java.time.temporal.ChronoField;
20 import java.time.temporal.TemporalAccessor;
21 import java.util.HashSet;
22 import java.util.Iterator;
24 import java.util.concurrent.ExecutionException;
25 import javax.xml.xpath.XPathExpressionException;
26 import org.checkerframework.checker.lock.qual.GuardedBy;
27 import org.checkerframework.checker.lock.qual.Holding;
28 import org.eclipse.jdt.annotation.NonNull;
29 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
30 import org.opendaylight.restconf.nb.rfc8040.NotificationQueryParams;
31 import org.opendaylight.restconf.nb.rfc8040.streams.StreamSessionHandler;
32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
33 import org.opendaylight.yang.gen.v1.urn.sal.restconf.event.subscription.rev140708.NotificationOutputTypeGrouping.NotificationOutputType;
34 import org.opendaylight.yangtools.concepts.Registration;
35 import org.opendaylight.yangtools.yang.common.QName;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
40 * Features of subscribing part of both notifications.
42 abstract class AbstractCommonSubscriber<P, T> extends AbstractNotificationsData implements BaseListenerInterface {
43 private static final Logger LOG = LoggerFactory.getLogger(AbstractCommonSubscriber.class);
44 private static final DateTimeFormatter FORMATTER = new DateTimeFormatterBuilder()
45 .appendValue(ChronoField.YEAR, 4).appendLiteral('-')
46 .appendValue(ChronoField.MONTH_OF_YEAR, 2).appendLiteral('-')
47 .appendValue(ChronoField.DAY_OF_MONTH, 2).appendLiteral('T')
48 .appendValue(ChronoField.HOUR_OF_DAY, 2).appendLiteral(':')
49 .appendValue(ChronoField.MINUTE_OF_HOUR, 2).appendLiteral(':')
50 .appendValue(ChronoField.SECOND_OF_MINUTE, 2)
51 .appendFraction(ChronoField.NANO_OF_SECOND, 0, 9, true)
52 .appendOffset("+HH:MM", "Z").toFormatter();
54 private final EventFormatterFactory<T> formatterFactory;
55 private final NotificationOutputType outputType;
56 private final String streamName;
60 private final Set<StreamSessionHandler> subscribers = new HashSet<>();
62 private Registration registration;
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;
72 AbstractCommonSubscriber(final QName lastQName, final String streamName, final P path,
73 final NotificationOutputType outputType, final EventFormatterFactory<T> formatterFactory) {
75 this.streamName = requireNonNull(streamName);
76 checkArgument(!streamName.isEmpty());
77 this.path = requireNonNull(path);
79 this.outputType = requireNonNull(outputType);
80 this.formatterFactory = requireNonNull(formatterFactory);
81 formatter = formatterFactory.getFormatter();
85 public final String getStreamName() {
90 public final String getOutputType() {
91 return outputType.getName();
95 public final synchronized boolean hasSubscribers() {
96 return !subscribers.isEmpty();
100 public final synchronized Set<StreamSessionHandler> getSubscribers() {
101 return new HashSet<>(subscribers);
105 public final synchronized void close() throws InterruptedException, ExecutionException {
106 if (registration != null) {
107 registration.close();
110 deleteDataInDS().get();
115 public synchronized void addSubscriber(final StreamSessionHandler subscriber) {
116 final boolean isConnected = subscriber.isConnected();
117 checkState(isConnected);
118 LOG.debug("Subscriber {} is added.", subscriber);
119 subscribers.add(subscriber);
123 public synchronized void removeSubscriber(final StreamSessionHandler subscriber) {
124 final boolean isConnected = subscriber.isConnected();
125 checkState(isConnected);
126 LOG.debug("Subscriber {} is removed", subscriber);
127 subscribers.remove(subscriber);
128 if (!hasSubscribers()) {
129 ListenersBroker.getInstance().removeAndCloseListener(this);
133 public final Instant getStart() {
138 * Set query parameters for listener.
140 * @param params NotificationQueryParams to use.
142 public final void setQueryParams(final NotificationQueryParams params) {
143 final var startTime = params.startTime();
144 start = startTime == null ? Instant.now() : parseDateAndTime(startTime.value());
146 final var stopTime = params.stopTime();
147 stop = stopTime == null ? null : parseDateAndTime(stopTime.value());
149 final var leafNodes = params.leafNodesOnly();
150 leafNodesOnly = leafNodes == null ? false : leafNodes.value();
152 final var skipData = params.skipNotificationData();
153 skipNotificationData = skipData == null ? false : skipData.value();
155 final var changedLeafNodes = params.changedLeafNodesOnly();
156 changedLeafNodesOnly = changedLeafNodes == null ? false : changedLeafNodes.value();
158 final var filter = params.filter();
159 final String filterValue = filter == null ? null : filter.paramValue();
160 if (filterValue != null && !filterValue.isEmpty()) {
162 formatter = formatterFactory.getFormatter(filterValue);
163 } catch (XPathExpressionException e) {
164 throw new IllegalArgumentException("Failed to get filter", e);
167 formatter = formatterFactory.getFormatter();
176 * Check whether this query should only notify about leaf node changes.
178 * @return true if this query should only notify about leaf node changes
180 final boolean getLeafNodesOnly() {
181 return leafNodesOnly;
185 * Check whether this query should only notify about leaf node changes and report only changed nodes.
187 * @return true if this query should only notify about leaf node changes and report only changed nodes
189 final boolean getChangedLeafNodesOnly() {
190 return changedLeafNodesOnly;
194 * Check whether this query should notify changes without data.
196 * @return true if this query should notify about changes with data
198 final boolean isSkipNotificationData() {
199 return skipNotificationData;
202 final EventFormatter<T> formatter() {
207 * Sets {@link Registration} registration.
209 * @param registration a listener registration registration.
212 final void setRegistration(final Registration registration) {
213 this.registration = requireNonNull(registration);
217 * Checks if {@link Registration} registration exists.
219 * @return {@code true} if exists, {@code false} otherwise.
222 final boolean isListening() {
223 return registration != null;
227 * Post data to subscribed SSE session handlers.
229 * @param data Data of incoming notifications.
231 synchronized void post(final String data) {
232 final Iterator<StreamSessionHandler> iterator = subscribers.iterator();
233 while (iterator.hasNext()) {
234 final StreamSessionHandler subscriber = iterator.next();
235 final boolean isConnected = subscriber.isConnected();
237 subscriber.sendDataMessage(data);
238 LOG.debug("Data was sent to subscriber {} on connection {}:", this, subscriber);
240 // removal is probably not necessary, because it will be removed explicitly soon after invocation of
241 // onWebSocketClosed(..) in handler; but just to be sure ...
243 LOG.debug("Subscriber for {} was removed - web-socket session is not open.", this);
248 @SuppressWarnings("checkstyle:IllegalCatch")
249 final boolean checkStartStop(final Instant now) {
251 if (start.compareTo(now) < 0 && stop.compareTo(now) > 0) {
254 if (stop.compareTo(now) < 0) {
257 } catch (final Exception e) {
258 throw new RestconfDocumentedException("Problem with unregister listener." + e);
261 } else if (start != null) {
262 if (start.compareTo(now) < 0) {
273 public final String toString() {
274 return MoreObjects.toStringHelper(this)
276 .add("stream-name", streamName)
277 .add("output-type", getOutputType())
282 * Parse input of query parameters - start-time or stop-time - from {@link DateAndTime} format
283 * to {@link Instant} format.
285 * @param uriValue Start-time or stop-time as string in {@link DateAndTime} format.
286 * @return Parsed {@link Instant} by entry.
288 private static @NonNull Instant parseDateAndTime(final DateAndTime dateAndTime) {
289 final TemporalAccessor accessor;
291 accessor = FORMATTER.parse(dateAndTime.getValue());
292 } catch (final DateTimeParseException e) {
293 throw new RestconfDocumentedException("Cannot parse of value in date: " + dateAndTime, e);
295 return Instant.from(accessor);