HwvtepConnectionInstance.java

/*
 * Copyright (c) 2015, 2017 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */

package org.opendaylight.ovsdb.hwvtepsouthbound;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ExecutionException;

import javax.annotation.Nonnull;

import org.opendaylight.controller.md.sal.binding.api.DataBroker;
import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
import org.opendaylight.ovsdb.hwvtepsouthbound.transact.TransactCommand;
import org.opendaylight.ovsdb.hwvtepsouthbound.transact.TransactInvoker;
import org.opendaylight.ovsdb.hwvtepsouthbound.transact.TransactInvokerImpl;
import org.opendaylight.ovsdb.hwvtepsouthbound.transactions.md.TransactionInvoker;
import org.opendaylight.ovsdb.lib.LockAquisitionCallback;
import org.opendaylight.ovsdb.lib.LockStolenCallback;
import org.opendaylight.ovsdb.lib.MonitorCallBack;
import org.opendaylight.ovsdb.lib.MonitorHandle;
import org.opendaylight.ovsdb.lib.OvsdbClient;
import org.opendaylight.ovsdb.lib.OvsdbConnectionInfo;
import org.opendaylight.ovsdb.lib.message.MonitorRequest;
import org.opendaylight.ovsdb.lib.message.MonitorRequestBuilder;
import org.opendaylight.ovsdb.lib.message.MonitorSelect;
import org.opendaylight.ovsdb.lib.message.TableUpdates;
import org.opendaylight.ovsdb.lib.notation.Row;
import org.opendaylight.ovsdb.lib.operations.Operation;
import org.opendaylight.ovsdb.lib.operations.OperationResult;
import org.opendaylight.ovsdb.lib.operations.TransactionBuilder;
import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
import org.opendaylight.ovsdb.lib.schema.GenericTableSchema;
import org.opendaylight.ovsdb.lib.schema.TableSchema;
import org.opendaylight.ovsdb.lib.schema.typed.TypedBaseTable;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalAugmentation;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.ConnectionInfo;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.google.common.util.concurrent.ListenableFuture;

public class HwvtepConnectionInstance {
    private static final Logger LOG = LoggerFactory.getLogger(HwvtepConnectionInstance.class);
    private ConnectionInfo connectionInfo;
    private OvsdbClient client;
    private InstanceIdentifier<Node> instanceIdentifier;
    private TransactionInvoker txInvoker;
    private Map<DatabaseSchema,TransactInvoker> transactInvokers;
    private MonitorCallBack callback;
    private volatile boolean hasDeviceOwnership = false;
    private Entity connectedEntity;
    private EntityOwnershipCandidateRegistration deviceOwnershipCandidateRegistration;
    private HwvtepGlobalAugmentation initialCreatedData = null;
    private HwvtepDeviceInfo deviceInfo;
    private DataBroker dataBroker;
    private final HwvtepConnectionManager hwvtepConnectionManager;

    HwvtepConnectionInstance (HwvtepConnectionManager hwvtepConnectionManager, ConnectionInfo key, OvsdbClient client,
                              InstanceIdentifier<Node> iid, TransactionInvoker txInvoker, DataBroker dataBroker) {
        this.hwvtepConnectionManager = hwvtepConnectionManager;
        this.connectionInfo = key;
        this.client = client;
        this.instanceIdentifier = iid;
        this.txInvoker = txInvoker;
        this.deviceInfo = new HwvtepDeviceInfo(this);
        this.dataBroker = dataBroker;
    }

    public synchronized void transact(TransactCommand command) {
        for (TransactInvoker transactInvoker: transactInvokers.values()) {
            transactInvoker.invoke(command);
        }
    }

    public void registerCallbacks() {
        if ( this.callback == null) {
            if(this.initialCreatedData != null) {
                this.updateConnectionAttributes();
            }

            try {
                String database = HwvtepSchemaConstants.HARDWARE_VTEP;
                DatabaseSchema dbSchema = getSchema(database).get();
                if (dbSchema != null) {
                    LOG.info("Monitoring database: {}", database);
                    callback = new HwvtepMonitorCallback(this, txInvoker);
                    monitorAllTables(database, dbSchema);
                } else {
                    LOG.info("No database {} found on {}", database, connectionInfo);
                }
            } catch (InterruptedException | ExecutionException e) {
                LOG.warn("Exception attempting to registerCallbacks {}: ", connectionInfo, e);
            }
        }
    }

    public void createTransactInvokers() {
        if (transactInvokers == null) {
            try {
                transactInvokers = new HashMap<>();
                DatabaseSchema dbSchema = getSchema(HwvtepSchemaConstants.HARDWARE_VTEP).get();
                if(dbSchema != null) {
                    transactInvokers.put(dbSchema, new TransactInvokerImpl(this,dbSchema));
                }
            } catch (InterruptedException | ExecutionException e) {
                LOG.warn("Exception attempting to createTransactionInvokers {}", connectionInfo, e);
            }
        }
    }

    private void monitorAllTables(String database, DatabaseSchema dbSchema) {
        Set<String> tables = dbSchema.getTables();
        if (tables != null) {
            List<MonitorRequest> monitorRequests = new ArrayList<>();
            for (String tableName : tables) {
                if (!HwvtepSouthboundConstants.SKIP_HWVTEP_TABLE.containsKey(tableName)) {
                    LOG.info("HwvtepSouthbound monitoring Hwvtep schema table {}", tableName);
                    GenericTableSchema tableSchema = dbSchema.table(tableName, GenericTableSchema.class);
                    Set<String> columns = new HashSet<>(tableSchema.getColumns());
                    List<String> skipColumns = HwvtepSouthboundConstants.SKIP_COLUMN_FROM_HWVTEP_TABLE.get(tableName);
                    if (skipColumns != null) {
                        LOG.info("HwvtepSouthbound NOT monitoring columns {} in table {}", skipColumns, tableName);
                        columns.removeAll(skipColumns);
                    }
                    monitorRequests.add(new MonitorRequestBuilder<>(tableSchema)
                            .addColumns(columns)
                            .with(new MonitorSelect(true, true, true, true)).build());
                }
            }
            this.callback.update(monitor(dbSchema, monitorRequests, callback), dbSchema);
        } else {
            LOG.warn("No tables for schema {} for database {} for key {}",dbSchema,database,connectionInfo);
        }
    }

