X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-binding-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Fbinding%2Fapi%2Fdata%2FDataBrokerService.java;h=d30ca6beaf6fc209f600fbe09175895d4b9bdd62;hb=44c747db358bf0d49434d5f818121286b5928d4a;hp=dd055aa3820d64c6ffaa084066ed0bf22c25a5d5;hpb=738d46bed116293e3e42171ad2035ab805b0b2be;p=controller.git diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataBrokerService.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataBrokerService.java index dd055aa382..d30ca6beaf 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataBrokerService.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataBrokerService.java @@ -7,128 +7,76 @@ */ package org.opendaylight.controller.sal.binding.api.data; -import java.util.concurrent.Future; - +import org.opendaylight.controller.md.sal.common.api.data.DataChangePublisher; +import org.opendaylight.controller.md.sal.common.api.data.DataModificationTransactionFactory; +import org.opendaylight.controller.md.sal.common.api.data.DataReader; import org.opendaylight.controller.sal.binding.api.BindingAwareService; -import org.opendaylight.controller.sal.common.DataStoreIdentifier; -import org.opendaylight.yangtools.yang.binding.DataRoot; -import org.opendaylight.yangtools.yang.common.RpcResult; +import org.opendaylight.yangtools.concepts.ListenerRegistration; +import org.opendaylight.yangtools.yang.binding.DataObject; +import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; /** * DataBrokerService provides unified access to the data stores available in the * system. - * - * + * + * * @see DataProviderService + * @deprecated Replaced by newer better documented version {@link org.opendaylight.controller.md.sal.binding.api.DataBroker} */ -public interface DataBrokerService extends BindingAwareService { - - /** - * Returns a data from specified Data Store. - * - * Returns all the data visible to the consumer from specified Data Store. - * - * @param - * Interface generated from YANG module representing root of data - * @param store - * Identifier of the store, from which will be data retrieved - * @return data visible to the consumer - */ - T getData(DataStoreIdentifier store, Class rootType); - - /** - * Returns a filtered subset of data from specified Data Store. - * - *

- * The filter is modeled as an hierarchy of Java TOs starting with - * implementation of {@link DataRoot} representing data root. The semantics - * of the filter tree is the same as filter semantics defined in the NETCONF - * protocol for rpc operations get and get-config - * in Section 6 of RFC6241. - * - * - * @see http://tools.ietf.org/html/rfc6241#section-6 - * @param - * Interface generated from YANG module representing root of data - * @param store - * Identifier of the store, from which will be data retrieved - * @param filter - * Data tree filter similar to the NETCONF filter - * @return - */ - T getData(DataStoreIdentifier store, T filter); - +@Deprecated +public interface DataBrokerService extends // + BindingAwareService, // + DataModificationTransactionFactory, DataObject>, // + DataReader, DataObject>, // + DataChangePublisher, DataObject, DataChangeListener> { /** - * Returns a candidate data which are not yet commited. - * - * - * @param - * Interface generated from YANG module representing root of data - * @param store - * Identifier of the store, from which will be data retrieved - * @return + * Creates a data modification transaction. + * + * @return new blank data modification transaction. + * @deprecated Replaced by more specific transaction types. Please use + * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction(), + * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadWriteTransaction() + * or + * {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newWriteOnlyTransaction(). */ - T getCandidateData(DataStoreIdentifier store, Class rootType); + @Deprecated + @Override + DataModificationTransaction beginTransaction(); /** - * Returns a filtered subset of candidate data from specified Data Store. - * - *

- * The filter is modeled as an hierarchy of {@link Node} starting with - * {@link CompositeNode} representing data root. The semantics of the filter - * tree is the same as filter semantics defined in the NETCONF protocol for - * rpc operations get and get-config in Section 6 - * of RFC6241. - * - * - * @see http://tools.ietf.org/html/rfc6241#section-6 - * @param - * Interface generated from YANG module representing root of data - * @param store - * Identifier of the store, from which will be data retrieved - * @param filter - * A filter data root - * @return + * Reads data subtree from configurational store. + * (Store which is populated by consumer, which is usually used to + * inject state into providers. E.g. Flow configuration) + * + * + * @deprecated Please use {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction()} + * */ - T getCandidateData(DataStoreIdentifier store, T filter); + @Deprecated + @Override + public DataObject readConfigurationData(InstanceIdentifier path); /** - * - * @param - * Interface generated from YANG module representing root of data - * @param store - * Identifier of the store, in which will be the candidate data - * modified - * @param changeSet - * Modification of data tree. - * @return Result object containing the modified data tree if the operation - * was successful, otherwise list of the encountered errors. + * Reads data subtree from operational store. + * (Store which is populated by providers, which is usually used to + * capture state of providers. E.g. Topology) + * + * @deprecated Please use {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction()} */ - RpcResult editCandidateData(DataStoreIdentifier store, DataRoot changeSet); + @Deprecated + @Override + public DataObject readOperationalData(InstanceIdentifier path); /** - * Initiates a two-phase commit of candidate data. - * - *

- * The {@link Consumer} could initiate a commit of candidate data - * - *

- * The successful commit changes the state of the system and may affect - * several components. - * - *

- * The effects of successful commit of data are described in the - * specifications and YANG models describing the {@link Provider} components - * of controller. It is assumed that {@link Consumer} has an understanding - * of this changes. - * - * - * @see DataCommitHandler for further information how two-phase commit is - * processed. - * @param store - * Identifier of the store, where commit should occur. - * @return Result of the commit, containing success information or list of - * encountered errors, if commit was not successful. + * Register a data change listener for particular subtree. + * + * Callback is invoked each time data in subtree changes. + * + * @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)} + * which provides more fine-grained registration options. */ - Future> commit(DataStoreIdentifier store); + @Deprecated + @Override + public ListenerRegistration registerDataChangeListener( + InstanceIdentifier path, DataChangeListener listener); }