org.opendaylight.lispflowmapping.interfaces.mappingservice

Interface IMappingService

All Known Implementing Classes:

MappingService

public interface IMappingService

Mapping Service Java API

Author:

Florin Coras

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.
void	addMapping(MappingOrigin origin, Eid key, SiteId siteId, Object data) Add mapping
void	cleanCachedMappings() Cleans all cached mappings.Used for testing.
MappingAuthkey	getAuthenticationKey(Eid key) Retrieve authentication key
Object	getData(MappingOrigin origin, Eid key, String subKey) Generic retrieval of data
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.
Object	getMapping(MappingOrigin origin, Eid key) Retrieves mapping with given origin for the provided key.
String	printMappings() Print all mappings.
void	removeAuthenticationKey(Eid key) Remove authentication key
void	removeData(MappingOrigin origin, Eid key, String subKey) Generic removal of data
void	removeMapping(MappingOrigin origin, Eid key) Remove mapping
void	setMappingOverwrite(boolean overwrite) Configures Mapping Service mapping overwrite option.

Method Detail

addMapping

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

Add mapping

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

Object getMapping(MappingOrigin origin,
                Eid key)

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

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

Object getMapping(Eid key)

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

Parameters:

key - Key to be looked up

Returns:

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

getMapping

Object getMapping(Eid srcKey,
                Eid dstKey)

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

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

void removeMapping(MappingOrigin origin,
                 Eid key)

Remove mapping

Parameters:

origin - Table from where the mapping should be removed

key - Key to be removed

addAuthenticationKey

void addAuthenticationKey(Eid key,
                        MappingAuthkey authKey)

Add authentication key

Parameters:

key - The key for which the authentication key is added

authKey - The authentication key

getAuthenticationKey

MappingAuthkey getAuthenticationKey(Eid key)

Retrieve authentication key

Parameters:

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

Returns:

The authentication key.

removeAuthenticationKey

void removeAuthenticationKey(Eid key)

Remove authentication key

Parameters:

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

addData

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

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

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

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

Generic retrieval of data

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

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

Generic removal of data

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

setMappingOverwrite

void setMappingOverwrite(boolean overwrite)

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

Parameters:

overwrite - enables or disables mapping overwrite

printMappings

String printMappings()

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

Returns:

String consisting of all mappings

cleanCachedMappings

void cleanCachedMappings()

Cleans all cached mappings.Used for testing.