    private void updateConnectionAttributes() {
        LOG.debug("Update attributes of ovsdb node ip: {} port: {}",
                    this.initialCreatedData.getConnectionInfo().getRemoteIp(),
                    this.initialCreatedData.getConnectionInfo().getRemotePort());
        /*
         * TODO: Do we have anything to update?
         * Hwvtep doesn't have other_config or external_ids like
         * Open_vSwitch. What else will be needed?
         */
    }

    public DataBroker getDataBroker() {
        return dataBroker;
    }

    public ListenableFuture<List<String>> getDatabases() {
        return client.getDatabases();
    }

    public ListenableFuture<DatabaseSchema> getSchema(String database) {
        return client.getSchema(database);
    }

    public TransactionBuilder transactBuilder(DatabaseSchema dbSchema) {
        return client.transactBuilder(dbSchema);
    }

    public ListenableFuture<List<OperationResult>> transact(DatabaseSchema dbSchema, List<Operation> operations) {
        return client.transact(dbSchema, operations);
    }

    public <E extends TableSchema<E>> TableUpdates monitor(DatabaseSchema schema,
                    List<MonitorRequest> monitorRequests, MonitorCallBack callback) {
        return client.monitor(schema, monitorRequests, callback);
    }

    public <E extends TableSchema<E>> TableUpdates monitor(DatabaseSchema schema,
                    List<MonitorRequest> monitorRequests, MonitorHandle monitorHandle, MonitorCallBack callback) {
        return null;
    }

    public void cancelMonitor(MonitorHandle handler) {
        client.cancelMonitor(handler);
    }

    public void lock(String lockId, LockAquisitionCallback lockedCallBack, LockStolenCallback stolenCallback) {
        client.lock(lockId, lockedCallBack, stolenCallback);
    }

    public ListenableFuture<Boolean> steal(String lockId) {
        return client.steal(lockId);
    }

    public ListenableFuture<Boolean> unLock(String lockId) {
        return client.unLock(lockId);
    }

    public OvsdbConnectionInfo getConnectionInfo() {
        return client.getConnectionInfo();
    }

    public boolean isActive() {
        return client.isActive();
    }

    public void disconnect() {
        client.disconnect();
    }

    public DatabaseSchema getDatabaseSchema(String dbName) {
        return client.getDatabaseSchema(dbName);
    }

    public <T extends TypedBaseTable<?>> T createTypedRowWrapper(Class<T> klazz) {
        return client.createTypedRowWrapper(klazz);
    }

    public <T extends TypedBaseTable<?>> T createTypedRowWrapper(DatabaseSchema dbSchema, Class<T> klazz) {
        return client.createTypedRowWrapper(dbSchema, klazz);
    }

    public <T extends TypedBaseTable<?>> T getTypedRowWrapper(Class<T> klazz, Row<GenericTableSchema> row) {
        return client.getTypedRowWrapper(klazz, row);
    }

    public ConnectionInfo getMDConnectionInfo() {
        return connectionInfo;
    }

    public void setMDConnectionInfo(ConnectionInfo key) {
        this.connectionInfo = key;
    }

    public InstanceIdentifier<Node> getInstanceIdentifier() {
        return instanceIdentifier;
    }

    public NodeKey getNodeKey() {
        //TODO: What is the alternative here?
        return getInstanceIdentifier().firstKeyOf(Node.class);
    }

    public NodeId getNodeId() {
        return getNodeKey().getNodeId();
    }

    public void setInstanceIdentifier(InstanceIdentifier<Node> iid) {
        this.instanceIdentifier = iid;
        hwvtepConnectionManager.putConnectionInstance(instanceIdentifier, this);
    }

    public Entity getConnectedEntity() {
        return this.connectedEntity;
    }

    public void setConnectedEntity(Entity entity ) {
        this.connectedEntity = entity;
    }

    public Boolean hasOvsdbClient(OvsdbClient otherClient) {
        return client.equals(otherClient);
    }

    public Boolean getHasDeviceOwnership() {
        return hasDeviceOwnership;
    }

    public void setHasDeviceOwnership(Boolean hasDeviceOwnership) {
        if (hasDeviceOwnership != null) {
            this.hasDeviceOwnership = hasDeviceOwnership;
        }
    }

    public void setDeviceOwnershipCandidateRegistration(@Nonnull EntityOwnershipCandidateRegistration registration) {
        this.deviceOwnershipCandidateRegistration = registration;
    }

    public void closeDeviceOwnershipCandidateRegistration() {
        if (deviceOwnershipCandidateRegistration != null) {
            this.deviceOwnershipCandidateRegistration.close();
            setHasDeviceOwnership(Boolean.FALSE);
        }
    }

    public void setHwvtepGlobalAugmentation(HwvtepGlobalAugmentation hwvtepGlobalData) {
        this.initialCreatedData = hwvtepGlobalData;
    }

    public HwvtepGlobalAugmentation getHwvtepGlobalAugmentation() {
        return this.initialCreatedData;
    }
    public HwvtepDeviceInfo getDeviceInfo() {
        return this.deviceInfo;
    }

    public OvsdbClient getOvsdbClient() {
        return client;
    }
}