opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataProviderService.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
  11 import org.opendaylight.controller.md.sal.common.api.data.DataProvisionService;
  12 import org.opendaylight.controller.md.sal.common.api.data.DataReader;
  13 import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
  14 import org.opendaylight.yangtools.concepts.Registration;
  15 import org.opendaylight.yangtools.yang.binding.DataObject;
  16 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  17
  18 /**
  19  * DataProviderService is common access point for {@link BindingAwareProvider} providers
  20  * to access data trees described by the YANG model.
  21  *
  22  */
  23 public interface DataProviderService extends DataBrokerService, DataProvisionService<InstanceIdentifier<? extends DataObject>, DataObject> {
  24
  25
  26     /**
  27      * Registers a data reader for particular subtree of overal YANG data tree.
  28      *
  29      * Registered data reader is called if anyone tries to read data from
  30      * paths which are nested to provided path.
  31      *
  32      * @param path Subpath which is handled by registered data reader
  33      * @param reader Instance of reader which
  34      * @return Registration object for reader. Invoking {@link Registration#close()} will unregister reader.
  35      */
  36     Registration<DataReader<InstanceIdentifier<? extends DataObject>,DataObject>> registerDataReader(InstanceIdentifier<? extends DataObject> path,DataReader<InstanceIdentifier<? extends DataObject>,DataObject> reader);
  37 }