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.annotations.VisibleForTesting;
  15 import com.google.common.base.Preconditions;
  16 import com.google.common.collect.MutableClassToInstanceMap;
  17 import java.util.HashMap;
  18 import java.util.Map;
  19 import java.util.Optional;
  20 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  21 import org.opendaylight.mdsal.dom.api.DOMMountPointListener;
  22 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  23 import org.opendaylight.mdsal.dom.api.DOMService;
  24 import org.opendaylight.mdsal.dom.spi.SimpleDOMMountPoint;
  25 import org.opendaylight.yangtools.concepts.AbstractObjectRegistration;
  26 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  27 import org.opendaylight.yangtools.concepts.ObjectRegistration;
  28 import org.opendaylight.yangtools.util.ListenerRegistry;
  29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  30 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  31 import org.slf4j.Logger;
  32 import org.slf4j.LoggerFactory;
  33
  34 public class DOMMountPointServiceImpl implements DOMMountPointService {
  35     private static final Logger LOG = LoggerFactory.getLogger(DOMMountPointServiceImpl.class);
  36
  37     private final Map<YangInstanceIdentifier, DOMMountPoint> mountPoints = new HashMap<>();
  38
  39     private final ListenerRegistry<DOMMountPointListener> listeners = ListenerRegistry.create();
  40
  41     @Override
  42     public Optional<DOMMountPoint> getMountPoint(final YangInstanceIdentifier path) {
  43         return Optional.ofNullable(mountPoints.get(path));
  44     }
  45
  46     @Override
  47     public DOMMountPointBuilder createMountPoint(final YangInstanceIdentifier path) {
  48         checkState(!mountPoints.containsKey(path), "Mount point already exists");
  49         return new DOMMountPointBuilderImpl(path);
  50     }
  51
  52     @Override
  53     public ListenerRegistration<DOMMountPointListener> registerProvisionListener(final DOMMountPointListener listener) {
  54         return listeners.register(listener);
  55     }
  56
  57     /**
  58      * Deprecated.
  59      *
  60      * @deprecated this method should never have been exposed publicly - registration should be done via the public
  61      *             {@link #createMountPoint} interface. As such, this method expects the {@code mountPoint} part to be
  62      *             of type {@link SimpleDOMMountPoint}.
  63      */
  64     @Deprecated
  65     public ObjectRegistration<DOMMountPoint> registerMountPoint(final DOMMountPoint mountPoint) {
  66         Preconditions.checkArgument(mountPoint instanceof SimpleDOMMountPoint,
  67                 "Expected mountpoint argument to be of type SimpleDOMMountPoint");
  68         return doRegisterMountPoint((SimpleDOMMountPoint) mountPoint);
  69     }
  70
  71     private ObjectRegistration<DOMMountPoint> doRegisterMountPoint(final SimpleDOMMountPoint mountPoint) {
  72         final YangInstanceIdentifier mountPointId = mountPoint.getIdentifier();
  73         synchronized (mountPoints) {
  74             final DOMMountPoint prev = mountPoints.putIfAbsent(mountPointId, mountPoint);
  75             checkState(prev == null, "Mount point %s already exists as %s", mountPointId, prev);
  76         }
  77         listeners.forEach(listener -> listener.getInstance().onMountPointCreated(mountPointId));
  78
  79         return new AbstractObjectRegistration<DOMMountPoint>(mountPoint) {
  80             @Override
  81             protected void removeRegistration() {
  82                 doUnregisterMountPoint(getInstance().getIdentifier());
  83             }
  84         };
  85     }
  86
  87     /**
  88      * Unregisters mountpoint.
  89      *
  90      * @param mountPointId Mountpoint identifier.
  91      *
  92      * @deprecated this method should never have been exposed publicly - mountpoint should be unregistered by simply
  93      *             closing its registration.
  94      *
  95      */
  96     @Deprecated
  97     public void unregisterMountPoint(final YangInstanceIdentifier mountPointId) {
  98         doUnregisterMountPoint(mountPointId);
  99     }
 100
 101     private void doUnregisterMountPoint(final YangInstanceIdentifier mountPointId) {
 102         synchronized (mountPoints) {
 103             if (mountPoints.remove(mountPointId) == null) {
 104                 LOG.warn("Removing non-existent mount point {} at", mountPointId, new Throwable());
 105                 return;
 106             }
 107         }
 108
 109         listeners.forEach(listener -> listener.getInstance().onMountPointRemoved(mountPointId));
 110     }
 111
 112     final class DOMMountPointBuilderImpl implements DOMMountPointBuilder {
 113
 114         private final MutableClassToInstanceMap<DOMService> services = MutableClassToInstanceMap.create();
 115         private final YangInstanceIdentifier path;
 116         private SchemaContext schemaContext;
 117
 118         private SimpleDOMMountPoint mountPoint;
 119
 120         DOMMountPointBuilderImpl(final YangInstanceIdentifier path) {
 121             this.path = requireNonNull(path);
 122         }
 123
 124         @VisibleForTesting
 125         SchemaContext getSchemaContext() {
 126             return schemaContext;
 127         }
 128
 129         @VisibleForTesting
 130         Map<Class<? extends DOMService>, DOMService> getServices() {
 131             return services;
 132         }
 133
 134         @Override
 135         public <T extends DOMService> DOMMountPointBuilder addService(final Class<T> type, final T impl) {
 136             services.putInstance(requireNonNull(type), requireNonNull(impl));
 137             return this;
 138         }
 139
 140         @Override
 141         public DOMMountPointBuilder addInitialSchemaContext(final SchemaContext ctx) {
 142             schemaContext = requireNonNull(ctx);
 143             return this;
 144         }
 145
 146         @Override
 147         public ObjectRegistration<DOMMountPoint> register() {
 148             checkState(mountPoint == null, "Mount point is already built.");
 149             mountPoint = SimpleDOMMountPoint.create(path, services,schemaContext);
 150             return doRegisterMountPoint(mountPoint);
 151         }
 152     }
 153 }