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

Class SfcGeniusSfReader

java.lang.Object

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

public class SfcGeniusSfReader
extends Object

Helper class to read data relative to a Service Function configuration from SFC data store API.

See Also:

SfcGeniusReaderAbstract.doRead(LogicalDatastoreType, InstanceIdentifier)

Constructor Summary

Constructors

Constructor and Description
SfcGeniusSfReader(org.opendaylight.controller.md.sal.binding.api.ReadTransaction readTransaction, Executor executor) Constructs a SfcGeniusSfReader 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<String>>	readInterfacesOfSf(SfName sfName) Read the interface names configured as data plane locators of a given service function.
CompletableFuture<List<SfName>>	readSfOnInterface(String interfaceName) Read the service function names that have the given interface configured as a data plane locator.

Methods inherited from class java.lang.Object

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

Constructor Detail

SfcGeniusSfReader

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

Constructs a SfcGeniusSfReader using the provided ReadTransaction and Executor.

Parameters:

readTransaction - the read transaction.

executor - the callback executor.

Method Detail

readSfOnInterface

public CompletableFuture<List<SfName>> readSfOnInterface(String interfaceName)

Read the service function names that have the given interface configured as a data plane locator.

Parameters:

interfaceName - the interface name.

Returns:

a list of service function names, empty list if none.

readInterfacesOfSf

public CompletableFuture<List<String>> readInterfacesOfSf(SfName sfName)

Read the interface names configured as data plane locators of a given service function.

Parameters:

sfName - the service function name.

Returns:

a list of interface names, empty list if none.

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.