Merge "Bug 6297: Change subscriber's RLOC selection algo"
[lispflowmapping.git] / mappingservice / southbound / src / main / java / org / opendaylight / lispflowmapping / southbound / lisp / LispSouthboundHandler.java
index b1728c1b8cc56314f558b407c53331f93fbd5594..dba899a532b299af0db0a43e37ec82151807d430 100644 (file)
@@ -8,6 +8,8 @@
 
 package org.opendaylight.lispflowmapping.southbound.lisp;
 
+import com.google.common.base.Preconditions;
+
 import io.netty.buffer.ByteBufUtil;
 import io.netty.channel.ChannelHandler;
 import io.netty.channel.ChannelHandlerContext;
@@ -16,52 +18,90 @@ import io.netty.channel.socket.DatagramPacket;
 
 import java.net.InetAddress;
 import java.nio.ByteBuffer;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
 
+import org.opendaylight.controller.md.sal.binding.api.DataBroker;
 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
-import org.opendaylight.lispflowmapping.southbound.LispSouthboundPlugin;
-import org.opendaylight.lispflowmapping.southbound.LispSouthboundStats;
-import org.opendaylight.lispflowmapping.southbound.util.LispNotificationHelper;
-import org.opendaylight.lispflowmapping.lisp.type.LispMessage;
-import org.opendaylight.lispflowmapping.lisp.util.ByteUtil;
-import org.opendaylight.lispflowmapping.lisp.util.MapRequestUtil;
+import org.opendaylight.lispflowmapping.dsbackend.DataStoreBackEnd;
+import org.opendaylight.lispflowmapping.inmemorydb.HashMapDb;
+import org.opendaylight.lispflowmapping.lisp.authentication.ILispAuthentication;
+import org.opendaylight.lispflowmapping.lisp.authentication.LispAuthenticationUtil;
 import org.opendaylight.lispflowmapping.lisp.serializer.MapNotifySerializer;
 import org.opendaylight.lispflowmapping.lisp.serializer.MapRegisterSerializer;
 import org.opendaylight.lispflowmapping.lisp.serializer.MapReplySerializer;
 import org.opendaylight.lispflowmapping.lisp.serializer.MapRequestSerializer;
+import org.opendaylight.lispflowmapping.lisp.type.LispMessage;
+import org.opendaylight.lispflowmapping.lisp.util.ByteUtil;
+import org.opendaylight.lispflowmapping.lisp.util.LispAddressStringifier;
+import org.opendaylight.lispflowmapping.lisp.util.MapRequestUtil;
+import org.opendaylight.lispflowmapping.mapcache.SimpleMapCache;
+import org.opendaylight.lispflowmapping.southbound.LispSouthboundPlugin;
+import org.opendaylight.lispflowmapping.southbound.LispSouthboundStats;
+import org.opendaylight.lispflowmapping.southbound.lisp.cache.MapRegisterCache;
+import org.opendaylight.lispflowmapping.southbound.lisp.cache.MapRegisterPartialDeserializer;
 import org.opendaylight.lispflowmapping.southbound.lisp.exception.LispMalformedPacketException;
 import org.opendaylight.lispflowmapping.southbound.lisp.network.PacketHeader;
+import org.opendaylight.lispflowmapping.southbound.util.LispNotificationHelper;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.AddMappingBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.GotMapNotifyBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.GotMapReplyBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MessageType;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapNotify;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapRegister;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapRequest;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapReply;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapRequest;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MappingKeepAlive;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MappingKeepAliveBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MessageType;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.RequestMappingBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.key.container.MapRegisterCacheKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.metadata.container.MapRegisterCacheMetadata;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.metadata.container.MapRegisterCacheMetadataBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.metadata.container.map.register.cache.metadata.EidLispAddress;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.metadata.container.map.register.cache.metadata.EidLispAddressBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.value.grouping.MapRegisterCacheValue;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.value.grouping.MapRegisterCacheValueBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecord;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.list.MappingRecordItem;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddressBuilder;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.PortNumber;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.db.instance.AuthenticationKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.authkey.container.MappingAuthkey;
+import org.opendaylight.yangtools.yang.binding.Notification;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 @ChannelHandler.Sharable
 public class LispSouthboundHandler extends SimpleChannelInboundHandler<DatagramPacket>
