Checkstyle: fix issues and enforce on implementation
[lispflowmapping.git] / mappingservice / implementation / src / main / java / org / opendaylight / lispflowmapping / implementation / MappingService.java
index 905ac02e931becca8825b35f0c8fdda629835583..930a655ccbe8483f7fe70ec61913d792b27caec3 100644 (file)
@@ -7,26 +7,29 @@
  */
 package org.opendaylight.lispflowmapping.implementation;
 
+import com.google.common.base.Preconditions;
+import com.google.common.util.concurrent.Futures;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.concurrent.Future;
-
 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
-import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
-import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderContext;
-import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
-import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
-import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RpcRegistration;
+import org.opendaylight.lispflowmapping.dsbackend.DataStoreBackEnd;
 import org.opendaylight.lispflowmapping.implementation.config.ConfigIni;
 import org.opendaylight.lispflowmapping.implementation.mdsal.AuthenticationKeyDataListener;
-import org.opendaylight.lispflowmapping.implementation.mdsal.DataStoreBackEnd;
 import org.opendaylight.lispflowmapping.implementation.mdsal.MappingDataListener;
 import org.opendaylight.lispflowmapping.implementation.util.DSBEInputUtil;
 import org.opendaylight.lispflowmapping.implementation.util.RPCInputConvertorUtil;
 import org.opendaylight.lispflowmapping.interfaces.dao.ILispDAO;
 import org.opendaylight.lispflowmapping.interfaces.mappingservice.IMappingService;
+import org.opendaylight.lispflowmapping.lisp.util.LispAddressUtil;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.SiteId;
 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.locatorrecords.LocatorRecord;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.locatorrecords.LocatorRecordBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.authkey.container.MappingAuthkey;
 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.container.MappingRecordBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.AddKeyInput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.AddKeysInput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.AddMappingInput;
@@ -53,16 +56,12 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev15090
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.UpdateKeysInput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.UpdateMappingInput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.UpdateMappingsInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.mapping.authkey.container.MappingAuthkey;
 import org.opendaylight.yangtools.yang.common.RpcError;
 import org.opendaylight.yangtools.yang.common.RpcResult;
 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.google.common.base.Preconditions;
-import com.google.common.util.concurrent.Futures;
-
 /**
  * Dispatcher of API calls that implements the RPC and Java APIs in mappingservice.yang and IMappingService
  * respectively. It also coordinates and acts as container for all objects in charge of
@@ -74,50 +73,34 @@ import com.google.common.util.concurrent.Futures;
  * @author Florin Coras
  *
  */
