org.opendaylight.lispflowmapping.northbound

Class LispMappingNorthbound

java.lang.Object

org.opendaylight.lispflowmapping.northbound.LispMappingNorthbound

All Implemented Interfaces:

ILispmappingNorthbound

public class LispMappingNorthbound
extends Object
implements ILispmappingNorthbound

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
LispMappingNorthbound()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addAuthKey(String containerName, AuthKeyNB authKeyNB) Set the authentication key for an EID prefix
javax.ws.rs.core.Response	addMapping(String containerName, MapRegisterNB mapRegisterNB) Add a mapping to the LISP mapping system
javax.ws.rs.core.Response	delAuthKey(String containerName, int afi, int iid, String address, int mask) Delete the key used to register an EID prefix
javax.ws.rs.core.Response	delAuthKey(String containerName, int iid, int afi, String srcAdd, int srcML, String dstAdd, int dstML) Delete the key used to register an EID prefix
void	destroy()
AuthKeyNB	getAuthKey(String containerName, int iid, int afi, String address, int mask) Retrieve the key used to register an EID prefix
AuthKeyNB	getAuthKey(String containerName, int iid, int afi, String srcAdd, int srcML, String dstAdd, int dstML) Retrieve a key used to register a Source-Destination LCAF EID prefix
org.opendaylight.lispflowmapping.type.lisp.EidToLocatorRecord	getMapping(String containerName, int iid, int afi, String address, int mask)
org.opendaylight.lispflowmapping.type.lisp.EidToLocatorRecord	getMapping(String containerName, int iid, int afi, String srcAdd, int srcML, String dstAdd, int dstML) Retrieve a mapping from the LISP mapping system, using Source-Destination LCAF as EID
org.opendaylight.lispflowmapping.interfaces.lisp.IFlowMapping	getMappingService()
protected String	getUserName()
void	init()
void	setSecurityContext(javax.ws.rs.core.SecurityContext context)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

Constructor Detail

LispMappingNorthbound

public LispMappingNorthbound()

Method Detail

setSecurityContext

@Context
public void setSecurityContext(javax.ws.rs.core.SecurityContext context)

getUserName

protected String getUserName()

getMappingService

public org.opendaylight.lispflowmapping.interfaces.lisp.IFlowMapping getMappingService()

Specified by:

getMappingService in interface ILispmappingNorthbound

init

public void init()

start

public void start()

stop

public void stop()

destroy

public void destroy()

addMapping

public javax.ws.rs.core.Response addMapping(String containerName,
                                   MapRegisterNB mapRegisterNB)

Add a mapping to the LISP mapping system

Parameters:

containerName - name of the container context in which the mapping needs to be added

mapRegisterNB - JSON object that contains the mapping information

Returns:

Text plain confirming reception

 Example:
 
 Request URL:
 http://localhost:8080/lispflowmapping/nb/v2/default/mapping
 
 Request body in JSON:
 
 { 
 "key" : "asdf", 
 "mapregister" : 
   { 
   "wantMapNotify" : true, 
   "proxyMapReply" : false, 
   "eidToLocatorRecords" : 
     [ 
       { 
       "authoritative" : true, 
       "prefixGeneric" : 
         { 
         "ipAddress" : "10.0.0.1", 
         "afi" : 1
         },
       "mapVersion" : 3, 
       "maskLength" : 32, 
       "action" : "NoAction", 
       "locators" : 
         [ 
           { 
           "multicastPriority" : 3, 
           "locatorGeneric" : 
             { 
             "ipAddress" : "3.3.3.3", 
             "afi" : 1
             }, 
           "routed" : true, 
           "multicastWeight" : 3, 
           "rlocProbed" : false, 
           "localLocator" : false, 
           "priority" : 3, 
           "weight" : 3 
           } 
         ], 
       "recordTtl" : 3 
       } 
     ], 
   "nonce" : 3, 
   "keyId" : 0 
   } 
 }
 

getMapping

public org.opendaylight.lispflowmapping.type.lisp.EidToLocatorRecord getMapping(String containerName,
                                                                       int iid,
                                                                       int afi,
                                                                       String address,
                                                                       int mask)

getMapping