-        implements ILispSouthboundService {
+        implements ILispSouthboundService, AutoCloseable {
+    private MapRegisterCache mapRegisterCache;
+    private boolean mapRegisterCacheEnabled = true;
+    private long mapRegisterCacheTimeout;
+
+    private DataBroker dataBroker;
     private NotificationPublishService notificationPublishService;
+
     protected static final Logger LOG = LoggerFactory.getLogger(LispSouthboundHandler.class);
 
+    //TODO: think whether this field can be accessed through mappingservice or some other configuration parameter
+    private boolean authenticationEnabled = true;
     private final LispSouthboundPlugin lispSbPlugin;
     private LispSouthboundStats lispSbStats = null;
+    private SimpleMapCache smc;
+    private AuthenticationKeyDataListener authenticationKeyDataListener;
+    private DataStoreBackEnd dsbe;
 
     public LispSouthboundHandler(LispSouthboundPlugin lispSbPlugin) {
         this.lispSbPlugin = lispSbPlugin;
         if (lispSbPlugin != null) {
             this.lispSbStats = lispSbPlugin.getStats();
         }
-    }
-
-    public void setNotificationProvider(NotificationPublishService nps) {
-        this.notificationPublishService = nps;
+        this.mapRegisterCache = new MapRegisterCache();
+        this.smc = new SimpleMapCache(new HashMapDb());
     }
 
     public void handlePacket(DatagramPacket msg) {
@@ -74,7 +114,7 @@ public class LispSouthboundHandler extends SimpleChannelInboundHandler<DatagramP
             handleEncapsulatedControlMessage(inBuffer, msg.sender().getAddress());
         } else if (lispType == MessageType.MapRequest) {
             LOG.trace("Received packet of type Map-Request");
-            handleMapRequest(inBuffer, msg.sender().getPort());
+            handleMapRequest(inBuffer, msg.sender().getAddress(), msg.sender().getPort());
         } else if (lispType == MessageType.MapRegister) {
             LOG.trace("Received packet of type Map-Register");
             handleMapRegister(inBuffer, msg.sender().getAddress(), msg.sender().getPort());
@@ -91,16 +131,16 @@ public class LispSouthboundHandler extends SimpleChannelInboundHandler<DatagramP
 
     private void handleEncapsulatedControlMessage(ByteBuffer inBuffer, InetAddress sourceAddress) {
         try {
-            handleMapRequest(inBuffer, extractEncapsulatedSourcePort(inBuffer));
+            handleMapRequest(inBuffer, sourceAddress, extractEncapsulatedSourcePort(inBuffer));
         } catch (RuntimeException re) {
             throw new LispMalformedPacketException("Couldn't deserialize Map-Request (len="
                     + inBuffer.capacity() + ")", re);
         }
     }
 
-    private void handleMapRequest(ByteBuffer inBuffer, int port) {
+    private void handleMapRequest(ByteBuffer inBuffer, InetAddress sourceAddress, int port) {
         try {
-            MapRequest request = MapRequestSerializer.getInstance().deserialize(inBuffer);
+            MapRequest request = MapRequestSerializer.getInstance().deserialize(inBuffer, sourceAddress);
             InetAddress finalSourceAddress = MapRequestUtil.selectItrRloc(request);
             if (finalSourceAddress == null) {
                 throw new LispMalformedPacketException("Couldn't deserialize Map-Request, no ITR Rloc found!");
@@ -151,19 +191,57 @@ public class LispSouthboundHandler extends SimpleChannelInboundHandler<DatagramP
 
     private void handleMapRegister(ByteBuffer inBuffer, InetAddress sourceAddress, int port) {
         try {
-            MapRegister mapRegister = MapRegisterSerializer.getInstance().deserialize(inBuffer, sourceAddress);
-            AddMappingBuilder addMappingBuilder = new AddMappingBuilder();
-            addMappingBuilder.setMapRegister(LispNotificationHelper.convertMapRegister(mapRegister));
-            TransportAddressBuilder transportAddressBuilder = new TransportAddressBuilder();
-            transportAddressBuilder.setIpAddress(LispNotificationHelper
-                    .getIpAddressBinaryFromInetAddress(sourceAddress));
-            transportAddressBuilder.setPort(new PortNumber(port));
-            addMappingBuilder.setTransportAddress(transportAddressBuilder.build());
-            if (notificationPublishService != null) {
-                notificationPublishService.putNotification(addMappingBuilder.build());
-                LOG.trace("MapRegister was published!");
+            Map.Entry<MapRegisterCacheKey, byte[]> artificialEntry = null;
+            MapRegisterCacheKey cacheKey = null;
+            MapRegisterCacheValue cacheValue = null;
+            if (mapRegisterCacheEnabled) {
+                artificialEntry = MapRegisterPartialDeserializer.deserializePartially(inBuffer, sourceAddress);
+                cacheKey = artificialEntry == null ? null : artificialEntry.getKey();
+                cacheValue = resolveCacheValue(artificialEntry);
+            }
+            if (cacheValue != null) {
+                MapRegisterCacheMetadata mapRegisterMeta = cacheValue.getMapRegisterCacheMetadata();
+                LOG.debug("Map register message site-ID: {} xTR-ID: {} from cache.", mapRegisterMeta.getSiteId(),
+                        mapRegisterMeta.getXtrId());
+                cacheValue = refreshEntry(cacheKey);
+                if (cacheValue != null) {
+                    sendNotificationIfPossible(createMappingKeepAlive(cacheValue));
+                    if (cacheValue.getMapRegisterCacheMetadata().isWantMapNotify()) {
+                        sendMapNotifyMsg(inBuffer, sourceAddress, port, cacheValue);
+                    }
+                }
+                lispSbStats.incrementCacheHits();
             } else {
-                LOG.warn("Notification Provider is null!");
+                MapRegister mapRegister = MapRegisterSerializer.getInstance().deserialize(inBuffer, sourceAddress);
+                final MappingAuthkey mappingAuthkey = tryToAuthenticateMessage(mapRegister, inBuffer);
+                if (mappingAuthkey != null) {
+                    AddMappingBuilder addMappingBuilder = new AddMappingBuilder();
+                    addMappingBuilder.setMapRegister(LispNotificationHelper.convertMapRegister(mapRegister));
+                    TransportAddressBuilder transportAddressBuilder = new TransportAddressBuilder();
+                    transportAddressBuilder.setIpAddress(LispNotificationHelper.getIpAddressBinaryFromInetAddress(
+                            sourceAddress));
+                    transportAddressBuilder.setPort(new PortNumber(port));
+                    addMappingBuilder.setTransportAddress(transportAddressBuilder.build());
+                    sendNotificationIfPossible(addMappingBuilder.build());
+                    if (artificialEntry != null) {
+                        final MapRegisterCacheMetadataBuilder cacheMetadataBldNew = new
+                                MapRegisterCacheMetadataBuilder();
+                        cacheMetadataBldNew.setEidLispAddress(provideEidPrefixesFromMessage(mapRegister));
+                        cacheMetadataBldNew.setXtrId(mapRegister.getXtrId());
+                        cacheMetadataBldNew.setSiteId(mapRegister.getSiteId());
+                        cacheMetadataBldNew.setWantMapNotify(mapRegister.isWantMapNotify());
+                        cacheMetadataBldNew.setMergeEnabled(mapRegister.isMergeEnabled());
+                        cacheMetadataBldNew.setTimestamp(System.currentTimeMillis());
+
+                        final MapRegisterCacheValueBuilder cacheValueBldNew = new MapRegisterCacheValueBuilder();
+                        cacheValueBldNew.setPacketData(artificialEntry.getValue());
+                        cacheValueBldNew.setMappingAuthkey(mappingAuthkey);
+                        cacheValueBldNew.setMapRegisterCacheMetadata(cacheMetadataBldNew.build());
+
+                        mapRegisterCache.addEntry(cacheKey, cacheValueBldNew.build());
+                    }
+                }
+                lispSbStats.incrementCacheMisses();
             }
         } catch (RuntimeException re) {
             throw new LispMalformedPacketException("Couldn't deserialize Map-Register (len="
@@ -173,6 +251,192 @@ public class LispSouthboundHandler extends SimpleChannelInboundHandler<DatagramP
         }
     }
 
+    private MapRegisterCacheValue refreshEntry(final MapRegisterCacheKey cacheKey) {
+        MapRegisterCacheValue mapRegisterCacheValue = mapRegisterCache.refreshEntry(cacheKey);
+        if (mapRegisterCacheValue != null) {
+            mapRegisterCacheValue = refreshAuthKeyIfNecessary(mapRegisterCacheValue);
+            mapRegisterCache.addEntry(cacheKey, mapRegisterCacheValue);
+            return mapRegisterCacheValue;
+        }
+        return null;
+    }
+
+    private MapRegisterCacheValue refreshAuthKeyIfNecessary(MapRegisterCacheValue mapRegisterCacheValue) {
+        if (authenticationKeyDataListener.isAuthKeyRefreshing()) {
+            final boolean shouldAuthKeyRefreshingStop = System.currentTimeMillis() - authenticationKeyDataListener
+                    .getAuthKeyRefreshingDate() > mapRegisterCacheTimeout;
+            if (shouldAuthKeyRefreshingStop) {
+                authenticationKeyDataListener.setAuthKeyRefreshing(false);
+            } else {
+                final MappingAuthkey mappingAuthkey = provideAuthenticateKey(mapRegisterCacheValue
+                        .getMapRegisterCacheMetadata().getEidLispAddress());
+
+                final MapRegisterCacheValueBuilder newMapRegisterCacheValueBuilder = new MapRegisterCacheValueBuilder
+                        (mapRegisterCacheValue);
+                final MapRegisterCacheMetadataBuilder newMapRegisterCacheMetadataBuilder =
+                        new MapRegisterCacheMetadataBuilder(mapRegisterCacheValue.getMapRegisterCacheMetadata());
+
+                newMapRegisterCacheValueBuilder.setMappingAuthkey(mappingAuthkey);
+                newMapRegisterCacheValueBuilder.setMapRegisterCacheMetadata(newMapRegisterCacheMetadataBuilder.build());
+                return newMapRegisterCacheValueBuilder.build();
+            }
+        }
+
+        return mapRegisterCacheValue;
+
+    }
+
+    private MapRegisterCacheValue resolveCacheValue(Map.Entry<MapRegisterCacheKey, byte[]> entry) {
+        if (entry != null) {
+            final MapRegisterCacheValue mapRegisterCacheValue = mapRegisterCache.getEntry(entry.getKey());
+            if (mapRegisterCacheValue != null) {
+                final long creationTime = mapRegisterCacheValue.getMapRegisterCacheMetadata().getTimestamp();
+                final long currentTime = System.currentTimeMillis();
+                if (currentTime - creationTime > mapRegisterCacheTimeout) {
+                    mapRegisterCache.removeEntry(entry.getKey());
+                    return null;
+                } else if (Arrays.equals(mapRegisterCacheValue.getPacketData(), entry.getValue())) {
+                    return mapRegisterCacheValue;
+                }
+            }
+        }
+        return null;
+    }
+
+    private void sendNotificationIfPossible(final Notification notification) throws InterruptedException {
+        if (notificationPublishService != null) {
+            notificationPublishService.putNotification(notification);
+            LOG.trace("{} was published.", notification.getClass());
+        } else {
+            LOG.warn("Notification Provider is null!");
+        }
+    }
+
+    private MappingKeepAlive createMappingKeepAlive(final MapRegisterCacheValue value) {
+        MappingKeepAliveBuilder mappingKeepAliveBuilder = new MappingKeepAliveBuilder();
+        mappingKeepAliveBuilder.setMapRegisterCacheMetadata(value.getMapRegisterCacheMetadata());
+        return mappingKeepAliveBuilder.build();
+    }
+
+    /**
+     * Returns null if not all of eids have the same value of authentication key
+     */
+    private MappingAuthkey provideAuthenticateKey(final List<EidLispAddress> eidLispAddresses) {
+        MappingAuthkey firstAuthKey = null;
+        for (int i = 0; i < eidLispAddresses.size(); i++) {
+            final Eid eid = eidLispAddresses.get(i).getEid();
+            if (i == 0) {
+                firstAuthKey = smc.getAuthenticationKey(eid);
+            } else {
+                final MappingAuthkey authKey = smc.getAuthenticationKey(eid);
+                if (!Objects.equals(firstAuthKey, authKey)) {
+                    return null;
+                }
+            }
+        }
+        return firstAuthKey;
+
+    }
+
+    private void sendMapNotifyMsg(final ByteBuffer inBuffer, final InetAddress inetAddress, int portNumber,
+                                  MapRegisterCacheValue mapRegisterValue) {
+        if (mapRegisterValue.getMappingAuthkey().getKeyType() != null) {
+            ByteBuffer outBuffer = transformMapRegisterToMapNotify(inBuffer);
+            if (mapRegisterValue.getMappingAuthkey().getKeyType() != 0) {
+                outBuffer = calculateAndSetNewMAC(outBuffer, mapRegisterValue.getMappingAuthkey().getKeyString());
+            }
+            outBuffer.position(0);
+            lispSbPlugin.handleSerializedLispBuffer(inetAddress, outBuffer, MessageType.MapNotify, portNumber);
+        } else {
+            LOG.error("Map-Register Cache: authentication succeeded, but can't find auth key for sending Map-Notify");
+        }
+    }
+
+    /**
+     * Calculates new message authentication code (MAC) for notify message.
+     *
+     * @param buffer
+     * @return
+     */
+    private ByteBuffer calculateAndSetNewMAC(final ByteBuffer buffer, final String authKey) {
+        final byte[] authenticationData = LispAuthenticationUtil.createAuthenticationData(buffer, authKey);
+        buffer.position(ILispAuthentication.MAP_REGISTER_AND_NOTIFY_AUTHENTICATION_POSITION);
+        buffer.put(authenticationData);
+        return buffer;
+    }
+
+    private ByteBuffer transformMapRegisterToMapNotify(final ByteBuffer buffer) {
+        buffer.position(0);
+        byte typeAndFlags = buffer.get(0);
+        // Shift the xTR-ID present and built for an RTR bits to their correct position
+        byte flags = (byte) ((typeAndFlags << 2) & 0x0F);
+        // Set control message type to 4 (Map-Notify)
+        byte type = 0x40;
+        // Combine the nibbles
+        typeAndFlags = (byte) (type | flags);
+        byte[] byteReplacement = new byte[] {typeAndFlags, 0x00, 0x00};
+        buffer.put(byteReplacement);
+
+        return buffer;
+    }
+
+    private List<EidLispAddress> provideEidPrefixesFromMessage(final MapRegister mapRegister) {
+        List<EidLispAddress> eidsResult = new ArrayList<>();
+        for (MappingRecordItem mappingRecordItem : mapRegister.getMappingRecordItem()) {
+            final EidLispAddressBuilder eidLispAddressBuilder = new EidLispAddressBuilder();
+            final Eid eid = mappingRecordItem.getMappingRecord().getEid();
+            eidLispAddressBuilder.setEidLispAddressId(LispAddressStringifier.getString(eid));
+            eidLispAddressBuilder.setEid(eid);
+            eidsResult.add(eidLispAddressBuilder.build());
+        }
+        return eidsResult;
+    }
+
+    /**
+     * Checks whether authentication data is valid.
+     *
+     * Methods pass through all records from map register message. For the EID of the first record it gets
+     * authentication key and does validation of authentication data again this authentication key. If it pass
+     * it just checks for remaining records (and its EID) whether they have the same authenticatin key stored in
+     * simple map cache (smc).
+     *
+     * @param mapRegister
+     * @param byteBuffer
+     * @return Returns authentication key if all of EIDs have the same authentication key or null otherwise
+     */
+    private MappingAuthkey tryToAuthenticateMessage(final MapRegister mapRegister, final ByteBuffer byteBuffer) {
+        if (!authenticationEnabled) {
+            return null;
+        }
+
+        if (smc == null) {
+            LOG.debug("Simple map cache wasn't instantieted and set.");
+            return null;
+        }
+
+        MappingAuthkey firstAuthKey = null;
+        final List<MappingRecordItem> mappingRecords = mapRegister.getMappingRecordItem();
+        for (int i = 0; i < mappingRecords.size(); i++) {
+            final MappingRecordItem recordItem = mappingRecords.get(i);
+            final MappingRecord mappingRecord = recordItem.getMappingRecord();
+            if (i == 0) {
+                firstAuthKey = smc.getAuthenticationKey(mappingRecord.getEid());
+                if (!LispAuthenticationUtil.validate(mapRegister, byteBuffer, mappingRecord.getEid(), firstAuthKey)) {
+                    return null;
+                }
+            } else {
+                final Eid eid = mappingRecord.getEid();
+                final MappingAuthkey authKey = smc.getAuthenticationKey(eid);
+                if (!firstAuthKey.equals(authKey)) {
+                    LOG.debug("Map register packet contained several eids. Authentication keys for first one and for " +
+                            "{} are different.",LispAddressStringifier.getString(eid));
+                    return null;
+                }
+            }
+        }
+        return firstAuthKey;
+    }
+
     private void handleMapNotify(ByteBuffer inBuffer, InetAddress sourceAddress, int port) {
         try {
             MapNotify mapNotify = MapNotifySerializer.getInstance().deserialize(inBuffer);
@@ -197,6 +461,7 @@ public class LispSouthboundHandler extends SimpleChannelInboundHandler<DatagramP
         }
     }
 
+
     private void handleMapReply(ByteBuffer inBuffer, InetAddress sourceAddress, int port) {
         try {
             MapReply mapReply = MapReplySerializer.getInstance().deserialize(inBuffer);
@@ -249,4 +514,57 @@ public class LispSouthboundHandler extends SimpleChannelInboundHandler<DatagramP
     public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
         LOG.error("Error on channel: " + cause, cause);
     }
+
+    @Override
+    public void close() throws Exception {
+        authenticationKeyDataListener.closeDataChangeListener();
+    }
+
+    public void setSimpleMapCache(final SimpleMapCache smc) {
+        this.smc = smc;
+    }
+
+    public void setDataBroker(final DataBroker dataBroker) {
+        this.dataBroker = dataBroker;
+    }
+
+    public void setNotificationProvider(NotificationPublishService nps) {
+        this.notificationPublishService = nps;
+    }
+
+    public void setMapRegisterCache(final MapRegisterCache mapRegisterCache) {
+        this.mapRegisterCache = mapRegisterCache;
+    }
+
+    public void setMapRegisterCacheEnabled(final boolean mapRegisterCacheEnabled) {
+        this.mapRegisterCacheEnabled = mapRegisterCacheEnabled;
+    }
+
+    /**
+    * Restore all keys from MDSAL datastore
+    */
+   public void restoreDaoFromDatastore() {
+       final List<AuthenticationKey> authKeys = dsbe.getAllAuthenticationKeys();
+       LOG.info("Restoring {} keys from datastore into southbound DAO", authKeys.size());
+
+       for (AuthenticationKey authKey : authKeys) {
+           final Eid key = authKey.getEid();
+           final MappingAuthkey mappingAuthkey = authKey.getMappingAuthkey();
+           LOG.debug("Adding authentication key '{}' with key-ID {} for {}", mappingAuthkey.getKeyString(),
+                   mappingAuthkey.getKeyType(),
+                   LispAddressStringifier.getString(key));
+           smc.addAuthenticationKey(key, mappingAuthkey);
+       }
+    }
+
+    public void init() {
+        Preconditions.checkNotNull(dataBroker);
+        Preconditions.checkNotNull(smc);
+        this.authenticationKeyDataListener = new AuthenticationKeyDataListener(dataBroker, smc);
+        dsbe = new DataStoreBackEnd(dataBroker);
+    }
+
+    public void setMapRegisterCacheTimeout(long mapRegisterCacheTimeout) {
+        this.mapRegisterCacheTimeout = mapRegisterCacheTimeout;
+    }
 }