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