Package org.opendaylight.controller.md.sal.dom.api

Interface DOMDataReadTransaction

  • All Superinterfaces:
    org.opendaylight.controller.md.sal.common.api.data.AsyncReadTransaction<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,​org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,​?>>, org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,​org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,​?>>, org.opendaylight.yangtools.concepts.Identifiable<Object>
    All Known Subinterfaces:
    DOMDataReadOnlyTransaction, DOMDataReadWriteTransaction
    @Deprecated(forRemoval=true)
public interface DOMDataReadTransaction
extends org.opendaylight.controller.md.sal.common.api.data.AsyncReadTransaction<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,​org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,​?>>
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use DOMDataTreeReadTransaction instead.
    A transaction that provides read access to a logical data store.

    For more information on usage and examples, please see the documentation in AsyncReadTransaction.

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      com.google.common.util.concurrent.CheckedFuture<Boolean,​org.opendaylight.controller.md.sal.common.api.data.ReadFailedException> exists​(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Checks if data is available in the logical data store located at provided path.
      com.google.common.util.concurrent.CheckedFuture<com.google.common.base.Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,​?>>,​org.opendaylight.controller.md.sal.common.api.data.ReadFailedException> read​(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Reads data from provided logical data store located at the provided path.

      • Methods inherited from interface org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction

        getIdentifier

    • Method Detail

      • read

        com.google.common.util.concurrent.CheckedFuture<com.google.common.base.Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,​?>>,​org.opendaylight.controller.md.sal.common.api.data.ReadFailedException> read​(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType store,
                                                                                                                                                                                                                                              org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Reads data from provided logical data store located at the provided path.

        If the target is a subtree, then the whole subtree is read (and will be accessible from the returned data object).

        Parameters:
        store - Logical data store from which read should occur.
        path - Path which uniquely identifies subtree which client want to read
        Returns:
        a CheckFuture containing the result of the read. The Future blocks until the commit operation is complete. Once complete:
        • If the data at the supplied path exists, the Future returns an Optional object containing the data.
        • If the data at the supplied path does not exist, the Future returns Optional#absent().
        • If the read of the data fails, the Future will fail with a ReadFailedException or an exception derived from ReadFailedException.

      • exists

        com.google.common.util.concurrent.CheckedFuture<Boolean,​org.opendaylight.controller.md.sal.common.api.data.ReadFailedException> exists​(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType store,
                                                                                                                                             org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Checks if data is available in the logical data store located at provided path.

        Note: a successful result from this method makes no guarantee that a subsequent call to read(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier) will succeed. It is possible that the data resides in a data store on a remote node and, if that node goes down or a network failure occurs, a subsequent read would fail. Another scenario is if the data is deleted in between the calls to exists and read

        Parameters:
        store - Logical data store from which read should occur.
        path - Path which uniquely identifies subtree which client want to check existence of
        Returns:
        a CheckFuture containing the result of the check.
        • If the data at the supplied path exists, the Future returns a Boolean whose value is true, false otherwise
        • If checking for the data fails, the Future will fail with a ReadFailedException or an exception derived from ReadFailedException.