org.opendaylight.lispflowmapping.implementation

Class MappingService

java.lang.Object

org.opendaylight.lispflowmapping.implementation.MappingService

All Implemented Interfaces:

AutoCloseable, org.opendaylight.controller.sal.binding.api.BindingAwareProvider, IMappingService, OdlMappingserviceService, org.opendaylight.yangtools.yang.binding.RpcService

public class MappingService
extends Object
implements OdlMappingserviceService, IMappingService, org.opendaylight.controller.sal.binding.api.BindingAwareProvider, 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

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
MappingService()

Method Summary

Methods

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, Object data) Add mapping
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	addMappings(AddMappingsInput input)
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)
Object	getMapping(Eid key) Retrieves mapping for given key.The lookup policy for the key is defined in the Mapping System
Object	getMapping(Eid srcKey, Eid dstKey) Retrieves mapping with a Source/Dest policy.
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetMappingOutput>>	getMapping(GetMappingInput input)
Object	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)
void	initialize()
void	onSessionInitiated(org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderContext session)
String	printMappings() Print all mappings.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	removeAllKeys()
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	removeAllMappings()
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	setBindingAwareBroker(org.opendaylight.controller.sal.binding.api.BindingAwareBroker broker)
void	setDaoService(ILispDAO dao)
void	setDataBroker(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker)
void	setMappingOverwrite(boolean overwrite) Configures Mapping Service mapping overwrite option.
void	setNotificationPublishService(org.opendaylight.controller.md.sal.binding.api.NotificationPublishService nps)
void	setRpcProviderRegistry(org.opendaylight.controller.sal.binding.api.RpcProviderRegistry rpc)
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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

Constructor Detail

MappingService

public MappingService()

Method Detail

setDataBroker

public void setDataBroker(org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker)

setRpcProviderRegistry

public void setRpcProviderRegistry(org.opendaylight.controller.sal.binding.api.RpcProviderRegistry rpc)

setBindingAwareBroker

public void setBindingAwareBroker(org.opendaylight.controller.sal.binding.api.BindingAwareBroker broker)

setNotificationPublishService

public void setNotificationPublishService(org.opendaylight.controller.md.sal.binding.api.NotificationPublishService nps)

setDaoService

public void setDaoService(ILispDAO dao)

setMappingOverwrite

public void setMappingOverwrite(boolean overwrite)

Description copied from interface: IMappingService

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

Specified by:

setMappingOverwrite in interface IMappingService

Parameters:

overwrite - enables or disables mapping overwrite

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

getKey

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

Specified by:

getKey in interface OdlMappingserviceService

getMapping

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

Specified by:

getMapping in interface OdlMappingserviceService

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

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

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

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

getMappings

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

Specified by:

getMappings in interface OdlMappingserviceService

addMapping

public void addMapping(MappingOrigin origin,
              Eid key,
              SiteId siteId,
              Object data)

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

data - Value to be stored

getMapping

public Object 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 object found in the Mapping System or null if nothing is found.

getMapping

public Object 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 object found in the Mapping System or null if nothing is found.

getMapping

public Object 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 object found in the Mapping System or null if nothing is found.

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

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

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

onSessionInitiated

public void onSessionInitiated(org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderContext session)

Specified by:

onSessionInitiated in interface org.opendaylight.controller.sal.binding.api.BindingAwareProvider

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