org.opendaylight.vtn.manager.internal

Interface VTNManagerProvider

All Superinterfaces:

AutoCloseable, Executor, NodeRpcWatcher, TxQueue

All Known Implementing Classes:

VTNManagerProviderImpl

public interface VTNManagerProvider
extends AutoCloseable, Executor, TxQueue, NodeRpcWatcher

This interface defines an internal OSGi service which provides MD-SAL VTN Manager services used by AD-SAL interface.

Method Summary

Methods

Modifier and Type	Method and Description
VTNFuture<VtnFlowId>	addFlow(VTNFlowBuilder builder) Add the given VTN data flow.
void	close() Close the VTN Manager provider service.
boolean	executeTask(Runnable task) Execute the specified task asynchronously.
org.opendaylight.controller.md.sal.binding.api.DataBroker	getDataBroker() Return a data broker service instance.
com.google.common.base.Optional<org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipState>	getOwnershipState(org.opendaylight.controller.md.sal.common.api.clustering.Entity ent) Return the current ownership state information about the given entity.
RouteResolver	getRouteResolver() Return the packet route resolver associated with the system default routing policy.
RouteResolver	getRouteResolver(Integer id) Return a packet route resolver.
<T extends org.opendaylight.yangtools.yang.binding.RpcService> T	getRpcService(Class<T> type) Return an implementation of the specified RPC service.
Timer	getTimer() Return the global timer.
VTNConfig	getVTNConfig() Return a VTNConfig instance that contains current configuration.
<T extends org.opendaylight.yangtools.yang.binding.RpcService> T	getVtnRpcService(Class<T> type) Return an implementation of the RPC service provided by the VTN Manager.
boolean	isOwner(VTNEntityType etype) Determine whether this process process is the owner of the given global entity.
TxContext	newTxContext() Create a new read-only MD-SAL datastore transaction context.
<T> VTNFuture<T>	postSync(TxTask<T> task) Post a new MD-SAL transaction task.
void	publish(org.opendaylight.yangtools.yang.binding.Notification n) Publish the given MD-SAL notification.
org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration	registerEntity(org.opendaylight.controller.md.sal.common.api.clustering.Entity ent) Register a candidate for ownership of the given entity.
org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListenerRegistration	registerListener(VTNEntityType etype, org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener listener) Register a listener that listens the ownership status of the entity specified by the given type.
VTNFuture<Void>	removeFlows(FlowRemover remover) Remove flow entries that match the given condition.
<T> void	setCallback(Future<T> future, com.google.common.util.concurrent.FutureCallback<? super T> cb) Set the given future callback to the given future.
void	transmit(List<org.apache.commons.lang3.tuple.Pair<SalPort,Packet>> packets) Transmit all the given packets.
void	transmit(SalPort egress, Packet packet) Transmit the given packet.

Methods inherited from interface java.util.concurrent.Executor

execute

Methods inherited from interface org.opendaylight.vtn.manager.internal.TxQueue

post, postFirst

Methods inherited from interface org.opendaylight.vtn.manager.internal.util.inventory.NodeRpcWatcher

registerRpc, unregisterRpc

Method Detail

getVTNConfig

VTNConfig getVTNConfig()

Return a VTNConfig instance that contains current configuration.

Returns:

A VTNConfig instance.

newTxContext

TxContext newTxContext()

Create a new read-only MD-SAL datastore transaction context.

Returns:

A read-only MD-SAL datastore transaction context.

getTimer

Timer getTimer()

Return the global timer.

Returns:

The global timer.

executeTask

boolean executeTask(Runnable task)

Execute the specified task asynchronously.

Parameters:

task - A task to be executed on this thread pool.

Returns:

true is returned if the specified task was submitted. false is returned if the specified tas was rejected.

Throws:

NullPointerException - task is null.

setCallback

<T> void setCallback(Future<T> future,
                   com.google.common.util.concurrent.FutureCallback<? super T> cb)

Set the given future callback to the given future.

If the given future implements ListenableFuture, this method adds the given callback to the given future, and the callback will be invoked by a thread which is executing the future. If not, the given callback will be invoked on another thread asynchronously.

Type Parameters:

T - The type of the object returned by the given future.

Parameters:

future - A Future instance to wait for its completion.

cb - A FutureCallback instance.

getDataBroker

org.opendaylight.controller.md.sal.binding.api.DataBroker getDataBroker()

