org.opendaylight.controller.cluster.databroker

Class DOMBrokerReadOnlyTransaction

java.lang.Object

org.opendaylight.controller.cluster.databroker.AbstractDOMBrokerTransaction<DOMStoreReadTransaction>

org.opendaylight.controller.cluster.databroker.DOMBrokerReadOnlyTransaction

All Implemented Interfaces:

AutoCloseable, AsyncReadOnlyTransaction<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>, AsyncReadTransaction<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>, AsyncTransaction<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>, DOMDataReadOnlyTransaction, DOMDataReadTransaction, org.opendaylight.yangtools.concepts.Identifiable<Object>

public class DOMBrokerReadOnlyTransaction
extends AbstractDOMBrokerTransaction<DOMStoreReadTransaction>
implements DOMDataReadOnlyTransaction

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DOMBrokerReadOnlyTransaction(Object identifier, Map<LogicalDatastoreType,? extends DOMStoreTransactionFactory> storeTxFactories) Creates new composite Transactions.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this transaction and releases all resources associated with it.
protected DOMStoreReadTransaction	createTransaction(LogicalDatastoreType key)
com.google.common.util.concurrent.CheckedFuture<Boolean,ReadFailedException>	exists(LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path) 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<?,?>>,ReadFailedException>	read(LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path) Reads data from provided logical data store located at the provided path.

Methods inherited from class org.opendaylight.controller.cluster.databroker.AbstractDOMBrokerTransaction

addToStringAttributes, closeSubtransactions, getIdentifier, getSubtransaction, getSubtransactions, getTxFactory, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getIdentifier

Constructor Detail

DOMBrokerReadOnlyTransaction

protected DOMBrokerReadOnlyTransaction(Object identifier,
                                       Map<LogicalDatastoreType,? extends DOMStoreTransactionFactory> storeTxFactories)

Creates new composite Transactions.

Parameters:

identifier - Identifier of transaction.

Method Detail

read

public com.google.common.util.concurrent.CheckedFuture<com.google.common.base.Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>,ReadFailedException> read(LogicalDatastoreType store,
                                                                                                                                                                                      org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

Description copied from interface: DOMDataReadTransaction

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).

Specified by:

read in interface DOMDataReadTransaction

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

public com.google.common.util.concurrent.CheckedFuture<Boolean,ReadFailedException> exists(LogicalDatastoreType store,
                                                                                           org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

Description copied from interface: DOMDataReadTransaction

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 DOMDataReadTransaction.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

Specified by:

exists in interface DOMDataReadTransaction

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.

close

public void close()

Description copied from interface: AsyncReadOnlyTransaction

Closes this transaction and releases all resources associated with it.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface AsyncReadOnlyTransaction<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

createTransaction

protected DOMStoreReadTransaction createTransaction(LogicalDatastoreType key)

Specified by:

createTransaction in class AbstractDOMBrokerTransaction<DOMStoreReadTransaction>