org.opendaylight.lispflowmapping.interfaces.mapcache

Interface IMapCache

All Known Implementing Classes:

FlatMapCache, MultiTableMapCache, SimpleMapCache

public interface IMapCache

Map-cache interface

Author:

Florin Coras

Method Summary

Methods

Modifier and Type	Method and Description
void	addAuthenticationKey(Eid key, MappingAuthkey authKey) Add authentication key
void	addData(Eid key, String subKey, Object data) Add data for key
void	addMapping(Eid key, Object data, boolean shouldOverwrite) Add mapping
MappingAuthkey	getAuthenticationKey(Eid key) Retrieve authentication key
Object	getData(Eid key, String subKey) Generic retrieval of data
Object	getMapping(Eid srcKey, Eid dstKey) Retrieves mapping for the provided srcKey and dstKey.
String	printMappings() Print mappings in cache.
void	removeAuthenticationKey(Eid key) Remove authentication key
void	removeData(Eid key, String subKey) Generic removal of data
void	removeMapping(Eid key, boolean overwrite) Remove mapping
void	updateMappingRegistration(Eid key) Update key registration

Method Detail

addMapping

void addMapping(Eid key,
              Object data,
              boolean shouldOverwrite)

Add mapping

Parameters:

key - Key of the mapping

data - Value to be stored

shouldOverwrite - Select if mappings with the same key are overwritten

getMapping

Object getMapping(Eid srcKey,
                Eid dstKey)

Retrieves mapping for the provided srcKey and dstKey.

Parameters:

srcKey - Source Key to be looked up

dstKey - Destination Key to be looked up

Returns:

Returns the object found in the cache or null if nothing is found.

removeMapping

void removeMapping(Eid key,
                 boolean overwrite)

Remove mapping

Parameters:

key - Key to be removed

overwrite - Select if mappings with the same key were overwritten on store

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.

updateMappingRegistration

void updateMappingRegistration(Eid key)

Update key registration

Parameters:

key - The key whose registration must be updated

addData

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

Add data for key

Parameters:

key - The key for which data is inserted

subKey - The subKey where data should be inserted

data - The data to be stored

getData

Object getData(Eid key,
             String subKey)

Generic retrieval of data

Parameters:

key - The key where the data is stored

subKey - The subKey where data is stored

Returns:

The data

removeData

void removeData(Eid key,
              String subKey)

Generic removal of data

Parameters:

key - The key of the data to be removed

subKey - The subKey of the data to be removed

printMappings

String printMappings()

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

Returns:

a String consisting of all the mappings in the cache