org.opendaylight.lispflowmapping.implementation

Class MappingService

java.lang.Object

org.opendaylight.lispflowmapping.implementation.MappingService

All Implemented Interfaces:

AutoCloseable, IMappingService, OdlMappingserviceService, org.opendaylight.yangtools.yang.binding.RpcService

public class MappingService
extends Object
implements OdlMappingserviceService, IMappingService, AutoCloseable

Dispatcher of API calls that implements the RPC and Java APIs in mappingservice.yang and IMappingService respectively. It also coordinates and acts as container for all objects in charge of - saving and updating md-sal datastore stored mappings - monitoring md-sal datastore mapping updates and pushing them to the in memory mapping-system - in memory mapping-system

Author:

Lorand Jakab, Florin Coras

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.lispflowmapping.interfaces.mappingservice.IMappingService

IMappingService.LookupPolicy

Constructor Summary

Constructors

Constructor and Description
MappingService(org.opendaylight.controller.md.sal.binding.api.DataBroker broker, org.opendaylight.controller.md.sal.binding.api.NotificationPublishService notificationPublishService, ILispDAO lispDAO)

Method Summary

Modifier and Type	Method and Description
void	addAuthenticationKey(Eid key, MappingAuthkey authKey) Add authentication key.
void	addData(MappingOrigin origin, Eid key, String subKey, Object data) Generic addition of data.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	addKey(AddKeyInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	addKeys(AddKeysInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	addMapping(AddMappingInput input)
void	addMapping(MappingOrigin origin, Eid key, SiteId siteId, MappingData mappingData) Add mapping.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	addMappings(AddMappingsInput input)
MappingData	addNegativeMapping(Eid key) Generate and add a negative mapping entry originated from the southbound, and return the generated mapping.
void	cleanCachedMappings() Cleans all cached mappings.Used for testing.
void	close()
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetAllKeysOutput>>	getAllKeys()
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetAllMappingsOutput>>	getAllMappings()
MappingAuthkey	getAuthenticationKey(Eid key) Retrieve authentication key.
Object	getData(MappingOrigin origin, Eid key, String subKey) Generic retrieval of data.
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetKeyOutput>>	getKey(GetKeyInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetKeysOutput>>	getKeys(GetKeysInput input)
MappingData	getMapping(Eid key) Retrieves mapping for given key.The lookup policy for the key is defined in the Mapping System.
MappingData	getMapping(Eid srcKey, Eid dstKey) Retrieves mapping with a Source/Dest policy.
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetMappingOutput>>	getMapping(GetMappingInput input)
MappingData	getMapping(MappingOrigin origin, Eid key) Retrieves mapping with given origin for the provided key.
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetMappingsOutput>>	getMappings(GetMappingsInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetMappingWithXtrIdOutput>>	getMappingWithXtrId(GetMappingWithXtrIdInput input)
Eid	getParentPrefix(Eid key) Returns the parent prefix for given key.
Set<Subscriber>	getSubscribers(Eid eid) Retrieves the subscribers for an EID.
Set<Eid>	getSubtree(MappingOrigin origin, Eid key) Retrieves the subtree of a maskable prefix from the given map-cache.
Eid	getWidestNegativePrefix(Eid key) Retrieves widest negative prefix found in the Mapping System for given key.
void	initialize()
boolean	isMaster() Get cluster master status.
String	prettyPrintKeys() Print keys in cache in a human friendly format.
String	prettyPrintMappings() Print mappings in cache in a human friendly format.
String	printKeys() Print all authentication keys.
String	printMappings() Print all mappings.
void	refreshMappingRegistration(Eid key, XtrId xtrId, Long timestamp) Refresh southbound mapping registration timestamp.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	removeAllKeys()
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	removeAllMappings()
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	removeAllOperationalContent()
void	removeAuthenticationKey(Eid key) Remove authentication key.
void	removeData(MappingOrigin origin, Eid key, String subKey) Generic removal of data.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	removeKey(RemoveKeyInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	removeKeys(RemoveKeysInput input)
void	removeMapping(MappingOrigin origin, Eid key) Remove mapping.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	removeMapping(RemoveMappingInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	removeMappings(RemoveMappingsInput input)
void	setIsMaster(boolean isMaster) Set cluster master status.
void	setLookupPolicy(IMappingService.LookupPolicy policy) Configures Mapping Service mapping lookup policy option.
void	setMappingMerge(boolean mergeMapping) Configures Mapping Service mapping merge option.
void	subscribe(Subscriber subscriber, Eid subscribedEid) Subscribe a Subscriber to receive updates about mapping changes for an EID.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	updateKey(UpdateKeyInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	updateKeys(UpdateKeysInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	updateMapping(UpdateMappingInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	updateMappings(UpdateMappingsInput input)

Methods inherited from class java.lang.Object

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

Constructor Detail

MappingService

public MappingService(org.opendaylight.controller.md.sal.binding.api.DataBroker broker,
                      org.opendaylight.controller.md.sal.binding.api.NotificationPublishService notificationPublishService,
                      ILispDAO lispDAO)

Method Detail

setMappingMerge

public void setMappingMerge(boolean mergeMapping)

Description copied from interface: IMappingService

Configures Mapping Service mapping merge option. If set to false, mappings with the same key are overwritten, otherwise, mappings with the same key but from different xTR-IDs are all stored.

Specified by:

setMappingMerge in interface IMappingService

Parameters:

mergeMapping - enables or disables mapping merge

setLookupPolicy

public void setLookupPolicy(IMappingService.LookupPolicy policy)

Description copied from interface: IMappingService

Configures Mapping Service mapping lookup policy option.

Specified by:

setLookupPolicy in interface IMappingService

Parameters:

policy - the policy to be activated

initialize

public void initialize()

addKey

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> addKey(AddKeyInput input)

Specified by:

addKey in interface OdlMappingserviceService

addMapping

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> addMapping(AddMappingInput input)

Specified by:

addMapping in interface OdlMappingserviceService

addMapping

public void addMapping(MappingOrigin origin,
                       Eid key,
                       SiteId siteId,
                       MappingData mappingData)

Description copied from interface: IMappingService

Add mapping.

Specified by:

addMapping in interface IMappingService

Parameters:

origin - Table where mapping should be added

key - Key of the mapping

siteId - Site that stores the mapping

mappingData - Mapping to be stored

addNegativeMapping

public MappingData addNegativeMapping(Eid key)

Description copied from interface: IMappingService

Generate and add a negative mapping entry originated from the southbound, and return the generated mapping.

Specified by:

addNegativeMapping in interface IMappingService

Parameters:

key - Key of the mapping

Returns:

Returns the generated negative mapping (which is never null).

refreshMappingRegistration

public void refreshMappingRegistration(Eid key,
                                       XtrId xtrId,
                                       Long timestamp)

Description copied from interface: IMappingService

Refresh southbound mapping registration timestamp.

Specified by:

refreshMappingRegistration in interface IMappingService

Parameters:

key - The EID whose registration must be refreshed

xtrId - xTR-ID of the mapping to be refreshed

timestamp - New timestamp for the mapping

getKey

public Future<org.opendaylight.yangtools.yang.common.RpcResult<GetKeyOutput>> getKey(GetKeyInput input)

Specified by:

getKey in interface OdlMappingserviceService

Returns:

java.util.concurrent.Future key, or null if not present

getMapping

public Future<org.opendaylight.yangtools.yang.common.RpcResult<GetMappingOutput>> getMapping(GetMappingInput input)

Specified by:

getMapping in interface OdlMappingserviceService

Returns:

java.util.concurrent.Future mapping, or null if not present

getMapping

public MappingData getMapping(MappingOrigin origin,
                              Eid key)

Description copied from interface: IMappingService

Retrieves mapping with given origin for the provided key. The lookup policy for the key is defined in the Mapping System.

Specified by:

getMapping in interface IMappingService

Parameters:

origin - Table where the mapping should be looked up.

key - Key to be looked up

Returns:

Returns the mapping found in the Mapping System or null if nothing is found.

getMapping

public MappingData getMapping(Eid key)

Description copied from interface: IMappingService

Retrieves mapping for given key.The lookup policy for the key is defined in the Mapping System.

Specified by:

getMapping in interface IMappingService

Parameters:

key - Key to be looked up

Returns:

Returns the mapping found in the Mapping System or null if nothing is found.

getMapping

public MappingData getMapping(Eid srcKey,
                              Eid dstKey)

Description copied from interface: IMappingService

Retrieves mapping with a Source/Dest policy. This method is meant to avoid the overhead of building LcafSourceDest addresses.

Specified by:

getMapping in interface IMappingService

Parameters:

srcKey - Source key being looked up

dstKey - Destination key being looked up

Returns:

Returns the mapping found in the Mapping System or null if nothing is found.

subscribe

public void subscribe(Subscriber subscriber,
                      Eid subscribedEid)

Description copied from interface: IMappingService

Subscribe a Subscriber to receive updates about mapping changes for an EID.

Specified by:

subscribe in interface IMappingService

Parameters:

subscriber - The Subscriber object with information about the subscriber

subscribedEid - The EID for which the subscriber will receive updates

getSubscribers

public Set<Subscriber> getSubscribers(Eid eid)

Description copied from interface: IMappingService

Retrieves the subscribers for an EID.

Specified by:

getSubscribers in interface IMappingService

Parameters:

eid - The EID to be looked up

Returns:

The set of subscribers for the EID

getMappingWithXtrId

public Future<org.opendaylight.yangtools.yang.common.RpcResult<GetMappingWithXtrIdOutput>> getMappingWithXtrId(GetMappingWithXtrIdInput input)

Specified by:

getMappingWithXtrId in interface OdlMappingserviceService

Returns:

java.util.concurrent.Future mappingWithXtrId, or null if not present

removeKey

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> removeKey(RemoveKeyInput input)

Specified by:

removeKey in interface OdlMappingserviceService

removeMapping

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> removeMapping(RemoveMappingInput input)

Specified by:

removeMapping in interface OdlMappingserviceService

removeMapping

public void removeMapping(MappingOrigin origin,
                          Eid key)

Description copied from interface: IMappingService

Remove mapping.

Specified by:

removeMapping in interface IMappingService

Parameters:

origin - Table from where the mapping should be removed

key - Key to be removed

updateKey

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> updateKey(UpdateKeyInput input)

Specified by:

updateKey in interface OdlMappingserviceService

updateMapping

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> updateMapping(UpdateMappingInput input)

Specified by:

updateMapping in interface OdlMappingserviceService

removeKeys

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> removeKeys(RemoveKeysInput input)

Specified by:

removeKeys in interface OdlMappingserviceService

removeMappings

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> removeMappings(RemoveMappingsInput input)

Specified by:

removeMappings in interface OdlMappingserviceService

getKeys

public Future<org.opendaylight.yangtools.yang.common.RpcResult<GetKeysOutput>> getKeys(GetKeysInput input)

Specified by:

getKeys in interface OdlMappingserviceService

Returns:

java.util.concurrent.Future keys, or null if not present

addMappings

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> addMappings(AddMappingsInput input)

Specified by:

addMappings in interface OdlMappingserviceService

updateKeys

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> updateKeys(UpdateKeysInput input)

Specified by:

updateKeys in interface OdlMappingserviceService

removeAllMappings

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> removeAllMappings()

Specified by:

removeAllMappings in interface OdlMappingserviceService

removeAllKeys

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> removeAllKeys()

Specified by:

removeAllKeys in interface OdlMappingserviceService

getAllKeys

public Future<org.opendaylight.yangtools.yang.common.RpcResult<GetAllKeysOutput>> getAllKeys()

Specified by:

getAllKeys in interface OdlMappingserviceService

Returns:

java.util.concurrent.Future allKeys, or null if not present

updateMappings

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> updateMappings(UpdateMappingsInput input)

Specified by:

updateMappings in interface OdlMappingserviceService

addKeys

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> addKeys(AddKeysInput input)

Specified by:

addKeys in interface OdlMappingserviceService

getAllMappings

public Future<org.opendaylight.yangtools.yang.common.RpcResult<GetAllMappingsOutput>> getAllMappings()

Specified by:

getAllMappings in interface OdlMappingserviceService

Returns:

java.util.concurrent.Future allMappings, or null if not present

getMappings

public Future<org.opendaylight.yangtools.yang.common.RpcResult<GetMappingsOutput>> getMappings(GetMappingsInput input)

Specified by:

getMappings in interface OdlMappingserviceService

Returns:

java.util.concurrent.Future mappings, or null if not present

removeAllOperationalContent

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> removeAllOperationalContent()

Specified by:

removeAllOperationalContent in interface OdlMappingserviceService

getWidestNegativePrefix

public Eid getWidestNegativePrefix(Eid key)

Description copied from interface: IMappingService

Retrieves widest negative prefix found in the Mapping System for given key.

Specified by:

getWidestNegativePrefix in interface IMappingService

Parameters:

key - Key being looked up

Returns:

Returns the widest negative prefix or null if nothing is found.

getSubtree

public Set<Eid> getSubtree(MappingOrigin origin,
                           Eid key)

Description copied from interface: IMappingService

Retrieves the subtree of a maskable prefix from the given map-cache.

Specified by:

getSubtree in interface IMappingService

Parameters:

origin - Table where the key should be looked up

key - Key to be looked up

Returns:

The child prefixes of the prefix, including the prefix itself if present

addAuthenticationKey

public void addAuthenticationKey(Eid key,
                                 MappingAuthkey authKey)

Description copied from interface: IMappingService

Add authentication key.

Specified by:

addAuthenticationKey in interface IMappingService

Parameters:

key - The key for which the authentication key is added

authKey - The authentication key

getAuthenticationKey

public MappingAuthkey getAuthenticationKey(Eid key)

Description copied from interface: IMappingService

Retrieve authentication key.

Specified by:

getAuthenticationKey in interface IMappingService

Parameters:

key - The key for which the authentication key is being looked up.

Returns:

The authentication key.

removeAuthenticationKey

public void removeAuthenticationKey(Eid key)

Description copied from interface: IMappingService

Remove authentication key.

Specified by:

removeAuthenticationKey in interface IMappingService

Parameters:

key - Key for which the authentication key should be removed.

addData

public void addData(MappingOrigin origin,
                    Eid key,
                    String subKey,
                    Object data)

Description copied from interface: IMappingService

Generic addition of data. Not stored in MD-SAL datastore!

Specified by:

addData in interface IMappingService

Parameters:

origin - Table where data should be inserted

key - The key where data should be inserted

subKey - The subKey where data should be inserted

data - The data to be stored

getData

public Object getData(MappingOrigin origin,
                      Eid key,
                      String subKey)

Description copied from interface: IMappingService

Generic retrieval of data.

Specified by:

getData in interface IMappingService

Parameters:

origin - Table from where the data should be read

key - The key where the data is stored

subKey - The subKey where data is stored

Returns:

The data

removeData

public void removeData(MappingOrigin origin,
                       Eid key,
                       String subKey)

Description copied from interface: IMappingService

Generic removal of data.

Specified by:

removeData in interface IMappingService

Parameters:

origin - The table from where the data should be removed

key - The key of the data to be removed

subKey - The subKey of the data to be removed

getParentPrefix

public Eid getParentPrefix(Eid key)

Description copied from interface: IMappingService

Returns the parent prefix for given key.

Specified by:

getParentPrefix in interface IMappingService

Parameters:

key - The key which parent is to be returned.

Returns:

The parent perfix of a specific key.

printMappings

public String printMappings()

Description copied from interface: IMappingService

Print all mappings. Used for testing, debugging and the karaf shell.

Specified by:

printMappings in interface IMappingService

Returns:

String consisting of all mappings

prettyPrintMappings

public String prettyPrintMappings()

Description copied from interface: IMappingService

Print mappings in cache in a human friendly format.

Specified by:

prettyPrintMappings in interface IMappingService

Returns:

a String consisting of all the mappings in the cache

printKeys

public String printKeys()

Description copied from interface: IMappingService

Print all authentication keys. Used for testing, debugging and the karaf shell.

Specified by:

printKeys in interface IMappingService

Returns:

String consisting of all mappings

prettyPrintKeys

public String prettyPrintKeys()

Description copied from interface: IMappingService

Print keys in cache in a human friendly format.

Specified by:

prettyPrintKeys in interface IMappingService

Returns:

a String consisting of all the keys in the cache

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

cleanCachedMappings

public void cleanCachedMappings()

Description copied from interface: IMappingService

Cleans all cached mappings.Used for testing.

Specified by:

cleanCachedMappings in interface IMappingService

setIsMaster

public void setIsMaster(boolean isMaster)

Description copied from interface: IMappingService

Set cluster master status.

Specified by:

setIsMaster in interface IMappingService

Parameters:

isMaster - is|isn't master

isMaster

public boolean isMaster()

Description copied from interface: IMappingService

Get cluster master status.

Specified by:

isMaster in interface IMappingService

Returns:

isMaster is|isn't master