binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/DataBroker.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 package org.opendaylight.mdsal.binding.api;
   9
  10 import org.opendaylight.mdsal.common.api.AsyncDataBroker;
  11 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  12 import org.opendaylight.mdsal.common.api.TransactionChainFactory;
  13 import org.opendaylight.mdsal.common.api.TransactionChainListener;
  14
  15 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  16 import org.opendaylight.yangtools.yang.binding.DataObject;
  17 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  18
  19 /**
  20  * Provides access to a conceptual data tree store and also provides the ability to
  21  * subscribe for changes to data under a given branch of the tree.
  22  * <p>
  23  * For more information on usage, please see the documentation in {@link AsyncDataBroker}.
  24  *
  25  * @see AsyncDataBroker
  26  * @see TransactionChainFactory
  27  */
  28 public interface DataBroker extends  AsyncDataBroker<InstanceIdentifier<?>, DataObject, DataChangeListener>,
  29     TransactionChainFactory<InstanceIdentifier<?>, DataObject>, TransactionFactory, BindingService, DataTreeChangeService {
  30     /**
  31      * {@inheritDoc}
  32      */
  33     @Override
  34     ReadOnlyTransaction newReadOnlyTransaction();
  35
  36     /**
  37      * {@inheritDoc}
  38      */
  39     @Override
  40     ReadWriteTransaction newReadWriteTransaction();
  41
  42     /**
  43      * {@inheritDoc}
  44      */
  45     @Override
  46     WriteTransaction newWriteOnlyTransaction();
  47
  48     /**
  49      * {@inheritDoc}
  50      */
  51     @Override
  52     ListenerRegistration<DataChangeListener> registerDataChangeListener(LogicalDatastoreType store,
  53             InstanceIdentifier<?> path, DataChangeListener listener, DataChangeScope triggeringScope);
  54
  55     /**
  56      * {@inheritDoc}
  57      */
  58     @Override
  59     BindingTransactionChain createTransactionChain(TransactionChainListener listener);
  60 }