2 * Copyright (c) 2014 Brocade Communications Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.md.sal.dom.store.impl;
10 import java.util.concurrent.ExecutorService;
11 import javax.annotation.Nullable;
12 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
13 import org.opendaylight.controller.sal.core.api.model.SchemaService;
14 import org.opendaylight.yangtools.util.concurrent.SpecialExecutors;
17 * A factory for creating InMemoryDOMDataStore instances.
19 * @author Thomas Pantelis
21 public final class InMemoryDOMDataStoreFactory {
23 private InMemoryDOMDataStoreFactory() {
26 public static InMemoryDOMDataStore create(final String name,
27 @Nullable final SchemaService schemaService) {
28 return create(name, schemaService, null);
32 * Creates an InMemoryDOMDataStore instance.
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
40 public static InMemoryDOMDataStore create(final String name,
41 @Nullable final SchemaService schemaService,
42 @Nullable final InMemoryDOMDataStoreConfigProperties properties) {
43 return create(name, LogicalDatastoreType.OPERATIONAL, schemaService, false, properties);
47 * Creates an InMemoryDOMDataStore instance.
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
56 * @deprecated Use {@link #create(String, LogicalDatastoreType, SchemaService, boolean, InMemoryDOMDataStoreConfigProperties)}
60 public static InMemoryDOMDataStore create(final String name,
61 @Nullable final SchemaService schemaService, final boolean debugTransactions,
62 @Nullable final InMemoryDOMDataStoreConfigProperties properties) {
63 return create(name, LogicalDatastoreType.OPERATIONAL, schemaService, debugTransactions, properties);
67 * Creates an InMemoryDOMDataStore instance.
69 * @param name the name of the data store
70 * @param type Data store type
71 * @param schemaService the SchemaService to which to register the data store.
72 * @param debugTransactions enable transaction debugging
73 * @param properties configuration properties for the InMemoryDOMDataStore instance. If null,
74 * default property values are used.
75 * @return an InMemoryDOMDataStore instance
77 public static InMemoryDOMDataStore create(final String name, final LogicalDatastoreType type,
78 @Nullable final SchemaService schemaService, final boolean debugTransactions,
79 @Nullable final InMemoryDOMDataStoreConfigProperties properties) {
81 InMemoryDOMDataStoreConfigProperties actualProperties = properties;
82 if (actualProperties == null) {
83 actualProperties = InMemoryDOMDataStoreConfigProperties.getDefault();
86 // For DataChangeListener notifications we use an executor that provides the fastest
87 // task execution time to get higher throughput as DataChangeListeners typically provide
88 // much of the business logic for a data model. If the executor queue size limit is reached,
89 // subsequent submitted notifications will block the calling thread.
90 int dclExecutorMaxQueueSize = actualProperties.getMaxDataChangeExecutorQueueSize();
91 int dclExecutorMaxPoolSize = actualProperties.getMaxDataChangeExecutorPoolSize();
93 ExecutorService dataChangeListenerExecutor = SpecialExecutors.newBlockingBoundedFastThreadPool(
94 dclExecutorMaxPoolSize, dclExecutorMaxQueueSize, name + "-DCL" );
96 final InMemoryDOMDataStore dataStore = new InMemoryDOMDataStore(name, type, dataChangeListenerExecutor,
97 actualProperties.getMaxDataChangeListenerQueueSize(), debugTransactions);
99 if (schemaService != null) {
100 schemaService.registerSchemaContextListener(dataStore);