org.opendaylight.mdsal.binding.dom.adapter.BindingDOMDataBrokerAdapter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mdsal-binding-dom-adapter Show documentation
There is a newer version: 14.0.2
Show newest version
/*
 * Copyright (c) 2014 Cisco Systems, Inc. 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.mdsal.binding.dom.adapter;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ClassToInstanceMap;
import com.google.common.collect.ImmutableSet;
import java.util.Set;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.mdsal.binding.api.DataBroker;
import org.opendaylight.mdsal.binding.api.DataTreeChangeListener;
import org.opendaylight.mdsal.binding.api.DataTreeChangeService;
import org.opendaylight.mdsal.binding.api.ReadTransaction;
import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
import org.opendaylight.mdsal.binding.api.TransactionChain;
import org.opendaylight.mdsal.binding.api.WriteTransaction;
import org.opendaylight.mdsal.binding.dom.adapter.BindingDOMAdapterBuilder.Factory;
import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
import org.opendaylight.mdsal.dom.api.DOMDataBroker;
import org.opendaylight.mdsal.dom.api.DOMDataBroker.DataTreeChangeExtension;
import org.opendaylight.mdsal.dom.api.DOMService;
import org.opendaylight.yangtools.binding.DataObject;
import org.opendaylight.yangtools.binding.DataObjectReference;
import org.opendaylight.yangtools.concepts.Registration;

/**
 * The DataBrokerImpl simply defers to the DOMDataBroker for all its operations. All transactions and listener
 * registrations are wrapped by the DataBrokerImpl to allow binding aware components to use the DataBroker
 * transparently.
 *
 * 
 * Besides this the DataBrokerImpl and it's collaborators also cache data that is already transformed from the binding
 * independent to binding aware format.
 */
@VisibleForTesting
public class BindingDOMDataBrokerAdapter extends AbstractBindingAdapter<@NonNull DOMDataBroker> implements DataBroker {
    static final Factory BUILDER_FACTORY = Builder::new;
    private final DataTreeChangeService treeChangeService;

    public BindingDOMDataBrokerAdapter(final AdapterContext adapterContext, final DOMDataBroker domDataBroker) {
        super(adapterContext, domDataBroker);
        final var domTreeChange = domDataBroker.extension(DataTreeChangeExtension.class);
        treeChangeService = domTreeChange == null ? null
                : new BindingDOMDataTreeChangeServiceAdapter(adapterContext, domTreeChange);
    }

    @Override
    public ReadTransaction newReadOnlyTransaction() {
        return new BindingDOMReadTransactionAdapter(adapterContext(), getDelegate().newReadOnlyTransaction());
    }

    @Override
    public WriteTransaction newWriteOnlyTransaction() {
        return new BindingDOMWriteTransactionAdapter<>(adapterContext(), getDelegate().newWriteOnlyTransaction());
    }

    @Override
    public ReadWriteTransaction newReadWriteTransaction() {
        return new BindingDOMReadWriteTransactionAdapter(adapterContext(), getDelegate().newReadWriteTransaction());
    }

    @Override
    public TransactionChain createTransactionChain() {
        return new BindingDOMTransactionChainAdapter(getDelegate().createTransactionChain(), adapterContext());
    }

    @Override
    public TransactionChain createMergingTransactionChain() {
        return new BindingDOMTransactionChainAdapter(getDelegate().createMergingTransactionChain(), adapterContext());
    }

    @Override
    public  Registration registerTreeChangeListener(final LogicalDatastoreType datastore,
            final DataObjectReference subtrees, final DataTreeChangeListener listener) {
        return getTreeChangeService().registerTreeChangeListener(datastore, subtrees, listener);
    }

    @Override
    @Deprecated(since = "13.0.0", forRemoval = true)
    public  Registration registerLegacyTreeChangeListener(final LogicalDatastoreType datastore,
            final DataObjectReference subtrees, final DataTreeChangeListener listener) {
        return getTreeChangeService().registerLegacyTreeChangeListener(datastore, subtrees, listener);
    }

    private @NonNull DataTreeChangeService getTreeChangeService() {
        final var local = treeChangeService;
        if (local == null) {
            throw new UnsupportedOperationException("Underlying data broker does not expose DOMDataTreeChangeService.");
        }
        return local;
    }

    private static class Builder extends BindingDOMAdapterBuilder {
        Builder(final AdapterContext adapterContext) {
            super(adapterContext);
        }

        @Override
        public Set>> getRequiredDelegates() {
            return ImmutableSet.of(DOMDataBroker.class);
        }

        @Override
        protected DataBroker createInstance(final ClassToInstanceMap> delegates) {
            return new BindingDOMDataBrokerAdapter(adapterContext(), delegates.getInstance(DOMDataBroker.class));
        }
    }
}