Return a data broker service instance.

Returns:

A DataBroker instance.

transmit

void transmit(SalPort egress,
            Packet packet)

Transmit the given packet.

Parameters:

egress - A SalPort instance which specifies the egress switch port.

packet - A Packet instance to transmit.

transmit

void transmit(List<org.apache.commons.lang3.tuple.Pair<SalPort,Packet>> packets)

Transmit all the given packets.

Parameters:

packets - A list of packets to transmit. The left of each elements indicates the egress switch port, and the right indiciates a packet to transmit.

getRouteResolver

RouteResolver getRouteResolver()

Return the packet route resolver associated with the system default routing policy.

Returns:

A RouteResolver instance on success. null if the routing management is already closed.

getRouteResolver

RouteResolver getRouteResolver(Integer id)

Return a packet route resolver.

Parameters:

id - The identifier of the path policy.

Returns:

A RouteResolver instance if found. null if not fonud.

addFlow

VTNFuture<VtnFlowId> addFlow(VTNFlowBuilder builder)

Add the given VTN data flow.

Parameters:

builder - A VTNFlowBuilder instance which contains data flow to be installed.

Returns:

A future associated with the task which adds a VTN data flow.

removeFlows

VTNFuture<Void> removeFlows(FlowRemover remover)

Remove flow entries that match the given condition.

Parameters:

remover - A FlowRemover instance which determines VTN data flows to be removed.

Returns:

A future associated with the task which removes VTN data flows.

registerEntity

org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration registerEntity(org.opendaylight.controller.md.sal.common.api.clustering.Entity ent)
                                                                                                             throws org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException

Register a candidate for ownership of the given entity.

Parameters:

ent - The entity to be registered as a candidate of ownership.

Returns:

An EntityOwnershipCandidateRegistration instance.

Throws:

org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException - The given entity is already registered.

registerListener

org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListenerRegistration registerListener(VTNEntityType etype,
                                                                                                            org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener listener)

Register a listener that listens the ownership status of the entity specified by the given type.

Parameters:

etype - The type of the VTN global entity.

listener - An EntityOwnershipListener instance.

Returns:

An EntityOwnershipListenerRegistration instance.

getOwnershipState

com.google.common.base.Optional<org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipState> getOwnershipState(org.opendaylight.controller.md.sal.common.api.clustering.Entity ent)

Return the current ownership state information about the given entity.

Parameters:

ent - The entity to query.

Returns:

An Optional instance that contains the entity ownership state if present.

isOwner

boolean isOwner(VTNEntityType etype)

Determine whether this process process is the owner of the given global entity.

Parameters:

etype - The type of VTN global entity. Specifying non-global entity type results in undefined behavior.

Returns:

true if this process is the owner of the given global entity. false otherwise.

getRpcService

<T extends org.opendaylight.yangtools.yang.binding.RpcService> T getRpcService(Class<T> type)
                                                                           throws VTNException

Return an implementation of the specified RPC service.

Type Parameters:

T - The type of the RPC service.

Parameters:

type - A class which specifies the RPC service.

Returns:

The proxy for the given RPC service.

Throws:

VTNException - The specified RPC service was not found.

getVtnRpcService

<T extends org.opendaylight.yangtools.yang.binding.RpcService> T getVtnRpcService(Class<T> type)
                                                                              throws VTNException

Return an implementation of the RPC service provided by the VTN Manager.

Type Parameters:

T - The type of the RPC service.

Parameters:

type - A class which specifies the RPC service.

Returns:

The proxy for the given RPC service.

Throws:

VTNException - The specified RPC service was not found.

publish

void publish(org.opendaylight.yangtools.yang.binding.Notification n)

Publish the given MD-SAL notification.

Parameters:

n - A Notification instance to be published.

postSync

<T> VTNFuture<T> postSync(TxTask<T> task)

Post a new MD-SAL transaction task.

This method associates a new VTNFuture instance with the given task, including all background tasks started by the task. Note that the given task is never canceled even if the returned VTNFuture is cancelled. Future.cancel(boolean) on the returned value only cancels the wait for background tasks.

Type Parameters:

T - The type of the object to be returned by the task.

Parameters:

task - A TxTask instance.

Returns:

A VTNFuture associated with the given task and its background tasks.

close

void close()

Close the VTN Manager provider service.

Specified by:

close in interface AutoCloseable