org.opendaylight.vtn.manager.internal.provider

Class VTNManagerProviderImpl

java.lang.Object

org.opendaylight.vtn.manager.internal.provider.VTNManagerProviderImpl

All Implemented Interfaces:

AutoCloseable, Executor, EventListener, TxQueue, BarrierSender, FlowRpcWatcher, NodeRpcWatcher, VTNManagerProvider, VTNManager, VtnVersionService, org.opendaylight.yangtools.yang.binding.RpcService, org.osgi.framework.BundleListener, org.osgi.framework.SynchronousBundleListener

public final class VTNManagerProviderImpl
extends Object
implements org.osgi.framework.SynchronousBundleListener, VTNManager, VTNManagerProvider, VtnVersionService

MD-SAL service provider of the VTN Manager.

Field Summary

Fields

Modifier and Type	Field and Description
static long	API_VERSION Current API version of the VTN Manager.

Constructor Summary

Constructors

Constructor and Description

VTNManagerProviderImpl(org.osgi.framework.BundleContext bctx, org.opendaylight.controller.md.sal.binding.api.DataBroker broker, org.opendaylight.controller.sal.binding.api.RpcProviderRegistry rpcReg, org.opendaylight.controller.md.sal.binding.api.NotificationService nsv, org.opendaylight.controller.md.sal.binding.api.NotificationPublishService npsv, org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService eos) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
VTNFuture<VtnFlowId>	addFlow(VTNFlowBuilder builder) Add the given VTN data flow.
void	asyncBarrier(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nref) Send a barrier request to the specified switch asynchronously.
void	bundleChanged(org.osgi.framework.BundleEvent ev) Invoked when the manager.implementation bundle has a lifecycle change.
boolean	canReuse() Determine whether this instance can be reused or not.
void	close() Close the VTN Manager provider service.
void	execute(Runnable task) Execute the specified task on one of worker threads in the pool.
boolean	executeTask(Runnable task) Execute the specified task asynchronously.
org.opendaylight.controller.md.sal.binding.api.DataBroker	getDataBroker() Return a data broker service instance.
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetManagerVersionOutput>>	getManagerVersion() Return the version information of the VTN Manager.
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.
VTNTimer	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>	post(TxTask<T> task) Post a new transaction for MD-SAL datastore.
<T> VTNFuture<T>	postFirst(TxTask<T> task) Post a new transaction for MD-SAL datastore.
<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.
void	registerRpc(NodeRpcInvocation<?,?> rpc) Register the specified RPC invocation routed to the specifiec switch.
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.
void	unregisterRpc(NodeRpcInvocation<?,?> rpc) Unregister the specified RPC invocation.

Methods inherited from class java.lang.Object

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

Field Detail

API_VERSION

public static final long API_VERSION

Current API version of the VTN Manager.

See Also:

Constant Field Values

Constructor Detail

VTNManagerProviderImpl

public VTNManagerProviderImpl(org.osgi.framework.BundleContext bctx,
                              org.opendaylight.controller.md.sal.binding.api.DataBroker broker,
                              org.opendaylight.controller.sal.binding.api.RpcProviderRegistry rpcReg,
                              org.opendaylight.controller.md.sal.binding.api.NotificationService nsv,
                              org.opendaylight.controller.md.sal.binding.api.NotificationPublishService npsv,
                              org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService eos)

Construct a new instance.

Parameters:

bctx - A BundleContext instance associated with the bundle that contains this class.

broker - A DataBroker service instance.

rpcReg - A RpcProviderRegistry service instance.

nsv - A NotificationService service instance.

npsv - A NotificationPublishService service instance.

eos - A EntityOwnershipService serivce instance.

Method Detail

canReuse

public boolean canReuse()

Determine whether this instance can be reused or not.

Returns:

true only if this instance can be reused.

bundleChanged

public void bundleChanged(org.osgi.framework.BundleEvent ev)

Invoked when the manager.implementation bundle has a lifecycle change.

Specified by:

bundleChanged in interface org.osgi.framework.BundleListener

Parameters:

ev - A BundleEvent instance.

getVTNConfig

public VTNConfig getVTNConfig()

Return a VTNConfig instance that contains current configuration.

Specified by:

getVTNConfig in interface VTNManagerProvider

Returns:

A VTNConfig instance.

newTxContext

public TxContext newTxContext()

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

Specified by:

newTxContext in interface VTNManagerProvider

Returns:

A read-only MD-SAL datastore transaction context.

getTimer

public VTNTimer getTimer()

