dom/mdsal-dom-inmemory-datastore/src/main/java/org/opendaylight/mdsal/dom/store/inmemory/InMemoryDOMDataStoreFactory.java

   1 /*
   2  * Copyright (c) 2014 Brocade Communications 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.mdsal.dom.store.inmemory;
   9
  10 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  11
  12 import java.util.concurrent.ExecutorService;
  13 import javax.annotation.Nullable;
  14 import org.opendaylight.yangtools.util.concurrent.SpecialExecutors;
  15
  16 /**
  17  * A factory for creating InMemoryDOMDataStore instances.
  18  *
  19  * @author Thomas Pantelis
  20  */
  21 public final class InMemoryDOMDataStoreFactory {
  22
  23     private InMemoryDOMDataStoreFactory() {
  24     }
  25
  26     public static InMemoryDOMDataStore create(final String name,
  27             @Nullable final DOMSchemaService schemaService) {
  28         return create(name, schemaService, null);
  29     }
  30
  31     /**
  32      * Creates an InMemoryDOMDataStore instance.
  33      *
  34      * @param name the name of the data store
  35      * @param schemaService the SchemaService to which to register the data store.
  36      * @param properties configuration properties for the InMemoryDOMDataStore instance. If null,
  37      *                   default property values are used.
  38      * @return an InMemoryDOMDataStore instance
  39      */
  40     public static InMemoryDOMDataStore create(final String name,
  41             @Nullable final DOMSchemaService schemaService,
  42             @Nullable final InMemoryDOMDataStoreConfigProperties properties) {
  43         return create(name, schemaService, false, properties);
  44     }
  45
  46     /**
  47      * Creates an InMemoryDOMDataStore instance.
  48      *
  49      * @param name the name of the data store
  50      * @param schemaService the SchemaService to which to register the data store.
  51      * @param debugTransactions enable transaction debugging
  52      * @param properties configuration properties for the InMemoryDOMDataStore instance. If null,
  53      *                   default property values are used.
  54      * @return an InMemoryDOMDataStore instance
  55      */
  56     public static InMemoryDOMDataStore create(final String name,
  57             @Nullable final DOMSchemaService schemaService, final boolean debugTransactions,
  58             @Nullable final InMemoryDOMDataStoreConfigProperties properties) {
  59
  60         InMemoryDOMDataStoreConfigProperties actualProperties = properties;
  61         if (actualProperties == null) {
  62             actualProperties = InMemoryDOMDataStoreConfigProperties.getDefault();
  63         }
  64
  65         // For DataChangeListener notifications we use an executor that provides the fastest
  66         // task execution time to get higher throughput as DataChangeListeners typically provide
  67         // much of the business logic for a data model. If the executor queue size limit is reached,
  68         // subsequent submitted notifications will block the calling thread.
  69         int dclExecutorMaxQueueSize = actualProperties.getMaxDataChangeExecutorQueueSize();
  70         int dclExecutorMaxPoolSize = actualProperties.getMaxDataChangeExecutorPoolSize();
  71
  72         ExecutorService dataChangeListenerExecutor = SpecialExecutors.newBlockingBoundedFastThreadPool(
  73                 dclExecutorMaxPoolSize, dclExecutorMaxQueueSize, name + "-DCL" );
  74
  75         final InMemoryDOMDataStore dataStore = new InMemoryDOMDataStore(name, dataChangeListenerExecutor,
  76                 actualProperties.getMaxDataChangeListenerQueueSize(), debugTransactions);
  77
  78         if (schemaService != null) {
  79             schemaService.registerSchemaContextListener(dataStore);
  80         }
  81
  82         return dataStore;
  83     }
  84 }