org.opendaylight.restconf.server.spi.Subscribers Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of restconf-server-spi Show documentation
RESTCONF server SPI
There is a newer version: 8.0.3
/*
 * Copyright (c) 2023 PANTHEON.tech, s.r.o. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.restconf.server.spi;

import static java.util.Objects.requireNonNull;

import com.google.common.base.VerifyException;
import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.ListMultimap;
import java.time.Instant;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * A set of subscribers attached to an {@link AbstractStream}. This is an immutable structure, which can be updated
 * through a copy-on-writer process driven by {@link #add(Subscriber)} and {@link #remove(Subscriber)}.
 *
 * @param  event type
 */
abstract sealed class Subscribers {
    static final class Empty extends Subscribers {
        private static final @NonNull Empty INSTANCE = new Empty<>();

        private Empty() {
            // Hidden on purpose
        }

        @Override
        Subscribers add(final Subscriber toAdd) {
            return new Single<>(toAdd);
        }

        @Override
        Subscribers remove(final Subscriber toRemove) {
            return this;
        }

        @Override
        void endOfStream() {
            // No-op
        }

        @Override
        void publish(final EffectiveModelContext modelContext, final T input, final Instant now) {
            // No-op
        }
    }

    private static final class Single extends Subscribers {
        private final Subscriber subscriber;

        Single(final Subscriber subscriber) {
            this.subscriber = requireNonNull(subscriber);
        }

        @Override
        Subscribers add(final Subscriber toAdd) {
            return new Multiple<>(ImmutableListMultimap.of(
                subscriber.formatter(), subscriber,
                toAdd.formatter(), toAdd));
        }

        @Override
        Subscribers remove(final Subscriber toRemove) {
            return toRemove.equals(subscriber) ? null : this;
        }

        @Override
        void endOfStream() {
            subscriber.sender().endOfStream();
        }

        @Override
        void publish(final EffectiveModelContext modelContext, final T input, final Instant now) {
            final var formatted = format(subscriber.formatter(), modelContext, input, now);
            if (formatted != null) {
                subscriber.sender().sendDataMessage(formatted);
            }
        }
    }

    private static final class Multiple extends Subscribers {
        private final ImmutableListMultimap, Subscriber> subscribers;

        Multiple(final ListMultimap, Subscriber> subscribers) {
            this.subscribers = ImmutableListMultimap.copyOf(subscribers);
        }

        @Override
        Subscribers add(final Subscriber toAdd) {
            final var newSubscribers = ArrayListMultimap.create(subscribers);
            newSubscribers.put(toAdd.formatter(), toAdd);
            return new Multiple<>(newSubscribers);
        }

        @Override
        Subscribers remove(final Subscriber toRemove) {
            final var newSubscribers = ArrayListMultimap.create(subscribers);
            return newSubscribers.remove(toRemove.formatter(), toRemove) ? switch (newSubscribers.size()) {
                case 0 -> throw new VerifyException("Unexpected empty subscribers");
                case 1 -> new Single<>(newSubscribers.values().iterator().next());
                default -> new Multiple<>(newSubscribers);
            } : this;
        }

        @Override
        void endOfStream() {
            subscribers.forEach((formatter, subscriber) -> subscriber.sender().endOfStream());
        }

        @Override
        void publish(final EffectiveModelContext modelContext, final T input, final Instant now) {
            for (var entry : subscribers.asMap().entrySet()) {
                final var formatted = format(entry.getKey(), modelContext, input, now);
                if (formatted != null) {
                    for (var subscriber : entry.getValue()) {
                        subscriber.sender().sendDataMessage(formatted);
                    }
                }
            }
        }
    }

    private static final Logger LOG = LoggerFactory.getLogger(Subscribers.class);

    private Subscribers() {
        // Hidden on purpose
    }

    /**
     * Return an An empty set of subscribers. This is the initial state of {@link RestconfStream}, waiting for the first
     * subscriber to appear.
     *
     * @param  event type
     * @return An empty {@link Subscribers} file
     */
    @SuppressWarnings("unchecked")
    static  org.opendaylight.restconf.server.spi.Subscribers empty() {
        return (Subscribers) Empty.INSTANCE;
    }

    /**
     * Add a new subscriber to this file.
     *
     * @param toAdd subscriber to add
     * @return A new {@link Subscribers} file
     * @throws NullPointerException if {@code toAdd} is {@code null}
     */
    abstract @NonNull Subscribers add(Subscriber toAdd);

    /**
     * Remove a subscriber to this file.
     *
     * @param toRemove subscriber to add
     * @return A new {@link Subscribers} file, or {@code null} if this file was not empty and it became empty
     * @throws NullPointerException if {@code toRemove} is {@code null}
     */
    abstract @Nullable Subscribers remove(Subscriber toRemove);

    /**
     * Signal end-of-stream to all subscribers.
     */
    abstract void endOfStream();

    /**
     * Publish an event to all {@link Subscriber}s in this file.
     *
     * @param modelContext An {@link EffectiveModelContext} used to format the input
     * @param input Input data
     * @param now Current time
     * @throws NullPointerException if any argument is {@code null}
     */
    abstract void publish(EffectiveModelContext modelContext, T input, Instant now);

    @SuppressWarnings("checkstyle:illegalCatch")
    private static  @Nullable String format(final EventFormatter formatter,
            final EffectiveModelContext modelContext, final T input, final Instant now) {
        try {
            return formatter.eventData(modelContext, input, now);
        } catch (Exception e) {
            LOG.warn("Failed to format", e);
            return null;
        }
    }
}