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