org.opendaylight.lispflowmapping.interfaces.mapcache

Interface IMappingSystem

All Known Implementing Classes:

MappingSystem

public interface IMappingSystem

Mapping System interface

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) Add data for key
void	addMapping(MappingOrigin origin, Eid key, Object data) Add mapping
MappingAuthkey	getAuthenticationKey(Eid key) Retrieve authentication key
Object	getData(MappingOrigin origin, Eid key, String subKey) Generic retrieval of data
Object	getMapping(Eid dst) Retrieves mapping for the provided dst key.
Object	getMapping(Eid src, Eid dst) Retrieves mapping for the provided src and dst key.
Object	getMapping(MappingOrigin origin, Eid key) Retrieves mapping from table for 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	setIterateMask(boolean iterate) Sets iterateMask.
void	setOverwritePolicy(boolean overwrite) Configure overwrite policy.
void	updateMappingRegistration(MappingOrigin origin, Eid key) Update key registration

Method Detail

addMapping

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

Add mapping

Parameters:

origin - Table where mapping should be added

key - Key of the mapping

data - Value to be stored

getMapping

Object getMapping(Eid src,
                Eid dst)

Retrieves mapping for the provided src and dst key.

Parameters:

src - Source Key to be looked up

dst - Destination Key to be looked up

Returns:

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

getMapping

Object getMapping(Eid dst)

Retrieves mapping for the provided dst key.

Parameters:

dst - Destination Key to be looked up

Returns:

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

getMapping

Object getMapping(MappingOrigin origin,
                Eid key)

Retrieves mapping from table for provided key

Parameters:

origin - Table where mapping should be looked up

key - Key to be looked up

Returns:

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

updateMappingRegistration

void updateMappingRegistration(MappingOrigin origin,
                             Eid key)

Update key registration

Parameters:

origin - Table for mapping that should be updated

key - The key whose registration must be updated

removeMapping

void removeMapping(MappingOrigin origin,
                 Eid key)

Remove mapping

Parameters:

origin - Table for mapping that 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)

Add data for key

Parameters:

origin - Table for data that should be added

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(MappingOrigin origin,
             Eid key,
             String subKey)

Generic retrieval of data

Parameters:

origin - Table from where data should be retrieved

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 - Table from where data should be removed

key - The key of the data to be removed

subKey - The subKey of the data to be removed

setIterateMask

void setIterateMask(boolean iterate)

Sets iterateMask. If set to true, longest prefix matching for IP keys is used.

Parameters:

iterate - Value to configure

setOverwritePolicy

void setOverwritePolicy(boolean overwrite)

Configure overwrite policy. If set to true, mappings are overwritten.

Parameters:

overwrite - Value to configure

printMappings

String printMappings()

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

Returns:

String consisting of all mappings