opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/sal/dom/broker/BrokerImpl.java

   1 /*
   2  * Copyright (c) 2013 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.controller.sal.dom.broker;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.collect.ClassToInstanceMap;
  13 import com.google.common.collect.ImmutableClassToInstanceMap;
  14 import com.google.common.util.concurrent.CheckedFuture;
  15 import java.util.Collections;
  16 import java.util.HashSet;
  17 import java.util.Set;
  18 import javax.annotation.Nonnull;
  19 import javax.annotation.Nullable;
  20 import org.opendaylight.controller.md.sal.dom.api.DOMRpcAvailabilityListener;
  21 import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
  22 import org.opendaylight.controller.md.sal.dom.api.DOMRpcIdentifier;
  23 import org.opendaylight.controller.md.sal.dom.api.DOMRpcImplementation;
  24 import org.opendaylight.controller.md.sal.dom.api.DOMRpcImplementationRegistration;
  25 import org.opendaylight.controller.md.sal.dom.api.DOMRpcProviderService;
  26 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  27 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  28 import org.opendaylight.controller.md.sal.dom.broker.impl.DOMRpcRouter;
  29 import org.opendaylight.controller.sal.core.api.Broker;
  30 import org.opendaylight.controller.sal.core.api.BrokerService;
  31 import org.opendaylight.controller.sal.core.api.Consumer;
  32 import org.opendaylight.controller.sal.core.api.Provider;
  33 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  34 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  35 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  36 import org.osgi.framework.BundleContext;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 @Deprecated
  41 public class BrokerImpl implements Broker, DOMRpcProviderService, DOMRpcService, AutoCloseable {
  42     private static final Logger LOG = LoggerFactory.getLogger(BrokerImpl.class);
  43
  44     // Broker Generic Context
  45     private final Set<ConsumerContextImpl> sessions = Collections
  46             .synchronizedSet(new HashSet<ConsumerContextImpl>());
  47     private final Set<ProviderContextImpl> providerSessions = Collections
  48             .synchronizedSet(new HashSet<ProviderContextImpl>());
  49
  50     private AutoCloseable deactivator;
  51
  52     private final DOMRpcService rpcService;
  53     private final DOMRpcProviderService rpcProvider;
  54
  55     private final ClassToInstanceMap<BrokerService> services;
  56
  57     public BrokerImpl(final DOMRpcRouter router,final ClassToInstanceMap<BrokerService> services) {
  58         this(router, router, services);
  59     }
  60
  61     public BrokerImpl(final DOMRpcService rpcService, final DOMRpcProviderService rpcProvider,
  62             final ClassToInstanceMap<BrokerService> services) {
  63         this.rpcService = Preconditions.checkNotNull(rpcService, "DOMRpcService must not be null");
  64         this.rpcProvider = Preconditions.checkNotNull(rpcProvider, "DOMRpcProviderService must not be null");
  65         this.services = ImmutableClassToInstanceMap.copyOf(services);
  66     }
  67
  68     @Override
  69     public ConsumerSession registerConsumer(final Consumer consumer,
  70             final BundleContext ctx) {
  71         return registerConsumer(consumer);
  72     }
  73
  74     @Override
  75     public ConsumerSession registerConsumer(final Consumer consumer) {
  76         checkPredicates(consumer);
  77         LOG.trace("Registering consumer {}", consumer);
  78         final ConsumerContextImpl session = newSessionFor(consumer);
  79         consumer.onSessionInitiated(session);
  80         sessions.add(session);
  81         return session;
  82     }
  83
  84     @Override
  85     public ProviderSession registerProvider(final Provider provider,
  86             final BundleContext ctx) {
  87         return registerProvider(provider);
  88     }
  89
  90     @Override
  91     public ProviderSession registerProvider(final Provider provider) {
  92         checkPredicates(provider);
  93         final ProviderContextImpl session = newSessionFor(provider);
  94         provider.onSessionInitiated(session);
  95         providerSessions.add(session);
  96         return session;
  97     }
  98
  99     // Validation
 100     private void checkPredicates(final Provider prov) {
 101         Preconditions.checkNotNull(prov, "Provider should not be null.");
 102         synchronized (providerSessions) {
 103             for (final ProviderContextImpl session : providerSessions) {
 104                 if (prov.equals(session.getProvider())) {
 105                     throw new IllegalStateException("Provider already registered");
 106                 }
 107             }
 108         }
 109
 110     }
 111
 112     private void checkPredicates(final Consumer cons) {
 113         Preconditions.checkNotNull(cons, "Consumer should not be null.");
 114         synchronized (sessions) {
 115             for (final ConsumerContextImpl session : sessions) {
 116                 if (cons.equals(session.getConsumer())) {
 117                     throw new IllegalStateException("Consumer already registered");
 118                 }
 119             }
 120         }
 121     }
 122
 123     // Private Factory methods
 124     private ConsumerContextImpl newSessionFor(final Consumer provider) {
 125         final ConsumerContextImpl ret = new ConsumerContextImpl(provider, this);
 126         return ret;
 127     }
 128
 129     private ProviderContextImpl newSessionFor(final Provider provider) {
 130         final ProviderContextImpl ret = new ProviderContextImpl(provider, this);
 131         return ret;
 132     }
 133
 134     protected void consumerSessionClosed(
 135             final ConsumerContextImpl consumerContextImpl) {
 136         sessions.remove(consumerContextImpl);
 137         providerSessions.remove(consumerContextImpl);
 138     }
 139
 140     @Override
 141     public void close() throws Exception {
 142         if (deactivator != null) {
 143             deactivator.close();
 144             deactivator = null;
 145         }
 146     }
 147
 148     /**
 149      * Gets deactivator.
 150      *
 151      * @return the deactivator
 152      */
 153     public AutoCloseable getDeactivator() {
 154         return deactivator;
 155     }
 156
 157     /**
 158      * Sets deactivator.
 159      *
 160      * @param deactivator
 161      *            the deactivator to set
 162      */
 163     public void setDeactivator(final AutoCloseable deactivator) {
 164         this.deactivator = deactivator;
 165     }
 166
 167     protected <T extends BrokerService> Optional<T> getGlobalService(final Class<T> service) {
 168         return Optional.fromNullable(services.getInstance(service));
 169     }
 170
 171     @Nonnull
 172     @Override
 173     public <T extends DOMRpcImplementation> DOMRpcImplementationRegistration<T> registerRpcImplementation(
 174             @Nonnull final T implementation, @Nonnull final DOMRpcIdentifier... rpcs) {
 175         return rpcProvider.registerRpcImplementation(implementation, rpcs);
 176     }
 177
 178     @Nonnull
 179     @Override
 180     public <T extends DOMRpcImplementation> DOMRpcImplementationRegistration<T> registerRpcImplementation(
 181             @Nonnull final T implementation, @Nonnull final Set<DOMRpcIdentifier> rpcs) {
 182         return rpcProvider.registerRpcImplementation(implementation, rpcs);
 183     }
 184
 185     @Nonnull
 186     @Override
 187     public CheckedFuture<DOMRpcResult, DOMRpcException> invokeRpc(@Nonnull final SchemaPath type,
 188                                                                   @Nullable final NormalizedNode<?, ?> input) {
 189         return rpcService.invokeRpc(type, input);
 190     }
 191
 192     @Nonnull
 193     @Override
 194     public <T extends DOMRpcAvailabilityListener> ListenerRegistration<T> registerRpcListener(
 195             @Nonnull final T listener) {
 196         return rpcService.registerRpcListener(listener);
 197     }
 198 }