Checkstyle: fix issues and enforce on implementation
[lispflowmapping.git] / mappingservice / implementation / src / main / java / org / opendaylight / lispflowmapping / implementation / mdsal / MappingDataListener.java
1 /*
2  * Copyright (c) 2015 Cisco Systems, Inc.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.lispflowmapping.implementation.mdsal;
9
10 import java.util.ArrayList;
11 import java.util.Collection;
12 import java.util.List;
13 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
14 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
15 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification.ModificationType;
16 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
17 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
18 import org.opendaylight.lispflowmapping.implementation.util.MSNotificationInputUtil;
19 import org.opendaylight.lispflowmapping.interfaces.mapcache.IMappingSystem;
20 import org.opendaylight.lispflowmapping.lisp.util.LispAddressUtil;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.locatorrecords.LocatorRecord;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.locatorrecords.LocatorRecordBuilder;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecord;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecordBuilder;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingChange;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingDatabase;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingOrigin;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.db.instance.Mapping;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.db.instance.MappingBuilder;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.mapping.database.VirtualNetworkIdentifier;
31 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
32 import org.slf4j.Logger;
33 import org.slf4j.LoggerFactory;
34
35 /**
36  * DataListener for all Mapping modification events.
37  *
38  * @author Lorand Jakab
39  * @author Florin Coras
40  *
41  */
42 public class MappingDataListener extends AbstractDataListener<Mapping> {
43     private static final Logger LOG = LoggerFactory.getLogger(MappingDataListener.class);
44     private IMappingSystem mapSystem;
45     private NotificationPublishService notificationPublishService;
46
47     public MappingDataListener(DataBroker broker, IMappingSystem msmr, NotificationPublishService nps) {
48         setBroker(broker);
49         setMappingSystem(msmr);
50         setNotificationProviderService(nps);
51         setPath(InstanceIdentifier.create(MappingDatabase.class).child(VirtualNetworkIdentifier.class)
52                 .child(Mapping.class));
53         LOG.trace("Registering Mapping listener.");
54         registerDataChangeListener();
55     }
56
57     public void setNotificationProviderService(NotificationPublishService nps) {
58         this.notificationPublishService = nps;
59     }
60
61     void setMappingSystem(IMappingSystem msmr) {
62         this.mapSystem = msmr;
63     }
64
65     @Override
66     public void onDataTreeChanged(Collection<DataTreeModification<Mapping>> changes) {
67         for (DataTreeModification<Mapping> change : changes) {
68             final DataObjectModification<Mapping> mod = change.getRootNode();
69
70             if (ModificationType.DELETE == mod.getModificationType()) {
71                 // Process deleted mappings
72
73                 final Mapping mapping = mod.getDataBefore();
74
75                 // Only treat mapping changes caused by Northbound, since Southbound changes are already handled
76                 // before being persisted.
77                 if (mapping.getOrigin() == MappingOrigin.Southbound) {
78                     continue;
79                 }
80
81                 LOG.trace("Received deleted data");
82                 LOG.trace("Key: {}", change.getRootPath().getRootIdentifier());
83                 LOG.trace("Value: {}", mapping);
84
85                 final Mapping convertedMapping = convertToBinaryIfNecessary(mapping);
86
87                 mapSystem.removeMapping(convertedMapping.getOrigin(), convertedMapping.getMappingRecord().getEid());
88                 try {
89                     notificationPublishService.putNotification(MSNotificationInputUtil.toMappingChanged(
90                             convertedMapping, MappingChange.Removed));
91                 } catch (InterruptedException e) {
92                     LOG.warn("Notification publication interrupted!");
93                 }
94
95             } else if (ModificationType.SUBTREE_MODIFIED == mod.getModificationType() || ModificationType.WRITE == mod
96                     .getModificationType()) {
97                 final Mapping mapping = mod.getDataAfter();
98
99                 // Only treat mapping changes caused by Northbound, since Southbound changes are already handled
100                 // before being persisted. XXX separate NB and SB to avoid ignoring SB notifications
101                 if (mapping.getOrigin() == MappingOrigin.Southbound) {
102                     continue;
103                 }
104
105                 MappingChange mappingChange;
106
107                 if (ModificationType.SUBTREE_MODIFIED == mod.getModificationType()) {
108                     LOG.trace("Received update data");
109                     mappingChange = MappingChange.Updated;
110                 } else {
111                     LOG.trace("Received write data");
112                     mappingChange = MappingChange.Created;
113                 }
114                 LOG.trace("Key: {}", change.getRootPath().getRootIdentifier());
115                 LOG.trace("Value: {}", mapping);
116
117                 final Mapping convertedMapping = convertToBinaryIfNecessary(mapping);
118
119                 mapSystem.addMapping(convertedMapping.getOrigin(), convertedMapping.getMappingRecord().getEid(),
120                         convertedMapping.getMappingRecord(), false);
121
122                 try {
123                     // The notifications are used for sending SMR.
124                     notificationPublishService.putNotification(MSNotificationInputUtil.toMappingChanged(
125                             convertedMapping, mappingChange));
126                 } catch (InterruptedException e) {
127                     LOG.warn("Notification publication interrupted!");
128                 }
129
130             } else {
131                 LOG.warn("Ignoring unhandled modification type {}", mod.getModificationType());
132             }
133         }
134     }
135
136     private static Mapping convertToBinaryIfNecessary(Mapping mapping) {
137         MappingRecord originalRecord = mapping.getMappingRecord();
138         List<LocatorRecord> originalLocators = originalRecord.getLocatorRecord();
139
140         List<LocatorRecord> convertedLocators = null;
141         if (originalLocators != null) {
142             // If convertedLocators is non-null, while originalLocators is also non-null, conversion has been made
143             convertedLocators = convertToBinaryIfNecessary(originalLocators);
144         }
145
146         if (LispAddressUtil.addressNeedsConversionToBinary(originalRecord.getEid().getAddress())
147                 || (originalLocators != null && convertedLocators != null)) {
148             MappingRecordBuilder mrb = new MappingRecordBuilder(originalRecord);
149             mrb.setEid(LispAddressUtil.convertToBinary(originalRecord.getEid()));
150             if (convertedLocators != null) {
151                 mrb.setLocatorRecord(convertedLocators);
152             }
153             return new MappingBuilder(mapping).setMappingRecord(mrb.build()).build();
154         }
155         return mapping;
156     }
157
158     private static List<LocatorRecord> convertToBinaryIfNecessary(List<LocatorRecord> originalLocators) {
159         List<LocatorRecord> convertedLocators = null;
160         for (LocatorRecord record : originalLocators) {
161             if (LispAddressUtil.addressNeedsConversionToBinary(record.getRloc().getAddress())) {
162                 LocatorRecordBuilder lrb = new LocatorRecordBuilder(record);
163                 lrb.setRloc(LispAddressUtil.convertToBinary(record.getRloc()));
164                 if (convertedLocators == null) {
165                     convertedLocators = new ArrayList<LocatorRecord>();
166                 }
167                 convertedLocators.add(lrb.build());
168             }
169         }
170         if (convertedLocators != null) {
171             return convertedLocators;
172         }
173         return originalLocators;
174     }
175 }