org.opendaylight.vtn.manager.internal.flow.reader

Class ReadFlowFuture

java.lang.Object

org.opendaylight.vtn.manager.internal.util.concurrent.AbstractVTNFuture<T>

org.opendaylight.vtn.manager.internal.util.concurrent.SettableVTNFuture<T>

org.opendaylight.vtn.manager.internal.flow.reader.AbstractReadFlowFuture<List<DataFlowInfo>>

org.opendaylight.vtn.manager.internal.flow.reader.ReadFlowFuture

All Implemented Interfaces:

com.google.common.util.concurrent.CheckedFuture<List<DataFlowInfo>,VTNException>, com.google.common.util.concurrent.ListenableFuture<List<DataFlowInfo>>, Future<List<DataFlowInfo>>, VTNFuture<List<DataFlowInfo>>, RpcOutputGenerator<List<DataFlowInfo>,GetDataFlowOutput>

Direct Known Subclasses:

ReadDataFlowFuture, ReadSingleFlowFuture

public abstract class ReadFlowFuture
extends AbstractReadFlowFuture<List<DataFlowInfo>>
implements RpcOutputGenerator<List<DataFlowInfo>,GetDataFlowOutput>

ReadFlowFuture describes a future associated with the task which reads data flow information.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReadFlowFuture(TxContext ctx, TxQueue txq, StatsReaderService srs, GetDataFlowInput input) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	clearFlowNode() Clear the physical switch specified by the RPC input.
protected void	clearFlowPort() Clear the physical switch port specified by the RPC input.
protected void	clearSourceHost() Clear the source L2 host specified by the RPC input.
static ReadFlowFuture	create(TxContext ctx, TxQueue txq, StatsReaderService srs, GetDataFlowInput input) Construct a new instance.
GetDataFlowOutput	createOutput(List<DataFlowInfo> result) Generate the output of the RPC request.
protected SalNode	getFlowNode() Return a SalNode instance corresponding to the physical switch specified by the RPC input.
protected SalPort	getFlowPort() Return a SalPort instance corresponding to the physical switch port specified by the RPC input.
Class<GetDataFlowOutput>	getOutputType() Return a class which indicates the type of the RPC output.
protected MacVlan	getSourceHost() Return a MacVlan instance corresponding to the source L2 host specified by the RPC input.
protected StatsReaderService	getStatsReaderService() Return the flow statistics reader service.
protected void	notFound() Set an empty flow list as the result.
protected boolean	select(FlowCache fc) Determine whether the given data flow should be selected or not.
protected DataFlowInfo	toDataFlowInfo(FlowCache fc, VTNFuture<FlowStatsRecord> current) Convert the given data flow into a DataFlowInfo instance.

Methods inherited from class org.opendaylight.vtn.manager.internal.flow.reader.AbstractReadFlowFuture

checkTenant, getTenantName, getTxContext, setFailure, setResult

Methods inherited from class org.opendaylight.vtn.manager.internal.util.concurrent.SettableVTNFuture

cancel, get, get, isCancelled, isDone, maskCancel, onFutureFailed, onFutureSucceeded, set, setException, setThread, unmaskCancel

Methods inherited from class org.opendaylight.vtn.manager.internal.util.concurrent.AbstractVTNFuture

addListener, done, getCause, getException

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.vtn.manager.internal.util.concurrent.VTNFuture

checkedGet, checkedGet

Constructor Detail

ReadFlowFuture

protected ReadFlowFuture(TxContext ctx,
                         TxQueue txq,
                         StatsReaderService srs,
                         GetDataFlowInput input)
                  throws VTNException

Construct a new instance.

Parameters:

ctx - A TxContext instance.

txq - A TxQueue instance used to update the MD-SAL datastore.

srs - The flow statistics reader service.

input - Input of the RPC call.

Throws:

VTNException - An error occurred.

Method Detail

create

public static final ReadFlowFuture create(TxContext ctx,
                                          TxQueue txq,
                                          StatsReaderService srs,
                                          GetDataFlowInput input)
                                   throws VTNException

Construct a new instance.

Parameters:

ctx - A TxContext instance.

txq - A TxQueue instance used to update the MD-SAL datastore.

srs - The flow statistics reader service.

input - Input of the RPC call.

Returns:

A ReadFlowFuture instance.

Throws:

VTNException - An error occurred.

getStatsReaderService

protected final StatsReaderService getStatsReaderService()

Return the flow statistics reader service.

Returns:

A StatsReaderService instance if flow statistics information needs to be fetched from switches. Otherwise null.

getFlowNode

protected final SalNode getFlowNode()

Return a SalNode instance corresponding to the physical switch specified by the RPC input.

Returns:

A SalNode instance or null.

getFlowPort

protected final SalPort getFlowPort()

Return a SalPort instance corresponding to the physical switch port specified by the RPC input.

Returns:

A SalPort instance or null.

getSourceHost

protected final MacVlan getSourceHost()

Return a MacVlan instance corresponding to the source L2 host specified by the RPC input.

Returns:

A MacVlan instance or null.

clearFlowNode

protected final void clearFlowNode()

Clear the physical switch specified by the RPC input.

clearFlowPort

protected final void clearFlowPort()

Clear the physical switch port specified by the RPC input.

clearSourceHost

protected final void clearSourceHost()

Clear the source L2 host specified by the RPC input.

notFound

protected final void notFound()

Set an empty flow list as the result.

select

protected final boolean select(FlowCache fc)

Determine whether the given data flow should be selected or not.

Parameters:

fc - A FlowCache instance.

Returns:

true if the given data flow should be selected. Otherwise false.

toDataFlowInfo

protected final DataFlowInfo toDataFlowInfo(FlowCache fc,
                                            VTNFuture<FlowStatsRecord> current)

Convert the given data flow into a DataFlowInfo instance.

This method set an exception as the result of this future if null is returned.

Parameters:

fc - A FlowCache instance.

current - A future which will return the current flow statistics for the given data flow. If null, only flow statistics cached in fc are used.

Returns:

A DataFlowInfo instance on success. null on failure.

getOutputType

public Class<GetDataFlowOutput> getOutputType()

Return a class which indicates the type of the RPC output.

Specified by:

getOutputType in interface RpcOutputGenerator<List<DataFlowInfo>,GetDataFlowOutput>

Returns:

A class which indicates the type of the RPC output.

createOutput

public GetDataFlowOutput createOutput(List<DataFlowInfo> result)

Generate the output of the RPC request.

Specified by:

createOutput in interface RpcOutputGenerator<List<DataFlowInfo>,GetDataFlowOutput>

Parameters:

result - The result of the RPC main procedure.

Returns:

The output of the RPC request.