org.opendaylight.controller.cluster.databroker.OSGiDOMDataBroker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of controller-docs Show documentation
Controller documentation
There is a newer version: 10.0.4
/*
 * Copyright (c) 2020 PANTHEON.tech, s.r.o. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.controller.cluster.databroker;

import com.google.common.annotations.Beta;
import com.google.common.collect.ClassToInstanceMap;
import com.google.common.collect.ImmutableMap;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.TimeUnit;
import org.opendaylight.controller.md.sal.common.util.jmx.ThreadExecutorStatsMXBeanImpl;
import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
import org.opendaylight.mdsal.dom.api.DOMDataBroker;
import org.opendaylight.mdsal.dom.api.DOMDataBrokerExtension;
import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener;
import org.opendaylight.mdsal.dom.spi.store.DOMStore;
import org.opendaylight.yangtools.util.DurationStatisticsTracker;
import org.opendaylight.yangtools.util.concurrent.SpecialExecutors;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Deactivate;
import org.osgi.service.component.annotations.Reference;
import org.osgi.service.metatype.annotations.AttributeDefinition;
import org.osgi.service.metatype.annotations.Designate;
import org.osgi.service.metatype.annotations.ObjectClassDefinition;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@Beta
@Component(immediate = true, configurationPid = "org.opendaylight.controller.cluster.datastore.broker",
    property = "type=default")
@Designate(ocd = OSGiDOMDataBroker.Config.class)
public final class OSGiDOMDataBroker implements DOMDataBroker {
    @ObjectClassDefinition
    public @interface Config {
        @AttributeDefinition(name = "max-data-broker-future-callback-queue-size")
        int callbackQueueSize() default 1000;
        @AttributeDefinition(name = "max-data-broker-future-callback-pool-size")
        int callbackPoolSize() default 20;
    }

    private static final Logger LOG = LoggerFactory.getLogger(OSGiDOMDataBroker.class);

    @Reference(target = "(type=distributed-config)")
    DOMStore configDatastore = null;
    @Reference(target = "(type=distributed-operational)")
    DOMStore operDatastore = null;

    private ExecutorService executorService;
    private ConcurrentDOMDataBroker delegate;
    private CommitStatsMXBeanImpl commitStats;
    private ThreadExecutorStatsMXBeanImpl threadStats;

    @Override
    public DOMDataTreeReadTransaction newReadOnlyTransaction() {
        return delegate.newReadOnlyTransaction();
    }

    @Override
    public DOMDataTreeWriteTransaction newWriteOnlyTransaction() {
        return delegate.newWriteOnlyTransaction();
    }

    @Override
    public DOMDataTreeReadWriteTransaction newReadWriteTransaction() {
        return delegate.newReadWriteTransaction();
    }

    @Override
    public ClassToInstanceMap getExtensions() {
        return delegate.getExtensions();
    }

    @Override
    public DOMTransactionChain createTransactionChain(final DOMTransactionChainListener listener) {
        return delegate.createTransactionChain(listener);
    }

    @Override
    public DOMTransactionChain createMergingTransactionChain(final DOMTransactionChainListener listener) {
        return delegate.createMergingTransactionChain(listener);
    }

    @Activate
    void activate(final Config config) {
        LOG.info("DOM Data Broker starting");
        final DurationStatisticsTracker commitStatsTracker = DurationStatisticsTracker.createConcurrent();

        executorService = SpecialExecutors.newBlockingBoundedCachedThreadPool(config.callbackPoolSize(),
            config.callbackQueueSize(), "CommitFutures", ConcurrentDOMDataBroker.class);
        delegate = new ConcurrentDOMDataBroker(ImmutableMap.of(
            LogicalDatastoreType.CONFIGURATION, configDatastore, LogicalDatastoreType.OPERATIONAL, operDatastore),
            executorService, commitStatsTracker);

        commitStats = new CommitStatsMXBeanImpl(commitStatsTracker, "DOMDataBroker");
        commitStats.register();
        threadStats = ThreadExecutorStatsMXBeanImpl.create(executorService, "CommitFutureExecutorStats",
            "DOMDataBroker");

        LOG.info("DOM Data Broker started");
    }

    @Deactivate
    void deactivate() {
        LOG.info("DOM Data Broker stopping");
        commitStats.unregister();
        if (threadStats != null) {
            threadStats.unregister();
        }

        delegate.close();
        executorService.shutdown();
        try {
            executorService.awaitTermination(1, TimeUnit.MINUTES);
        } catch (InterruptedException e) {
            LOG.warn("Future executor failed to finish in time, giving up", e);
        }
        LOG.info("DOM Data Broker stopped");
    }
}