org.opendaylight.controller.md.sal.binding.api

Class ForwardingReadOnlyTransaction

java.lang.Object

com.google.common.collect.ForwardingObject

org.opendaylight.controller.md.sal.binding.api.ForwardingReadOnlyTransaction

All Implemented Interfaces:

AutoCloseable, ReadOnlyTransaction, ReadTransaction, AsyncReadOnlyTransaction<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?>,org.opendaylight.yangtools.yang.binding.DataObject>, AsyncReadTransaction<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?>,org.opendaylight.yangtools.yang.binding.DataObject>, AsyncTransaction<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?>,org.opendaylight.yangtools.yang.binding.DataObject>, org.opendaylight.yangtools.concepts.Identifiable<Object>

public class ForwardingReadOnlyTransaction
extends com.google.common.collect.ForwardingObject
implements ReadOnlyTransaction

Utility ReadOnlyTransaction implementation which forwards all interface method invocation to a delegate instance.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ForwardingReadOnlyTransaction(ReadOnlyTransaction delegate)

Method Summary

Modifier and Type	Method and Description
void	close() Closes this transaction and releases all resources associated with it.
protected ReadTransaction	delegate()
com.google.common.util.concurrent.CheckedFuture<Boolean,ReadFailedException>	exists(LogicalDatastoreType store, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> path) Checks if data is available in the logical data store located at provided path.
Object	getIdentifier()
<T extends org.opendaylight.yangtools.yang.binding.DataObject> com.google.common.util.concurrent.CheckedFuture<com.google.common.base.Optional<T>,ReadFailedException>	read(LogicalDatastoreType store, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> path) Reads data from the provided logical data store located at the provided path.

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardingReadOnlyTransaction

protected ForwardingReadOnlyTransaction(ReadOnlyTransaction delegate)

Method Detail

delegate

protected ReadTransaction delegate()

Specified by:

delegate in class com.google.common.collect.ForwardingObject

read

public <T extends org.opendaylight.yangtools.yang.binding.DataObject> com.google.common.util.concurrent.CheckedFuture<com.google.common.base.Optional<T>,ReadFailedException> read(LogicalDatastoreType store,
                                                                                                                                                                                   org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> path)

Description copied from interface: ReadTransaction

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

Specified by:

read in interface ReadTransaction

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.binding.InstanceIdentifier<?> path)

Description copied from interface: ReadTransaction

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 ReadTransaction.read(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T>) 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

Default implementation delegates to ReadTransaction.read(LogicalDatastoreType, InstanceIdentifier), implementations are advised to provide a more efficient override.

Specified by:

exists in interface ReadTransaction

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.

getIdentifier

public Object getIdentifier()

Specified by:

getIdentifier in interface AsyncTransaction<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?>,org.opendaylight.yangtools.yang.binding.DataObject>

Specified by:

getIdentifier in interface org.opendaylight.yangtools.concepts.Identifiable<Object>

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.binding.InstanceIdentifier<?>,org.opendaylight.yangtools.yang.binding.DataObject>