Bug 9116: Move notification logic to MappingSystem
[lispflowmapping.git] / mappingservice / implementation / src / main / java / org / opendaylight / lispflowmapping / implementation / LispMappingService.java
index 347d33fd5dac88bed230b82b6e9d07e5db5cbd3c..1fcfe00c96a90b3f084016359fd7f5700171403f 100644 (file)
@@ -8,26 +8,29 @@
 
 package org.opendaylight.lispflowmapping.implementation;
 
+import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.ListenableFuture;
 import java.util.List;
-
 import org.apache.commons.lang3.tuple.MutablePair;
 import org.apache.commons.lang3.tuple.Pair;
 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
-import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderContext;
-import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
-import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
-import org.opendaylight.lispflowmapping.implementation.config.ConfigIni;
+import org.opendaylight.lispflowmapping.config.ConfigIni;
 import org.opendaylight.lispflowmapping.implementation.lisp.MapResolver;
 import org.opendaylight.lispflowmapping.implementation.lisp.MapServer;
 import org.opendaylight.lispflowmapping.implementation.util.LispNotificationHelper;
-import org.opendaylight.lispflowmapping.lisp.type.LispMessage;
 import org.opendaylight.lispflowmapping.interfaces.lisp.IFlowMapping;
 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapNotifyHandler;
 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapRequestResultHandler;
 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapResolverAsync;
 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapServerAsync;
+import org.opendaylight.lispflowmapping.interfaces.lisp.ISmrNotificationListener;
 import org.opendaylight.lispflowmapping.interfaces.mappingservice.IMappingService;
+import org.opendaylight.lispflowmapping.lisp.type.LispMessage;
 import org.opendaylight.lispflowmapping.lisp.util.LispAddressStringifier;
+import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService;
+import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
+import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
+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.AddMapping;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.GotMapNotify;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.GotMapReply;
@@ -35,10 +38,15 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.Ma
 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.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.OdlLispProtoListener;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.RequestMapping;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.XtrId;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.XtrReplyMapping;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.XtrRequestMapping;
