southbound/southbound-impl/src/main/java/org/opendaylight/ovsdb/southbound/SouthboundProvider.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. 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 package org.opendaylight.ovsdb.southbound;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.util.concurrent.CheckedFuture;
  12 import java.util.Map;
  13 import java.util.concurrent.ExecutionException;
  14 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  15 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  16 import org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException;
  17 import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
  18 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
  19 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipChange;
  20 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener;
  21 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListenerRegistration;
  22 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
  23 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipState;
  24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  25 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  26 import org.opendaylight.controller.sal.core.api.model.SchemaService;
  27 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  28 import org.opendaylight.ovsdb.lib.OvsdbConnection;
  29 import org.opendaylight.ovsdb.southbound.transactions.md.TransactionInvoker;
  30 import org.opendaylight.ovsdb.southbound.transactions.md.TransactionInvokerImpl;
  31 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  32 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  33 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  35 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 public class SouthboundProvider implements AutoCloseable {
  40
  41     private static final Logger LOG = LoggerFactory.getLogger(SouthboundProvider.class);
  42     private static final String ENTITY_TYPE = "ovsdb-southbound-provider";
  43
  44     public static DataBroker getDb() {
  45         return db;
  46     }
  47
  48     private static DataBroker db;
  49     private OvsdbConnectionManager cm;
  50     private TransactionInvoker txInvoker;
  51     private OvsdbDataTreeChangeListener ovsdbDataTreeChangeListener;
  52     private final EntityOwnershipService entityOwnershipService;
  53     private EntityOwnershipCandidateRegistration registration;
  54     private SouthboundPluginInstanceEntityOwnershipListener providerOwnershipChangeListener;
  55     private final OvsdbConnection ovsdbConnection;
  56     private final InstanceIdentifierCodec instanceIdentifierCodec;
  57     private static final String SKIP_MONITORING_MANAGER_STATUS_PARAM = "skip-monitoring-manager-status";
  58
  59     public SouthboundProvider(final DataBroker dataBroker,
  60             final EntityOwnershipService entityOwnershipServiceDependency,
  61             final OvsdbConnection ovsdbConnection,
  62             final SchemaService schemaService,
  63             final BindingNormalizedNodeSerializer bindingNormalizedNodeSerializer) {
  64         this.db = dataBroker;
  65         this.entityOwnershipService = entityOwnershipServiceDependency;
  66         registration = null;
  67         this.ovsdbConnection = ovsdbConnection;
  68
  69         this.instanceIdentifierCodec = new InstanceIdentifierCodec(schemaService,
  70                 bindingNormalizedNodeSerializer);
  71         LOG.info("SouthboundProvider ovsdbConnectionService Initialized");
  72     }
  73
  74     /**
  75      * Used by blueprint when starting the container.
  76      */
  77     public void init() {
  78         LOG.info("SouthboundProvider Session Initiated");
  79         this.txInvoker = new TransactionInvokerImpl(db);
  80         cm = new OvsdbConnectionManager(db,txInvoker,entityOwnershipService, ovsdbConnection, instanceIdentifierCodec);
  81         ovsdbDataTreeChangeListener = new OvsdbDataTreeChangeListener(db, cm, instanceIdentifierCodec);
  82
  83         //Register listener for entityOnwership changes
  84         providerOwnershipChangeListener =
  85                 new SouthboundPluginInstanceEntityOwnershipListener(this,this.entityOwnershipService);
  86
  87         //register instance entity to get the ownership of the provider
  88         Entity instanceEntity = new Entity(ENTITY_TYPE, ENTITY_TYPE);
  89         try {
  90             Optional<EntityOwnershipState> ownershipStateOpt = entityOwnershipService.getOwnershipState(instanceEntity);
  91             registration = entityOwnershipService.registerCandidate(instanceEntity);
  92             if (ownershipStateOpt.isPresent()) {
  93                 EntityOwnershipState ownershipState = ownershipStateOpt.get();
  94                 if (ownershipState.hasOwner() && !ownershipState.isOwner()) {
  95                     ovsdbConnection.registerConnectionListener(cm);
  96                     ovsdbConnection.startOvsdbManager(SouthboundConstants.DEFAULT_OVSDB_PORT);
  97                     LOG.info("*This* instance of OVSDB southbound provider is set as a SLAVE instance");
  98                 }
  99             }
 100         } catch (CandidateAlreadyRegisteredException e) {
 101             LOG.warn("OVSDB Southbound Provider instance entity {} was already "
 102                     + "registered for ownership", instanceEntity, e);
 103         }
 104     }
 105
 106     @Override
 107     public void close() {
 108         LOG.info("SouthboundProvider Closed");
 109         cm.close();
 110         ovsdbDataTreeChangeListener.close();
 111         registration.close();
 112         providerOwnershipChangeListener.close();
 113     }
 114
 115     private void initializeOvsdbTopology(LogicalDatastoreType type) {
 116         InstanceIdentifier<Topology> path = InstanceIdentifier
 117                 .create(NetworkTopology.class)
 118                 .child(Topology.class, new TopologyKey(SouthboundConstants.OVSDB_TOPOLOGY_ID));
 119         ReadWriteTransaction transaction = db.newReadWriteTransaction();
 120         CheckedFuture<Optional<Topology>, ReadFailedException> ovsdbTp = transaction.read(type, path);
 121         try {
 122             if (!ovsdbTp.get().isPresent()) {
 123                 TopologyBuilder tpb = new TopologyBuilder();
 124                 tpb.setTopologyId(SouthboundConstants.OVSDB_TOPOLOGY_ID);
 125                 transaction.put(type, path, tpb.build(), true);
 126                 transaction.submit();
 127             } else {
 128                 transaction.cancel();
 129             }
 130         } catch (InterruptedException | ExecutionException e) {
 131             LOG.error("Error initializing ovsdb topology", e);
 132         }
 133     }
 134
 135     public void handleOwnershipChange(EntityOwnershipChange ownershipChange) {
 136         if (ownershipChange.isOwner()) {
 137             LOG.info("*This* instance of OVSDB southbound provider is set as a MASTER instance");
 138             LOG.info("Initialize OVSDB topology {} in operational and config data store if not already present",
 139                     SouthboundConstants.OVSDB_TOPOLOGY_ID);
 140             initializeOvsdbTopology(LogicalDatastoreType.OPERATIONAL);
 141             initializeOvsdbTopology(LogicalDatastoreType.CONFIGURATION);
 142         } else {
 143             LOG.info("*This* instance of OVSDB southbound provider is set as a SLAVE instance");
 144         }
 145         ovsdbConnection.registerConnectionListener(cm);
 146         ovsdbConnection.startOvsdbManager(SouthboundConstants.DEFAULT_OVSDB_PORT);
 147     }
 148
 149     private class SouthboundPluginInstanceEntityOwnershipListener implements EntityOwnershipListener {
 150         private final SouthboundProvider sp;
 151         private final EntityOwnershipListenerRegistration listenerRegistration;
 152
 153         SouthboundPluginInstanceEntityOwnershipListener(SouthboundProvider sp,
 154                 EntityOwnershipService entityOwnershipService) {
 155             this.sp = sp;
 156             listenerRegistration = entityOwnershipService.registerListener(ENTITY_TYPE, this);
 157         }
 158
 159         public void close() {
 160             this.listenerRegistration.close();
 161         }
 162
 163         @Override
 164         public void ownershipChanged(EntityOwnershipChange ownershipChange) {
 165             sp.handleOwnershipChange(ownershipChange);
 166         }
 167     }
 168
 169     public void updateConfigParameter(Map<String, Object> configParameters) {
 170         if (configParameters != null && !configParameters.isEmpty()) {
 171             LOG.debug("Config parameters received : {}", configParameters.entrySet());
 172             for (Map.Entry<String, Object> paramEntry : configParameters.entrySet()) {
 173                 if (paramEntry.getKey().equalsIgnoreCase(SKIP_MONITORING_MANAGER_STATUS_PARAM)) {
 174                     setSkipMonitoringManagerStatus(Boolean.parseBoolean((String)paramEntry.getValue()));
 175                     break;
 176                 }
 177             }
 178         }
 179     }
 180
 181     public void setSkipMonitoringManagerStatus(boolean flag) {
 182         LOG.debug("skipManagerStatus set to {}", flag);
 183         if (flag) {
 184             SouthboundConstants.SKIP_COLUMN_FROM_TABLE.get("Manager").add("status");
 185         } else {
 186             SouthboundConstants.SKIP_COLUMN_FROM_TABLE.get("Manager").remove("status");
 187         }
 188     }
 189 }