org.opendaylight.sfc.genius.impl.handlers.readers

Class SfcGeniusSfStateReader

java.lang.Object

org.opendaylight.sfc.genius.impl.handlers.readers.SfcGeniusSfStateReader

public class SfcGeniusSfStateReader
extends Object

Helper class to the read information regarding a service function state from the SFC operational data store asynchronous API.

See Also:

SfcGeniusReaderAbstract.doRead(LogicalDatastoreType, InstanceIdentifier)

Constructor Summary

Constructors

Constructor and Description
SfcGeniusSfStateReader(org.opendaylight.controller.md.sal.binding.api.ReadTransaction readTransaction, Executor executor) Constructs a SfcGeniusSfStateReader using the provided ReadTransaction and Executor.

Method Summary

Modifier and Type	Method and Description
protected <T extends org.opendaylight.yangtools.yang.binding.DataObject> CompletableFuture<T>	doRead(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType logicalDatastoreType, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> instanceIdentifier) Utility method to read a DataObject from the data store.
protected <T extends org.opendaylight.yangtools.yang.binding.DataObject> CompletableFuture<Optional<T>>	doReadOptional(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType logicalDatastoreType, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> instanceIdentifier) Utility method to read a {#DataObject} from the data store.
CompletableFuture<List<SfpName>>	readSfpNames(SfName sfName) Read the service function path names associated to a service function.

Methods inherited from class java.lang.Object

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

Constructor Detail

SfcGeniusSfStateReader

public SfcGeniusSfStateReader(org.opendaylight.controller.md.sal.binding.api.ReadTransaction readTransaction,
                              Executor executor)

Constructs a SfcGeniusSfStateReader using the provided ReadTransaction and Executor.

Parameters:

readTransaction - the read transaction.

executor - the callback executor.

Method Detail

readSfpNames

public CompletableFuture<List<SfpName>> readSfpNames(SfName sfName)

Read the service function path names associated to a service function.

Parameters:

sfName - the name of the service function.

Returns:

completable future that will hold the names of the service function path names upon completion.

doRead

protected <T extends org.opendaylight.yangtools.yang.binding.DataObject> CompletableFuture<T> doRead(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType logicalDatastoreType,
                                                                                                     org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> instanceIdentifier)

Utility method to read a DataObject from the data store. If it does not exist, the future will be completed exceptionally with a SfcGeniusRuntimeException wrapping a NoSuchElementException.

Type Parameters:

T - the type of the object to read.

Parameters:

logicalDatastoreType - the data store type to read from..

instanceIdentifier - the instance identifier of the object to read.

Returns:

completable future to the data object.

doReadOptional

protected <T extends org.opendaylight.yangtools.yang.binding.DataObject> CompletableFuture<Optional<T>> doReadOptional(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType logicalDatastoreType,
                                                                                                                       org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> instanceIdentifier)

Utility method to read a {#DataObject} from the data store.

Type Parameters:

T - the type of the data object to read.

Parameters:

logicalDatastoreType - to read from.

instanceIdentifier - of the data object to read.

Returns:

future to an optional data object.