mappingservice/dsbackend/src/main/java/org/opendaylight/lispflowmapping/dsbackend/DataStoreBackEnd.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.dsbackend;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.util.concurrent.FutureCallback;
  12 import com.google.common.util.concurrent.ListenableFuture;
  13 import com.google.common.util.concurrent.MoreExecutors;
  14 import java.util.ArrayList;
  15 import java.util.Date;
  16 import java.util.List;
  17 import java.util.Optional;
  18 import java.util.concurrent.ExecutionException;
  19 import org.opendaylight.lispflowmapping.lisp.util.LispAddressStringifier;
  20 import org.opendaylight.mdsal.binding.api.DataBroker;
  21 import org.opendaylight.mdsal.binding.api.ReadTransaction;
  22 import org.opendaylight.mdsal.binding.api.Transaction;
  23 import org.opendaylight.mdsal.binding.api.TransactionChain;
  24 import org.opendaylight.mdsal.binding.api.TransactionChainListener;
  25 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  26 import org.opendaylight.mdsal.common.api.CommitInfo;
  27 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.XtrId;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingDatabase;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingOrigin;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.db.instance.AuthenticationKey;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.db.instance.Mapping;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.db.instance.mapping.XtrIdMapping;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.mapping.database.LastUpdated;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.mapping.database.LastUpdatedBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.mapping.database.VirtualNetworkIdentifier;
  37 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  38 import org.slf4j.Logger;
  39 import org.slf4j.LoggerFactory;
  40
  41 /**
  42  * Stores data coming from the mapping database RPCs into the MD-SAL datastore.
  43  *
  44  * @author Lorand Jakab
  45  *
  46  */
  47 public class DataStoreBackEnd implements TransactionChainListener {
  48     protected static final Logger LOG = LoggerFactory.getLogger(DataStoreBackEnd.class);
  49     private static final InstanceIdentifier<MappingDatabase> DATABASE_ROOT =
  50             InstanceIdentifier.create(MappingDatabase.class);
  51     private static final InstanceIdentifier<LastUpdated> LAST_UPDATED =
  52             InstanceIdentifier.create(MappingDatabase.class).child(LastUpdated.class);
  53     private final DataBroker broker;
  54     private TransactionChain txChain;
  55
  56     public DataStoreBackEnd(DataBroker broker) {
  57         this.broker = broker;
  58         createTransactionChain();
  59     }
  60
  61     public void createTransactionChain() {
  62         LOG.debug("Creating DataStoreBackEnd transaction chain...");
  63         txChain = broker.createMergingTransactionChain(this);
  64     }
  65
  66     public void addAuthenticationKey(AuthenticationKey authenticationKey) {
  67         if (LOG.isDebugEnabled()) {
  68             LOG.debug("MD-SAL: Adding authentication key '{}' for {}",
  69                     authenticationKey.getMappingAuthkey().getKeyString(),
  70                     LispAddressStringifier.getString(authenticationKey.getEid()));
  71         }
  72
  73         InstanceIdentifier<AuthenticationKey> path = InstanceIdentifierUtil
  74                 .createAuthenticationKeyIid(authenticationKey.getEid());
  75         writePutTransaction(path, authenticationKey, LogicalDatastoreType.CONFIGURATION,
  76                 "Adding authentication key to MD-SAL datastore failed");
  77     }
  78
  79     public void addMapping(Mapping mapping) {
  80         if (LOG.isDebugEnabled()) {
  81             LOG.debug("MD-SAL: Adding mapping for {}",
  82                     LispAddressStringifier.getString(mapping.getMappingRecord().getEid()));
  83         }
  84
  85         InstanceIdentifier<Mapping> path = InstanceIdentifierUtil
  86                 .createMappingIid(mapping.getMappingRecord().getEid(), mapping.getOrigin());
  87         writePutTransaction(path, mapping, getDestinationDatastore(mapping),
  88                 "Adding mapping to MD-SAL datastore failed");
  89     }
  90
  91     // This method assumes that it is only called for southbound originated Map-Registers
  92     public void addXtrIdMapping(XtrIdMapping mapping) {
  93         XtrId xtrId = mapping.getMappingRecord().getXtrId();
  94         Preconditions.checkNotNull(xtrId, "Make sure you only call addXtrIdMapping when the MappingRecord "
  95                 + "contains an xTR-ID");
  96         if (LOG.isDebugEnabled()) {
  97             LOG.debug("MD-SAL: Adding mapping for {}, xTR-ID {}",
  98                     LispAddressStringifier.getString(mapping.getMappingRecord().getEid()), xtrId);
  99         }
 100
 101         InstanceIdentifier<XtrIdMapping> path = InstanceIdentifierUtil
 102                 .createXtrIdMappingIid(mapping.getMappingRecord().getEid(), MappingOrigin.Southbound, xtrId);
 103         writePutTransaction(path, mapping, LogicalDatastoreType.OPERATIONAL,
 104                 "Adding xTR-ID mapping to MD-SAL datastore failed");
 105     }
 106
 107     public void removeAuthenticationKey(AuthenticationKey authenticationKey) {
 108         if (LOG.isDebugEnabled()) {
 109             LOG.debug("MD-SAL: Removing authentication key for {}",
 110                     LispAddressStringifier.getString(authenticationKey.getEid()));
 111         }
 112
 113         InstanceIdentifier<AuthenticationKey> path = InstanceIdentifierUtil
 114                 .createAuthenticationKeyIid(authenticationKey.getEid());
 115         deleteTransaction(path, LogicalDatastoreType.CONFIGURATION,
 116                 "Deleting authentication key from MD-SAL datastore failed");
 117     }
 118
 119     public void removeMapping(Mapping mapping) {
 120         if (LOG.isDebugEnabled()) {
 121             LOG.debug("MD-SAL: Removing mapping for {}",
 122                     LispAddressStringifier.getString(mapping.getMappingRecord().getEid()));
 123         }
 124
 125         InstanceIdentifier<Mapping> path = InstanceIdentifierUtil
 126                 .createMappingIid(mapping.getMappingRecord().getEid(), mapping.getOrigin());
 127         deleteTransaction(path, getDestinationDatastore(mapping), "Deleting mapping from MD-SAL datastore failed");
 128     }
 129
 130     public void removeXtrIdMapping(XtrIdMapping mapping) {
 131         XtrId xtrId = mapping.getMappingRecord().getXtrId();
 132         Preconditions.checkNotNull(xtrId, "Make sure you only call addXtrIdMapping when the MappingRecord "
 133                 + "contains an xTR-ID");
 134         if (LOG.isDebugEnabled()) {
 135             LOG.debug("MD-SAL: Removing mapping for {}, xTR-ID {}",
 136                     LispAddressStringifier.getString(mapping.getMappingRecord().getEid()), xtrId);
 137         }
 138
 139         InstanceIdentifier<XtrIdMapping> path = InstanceIdentifierUtil
 140                 .createXtrIdMappingIid(mapping.getMappingRecord().getEid(), MappingOrigin.Southbound, xtrId);
 141         deleteTransaction(path, LogicalDatastoreType.OPERATIONAL,
 142                 "Deleting xTR-ID mapping from MD-SAL datastore failed");
 143     }
 144
 145     public void removeAllDatastoreContent() {
 146         LOG.debug("MD-SAL: Removing all mapping database datastore content (mappings and keys)");
 147         removeAllConfigDatastoreContent();
 148         removeAllOperationalDatastoreContent();
 149     }
 150
 151     public void removeAllConfigDatastoreContent() {
 152         deleteTransaction(DATABASE_ROOT, LogicalDatastoreType.CONFIGURATION,
 153                 "Removal of all database content in config datastore failed");
 154     }
 155
 156     public void removeAllOperationalDatastoreContent() {
 157         deleteTransaction(DATABASE_ROOT, LogicalDatastoreType.OPERATIONAL,
 158                 "Removal of all database content in operational datastore failed");
 159     }
 160
 161     public void updateAuthenticationKey(AuthenticationKey authenticationKey) {
 162         if (LOG.isDebugEnabled()) {
 163             LOG.debug("MD-SAL: Updating authentication key for {} with '{}'",
 164                     LispAddressStringifier.getString(authenticationKey.getEid()),
 165                     authenticationKey.getMappingAuthkey().getKeyString());
 166         }
 167
 168         InstanceIdentifier<AuthenticationKey> path = InstanceIdentifierUtil
 169                 .createAuthenticationKeyIid(authenticationKey.getEid());
 170         writePutTransaction(path, authenticationKey, LogicalDatastoreType.CONFIGURATION,
 171                 "Updating authentication key in MD-SAL datastore failed");
 172     }
 173
 174     public void updateMapping(Mapping mapping) {
 175         if (LOG.isDebugEnabled()) {
 176             LOG.debug("MD-SAL: Updating mapping for {}",
 177                     LispAddressStringifier.getString(mapping.getMappingRecord().getEid()));
 178         }
 179
 180         InstanceIdentifier<Mapping> path = InstanceIdentifierUtil
 181                 .createMappingIid(mapping.getMappingRecord().getEid(), mapping.getOrigin());
 182         writePutTransaction(path, mapping, getDestinationDatastore(mapping),
 183                 "Updating mapping in MD-SAL datastore failed");
 184     }
 185
 186     public List<Mapping> getAllMappings() {
 187         List<Mapping> mappings = getAllMappings(LogicalDatastoreType.CONFIGURATION);
 188         mappings.addAll(getAllMappings(LogicalDatastoreType.OPERATIONAL));
 189         return mappings;
 190     }
 191
 192     public List<Mapping> getAllMappings(LogicalDatastoreType logicalDataStore) {
 193         LOG.debug("MD-SAL: Get all mappings from {} datastore",
 194                 logicalDataStore == LogicalDatastoreType.CONFIGURATION ? "config" : "operational");
 195         List<Mapping> mappings = new ArrayList<>();
 196         MappingDatabase mdb = readTransaction(DATABASE_ROOT, logicalDataStore);
 197
 198         if (mdb != null && mdb.getVirtualNetworkIdentifier() != null) {
 199             for (VirtualNetworkIdentifier id : mdb.getVirtualNetworkIdentifier()) {
 200                 List<Mapping> ms = id.getMapping();
 201                 if (ms != null) {
 202                     mappings.addAll(ms);
 203                 }
 204             }
 205         }
 206
 207         return mappings;
 208     }
 209
 210     public List<AuthenticationKey> getAllAuthenticationKeys() {
 211         LOG.debug("MD-SAL: Get all authentication keys from datastore");
 212         List<AuthenticationKey> authKeys = new ArrayList<>();
 213         MappingDatabase mdb = readTransaction(DATABASE_ROOT, LogicalDatastoreType.CONFIGURATION);
 214
 215         if (mdb != null && mdb.getVirtualNetworkIdentifier() != null) {
 216             for (VirtualNetworkIdentifier id : mdb.getVirtualNetworkIdentifier()) {
 217                 List<AuthenticationKey> keys = id.getAuthenticationKey();
 218                 if (keys != null) {
 219                     authKeys.addAll(keys);
 220                 }
 221             }
 222         }
 223
 224         return authKeys;
 225     }
 226
 227     public void saveLastUpdateTimestamp() {
 228         Long timestamp = System.currentTimeMillis();
 229         LOG.debug("MD-SAL: Saving last update timestamp to operational datastore: {}", new Date(timestamp).toString());
 230         writePutTransaction(LAST_UPDATED, new LastUpdatedBuilder().setLastUpdated(timestamp).build(),
 231                 LogicalDatastoreType.OPERATIONAL, "Couldn't save last update timestamp to operational datastore");
 232     }
 233
 234     public void removeLastUpdateTimestamp() {
 235         LOG.debug("MD-SAL: Removing last update timestamp from operational datastore");
 236         deleteTransaction(LAST_UPDATED, LogicalDatastoreType.OPERATIONAL,
 237                 "Couldn't remove last update timestamp from operational datastore");
 238     }
 239
 240     public Long getLastUpdateTimestamp() {
 241         LastUpdated lastUpdated = readTransaction(LAST_UPDATED, LogicalDatastoreType.OPERATIONAL);
 242         if (lastUpdated != null && lastUpdated.getLastUpdated() != null) {
 243             Long timestamp = lastUpdated.getLastUpdated();
 244             LOG.debug("MD-SAL: Retrieved last update timestamp from operational datastore: {}",
 245                     new Date(timestamp).toString());
 246             return timestamp;
 247         } else {
 248             LOG.debug("MD-SAL: Couldn't retrieve last update timestamp from operational datastore");
 249             return null;
 250         }
 251     }
 252
 253     private static LogicalDatastoreType getDestinationDatastore(Mapping mapping) {
 254         return mapping.getOrigin().equals(MappingOrigin.Southbound) ? LogicalDatastoreType.OPERATIONAL
 255                 : LogicalDatastoreType.CONFIGURATION;
 256     }
 257
 258     private <U extends org.opendaylight.yangtools.yang.binding.DataObject> void writePutTransaction(
 259             InstanceIdentifier<U> addIID, U data, LogicalDatastoreType logicalDatastoreType, String errMsg) {
 260         WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 261         writeTx.put(logicalDatastoreType, addIID, data, true);
 262         writeTx.commit().addCallback(new FutureCallback<CommitInfo>() {
 263
 264             @Override
 265             public void onSuccess(CommitInfo result) {
 266             }
 267
 268             @Override
 269             public void onFailure(Throwable throwable) {
 270                 LOG.error("Transaction failed:", throwable);
 271             }
 272         }, MoreExecutors.directExecutor());
 273     }
 274
 275     private <U extends org.opendaylight.yangtools.yang.binding.DataObject> U readTransaction(
 276             InstanceIdentifier<U> readIID, LogicalDatastoreType logicalDatastoreType) {
 277         final ListenableFuture<Optional<U>> readFuture;
 278         try (ReadTransaction readTx = txChain.newReadOnlyTransaction()) {
 279             readFuture = readTx.read(logicalDatastoreType, readIID);
 280         }
 281         try {
 282             Optional<U> optionalDataObject = readFuture.get();
 283             if (optionalDataObject != null && optionalDataObject.isPresent()) {
 284                 return optionalDataObject.get();
 285             } else {
 286                 LOG.debug("{}: Failed to read", Thread.currentThread().getStackTrace()[1]);
 287             }
 288         } catch (InterruptedException | ExecutionException e) {
 289             LOG.warn("Failed to ....", e);
 290         }
 291         return null;
 292     }
 293
 294     private <U extends org.opendaylight.yangtools.yang.binding.DataObject> void deleteTransaction(
 295             InstanceIdentifier<U> deleteIID, LogicalDatastoreType logicalDatastoreType, String errMsg) {
 296
 297         WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 298         writeTx.delete(logicalDatastoreType, deleteIID);
 299         writeTx.commit().addCallback(new FutureCallback<CommitInfo>() {
 300             @Override
 301             public void onSuccess(CommitInfo result) {
 302             }
 303
 304             @Override
 305             public void onFailure(Throwable throwable) {
 306                 LOG.error("Transaction failed:", throwable);
 307             }
 308         }, MoreExecutors.directExecutor());
 309     }
 310
 311     @Override
 312     public void onTransactionChainFailed(TransactionChain chain, Transaction transaction, Throwable cause) {
 313         LOG.error("Broken chain {} in DataStoreBackEnd, transaction {}, cause {}", chain, transaction.getIdentifier(),
 314                 cause);
 315     }
 316
 317     @Override
 318     public void onTransactionChainSuccessful(TransactionChain chain) {
 319         LOG.info("DataStoreBackEnd closed successfully, chain {}", chain);
 320     }
 321
 322     public void closeTransactionChain() {
 323         LOG.debug("Closing DataStoreBackEnd transaction chain...");
 324         txChain.close();
 325     }
 326 }