org.opendaylight.vtn.manager.internal.vnode

Class VBridgeManager

java.lang.Object

org.opendaylight.vtn.manager.internal.vnode.VBridgeManager

All Implemented Interfaces:

org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener, VtnMacMapService, VtnVlanMapService, VtnMacTableService, VtnVbridgeService, org.opendaylight.yangtools.yang.binding.RpcService

public final class VBridgeManager
extends Object
implements org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener, VtnVbridgeService, VtnMacTableService, VtnVlanMapService, VtnMacMapService

VBridgeManager provides services related to vBridge.

Constructor Summary

Constructors

Constructor and Description
VBridgeManager(VTNManagerProvider provider) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
Future<org.opendaylight.yangtools.yang.common.RpcResult<AddVlanMapOutput>>	addVlanMap(AddVlanMapInput input) Configure a VLAN mapping in the specified vBridge.
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetMacMappedHostOutput>>	getMacMappedHost(GetMacMappedHostInput input) Get a list of hosts where mapping is actually active based on MAC mapping configured in the specified vBridge.
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetVlanMapOutput>>	getVlanMap(GetVlanMapInput input) Search for a VLAN mapping with the specified VLAN mapping configuration in the specified vBridge.
void	initRpcServices(org.opendaylight.controller.sal.binding.api.RpcProviderRegistry rpcReg, CompositeAutoCloseable regs) Register RPC services.
void	ownershipChanged(org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipChange change) Invoked when the ownership status of the vBridge has been changed.
void	removeEntity(VBridgeIdentifier ident) Remove the entity of the specified vBridge.
Future<org.opendaylight.yangtools.yang.common.RpcResult<RemoveMacEntryOutput>>	removeMacEntry(RemoveMacEntryInput input) Remove the specified MAC address information from the MAC address table in the specified vBridge.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	removeVbridge(RemoveVbridgeInput input) Remove the specified vBridge.
Future<org.opendaylight.yangtools.yang.common.RpcResult<RemoveVlanMapOutput>>	removeVlanMap(RemoveVlanMapInput input) Remove the specified VLAN mappings from the vBridge.
Future<org.opendaylight.yangtools.yang.common.RpcResult<SetMacMapOutput>>	setMacMap(SetMacMapInput input) Configure MAC mapping in the specified vBridge.
Future<org.opendaylight.yangtools.yang.common.RpcResult<SetMacMapAclOutput>>	setMacMapAcl(SetMacMapAclInput input) Configure MAC mapping in the specified vBridge.
void	shutdown() Shut down the vBridge entity management.
void	updateEntity(VBridgeIdentifier ident, VbridgeConfig config) Update the entity of the specified vBridge.
Future<org.opendaylight.yangtools.yang.common.RpcResult<UpdateVbridgeOutput>>	updateVbridge(UpdateVbridgeInput input) Create or modify the specified vBridge.

Methods inherited from class java.lang.Object

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

Constructor Detail

VBridgeManager

public VBridgeManager(VTNManagerProvider provider)

Construct a new instance.

Parameters:

provider - A VTN Manager provider service.

Method Detail

initRpcServices

public void initRpcServices(org.opendaylight.controller.sal.binding.api.RpcProviderRegistry rpcReg,
                            CompositeAutoCloseable regs)

Register RPC services.

Parameters:

rpcReg - A RpcProviderRegistry service instance.

regs - A CompositeAutoCloseable instance to store RPC registration.

updateEntity

public void updateEntity(VBridgeIdentifier ident,
                         VbridgeConfig config)

Update the entity of the specified vBridge.

The entity of the specified vBridge will be created if not present. If present, the specified configuration will be applied to the existing entity of the vBridge.

Parameters:

ident - The identifier for the target vBridge.

config - The configuration of the vBridge.

removeEntity

public void removeEntity(VBridgeIdentifier ident)

Remove the entity of the specified vBridge.

Parameters:

ident - The identifier for the target vBridge.

shutdown

public void shutdown()

Shut down the vBridge entity management.

ownershipChanged

public void ownershipChanged(org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipChange change)

Invoked when the ownership status of the vBridge has been changed.

Specified by:

ownershipChanged in interface org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener

Parameters:

change - An EntityOwnershipChange instance.

updateVbridge

public Future<org.opendaylight.yangtools.yang.common.RpcResult<UpdateVbridgeOutput>> updateVbridge(UpdateVbridgeInput input)

Create or modify the specified vBridge.

Specified by:

updateVbridge in interface VtnVbridgeService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

removeVbridge

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> removeVbridge(RemoveVbridgeInput input)

Remove the specified vBridge.

Specified by:

removeVbridge in interface VtnVbridgeService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

removeMacEntry

public Future<org.opendaylight.yangtools.yang.common.RpcResult<RemoveMacEntryOutput>> removeMacEntry(RemoveMacEntryInput input)

Remove the specified MAC address information from the MAC address table in the specified vBridge.

Specified by:

removeMacEntry in interface VtnMacTableService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

addVlanMap

public Future<org.opendaylight.yangtools.yang.common.RpcResult<AddVlanMapOutput>> addVlanMap(AddVlanMapInput input)

Configure a VLAN mapping in the specified vBridge.

Specified by:

addVlanMap in interface VtnVlanMapService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

removeVlanMap

public Future<org.opendaylight.yangtools.yang.common.RpcResult<RemoveVlanMapOutput>> removeVlanMap(RemoveVlanMapInput input)

Remove the specified VLAN mappings from the vBridge.

Specified by:

removeVlanMap in interface VtnVlanMapService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

getVlanMap

public Future<org.opendaylight.yangtools.yang.common.RpcResult<GetVlanMapOutput>> getVlanMap(GetVlanMapInput input)

Search for a VLAN mapping with the specified VLAN mapping configuration in the specified vBridge.

Specified by:

getVlanMap in interface VtnVlanMapService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

setMacMap

public Future<org.opendaylight.yangtools.yang.common.RpcResult<SetMacMapOutput>> setMacMap(SetMacMapInput input)

Configure MAC mapping in the specified vBridge.

Specified by:

setMacMap in interface VtnMacMapService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

setMacMapAcl

public Future<org.opendaylight.yangtools.yang.common.RpcResult<SetMacMapAclOutput>> setMacMapAcl(SetMacMapAclInput input)

Configure MAC mapping in the specified vBridge.

Specified by:

setMacMapAcl in interface VtnMacMapService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

getMacMappedHost

public Future<org.opendaylight.yangtools.yang.common.RpcResult<GetMacMappedHostOutput>> getMacMappedHost(GetMacMappedHostInput input)

Get a list of hosts where mapping is actually active based on MAC mapping configured in the specified vBridge.

Specified by:

getMacMappedHost in interface VtnMacMapService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.