+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.metadata.container.MapRegisterCacheMetadata;
+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.mapnotifymessage.MapNotifyBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapreplymessage.MapReplyBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequestmessage.MapRequestBuilder;
@@ -49,61 +57,59 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.OdlLi
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapNotifyInputBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapReplyInputBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapRequestInputBuilder;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.PortNumber;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public class LispMappingService implements IFlowMapping, BindingAwareProvider, IMapRequestResultHandler,
-        IMapNotifyHandler, OdlLispProtoListener, AutoCloseable {
-    protected static final Logger LOG = LoggerFactory.getLogger(LispMappingService.class);
+public class LispMappingService implements IFlowMapping, IMapRequestResultHandler,
+        IMapNotifyHandler, OdlLispProtoListener, AutoCloseable, ClusterSingletonService {
+    private static final String LISPFLOWMAPPING_ENTITY_NAME = "lispflowmapping";
+    private static final ServiceGroupIdentifier SERVICE_GROUP_IDENTIFIER = ServiceGroupIdentifier.create(
+            LISPFLOWMAPPING_ENTITY_NAME);
 
-    private volatile boolean shouldAuthenticate = true;
+
+    private static final Logger LOG = LoggerFactory.getLogger(LispMappingService.class);
+    private final ClusterSingletonServiceProvider clusterSingletonService;
 
     private volatile boolean smr = ConfigIni.getInstance().smrIsSet();
     private volatile String elpPolicy = ConfigIni.getInstance().getElpPolicy();
 
     private ThreadLocal<MapReply> tlsMapReply = new ThreadLocal<MapReply>();
-    private ThreadLocal<Pair<MapNotify, List<TransportAddress>>> tlsMapNotify = new ThreadLocal<Pair<MapNotify, List<TransportAddress>>>();
-    private ThreadLocal<Pair<MapRequest, TransportAddress>> tlsMapRequest = new ThreadLocal<Pair<MapRequest, TransportAddress>>();
+    private ThreadLocal<Pair<MapNotify, List<TransportAddress>>> tlsMapNotify =
+            new ThreadLocal<Pair<MapNotify, List<TransportAddress>>>();
+    private ThreadLocal<Pair<MapRequest, TransportAddress>> tlsMapRequest =
+            new ThreadLocal<Pair<MapRequest, TransportAddress>>();
 
-    private OdlLispSbService lispSB = null;
+    private final OdlLispSbService lispSB;
     private IMapResolverAsync mapResolver;
     private IMapServerAsync mapServer;
 
-    private IMappingService mapService;
-    private NotificationService notificationService;
-    private BindingAwareBroker broker;
-    private ProviderContext session;
+    private final IMappingService mapService;
+    private final NotificationService notificationService;
 
-    public LispMappingService() {
-        LOG.debug("LispMappingService Module constructed!");
-    }
+    public LispMappingService(final NotificationService notificationService,
+            final IMappingService mappingService,
+            final OdlLispSbService odlLispService, final ClusterSingletonServiceProvider clusterSingletonService) {
 
-    public void setBindingAwareBroker(BindingAwareBroker broker) {
-        this.broker = broker;
-    }
-
-    public void setNotificationService(NotificationService ns) {
-        this.notificationService = ns;
-    }
-
-    public void setMappingService(IMappingService ms) {
-        LOG.trace("MappingService set in LispMappingService");
-        this.mapService = ms;
+        this.notificationService = notificationService;
+        this.mapService = mappingService;
+        this.lispSB = odlLispService;
+        this.clusterSingletonService = clusterSingletonService;
+        LOG.debug("LispMappingService Module constructed!");
     }
 
     public boolean shouldUseSmr() {
         return this.smr;
     }
 
-    public void setShouldUseSmr(boolean smr) {
-        this.smr = smr;
+    public void setShouldUseSmr(boolean shouldUseSmr) {
+        this.smr = shouldUseSmr;
         if (mapServer != null) {
-            mapServer.setSubscriptionService(smr);
+            mapServer.setSubscriptionService(shouldUseSmr);
         }
         if (mapResolver != null) {
-            mapResolver.setSubscriptionService(smr);
+            mapResolver.setSubscriptionService(shouldUseSmr);
         }
+        ConfigIni.getInstance().setSmr(shouldUseSmr);
     }
 
     public NotificationService getNotificationService() {
@@ -111,27 +117,24 @@ public class LispMappingService implements IFlowMapping, BindingAwareProvider, I
     }
 
     public void initialize() {
-        broker.registerProvider(this);
-        notificationService.registerNotificationListener(this);
         mapResolver = new MapResolver(mapService, smr, elpPolicy, this);
-        mapServer = new MapServer(mapService, shouldAuthenticate, smr, this, notificationService);
+        mapServer = new MapServer(mapService, smr, this, notificationService);
+        this.clusterSingletonService.registerClusterSingletonService(this);
+        mapResolver.setSmrNotificationListener((ISmrNotificationListener) mapServer);
+        LOG.info("LISP (RFC6830) Mapping Service init finished");
     }
 
     public void basicInit() {
         mapResolver = new MapResolver(mapService, smr, elpPolicy, this);
-        mapServer = new MapServer(mapService, shouldAuthenticate, smr, this, notificationService);
-    }
-
-    @Override
-    public void onSessionInitiated(ProviderContext session) {
-        LOG.info("Lisp Consumer session initialized!");
-        this.session = session;
-        LOG.info("LISP (RFC6830) Mapping Service init finished");
+        mapServer = new MapServer(mapService, smr, this, notificationService);
+        mapResolver.setSmrNotificationListener((ISmrNotificationListener) mapServer);
     }
 
     public MapReply handleMapRequest(MapRequest request) {
-        LOG.debug("DAO: Retrieving mapping for {}",
-                LispAddressStringifier.getString(request.getEidItem().get(0).getEid()));
+        if (LOG.isDebugEnabled()) {
+            LOG.debug("LISP: Retrieving mapping for {}",
+                    LispAddressStringifier.getString(request.getEidItem().get(0).getEid()));
+        }
 
         tlsMapReply.set(null);
         tlsMapRequest.set(null);
@@ -139,7 +142,6 @@ public class LispMappingService implements IFlowMapping, BindingAwareProvider, I
         // After this invocation we assume that the thread local is filled with the reply
         if (tlsMapRequest.get() != null) {
             SendMapRequestInputBuilder smrib = new SendMapRequestInputBuilder();
-            new MapRequestBuilder(tlsMapRequest.get().getLeft());
             smrib.setMapRequest(new MapRequestBuilder(tlsMapRequest.get().getLeft()).build());
             smrib.setTransportAddress(tlsMapRequest.get().getRight());
             getLispSB().sendMapRequest(smrib.build());
@@ -150,20 +152,11 @@ public class LispMappingService implements IFlowMapping, BindingAwareProvider, I
     }
 
     public Pair<MapNotify, List<TransportAddress>> handleMapRegister(MapRegister mapRegister) {
-        LOG.debug("DAO: Adding mapping for {}",
-                LispAddressStringifier.getString(mapRegister.getMappingRecordItem().get(0)
-                        .getMappingRecord().getEid()));
-
-        tlsMapNotify.set(null);
-        mapServer.handleMapRegister(mapRegister);
-        // After this invocation we assume that the thread local is filled with the reply
-        return tlsMapNotify.get();
-    }
-
-    public Pair<MapNotify, List<TransportAddress>> handleMapRegister(MapRegister mapRegister, boolean smr) {
-        LOG.debug("DAO: Adding mapping for {}",
-                LispAddressStringifier.getString(mapRegister.getMappingRecordItem().get(0)
-                        .getMappingRecord().getEid()));
+        if (LOG.isDebugEnabled()) {
+            LOG.debug("LISP: Adding mapping for {}",
+                    LispAddressStringifier.getString(mapRegister.getMappingRecordItem().get(0)
+                            .getMappingRecord().getEid()));
+        }
 
         tlsMapNotify.set(null);
         mapServer.handleMapRegister(mapRegister);
@@ -172,13 +165,7 @@ public class LispMappingService implements IFlowMapping, BindingAwareProvider, I
     }
 
     public void setShouldAuthenticate(boolean shouldAuthenticate) {
-        this.shouldAuthenticate = shouldAuthenticate;
         this.mapResolver.setShouldAuthenticate(shouldAuthenticate);
-        this.mapServer.setShouldAuthenticate(shouldAuthenticate);
-    }
-
-    public boolean shouldAuthenticate() {
-        return shouldAuthenticate;
     }
 
     private void sendMapNotify(MapNotify mapNotify, TransportAddress address) {
@@ -193,7 +180,7 @@ public class LispMappingService implements IFlowMapping, BindingAwareProvider, I
         Pair<MapNotify, List<TransportAddress>> result = handleMapRegister(mapRegisterNotification.getMapRegister());
         if (result != null && result.getLeft() != null) {
             MapNotify mapNotify = result.getLeft();
-            List <TransportAddress> rlocs = result.getRight();
+            List<TransportAddress> rlocs = result.getRight();
             if (rlocs == null) {
                 TransportAddressBuilder tab = new TransportAddressBuilder();
                 tab.setIpAddress(mapRegisterNotification.getTransportAddress().getIpAddress());
@@ -218,7 +205,7 @@ public class LispMappingService implements IFlowMapping, BindingAwareProvider, I
             smrib.setTransportAddress(mapRequestNotification.getTransportAddress());
             getLispSB().sendMapReply(smrib.build());
         } else {
-            LOG.warn("got null map reply");
+            LOG.debug("handleMapRequest: Got null MapReply");
         }
     }
 
@@ -242,10 +229,20 @@ public class LispMappingService implements IFlowMapping, BindingAwareProvider, I
         LOG.debug("Received XtrReplyMapping notification, ignoring");
     }
 
-    private OdlLispSbService getLispSB() {
-        if (lispSB == null) {
-            lispSB = session.getRpcService(OdlLispSbService.class);
+    @Override
+    public void onMappingKeepAlive(MappingKeepAlive notification) {
+        final MapRegisterCacheMetadata cacheMetadata = notification.getMapRegisterCacheMetadata();
+        for (EidLispAddress eidLispAddress : cacheMetadata.getEidLispAddress()) {
+            final Eid eid = eidLispAddress.getEid();
+            final XtrId xtrId = cacheMetadata.getXtrId();
+            final Long timestamp = cacheMetadata.getTimestamp();
+            LOG.debug("Update map registration for eid {} with timestamp {}", LispAddressStringifier.getString(eid),
+                    timestamp);
+            mapService.refreshMappingRegistration(eid, xtrId, timestamp);
         }
+    }
+
+    private OdlLispSbService getLispSB() {
         return lispSB;
     }
 
@@ -260,13 +257,15 @@ public class LispMappingService implements IFlowMapping, BindingAwareProvider, I
     }
 
     @Override
-    public void handleSMR(MapRequest smr, Rloc subscriber) {
-        LOG.debug("Sending SMR to {} with Source-EID {} and EID Record {}",
-                LispAddressStringifier.getString(subscriber),
-                LispAddressStringifier.getString(smr.getSourceEid().getEid()),
-                LispAddressStringifier.getString(smr.getEidItem().get(0).getEid()));
+    public void handleSMR(MapRequest smrMapRequest, Rloc subscriber) {
+        if (LOG.isDebugEnabled()) {
+            LOG.debug("Sending SMR Map-Request to {} with Source-EID {} and EID Record {} (reversed)",
+                    LispAddressStringifier.getString(subscriber),
+                    LispAddressStringifier.getString(smrMapRequest.getSourceEid().getEid()),
+                    LispAddressStringifier.getString(smrMapRequest.getEidItem().get(0).getEid()));
+        }
         SendMapRequestInputBuilder smrib = new SendMapRequestInputBuilder();
-        smrib.setMapRequest(new MapRequestBuilder(smr).build());
+        smrib.setMapRequest(new MapRequestBuilder(smrMapRequest).build());
         smrib.setTransportAddress(LispNotificationHelper.getTransportAddressFromRloc(subscriber));
         getLispSB().sendMapRequest(smrib.build());
 
@@ -277,7 +276,7 @@ public class LispMappingService implements IFlowMapping, BindingAwareProvider, I
         tlsMapRequest.set(new MutablePair<MapRequest, TransportAddress>(mapRequest, transportAddress));
     }
 
-    public void destroy() {
+    private void destroy() {
         LOG.info("LISP (RFC6830) Mapping Service is destroyed!");
         mapResolver = null;
         mapServer = null;
@@ -286,5 +285,24 @@ public class LispMappingService implements IFlowMapping, BindingAwareProvider, I
     @Override
     public void close() throws Exception {
         destroy();
+        clusterSingletonService.close();
+    }
+
+    @Override
+    public void instantiateServiceInstance() {
+        mapService.setIsMaster(true);
+    }
+
+    @Override
+    public ListenableFuture<Void> closeServiceInstance() {
+        if (mapService != null) {
+            mapService.setIsMaster(false);
+        }
+        return Futures.<Void>immediateFuture(null);
+    }
+
+    @Override
+    public ServiceGroupIdentifier getIdentifier() {
+        return SERVICE_GROUP_IDENTIFIER;
     }
 }