org.opendaylight.mdsal.binding.api

Interface ReadTransaction

All Superinterfaces:

AsyncReadTransaction<InstanceIdentifier<?>,DataObject>, AsyncTransaction<InstanceIdentifier<?>,DataObject>, AutoCloseable, org.opendaylight.yangtools.concepts.Identifiable<Object>

All Known Subinterfaces:

ReadWriteTransaction

public interface ReadTransaction
extends AsyncReadTransaction<InstanceIdentifier<?>,DataObject>

A transaction that provides a stateful read-only view of the data tree.

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

Method Summary

Modifier and Type	Method and Description
<T extends DataObject> com.google.common.util.concurrent.CheckedFuture<com.google.common.base.Optional<T>,ReadFailedException>	read(LogicalDatastoreType store, InstanceIdentifier<T> path) Reads data from the provided logical data store located at the provided path.

Methods inherited from interface org.opendaylight.mdsal.common.api.AsyncReadTransaction

close

Methods inherited from interface org.opendaylight.mdsal.common.api.AsyncTransaction

getIdentifier

Method Detail

read

<T extends DataObject> com.google.common.util.concurrent.CheckedFuture<com.google.common.base.Optional<T>,ReadFailedException> read(LogicalDatastoreType store,
                                                                                                                                    InstanceIdentifier<T> path)

Reads data from the 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.