hwvtepsouthbound/hwvtepsouthbound-impl/src/main/java/org/opendaylight/ovsdb/hwvtepsouthbound/HwvtepConnectionInstance.java

   1 /*
   2  * Copyright (c) 2015, 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.ovsdb.hwvtepsouthbound;
  10
  11 import java.util.HashMap;
  12 import java.util.List;
  13 import java.util.Map;
  14 import java.util.Set;
  15 import java.util.concurrent.ExecutionException;
  16
  17 import javax.annotation.Nonnull;
  18
  19 import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
  20 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
  21 import org.opendaylight.ovsdb.hwvtepsouthbound.transact.TransactCommand;
  22 import org.opendaylight.ovsdb.hwvtepsouthbound.transact.TransactInvoker;
  23 import org.opendaylight.ovsdb.hwvtepsouthbound.transact.TransactInvokerImpl;
  24 import org.opendaylight.ovsdb.hwvtepsouthbound.transactions.md.TransactionInvoker;
  25 import org.opendaylight.ovsdb.lib.EchoServiceCallbackFilters;
  26 import org.opendaylight.ovsdb.lib.LockAquisitionCallback;
  27 import org.opendaylight.ovsdb.lib.LockStolenCallback;
  28 import org.opendaylight.ovsdb.lib.MonitorCallBack;
  29 import org.opendaylight.ovsdb.lib.MonitorHandle;
  30 import org.opendaylight.ovsdb.lib.OvsdbClient;
  31 import org.opendaylight.ovsdb.lib.OvsdbConnectionInfo;
  32 import org.opendaylight.ovsdb.lib.message.MonitorRequest;
  33 import org.opendaylight.ovsdb.lib.message.MonitorRequestBuilder;
  34 import org.opendaylight.ovsdb.lib.message.MonitorSelect;
  35 import org.opendaylight.ovsdb.lib.message.TableUpdates;
  36 import org.opendaylight.ovsdb.lib.notation.Row;
  37 import org.opendaylight.ovsdb.lib.operations.Operation;
  38 import org.opendaylight.ovsdb.lib.operations.OperationResult;
  39 import org.opendaylight.ovsdb.lib.operations.TransactionBuilder;
  40 import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
  41 import org.opendaylight.ovsdb.lib.schema.GenericTableSchema;
  42 import org.opendaylight.ovsdb.lib.schema.TableSchema;
  43 import org.opendaylight.ovsdb.lib.schema.typed.TypedBaseTable;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalAugmentation;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.ConnectionInfo;
  46 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  47 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  48 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  49 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  50 import org.slf4j.Logger;
  51 import org.slf4j.LoggerFactory;
  52
  53 import com.google.common.collect.Lists;
  54 import com.google.common.util.concurrent.ListenableFuture;
  55
  56 public class HwvtepConnectionInstance {
  57     private static final Logger LOG = LoggerFactory.getLogger(HwvtepConnectionInstance.class);
  58     private ConnectionInfo connectionInfo;
  59     private OvsdbClient client;
  60     private InstanceIdentifier<Node> instanceIdentifier;
  61     private TransactionInvoker txInvoker;
  62     private Map<DatabaseSchema,TransactInvoker> transactInvokers;
  63     private MonitorCallBack callback;
  64     private volatile boolean hasDeviceOwnership = false;
  65     private Entity connectedEntity;
  66     private EntityOwnershipCandidateRegistration deviceOwnershipCandidateRegistration;
  67     private HwvtepGlobalAugmentation initialCreatedData = null;
  68     private HwvtepDeviceInfo deviceInfo;
  69
  70     HwvtepConnectionInstance (ConnectionInfo key, OvsdbClient client,
  71                               InstanceIdentifier<Node> iid, TransactionInvoker txInvoker) {
  72         this.connectionInfo = key;
  73         this.client = client;
  74         this.instanceIdentifier = iid;
  75         this.txInvoker = txInvoker;
  76         this.deviceInfo = new HwvtepDeviceInfo();
  77     }
  78
  79     public void transact(TransactCommand command) {
  80         for (TransactInvoker transactInvoker: transactInvokers.values()) {
  81             transactInvoker.invoke(command);
  82         }
  83     }
  84
  85     public void registerCallbacks() {
  86         if ( this.callback == null) {
  87             if(this.initialCreatedData != null) {
  88                 this.updateConnectionAttributes();
  89             }
  90
  91             try {
  92                 String database = HwvtepSchemaConstants.HARDWARE_VTEP;
  93                 DatabaseSchema dbSchema = getSchema(database).get();
  94                 if (dbSchema != null) {
  95                     LOG.info("Monitoring database: {}", database);
  96                     callback = new HwvtepMonitorCallback(this, txInvoker);
  97                     monitorAllTables(database, dbSchema);
  98                 } else {
  99                     LOG.info("No database {} found on {}", database, connectionInfo);
 100                 }
 101             } catch (InterruptedException | ExecutionException e) {
 102                 LOG.warn("Exception attempting to registerCallbacks {}: ", connectionInfo, e);
 103             }
 104         }
 105     }
 106
 107     public void createTransactInvokers() {
 108         if (transactInvokers == null) {
 109             try {
 110                 transactInvokers = new HashMap<>();
 111                 DatabaseSchema dbSchema = getSchema(HwvtepSchemaConstants.HARDWARE_VTEP).get();
 112                 if(dbSchema != null) {
 113                     transactInvokers.put(dbSchema, new TransactInvokerImpl(this,dbSchema));
 114                 }
 115             } catch (InterruptedException | ExecutionException e) {
 116                 LOG.warn("Exception attempting to createTransactionInvokers {}", connectionInfo, e);
 117             }
 118         }
 119     }
 120
 121     private void monitorAllTables(String database, DatabaseSchema dbSchema) {
 122         Set<String> tables = dbSchema.getTables();
 123         if (tables != null) {
 124             List<MonitorRequest> monitorRequests = Lists.newArrayList();
 125             for (String tableName : tables) {
 126                 LOG.debug("HwvtepSouthbound monitoring table {} in {}", tableName, dbSchema.getName());
 127                 GenericTableSchema tableSchema = dbSchema.table(tableName, GenericTableSchema.class);
 128                 Set<String> columns = tableSchema.getColumns();
 129                 MonitorRequestBuilder<GenericTableSchema> monitorBuilder = MonitorRequestBuilder.builder(tableSchema);
 130                 for (String column : columns) {
 131                     monitorBuilder.addColumn(column);
 132                 }
 133                 monitorRequests.add(monitorBuilder.with(new MonitorSelect(true, true, true, true)).build());
 134             }
 135             this.callback.update(monitor(dbSchema, monitorRequests, callback),dbSchema);
 136         } else {
 137             LOG.warn("No tables for schema {} for database {} for key {}",dbSchema,database,connectionInfo);
 138         }
 139     }
 140
 141     private void updateConnectionAttributes() {
 142         LOG.debug("Update attributes of ovsdb node ip: {} port: {}",
 143                     this.initialCreatedData.getConnectionInfo().getRemoteIp(),
 144                     this.initialCreatedData.getConnectionInfo().getRemotePort());
 145         /*
 146          * TODO: Do we have anything to update?
 147          * Hwvtep doesn't have other_config or external_ids like
 148          * Open_vSwitch. What else will be needed?
 149          */
 150     }
 151
 152     public ListenableFuture<List<String>> getDatabases() {
 153         return client.getDatabases();
 154     }
 155
 156     public ListenableFuture<DatabaseSchema> getSchema(String database) {
 157         return client.getSchema(database);
 158     }
 159
 160     public TransactionBuilder transactBuilder(DatabaseSchema dbSchema) {
 161         return client.transactBuilder(dbSchema);
 162     }
 163
 164     public ListenableFuture<List<OperationResult>> transact(DatabaseSchema dbSchema, List<Operation> operations) {
 165         return client.transact(dbSchema, operations);
 166     }
 167
 168     public <E extends TableSchema<E>> TableUpdates monitor(DatabaseSchema schema,
 169                     List<MonitorRequest> monitorRequests, MonitorCallBack callback) {
 170         return client.monitor(schema, monitorRequests, callback);
 171     }
 172
 173     public <E extends TableSchema<E>> TableUpdates monitor(DatabaseSchema schema,
 174                     List<MonitorRequest> monitorRequests, MonitorHandle monitorHandle, MonitorCallBack callback) {
 175         return null;
 176     }
 177
 178     public void cancelMonitor(MonitorHandle handler) {
 179         client.cancelMonitor(handler);
 180     }
 181
 182     public void lock(String lockId, LockAquisitionCallback lockedCallBack, LockStolenCallback stolenCallback) {
 183         client.lock(lockId, lockedCallBack, stolenCallback);
 184     }
 185
 186     public ListenableFuture<Boolean> steal(String lockId) {
 187         return client.steal(lockId);
 188     }
 189
 190     public ListenableFuture<Boolean> unLock(String lockId) {
 191         return client.unLock(lockId);
 192     }
 193
 194     public OvsdbConnectionInfo getConnectionInfo() {
 195         return client.getConnectionInfo();
 196     }
 197
 198     public boolean isActive() {
 199         return client.isActive();
 200     }
 201
 202     public void disconnect() {
 203         client.disconnect();
 204     }
 205
 206     public DatabaseSchema getDatabaseSchema(String dbName) {
 207         return client.getDatabaseSchema(dbName);
 208     }
 209
 210     public <T extends TypedBaseTable<?>> T createTypedRowWrapper(Class<T> klazz) {
 211         return client.createTypedRowWrapper(klazz);
 212     }
 213
 214     public <T extends TypedBaseTable<?>> T createTypedRowWrapper(DatabaseSchema dbSchema, Class<T> klazz) {
 215         return client.createTypedRowWrapper(dbSchema, klazz);
 216     }
 217
 218     public <T extends TypedBaseTable<?>> T getTypedRowWrapper(Class<T> klazz, Row<GenericTableSchema> row) {
 219         return client.getTypedRowWrapper(klazz, row);
 220     }
 221
 222     public ConnectionInfo getMDConnectionInfo() {
 223         return connectionInfo;
 224     }
 225
 226     public void setMDConnectionInfo(ConnectionInfo key) {
 227         this.connectionInfo = key;
 228     }
 229
 230     public InstanceIdentifier<Node> getInstanceIdentifier() {
 231         return instanceIdentifier;
 232     }
 233
 234     public NodeKey getNodeKey() {
 235         //TODO: What is the alternative here?
 236         return getInstanceIdentifier().firstKeyOf(Node.class, NodeKey.class);
 237     }
 238
 239     public NodeId getNodeId() {
 240         return getNodeKey().getNodeId();
 241     }
 242
 243     public void setInstanceIdentifier(InstanceIdentifier<Node> iid) {
 244         this.instanceIdentifier = iid;
 245     }
 246
 247     public Entity getConnectedEntity() {
 248         return this.connectedEntity;
 249     }
 250
 251     public void setConnectedEntity(Entity entity ) {
 252         this.connectedEntity = entity;
 253     }
 254
 255     public Boolean hasOvsdbClient(OvsdbClient otherClient) {
 256         return client.equals(otherClient);
 257     }
 258
 259     public Boolean getHasDeviceOwnership() {
 260         return hasDeviceOwnership;
 261     }
 262
 263     public void setHasDeviceOwnership(Boolean hasDeviceOwnership) {
 264         if (hasDeviceOwnership != null) {
 265             this.hasDeviceOwnership = hasDeviceOwnership;
 266         }
 267     }
 268
 269     public void setDeviceOwnershipCandidateRegistration(@Nonnull EntityOwnershipCandidateRegistration registration) {
 270         this.deviceOwnershipCandidateRegistration = registration;
 271     }
 272
 273     public void closeDeviceOwnershipCandidateRegistration() {
 274         if (deviceOwnershipCandidateRegistration != null) {
 275             this.deviceOwnershipCandidateRegistration.close();
 276             setHasDeviceOwnership(Boolean.FALSE);
 277         }
 278     }
 279
 280     public void setHwvtepGlobalAugmentation(HwvtepGlobalAugmentation hwvtepGlobalData) {
 281         this.initialCreatedData = hwvtepGlobalData;
 282     }
 283
 284     public HwvtepGlobalAugmentation getHwvtepGlobalAugmentation() {
 285         return this.initialCreatedData;
 286     }
 287     public HwvtepDeviceInfo getDeviceInfo() {
 288         return this.deviceInfo;
 289     }
 290
 291     public OvsdbClient getOvsdbClient() {
 292         return client;
 293     }
 294 }