opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/DistributedDataStore.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.controller.cluster.datastore;
  10
  11 import akka.actor.ActorSystem;
  12 import com.google.common.annotations.VisibleForTesting;
  13 import com.google.common.base.Preconditions;
  14 import org.opendaylight.controller.cluster.datastore.identifiers.ShardManagerIdentifier;
  15 import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategyFactory;
  16 import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
  17 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker;
  18 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeListener;
  19 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
  20 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
  21 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
  22 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain;
  23 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
  24 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  26 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  27 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  28 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
  29 import org.slf4j.Logger;
  30 import org.slf4j.LoggerFactory;
  31
  32 /**
  33  *
  34  */
  35 public class DistributedDataStore implements DOMStore, SchemaContextListener, AutoCloseable {
  36
  37     private static final Logger LOG = LoggerFactory.getLogger(DistributedDataStore.class);
  38     public static final int REGISTER_DATA_CHANGE_LISTENER_TIMEOUT_FACTOR = 24; // 24 times the usual operation timeout
  39
  40     private final ActorContext actorContext;
  41
  42     public DistributedDataStore(ActorSystem actorSystem, ClusterWrapper cluster,
  43             Configuration configuration, DatastoreContext datastoreContext) {
  44         Preconditions.checkNotNull(actorSystem, "actorSystem should not be null");
  45         Preconditions.checkNotNull(cluster, "cluster should not be null");
  46         Preconditions.checkNotNull(configuration, "configuration should not be null");
  47         Preconditions.checkNotNull(datastoreContext, "datastoreContext should not be null");
  48
  49         String type = datastoreContext.getDataStoreType();
  50
  51         String shardManagerId = ShardManagerIdentifier.builder().type(type).build().toString();
  52
  53         LOG.info("Creating ShardManager : {}", shardManagerId);
  54
  55         actorContext = new ActorContext(actorSystem, actorSystem.actorOf(
  56                 ShardManager.props(cluster, configuration, datastoreContext)
  57                     .withMailbox(ActorContext.MAILBOX), shardManagerId ),
  58                 cluster, configuration, datastoreContext);
  59     }
  60
  61     public DistributedDataStore(ActorContext actorContext) {
  62         this.actorContext = Preconditions.checkNotNull(actorContext, "actorContext should not be null");
  63     }
  64
  65     @SuppressWarnings("unchecked")
  66     @Override
  67     public <L extends AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>>
  68                                               ListenerRegistration<L> registerChangeListener(
  69         final YangInstanceIdentifier path, L listener,
  70         AsyncDataBroker.DataChangeScope scope) {
  71
  72         Preconditions.checkNotNull(path, "path should not be null");
  73         Preconditions.checkNotNull(listener, "listener should not be null");
  74
  75         LOG.debug("Registering listener: {} for path: {} scope: {}", listener, path, scope);
  76
  77         String shardName = ShardStrategyFactory.getStrategy(path).findShard(path);
  78
  79         final DataChangeListenerRegistrationProxy listenerRegistrationProxy =
  80                 new DataChangeListenerRegistrationProxy(shardName, actorContext, listener);
  81         listenerRegistrationProxy.init(path, scope);
  82
  83         return listenerRegistrationProxy;
  84     }
  85
  86     @Override
  87     public DOMStoreTransactionChain createTransactionChain() {
  88         return new TransactionChainProxy(actorContext);
  89     }
  90
  91     @Override
  92     public DOMStoreReadTransaction newReadOnlyTransaction() {
  93         return new TransactionProxy(actorContext, TransactionProxy.TransactionType.READ_ONLY);
  94     }
  95
  96     @Override
  97     public DOMStoreWriteTransaction newWriteOnlyTransaction() {
  98         actorContext.acquireTxCreationPermit();
  99         return new TransactionProxy(actorContext, TransactionProxy.TransactionType.WRITE_ONLY);
 100     }
 101
 102     @Override
 103     public DOMStoreReadWriteTransaction newReadWriteTransaction() {
 104         actorContext.acquireTxCreationPermit();
 105         return new TransactionProxy(actorContext, TransactionProxy.TransactionType.READ_WRITE);
 106     }
 107
 108     @Override
 109     public void onGlobalContextUpdated(SchemaContext schemaContext) {
 110         actorContext.setSchemaContext(schemaContext);
 111     }
 112
 113     @Override
 114     public void close() throws Exception {
 115         actorContext.shutdown();
 116     }
 117
 118     @VisibleForTesting
 119     ActorContext getActorContext() {
 120         return actorContext;
 121     }
 122 }