dom/mdsal-dom-broker/src/main/java/org/opendaylight/mdsal/dom/broker/DOMMountPointServiceImpl.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.mdsal.dom.broker;
  10
  11 import static com.google.common.base.Preconditions.checkState;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import com.google.common.collect.MutableClassToInstanceMap;
  15 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  16 import java.util.HashMap;
  17 import java.util.Map;
  18 import java.util.Optional;
  19 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  20 import org.opendaylight.mdsal.dom.api.DOMMountPointListener;
  21 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  22 import org.opendaylight.mdsal.dom.api.DOMService;
  23 import org.opendaylight.mdsal.dom.spi.SimpleDOMMountPoint;
  24 import org.opendaylight.yangtools.concepts.AbstractObjectRegistration;
  25 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  26 import org.opendaylight.yangtools.concepts.ObjectRegistration;
  27 import org.opendaylight.yangtools.util.ListenerRegistry;
  28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  29 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32
  33 public class DOMMountPointServiceImpl implements DOMMountPointService {
  34     private static final Logger LOG = LoggerFactory.getLogger(DOMMountPointServiceImpl.class);
  35
  36     private final Map<YangInstanceIdentifier, DOMMountPoint> mountPoints = new HashMap<>();
  37
  38     private final ListenerRegistry<DOMMountPointListener> listeners = ListenerRegistry.create();
  39
  40     @Override
  41     public Optional<DOMMountPoint> getMountPoint(final YangInstanceIdentifier path) {
  42         return Optional.ofNullable(mountPoints.get(path));
  43     }
  44
  45     @Override
  46     public DOMMountPointBuilder createMountPoint(final YangInstanceIdentifier path) {
  47         checkState(!mountPoints.containsKey(path), "Mount point already exists");
  48         return new DOMMountPointBuilderImpl(path);
  49     }
  50
  51     @Override
  52     public ListenerRegistration<DOMMountPointListener> registerProvisionListener(final DOMMountPointListener listener) {
  53         return listeners.register(listener);
  54     }
  55
  56     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
  57             justification = "https://github.com/spotbugs/spotbugs/issues/811")
  58     @SuppressWarnings("checkstyle:IllegalCatch")
  59     private ObjectRegistration<DOMMountPoint> registerMountPoint(final SimpleDOMMountPoint mountPoint) {
  60         final YangInstanceIdentifier mountPointId = mountPoint.getIdentifier();
  61         synchronized (mountPoints) {
  62             final DOMMountPoint prev = mountPoints.putIfAbsent(mountPointId, mountPoint);
  63             checkState(prev == null, "Mount point %s already exists as %s", mountPointId, prev);
  64         }
  65         listeners.getRegistrations().forEach(listener -> {
  66             try {
  67                 listener.getInstance().onMountPointCreated(mountPointId);
  68             } catch (final Exception ex) {
  69                 LOG.error("Listener {} failed on mount point {} created event", listener, mountPoint, ex);
  70             }
  71         });
  72
  73         return new AbstractObjectRegistration<DOMMountPoint>(mountPoint) {
  74             @Override
  75             protected void removeRegistration() {
  76                 unregisterMountPoint(getInstance().getIdentifier());
  77             }
  78         };
  79     }
  80
  81     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
  82             justification = "https://github.com/spotbugs/spotbugs/issues/811")
  83     @SuppressWarnings("checkstyle:IllegalCatch")
  84     private void unregisterMountPoint(final YangInstanceIdentifier mountPointId) {
  85         synchronized (mountPoints) {
  86             if (mountPoints.remove(mountPointId) == null) {
  87                 LOG.warn("Removing non-existent mount point {} at", mountPointId, new Throwable());
  88                 return;
  89             }
  90         }
  91
  92         listeners.getRegistrations().forEach(listener -> {
  93             try {
  94                 listener.getInstance().onMountPointRemoved(mountPointId);
  95             } catch (final Exception ex) {
  96                 LOG.error("Listener {} failed on mount point {} removed event", listener, mountPointId, ex);
  97             }
  98         });
  99     }
 100
 101     private final class DOMMountPointBuilderImpl implements DOMMountPointBuilder {
 102
 103         private final MutableClassToInstanceMap<DOMService> services = MutableClassToInstanceMap.create();
 104         private final YangInstanceIdentifier path;
 105         private SchemaContext schemaContext;
 106
 107         private SimpleDOMMountPoint mountPoint;
 108
 109         DOMMountPointBuilderImpl(final YangInstanceIdentifier path) {
 110             this.path = requireNonNull(path);
 111         }
 112
 113         @Override
 114         public <T extends DOMService> DOMMountPointBuilder addService(final Class<T> type, final T impl) {
 115             services.putInstance(requireNonNull(type), requireNonNull(impl));
 116             return this;
 117         }
 118
 119         @Override
 120         public DOMMountPointBuilder addInitialSchemaContext(final SchemaContext ctx) {
 121             schemaContext = requireNonNull(ctx);
 122             return this;
 123         }
 124
 125         @Override
 126         public ObjectRegistration<DOMMountPoint> register() {
 127             checkState(mountPoint == null, "Mount point is already built.");
 128             mountPoint = SimpleDOMMountPoint.create(path, services, schemaContext);
 129             return registerMountPoint(mountPoint);
 130         }
 131     }
 132 }