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

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