opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataBrokerService.java

   1 /*
   2  * Copyright (c) 2013 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.sal.binding.api.data;
   9
  10 import org.opendaylight.controller.md.sal.common.api.data.DataReader;
  11 import org.opendaylight.controller.sal.binding.api.BindingAwareService;
  12 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  13 import org.opendaylight.yangtools.yang.binding.DataObject;
  14 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  15
  16 /**
  17  * DataBrokerService provides unified access to the data stores available in the
  18  * system.
  19  *
  20  *
  21  * @see DataProviderService
  22  * @deprecated Replaced by newer better documented version {@link org.opendaylight.controller.md.sal.binding.api.DataBroker}
  23  */
  24 @Deprecated
  25 public interface DataBrokerService extends BindingAwareService,
  26         DataReader<InstanceIdentifier<? extends DataObject>, DataObject> {
  27     /**
  28      * Creates a data modification transaction.
  29      *
  30      * @return new blank data modification transaction.
  31      * @deprecated Replaced by more specific transaction types. Please use
  32      *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction()},
  33      *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadWriteTransaction()}
  34      *          or
  35      *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newWriteOnlyTransaction()}.
  36      */
  37     @Deprecated
  38     DataModificationTransaction beginTransaction();
  39
  40     /**
  41      * Reads data subtree from configurational store.
  42      * (Store which is populated by consumer, which is usually used to
  43      * inject state into providers. E.g. Flow configuration)
  44      *
  45      *
  46      * @deprecated Please use {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction()}
  47      *
  48      */
  49     @Override
  50     @Deprecated
  51     DataObject readConfigurationData(InstanceIdentifier<? extends DataObject> path);
  52
  53     /**
  54      * Reads data subtree from operational store.
  55      * (Store which is populated by providers, which is usually used to
  56      * capture state of providers. E.g. Topology)
  57      *
  58      * @deprecated Please use {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction()}
  59      */
  60     @Override
  61     @Deprecated
  62     DataObject readOperationalData(InstanceIdentifier<? extends DataObject> path);
  63
  64     /**
  65      * Register a data change listener for particular subtree.
  66      *
  67      * Callback is invoked each time data in subtree changes.
  68      *
  69      * @deprecated Please use {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#registerDataChangeListener(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType, InstanceIdentifier, org.opendaylight.controller.md.sal.binding.api.DataChangeListener, org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope)}
  70      * which provides more fine-grained registration options.
  71      */
  72     @Deprecated
  73     ListenerRegistration<DataChangeListener> registerDataChangeListener(
  74             InstanceIdentifier<? extends DataObject> path, DataChangeListener listener);
  75 }