-public class MappingService implements OdlMappingserviceService, IMappingService, BindingAwareProvider, AutoCloseable {
+public class MappingService implements OdlMappingserviceService, IMappingService, AutoCloseable {
     protected static final Logger LOG = LoggerFactory.getLogger(MappingService.class);
     private static final String NOT_FOUND_TAG = "data-missing";
     private static final String DATA_EXISTS_TAG = "data-exists";
 
     private MappingSystem mappingSystem;
     private DataStoreBackEnd dsbe;
-    private RpcRegistration<OdlMappingserviceService> mappingServiceRpc;
     private AuthenticationKeyDataListener keyListener;
     private MappingDataListener mappingListener;
-    private ILispDAO dao;
+    private final ILispDAO dao;
 
-    private DataBroker dataBroker;
-    private RpcProviderRegistry rpcRegistry;
-    private BindingAwareBroker bindingAwareBroker;
-    private NotificationPublishService notificationPublishService;
+    private final DataBroker dataBroker;
+    private final NotificationPublishService notificationPublishService;
 
     private boolean overwritePolicy = ConfigIni.getInstance().mappingOverwriteIsSet();
     private boolean notificationPolicy = ConfigIni.getInstance().smrIsSet();
     private boolean iterateMask = true;
 
-    public MappingService() {
-        LOG.debug("MappingService created!");
-    }
-
-    public void setDataBroker(DataBroker dataBroker) {
-        this.dataBroker = dataBroker;
-    }
-
-    public void setRpcProviderRegistry(RpcProviderRegistry rpc) {
-        this.rpcRegistry = rpc;
-    }
-
-    public void setBindingAwareBroker(BindingAwareBroker broker) {
-        this.bindingAwareBroker = broker;
-    }
+    public MappingService(final DataBroker broker,
+            final NotificationPublishService notificationPublishService,
+            final ILispDAO lispDAO) {
+        this.dataBroker = broker;
+        this.notificationPublishService = notificationPublishService;
+        this.dao = lispDAO;
 
-    public void setNotificationPublishService(NotificationPublishService nps) {
-        this.notificationPublishService = nps;
+        LOG.debug("MappingService created!");
     }
 
-    public void setDaoService(ILispDAO dao) {
-        this.dao = dao;
-    }
 
     @Override
     public void setMappingOverwrite(boolean overwrite) {
@@ -134,9 +117,7 @@ public class MappingService implements OdlMappingserviceService, IMappingService
     }
 
     public void initialize() {
-        bindingAwareBroker.registerProvider(this);
-
-        mappingServiceRpc = rpcRegistry.addRpcImplementation(OdlMappingserviceService.class, this);
+        LOG.info("Mapping Service initializing...");
         dsbe = new DataStoreBackEnd(dataBroker);
 
         mappingSystem = new MappingSystem(dao, iterateMask, notificationPolicy, overwritePolicy);
@@ -145,6 +126,7 @@ public class MappingService implements OdlMappingserviceService, IMappingService
 
         keyListener = new AuthenticationKeyDataListener(dataBroker, mappingSystem);
         mappingListener = new MappingDataListener(dataBroker, mappingSystem, notificationPublishService);
+        LOG.info("Mapping Service loaded.");
     }
 
     @Override
@@ -154,7 +136,7 @@ public class MappingService implements OdlMappingserviceService, IMappingService
 
         RpcResultBuilder<Void> rpcResultBuilder;
 
-        MappingAuthkey key = mappingSystem.getAuthenticationKey(input.getEid());
+        MappingAuthkey key = mappingSystem.getAuthenticationKey(convertToBinaryIfNecessary(input.getEid()));
 
         if (key != null) {
             String message = "Key already exists! Please use update-key if you want to change it.";
@@ -183,6 +165,27 @@ public class MappingService implements OdlMappingserviceService, IMappingService
         return Futures.immediateFuture(rpcResultBuilder.build());
     }
 
+    @Override
+    public void addMapping(MappingOrigin origin, Eid key, SiteId siteId, Object data, boolean merge) {
+        // SB registrations are first written to the MappingSystem and only afterwards are persisted to the datastore
+        if (origin.equals(MappingOrigin.Southbound)) {
+            // Store data first in MapCache and only afterwards persist to datastore. This should be used only for SB
+            // registrations
+            mappingSystem.addMapping(origin, key, data, merge);
+            dsbe.addMapping(DSBEInputUtil.toMapping(origin, key, siteId, (MappingRecord) data));
+            if (((MappingRecord) data).getXtrId() != null) {
+                dsbe.addXtrIdMapping(DSBEInputUtil.toXtrIdMapping((MappingRecord) data));
+            }
+        } else {
+            dsbe.addMapping(DSBEInputUtil.toMapping(origin, key, siteId, (MappingRecord) data));
+        }
+    }
+
+    @Override
+    public void updateMappingRegistration(MappingOrigin origin, Eid key, Long timestamp) {
+        mappingSystem.updateMappingRegistration(origin, key, timestamp);
+    }
+
     @Override
     public Future<RpcResult<GetKeyOutput>> getKey(GetKeyInput input) {
         Preconditions.checkNotNull(input, "get-key RPC input must be not null!");
@@ -190,7 +193,7 @@ public class MappingService implements OdlMappingserviceService, IMappingService
 
         RpcResultBuilder<GetKeyOutput> rpcResultBuilder;
 
-        MappingAuthkey key = mappingSystem.getAuthenticationKey(input.getEid());
+        MappingAuthkey key = mappingSystem.getAuthenticationKey(convertToBinaryIfNecessary(input.getEid()));
 
         if (key == null) {
             String message = "Key was not found in the mapping database";
@@ -210,19 +213,35 @@ public class MappingService implements OdlMappingserviceService, IMappingService
 
         RpcResultBuilder<GetMappingOutput> rpcResultBuilder;
 
-        MappingRecord reply = (MappingRecord) mappingSystem.getMapping(input.getEid());
+        MappingRecord reply = (MappingRecord) mappingSystem.getMapping(convertToBinaryIfNecessary(input.getEid()));
 
         if (reply == null) {
             String message = "No mapping was found in the mapping database";
             rpcResultBuilder = RpcResultBuilder.<GetMappingOutput>failed()
                     .withError(RpcError.ErrorType.APPLICATION, NOT_FOUND_TAG, message);
         } else {
-            rpcResultBuilder = RpcResultBuilder.success(new GetMappingOutputBuilder().setMappingRecord(reply));
+            final MappingRecord convertedReply = convertFromBinaryIfNecessary(reply);
+            rpcResultBuilder = RpcResultBuilder.success(new GetMappingOutputBuilder().setMappingRecord(convertedReply));
         }
 
         return Futures.immediateFuture(rpcResultBuilder.build());
     }
 
+    @Override
+    public Object getMapping(MappingOrigin origin, Eid key) {
+        return mappingSystem.getMapping(origin, key);
+    }
+
+    @Override
+    public Object getMapping(Eid key) {
+        return mappingSystem.getMapping(key);
+    }
+
+    @Override
+    public Object getMapping(Eid srcKey, Eid dstKey) {
+        return mappingSystem.getMapping(srcKey, dstKey);
+    }
+
     @Override
     public Future<RpcResult<Void>> removeKey(RemoveKeyInput input) {
         Preconditions.checkNotNull(input, "remove-key RPC input must be not null!");
@@ -251,6 +270,11 @@ public class MappingService implements OdlMappingserviceService, IMappingService
         return Futures.immediateFuture(rpcResultBuilder.build());
     }
 
+    @Override
+    public void removeMapping(MappingOrigin origin, Eid key) {
+        dsbe.removeMapping(DSBEInputUtil.toMapping(origin, key));
+    }
+
     @Override
     public Future<RpcResult<Void>> updateKey(UpdateKeyInput input) {
         Preconditions.checkNotNull(input, "update-key RPC input must be not null!");
@@ -258,7 +282,7 @@ public class MappingService implements OdlMappingserviceService, IMappingService
 
         RpcResultBuilder<Void> rpcResultBuilder;
 
-        MappingAuthkey key = mappingSystem.getAuthenticationKey(input.getEid());
+        MappingAuthkey key = mappingSystem.getAuthenticationKey(convertToBinaryIfNecessary(input.getEid()));
 
         if (key == null) {
             String message = "Key doesn't exist! Please use add-key if you want to create a new authentication key.";
@@ -361,39 +385,8 @@ public class MappingService implements OdlMappingserviceService, IMappingService
     }
 
     @Override
-    public void addMapping(MappingOrigin origin, Eid key, SiteId siteId, Object data, boolean merge) {
-        // SB registrations are first written to the MappingSystem and only afterwards are persisted to the datastore
-        if (origin.equals(MappingOrigin.Southbound)) {
-            // Store data first in MapCache and only afterwards persist to datastore. This should be used only for SB
-            // registrations
-            mappingSystem.addMapping(origin, key, data, merge);
-            dsbe.addMapping(DSBEInputUtil.toMapping(origin, key, siteId, (MappingRecord) data));
-            if (((MappingRecord) data).getXtrId() != null) {
-                dsbe.addXtrIdMapping(DSBEInputUtil.toXtrIdMapping((MappingRecord) data));
-            }
-        } else {
-            dsbe.addMapping(DSBEInputUtil.toMapping(origin, key, siteId, (MappingRecord) data));
-        }
-    }
-
-    @Override
-    public Object getMapping(MappingOrigin origin, Eid key) {
-        return mappingSystem.getMapping(origin, key);
-    }
-
-    @Override
-    public Object getMapping(Eid key) {
-        return mappingSystem.getMapping(key);
-    }
-
-    @Override
-    public Object getMapping(Eid srcKey, Eid dstKey) {
-        return mappingSystem.getMapping(srcKey, dstKey);
-    }
-
-    @Override
-    public void removeMapping(MappingOrigin origin, Eid key) {
-        dsbe.removeMapping(DSBEInputUtil.toMapping(origin, key));
+    public Eid getWidestNegativePrefix(Eid key) {
+        return mappingSystem.getWidestNegativePrefix(key);
     }
 
     @Override
@@ -431,15 +424,9 @@ public class MappingService implements OdlMappingserviceService, IMappingService
         return mappingSystem.printMappings();
     }
 
-    @Override
-    public void onSessionInitiated(ProviderContext session) {
-        LOG.info("Mapping Service provider session initializing!");
-    }
-
     @Override
     public void close() throws Exception {
         LOG.info("Mapping Service is being destroyed!");
-        mappingServiceRpc.close();
         keyListener.closeDataChangeListener();
         mappingListener.closeDataChangeListener();
     }
@@ -449,4 +436,50 @@ public class MappingService implements OdlMappingserviceService, IMappingService
         mappingSystem.cleanCaches();
         dsbe.removeAllDatastoreContent();
     }
+
+    private static Eid convertToBinaryIfNecessary(Eid eid) {
+        if (LispAddressUtil.addressNeedsConversionToBinary(eid.getAddress())) {
+            return LispAddressUtil.convertToBinary(eid);
+        }
+        return eid;
+    }
+
+    private static MappingRecord convertFromBinaryIfNecessary(MappingRecord originalRecord) {
+        List<LocatorRecord> originalLocators = originalRecord.getLocatorRecord();
+
+        List<LocatorRecord> convertedLocators = null;
+        if (originalLocators != null) {
+            // If convertedLocators is non-null, while originalLocators is also non-null, conversion has been made
+            convertedLocators = convertFromBinaryIfNecessary(originalLocators);
+        }
+
+        if (LispAddressUtil.addressNeedsConversionFromBinary(originalRecord.getEid().getAddress())
+                || (originalLocators != null && convertedLocators != null)) {
+            MappingRecordBuilder mrb = new MappingRecordBuilder(originalRecord);
+            mrb.setEid(LispAddressUtil.convertFromBinary(originalRecord.getEid()));
+            if (convertedLocators != null) {
+                mrb.setLocatorRecord(convertedLocators);
+            }
+            return mrb.build();
+        }
+        return originalRecord;
+    }
+
+    private static List<LocatorRecord> convertFromBinaryIfNecessary(List<LocatorRecord> originalLocators) {
+        List<LocatorRecord> convertedLocators = null;
+        for (LocatorRecord record : originalLocators) {
+            if (LispAddressUtil.addressNeedsConversionFromBinary(record.getRloc().getAddress())) {
+                LocatorRecordBuilder lrb = new LocatorRecordBuilder(record);
+                lrb.setRloc(LispAddressUtil.convertFromBinary(record.getRloc()));
+                if (convertedLocators == null) {
+                    convertedLocators = new ArrayList<LocatorRecord>();
+                }
+                convertedLocators.add(lrb.build());
+            }
+        }
+        if (convertedLocators != null) {
+            return convertedLocators;
+        }
+        return originalLocators;
+    }
 }