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