vpnservice/elanmanager/elanmanager-impl/src/main/java/org/opendaylight/netvirt/elan/internal/ElanInstanceManager.java

   1 /*
   2  * Copyright (c) 2016 Ericsson India Global Services Pvt Ltd. and others.  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
   9 package org.opendaylight.netvirt.elan.internal;
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.util.concurrent.ListenableFuture;
  13 import java.util.ArrayList;
  14 import java.util.Collections;
  15 import java.util.List;
  16 import javax.annotation.PostConstruct;
  17 import javax.inject.Inject;
  18 import javax.inject.Singleton;
  19 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  20 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  21 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  22 import org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase;
  23 import org.opendaylight.genius.datastoreutils.DataStoreJobCoordinator;
  24 import org.opendaylight.genius.interfacemanager.globals.InterfaceInfo;
  25 import org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager;
  26 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  27 import org.opendaylight.netvirt.elan.ElanException;
  28 import org.opendaylight.netvirt.elan.utils.ElanConstants;
  29 import org.opendaylight.netvirt.elan.utils.ElanUtils;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.etree.rev160614.EtreeInstance;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanDpnInterfaces;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInstances;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesList;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesListKey;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfaces;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstanceKey;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterface;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.state.Elan;
  41 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  42 import org.slf4j.Logger;
  43 import org.slf4j.LoggerFactory;
  44
  45 @Singleton
  46 public class ElanInstanceManager extends AsyncDataTreeChangeListenerBase<ElanInstance, ElanInstanceManager>
  47         implements AutoCloseable {
  48
  49     private static final Logger LOG = LoggerFactory.getLogger(ElanInstanceManager.class);
  50
  51     private final DataBroker broker;
  52     private final IdManagerService idManager;
  53     private final IInterfaceManager interfaceManager;
  54     private final ElanInterfaceManager elanInterfaceManager;
  55
  56     @Inject
  57     public ElanInstanceManager(final DataBroker dataBroker, final IdManagerService managerService,
  58                                final ElanInterfaceManager elanInterfaceManager,
  59                                final IInterfaceManager interfaceManager) {
  60         super(ElanInstance.class, ElanInstanceManager.class);
  61         this.broker = dataBroker;
  62         this.idManager = managerService;
  63         this.elanInterfaceManager = elanInterfaceManager;
  64         this.interfaceManager = interfaceManager;
  65     }
  66
  67     @Override
  68     @PostConstruct
  69     public void init() {
  70         registerListener(LogicalDatastoreType.CONFIGURATION, broker);
  71     }
  72
  73     @Override
  74     protected void remove(InstanceIdentifier<ElanInstance> identifier, ElanInstance deletedElan) {
  75         LOG.trace("Remove ElanInstance - Key: {}, value: {}", identifier, deletedElan);
  76         List<ListenableFuture<Void>> futures = new ArrayList<>();
  77         String elanName = deletedElan.getElanInstanceName();
  78         // check the elan Instance present in the Operational DataStore
  79         Elan existingElan = ElanUtils.getElanByName(broker, elanName);
  80         long elanTag = deletedElan.getElanTag();
  81         // Cleaning up the existing Elan Instance
  82         if (existingElan != null) {
  83             List<String> elanInterfaces = existingElan.getElanInterfaces();
  84             if (elanInterfaces != null && !elanInterfaces.isEmpty()) {
  85                 for (String elanInterfaceName : elanInterfaces) {
  86                     InstanceIdentifier<ElanInterface> elanInterfaceId = ElanUtils
  87                             .getElanInterfaceConfigurationDataPathId(elanInterfaceName);
  88                     InterfaceInfo interfaceInfo = interfaceManager.getInterfaceInfo(elanInterfaceName);
  89                     elanInterfaceManager.removeElanInterface(futures, deletedElan, elanInterfaceName,
  90                             interfaceInfo, false);
  91                     ElanUtils.delete(broker, LogicalDatastoreType.CONFIGURATION,
  92                             elanInterfaceId);
  93                 }
  94             }
  95             ElanUtils.delete(broker, LogicalDatastoreType.OPERATIONAL,
  96                     ElanUtils.getElanInstanceOperationalDataPath(elanName));
  97             Optional<ElanDpnInterfacesList> elanDpnInterfaceList = MDSALUtil.read(broker,
  98                     LogicalDatastoreType.OPERATIONAL,
  99                     ElanUtils.getElanDpnOperationDataPath(elanName));
 100             if (elanDpnInterfaceList.isPresent()) {
 101                 ElanUtils.delete(broker, LogicalDatastoreType.OPERATIONAL,
 102                     getElanDpnOperationDataPath(elanName));
 103             }
 104             ElanUtils.delete(broker, LogicalDatastoreType.OPERATIONAL,
 105                     ElanUtils.getElanInfoEntriesOperationalDataPath(elanTag));
 106         }
 107         // Release tag
 108         ElanUtils.releaseId(idManager, ElanConstants.ELAN_ID_POOL_NAME, elanName);
 109         if (deletedElan.getAugmentation(EtreeInstance.class) != null) {
 110             removeEtreeInstance(deletedElan);
 111         }
 112     }
 113
 114     private void removeEtreeInstance(ElanInstance deletedElan) {
 115         // Release leaves tag
 116         ElanUtils.releaseId(idManager, ElanConstants.ELAN_ID_POOL_NAME,
 117                 deletedElan.getElanInstanceName() + ElanConstants.LEAVES_POSTFIX);
 118
 119         ElanUtils.delete(broker, LogicalDatastoreType.OPERATIONAL,
 120                 ElanUtils.getElanInfoEntriesOperationalDataPath(
 121                 deletedElan.getAugmentation(EtreeInstance.class).getEtreeLeafTagVal().getValue()));
 122     }
 123
 124     @Override
 125     protected void update(InstanceIdentifier<ElanInstance> identifier, ElanInstance original, ElanInstance update) {
 126         Long existingElanTag = original.getElanTag();
 127         String elanName = update.getElanInstanceName();
 128         if (existingElanTag != null && existingElanTag.equals(update.getElanTag())) {
 129             return;
 130         } else if (update.getElanTag() == null) {
 131             // update the elan-Instance with new properties
 132             WriteTransaction tx = broker.newWriteOnlyTransaction();
 133             ElanUtils.updateOperationalDataStore(broker, idManager,
 134                     update, new ArrayList<>(), tx);
 135             ElanUtils.waitForTransactionToComplete(tx);
 136             return;
 137         }
 138
 139         DataStoreJobCoordinator dataStoreCoordinator = DataStoreJobCoordinator.getInstance();
 140         dataStoreCoordinator.enqueueJob(elanName, () -> {
 141             try {
 142                 elanInterfaceManager.handleunprocessedElanInterfaces(update);
 143             } catch (ElanException e) {
 144                 LOG.error("update() failed for ElanInstance: " + identifier.toString(), e);
 145             }
 146             return null;
 147         }, ElanConstants.JOB_MAX_RETRIES);
 148
 149     }
 150
 151     @Override
 152     protected void add(InstanceIdentifier<ElanInstance> identifier, ElanInstance elanInstanceAdded) {
 153         String elanInstanceName  = elanInstanceAdded.getElanInstanceName();
 154         Elan elanInfo = ElanUtils.getElanByName(broker, elanInstanceName);
 155         if (elanInfo == null) {
 156             WriteTransaction tx = broker.newWriteOnlyTransaction();
 157             ElanUtils.updateOperationalDataStore(broker, idManager,
 158                 elanInstanceAdded, new ArrayList<>(), tx);
 159             ElanUtils.waitForTransactionToComplete(tx);
 160         }
 161     }
 162
 163     public ElanInstance getElanInstanceByName(String elanInstanceName) {
 164         InstanceIdentifier<ElanInstance> elanIdentifierId = getElanInstanceConfigurationDataPath(elanInstanceName);
 165         return MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION, elanIdentifierId).orNull();
 166     }
 167
 168     public List<DpnInterfaces> getElanDPNByName(String elanInstanceName) {
 169         InstanceIdentifier<ElanDpnInterfacesList> elanIdentifier = getElanDpnOperationDataPath(elanInstanceName);
 170         return MDSALUtil.read(broker, LogicalDatastoreType.OPERATIONAL, elanIdentifier).transform(
 171                 ElanDpnInterfacesList::getDpnInterfaces).or(Collections.emptyList());
 172     }
 173
 174     private InstanceIdentifier<ElanDpnInterfacesList> getElanDpnOperationDataPath(String elanInstanceName) {
 175         return InstanceIdentifier.builder(ElanDpnInterfaces.class)
 176                 .child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName)).build();
 177     }
 178
 179     private InstanceIdentifier<ElanInstance> getElanInstanceConfigurationDataPath(String elanInstanceName) {
 180         return InstanceIdentifier.builder(ElanInstances.class)
 181                 .child(ElanInstance.class, new ElanInstanceKey(elanInstanceName)).build();
 182     }
 183
 184     @Override
 185     protected InstanceIdentifier<ElanInstance> getWildCardPath() {
 186         return InstanceIdentifier.create(ElanInstances.class).child(ElanInstance.class);
 187     }
 188
 189     @Override
 190     protected ElanInstanceManager getDataTreeChangeListener() {
 191         return this;
 192     }
 193 }