public org.opendaylight.lispflowmapping.type.lisp.EidToLocatorRecord getMapping(String containerName,
                                                                       int iid,
                                                                       int afi,
                                                                       String srcAdd,
                                                                       int srcML,
                                                                       String dstAdd,
                                                                       int dstML)

Retrieve a mapping from the LISP mapping system, using Source-Destination LCAF as EID

Parameters:

containerName - name of the container context from which the mapping is going to be retrieved

iid - Instance-ID of the addresses (0 if none)

afi - Address Family of the addresses (IPv4, IPv6 or MAC)

srcAdd - Source address of type defined by afi

srcML - Network mask length of the source address

dstAdd - Destination address of type defined by afi

dstML - Network mask length of the destination address

Returns:

EidToLocatorRecord as a JSON object

 Example:
 
 Request URL:
 
      http://localhost:8080/lispflowmapping/nb/v2/default/mapping/0/1/10.0.0.1/32/20.0.0.2/32
 
 

addAuthKey

public javax.ws.rs.core.Response addAuthKey(String containerName,
                                   AuthKeyNB authKeyNB)

Set the authentication key for an EID prefix

Parameters:

containerName - name of the container context in which the key needs to be set

authKeyNB - JSON object that contains the key information

Returns:

Text plain confirming reception

 Example:
 
 Request URL:
 http://localhost:8080/lispflowmapping/nb/v2/default/key
 
 Request body in JSON:
 
 {
 "key" : "asdf",
 "maskLength" : 24,
 "address" :
 {
 "ipAddress" : "10.0.0.1",
 "afi" : 1
 }
 }
 
 

getAuthKey

public AuthKeyNB getAuthKey(String containerName,
                   int iid,
                   int afi,
                   String address,
                   int mask)

Retrieve the key used to register an EID prefix

Parameters:

containerName - name of the container context from which the key is going to be retrieved

afi - Address Family of the address (IPv4, IPv6 or MAC)

address - Address of type defined by afi

mask - Network mask length

Returns:

AuthKeyNB as a JSON object

 Example:
 
 Request URL:
 http://localhost:8080/lispflowmapping/nb/v2/default/key/0/1/10.0.0.1/32
 
 

getAuthKey

public AuthKeyNB getAuthKey(String containerName,
                   int iid,
                   int afi,
                   String srcAdd,
                   int srcML,
                   String dstAdd,
                   int dstML)

Retrieve a key used to register a Source-Destination LCAF EID prefix

Parameters:

containerName - name of the container context from which the key is going to be retrieved

afi - Address Family of the addresses (IPv4, IPv6 or MAC)

srcAdd - Source address of type defined by afi

srcML - Network mask length of the source address

dstAdd - Destination address of type defined by afi

dstML - Network mask length of the destination address

Returns:

AuthKeyNB as a JSON object

 Example:
 
 Request URL:
 
 http://localhost:8080/lispflowmapping/nb/v2/default/key/0/1/10.0.0.1/32/20.0.0.2/32
 
 

delAuthKey

public javax.ws.rs.core.Response delAuthKey(String containerName,
                                   int afi,
                                   int iid,
                                   String address,
                                   int mask)

Delete the key used to register an EID prefix

Parameters:

containerName - name of the container context from which the key is going to be deleted

afi - Address Family of the address (IPv4, IPv6 or MAC)

address - Address of type defined by afi

mask - Network mask length

Returns:

Text plain confirming deletion

 Example:
 
 Request URL:
 http://localhost:8080/lispflowmapping/nb/v2/default/key/0/1/10.0.0.1/32
 
 

delAuthKey

public javax.ws.rs.core.Response delAuthKey(String containerName,
                                   int iid,
                                   int afi,
                                   String srcAdd,
                                   int srcML,
                                   String dstAdd,
                                   int dstML)

Delete the key used to register an EID prefix

Parameters:

containerName - name of the container context from which the key is going to be retrieved

afi - Address Family of the addresses (IPv4, IPv6 or MAC)

srcAdd - Source address of type defined by afi

srcML - Network mask length of the source address

dstAdd - Destination address of type defined by afi

dstML - Network mask length of the destination address

Returns:

AuthKeyNB as a JSON object

 Example:
 
 Request URL:
 http://localhost:8080/lispflowmapping/nb/v2/default/key/0/1/10.0.0.1/32/20.0.0.2/32