Return the global timer.

Specified by:

getTimer in interface VTNManagerProvider

Returns:

The global timer.

executeTask

public boolean executeTask(Runnable task)

Execute the specified task asynchronously.

Specified by:

executeTask in interface VTNManagerProvider

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.

setCallback

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

Specified by:

setCallback in interface VTNManagerProvider

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

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

Return a data broker service instance.

Specified by:

getDataBroker in interface VTNManagerProvider

Returns:

A DataBroker instance.

transmit

public void transmit(SalPort egress,
                     Packet packet)

Transmit the given packet.

Specified by:

transmit in interface VTNManagerProvider

Parameters:

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

packet - A Packet instance to transmit.

transmit

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

Transmit all the given packets.

Specified by:

transmit in interface VTNManagerProvider

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

public RouteResolver getRouteResolver()

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

Specified by:

getRouteResolver in interface VTNManagerProvider

Returns:

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

getRouteResolver

public RouteResolver getRouteResolver(Integer id)

Return a packet route resolver.

Specified by:

getRouteResolver in interface VTNManagerProvider

Parameters:

id - The identifier of the path policy.

Returns:

A RouteResolver instance if found. null if not fonud.

addFlow

public VTNFuture<VtnFlowId> addFlow(VTNFlowBuilder builder)

Add the given VTN data flow.

Specified by:

addFlow in interface VTNManagerProvider

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

public VTNFuture<Void> removeFlows(FlowRemover remover)

Remove flow entries that match the given condition.

Specified by:

removeFlows in interface VTNManagerProvider

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

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

Specified by:

registerEntity in interface VTNManagerProvider

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

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

Specified by:

registerListener in interface VTNManagerProvider

Parameters:

etype - The type of the VTN global entity.

listener - An EntityOwnershipListener instance.

Returns:

An EntityOwnershipListenerRegistration instance.

getOwnershipState

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

Specified by:

getOwnershipState in interface VTNManagerProvider

Parameters:

ent - The entity to query.

Returns:

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

isOwner

public boolean isOwner(VTNEntityType etype)

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

Specified by:

isOwner in interface VTNManagerProvider

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

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

Return an implementation of the specified RPC service.

Specified by:

getRpcService in interface VTNManagerProvider

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

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

Specified by:

getVtnRpcService in interface VTNManagerProvider

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

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

Publish the given MD-SAL notification.

Specified by:

publish in interface VTNManagerProvider

Parameters:

n - A Notification instance to be published.

postSync

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

Specified by:

postSync in interface VTNManagerProvider

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

public void close()

Close the VTN Manager provider service.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface VTNManagerProvider

registerRpc

public void registerRpc(NodeRpcInvocation<?,?> rpc)

Register the specified RPC invocation routed to the specifiec switch.

Specified by:

registerRpc in interface NodeRpcWatcher

Parameters:

rpc - An RPC invocation to be registered.

unregisterRpc

public void unregisterRpc(NodeRpcInvocation<?,?> rpc)

Unregister the specified RPC invocation.

Specified by:

unregisterRpc in interface NodeRpcWatcher

Parameters:

rpc - An RPC invocation to be unregistered.

asyncBarrier

public void asyncBarrier(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nref)

Send a barrier request to the specified switch asynchronously.

Specified by:

asyncBarrier in interface BarrierSender

Parameters:

nref - Reference to the target node.

execute

public void execute(Runnable task)

Execute the specified task on one of worker threads in the pool.

Specified by:

execute in interface Executor

Parameters:

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

Throws:

NullPointerException - task is null.

post

public <T> VTNFuture<T> post(TxTask<T> task)

Post a new transaction for MD-SAL datastore.

This method put the given task at the tail of the transaction queue.

Specified by:

post in interface TxQueue

Type Parameters:

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

Parameters:

task - A TxTask instance.

Returns:

A VTNFuture instance that returns the result of the task.

postFirst

public <T> VTNFuture<T> postFirst(TxTask<T> task)

Post a new transaction for MD-SAL datastore.

This method put the given task at the head of the transaction queue.

Specified by:

postFirst in interface TxQueue

Type Parameters:

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

Parameters:

task - A TxTask instance.

Returns:

A VTNFuture instance that returns the result of the task.

getManagerVersion

public Future<org.opendaylight.yangtools.yang.common.RpcResult<GetManagerVersionOutput>> getManagerVersion()

Return the version information of the VTN Manager.

Specified by:

getManagerVersion in interface VtnVersionService

Returns:

A Future associated with the RPC task.