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