* 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.netconf.sal.connect.netconf.sal;
-import com.google.common.base.Preconditions;
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.collect.ImmutableList;
import com.google.common.util.concurrent.FutureCallback;
import com.google.common.util.concurrent.MoreExecutors;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Map;
+import com.google.common.util.concurrent.SettableFuture;
import java.util.concurrent.ExecutionException;
import java.util.stream.Collectors;
-import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
-import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
-import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
+import org.opendaylight.mdsal.binding.api.DataBroker;
+import org.opendaylight.mdsal.binding.api.Transaction;
+import org.opendaylight.mdsal.binding.api.TransactionChain;
+import org.opendaylight.mdsal.binding.api.TransactionChainListener;
+import org.opendaylight.mdsal.binding.api.WriteTransaction;
import org.opendaylight.mdsal.common.api.CommitInfo;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCapabilities;
import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeConnectionStatus.ConnectionStatus;
import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.AvailableCapabilitiesBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.ClusteredConnectionStatusBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.UnavailableCapabilities;
import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.UnavailableCapabilitiesBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapability;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapability.FailureReason;
import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapabilityBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.network.topology.topology.topology.types.TopologyNetconf;
-import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
-import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopologyBuilder;
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.TopologyId;
-import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
-import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
-import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
-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.NodeBuilder;
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.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
-import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.Empty;
+import org.opendaylight.yangtools.yang.common.Uint16;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-public final class NetconfDeviceTopologyAdapter implements AutoCloseable {
-
+public final class NetconfDeviceTopologyAdapter implements TransactionChainListener, AutoCloseable {
private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceTopologyAdapter.class);
+ private final SettableFuture<Empty> closeFuture = SettableFuture.create();
+ private final DataBroker dataBroker;
private final RemoteDeviceId id;
- private BindingTransactionChain txChain;
-
- private final InstanceIdentifier<NetworkTopology> networkTopologyPath;
- private final KeyedInstanceIdentifier<Topology, TopologyKey> topologyListPath;
- private static final String UNKNOWN_REASON = "Unknown reason";
- NetconfDeviceTopologyAdapter(final RemoteDeviceId id, final BindingTransactionChain txChain) {
- this.id = id;
- this.txChain = Preconditions.checkNotNull(txChain);
+ private TransactionChain txChain;
- this.networkTopologyPath = InstanceIdentifier.builder(NetworkTopology.class).build();
- this.topologyListPath = networkTopologyPath
- .child(Topology.class, new TopologyKey(new TopologyId(TopologyNetconf.QNAME.getLocalName())));
+ NetconfDeviceTopologyAdapter(final DataBroker dataBroker, final RemoteDeviceId id) {
+ this.dataBroker = requireNonNull(dataBroker);
+ this.id = requireNonNull(id);
+ txChain = dataBroker.createMergingTransactionChain(this);
- initDeviceData();
- }
-
- private void initDeviceData() {
final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
-
- createNetworkTopologyIfNotPresent(writeTx);
-
- final InstanceIdentifier<Node> path = id.getTopologyBindingPath();
- final NodeBuilder nodeBuilder = getNodeIdBuilder(id);
- NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder();
- netconfNodeBuilder.setConnectionStatus(ConnectionStatus.Connecting);
- netconfNodeBuilder.setHost(id.getHost());
- netconfNodeBuilder.setPort(new PortNumber(id.getAddress().getPort()));
- nodeBuilder.addAugmentation(NetconfNode.class, netconfNodeBuilder.build());
- Node node = nodeBuilder.build();
-
- LOG.trace("{}: Init device state transaction {} putting if absent operational data started.",
- id, writeTx.getIdentifier());
- writeTx.put(LogicalDatastoreType.OPERATIONAL, path, node);
+ LOG.trace("{}: Init device state transaction {} putting if absent operational data started.", id,
+ writeTx.getIdentifier());
+ writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath(), getNodeIdBuilder(id)
+ .addAugmentation(new NetconfNodeBuilder()
+ .setConnectionStatus(ConnectionStatus.Connecting)
+ .setHost(id.getHost())
+ .setPort(new PortNumber(Uint16.valueOf(id.getAddress().getPort()))).build())
+ .build());
LOG.trace("{}: Init device state transaction {} putting operational data ended.", id, writeTx.getIdentifier());
- LOG.trace("{}: Init device state transaction {} putting if absent config data started.",
- id, writeTx.getIdentifier());
- LOG.trace("{}: Init device state transaction {} putting config data ended.", id, writeTx.getIdentifier());
commitTransaction(writeTx, "init");
}
- public void updateDeviceData(final boolean up, final NetconfDeviceCapabilities capabilities) {
- final NetconfNode data = buildDataForNetconfNode(up, capabilities);
+ public void updateDeviceData(final ConnectionStatus connectionStatus,
+ final NetconfDeviceCapabilities capabilities, final LogicalDatastoreType dsType, final NetconfNode node) {
+ NetconfNode data;
+ if (node != null && dsType == LogicalDatastoreType.CONFIGURATION) {
+ data = node;
+ } else {
+ data = newNetconfNodeBuilder(connectionStatus, capabilities).build();
+ }
final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
LOG.trace("{}: Update device state transaction {} merging operational data started.",
id, writeTx.getIdentifier());
- writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath().augmentation(NetconfNode.class),
- data, true);
+ writeTx.mergeParentStructurePut(dsType, id.getTopologyBindingPath().augmentation(NetconfNode.class), data);
LOG.trace("{}: Update device state transaction {} merging operational data ended.",
id, writeTx.getIdentifier());
commitTransaction(writeTx, "update");
}
+ public void updateDeviceData(final boolean up, final NetconfDeviceCapabilities capabilities) {
+ updateDeviceData(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting, capabilities,
+ LogicalDatastoreType.OPERATIONAL, null);
+ }
+
public void updateClusteredDeviceData(final boolean up, final String masterAddress,
final NetconfDeviceCapabilities capabilities) {
- final NetconfNode data = buildDataForNetconfClusteredNode(up, masterAddress, capabilities);
-
final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
LOG.trace("{}: Update device state transaction {} merging operational data started.",
id, writeTx.getIdentifier());
- writeTx.put(LogicalDatastoreType.OPERATIONAL,
- id.getTopologyBindingPath().augmentation(NetconfNode.class), data, true);
+ writeTx.mergeParentStructurePut(LogicalDatastoreType.OPERATIONAL,
+ id.getTopologyBindingPath().augmentation(NetconfNode.class),
+ newNetconfNodeBuilder(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting, capabilities)
+ .setClusteredConnectionStatus(new ClusteredConnectionStatusBuilder()
+ .setNetconfMasterNode(masterAddress)
+ .build())
+ .build());
LOG.trace("{}: Update device state transaction {} merging operational data ended.",
id, writeTx.getIdentifier());
commitTransaction(writeTx, "update");
}
+ @Override
+ public void onTransactionChainFailed(final TransactionChain chain, final Transaction transaction,
+ final Throwable cause) {
+ LOG.warn("{}: TransactionChain({}) {} FAILED!", id, chain, transaction.getIdentifier(), cause);
+ chain.close();
+
+ txChain = dataBroker.createMergingTransactionChain(this);
+ LOG.info("{}: TransactionChain reset to {}", id, txChain);
+ // FIXME: restart last update
+ }
+
+ @Override
+ public void onTransactionChainSuccessful(final TransactionChain chain) {
+ LOG.trace("{}: TransactionChain({}) SUCCESSFUL", id, chain);
+ closeFuture.set(Empty.value());
+ }
+
public void setDeviceAsFailed(final Throwable throwable) {
- String reason = throwable != null && throwable.getMessage() != null ? throwable.getMessage() : UNKNOWN_REASON;
+ String reason = throwable != null && throwable.getMessage() != null ? throwable.getMessage() : "Unknown reason";
final NetconfNode data = new NetconfNodeBuilder()
.setHost(id.getHost())
- .setPort(new PortNumber(id.getAddress().getPort()))
+ .setPort(new PortNumber(Uint16.valueOf(id.getAddress().getPort())))
.setConnectionStatus(ConnectionStatus.UnableToConnect).setConnectedMessage(reason).build();
final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
LOG.trace(
"{}: Setting device state as failed {} putting operational data started.",
id, writeTx.getIdentifier());
- writeTx.put(LogicalDatastoreType.OPERATIONAL,
- id.getTopologyBindingPath().augmentation(NetconfNode.class), data, true);
+ writeTx.mergeParentStructurePut(LogicalDatastoreType.OPERATIONAL,
+ id.getTopologyBindingPath().augmentation(NetconfNode.class), data);
LOG.trace(
"{}: Setting device state as failed {} putting operational data ended.",
id, writeTx.getIdentifier());
commitTransaction(writeTx, "update-failed-device");
}
- private NetconfNode buildDataForNetconfNode(final boolean up, final NetconfDeviceCapabilities capabilities) {
- List<AvailableCapability> capabilityList = new ArrayList<>();
- capabilityList.addAll(capabilities.getNonModuleBasedCapabilities());
- capabilityList.addAll(capabilities.getResolvedCapabilities());
-
- final AvailableCapabilitiesBuilder avCapabalitiesBuilder = new AvailableCapabilitiesBuilder();
- avCapabalitiesBuilder.setAvailableCapability(capabilityList);
-
- final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder()
- .setHost(id.getHost())
- .setPort(new PortNumber(id.getAddress().getPort()))
- .setConnectionStatus(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting)
- .setAvailableCapabilities(avCapabalitiesBuilder.build())
- .setUnavailableCapabilities(unavailableCapabilities(capabilities.getUnresolvedCapabilites()));
-
- return netconfNodeBuilder.build();
- }
-
- private NetconfNode buildDataForNetconfClusteredNode(final boolean up, final String masterNodeAddress,
- final NetconfDeviceCapabilities capabilities) {
- List<AvailableCapability> capabilityList = new ArrayList<>();
- capabilityList.addAll(capabilities.getNonModuleBasedCapabilities());
- capabilityList.addAll(capabilities.getResolvedCapabilities());
- final AvailableCapabilitiesBuilder avCapabalitiesBuilder = new AvailableCapabilitiesBuilder();
- avCapabalitiesBuilder.setAvailableCapability(capabilityList);
-
- final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder()
- .setHost(id.getHost())
- .setPort(new PortNumber(id.getAddress().getPort()))
- .setConnectionStatus(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting)
- .setAvailableCapabilities(avCapabalitiesBuilder.build())
- .setUnavailableCapabilities(unavailableCapabilities(capabilities.getUnresolvedCapabilites()))
- .setClusteredConnectionStatus(
- new ClusteredConnectionStatusBuilder().setNetconfMasterNode(masterNodeAddress).build());
-
- return netconfNodeBuilder.build();
- }
-
- private static UnavailableCapabilities unavailableCapabilities(final Map<QName, FailureReason> input) {
- return new UnavailableCapabilitiesBuilder().setUnavailableCapability(input.entrySet().stream().map(
- e -> new UnavailableCapabilityBuilder().setCapability(e.getKey().toString()).setFailureReason(
- e.getValue()).build()).collect(Collectors.toList())).build();
- }
-
- public void removeDeviceConfiguration() {
- final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
-
- LOG.trace(
- "{}: Close device state transaction {} removing all data started.",
- id, writeTx.getIdentifier());
- writeTx.delete(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath());
- LOG.trace(
- "{}: Close device state transaction {} removing all data ended.",
- id, writeTx.getIdentifier());
-
- try {
- writeTx.commit().get();
- } catch (InterruptedException | ExecutionException e) {
- LOG.error("{}: Transaction(close) {} FAILED!", id, writeTx.getIdentifier(), e);
- throw new IllegalStateException(id + " Transaction(close) not committed correctly", e);
- }
- }
-
- private void createNetworkTopologyIfNotPresent(final WriteTransaction writeTx) {
-
- final NetworkTopology networkTopology = new NetworkTopologyBuilder().build();
- LOG.trace("{}: Merging {} container to ensure its presence", id,
- NetworkTopology.QNAME, writeTx.getIdentifier());
- writeTx.merge(LogicalDatastoreType.OPERATIONAL, networkTopologyPath, networkTopology);
-
- final Topology topology =
- new TopologyBuilder().setTopologyId(new TopologyId(TopologyNetconf.QNAME.getLocalName())).build();
- LOG.trace("{}: Merging {} container to ensure its presence", id,
- Topology.QNAME, writeTx.getIdentifier());
- writeTx.merge(LogicalDatastoreType.OPERATIONAL, topologyListPath, topology);
+ private NetconfNodeBuilder newNetconfNodeBuilder(final ConnectionStatus connectionStatus,
+ final NetconfDeviceCapabilities capabilities) {
+ return new NetconfNodeBuilder()
+ .setHost(id.getHost())
+ .setPort(new PortNumber(Uint16.valueOf(id.getAddress().getPort())))
+ .setConnectionStatus(connectionStatus)
+ .setAvailableCapabilities(new AvailableCapabilitiesBuilder()
+ .setAvailableCapability(ImmutableList.<AvailableCapability>builder()
+ .addAll(capabilities.getNonModuleBasedCapabilities())
+ .addAll(capabilities.getResolvedCapabilities())
+ .build())
+ .build())
+ .setUnavailableCapabilities(new UnavailableCapabilitiesBuilder()
+ .setUnavailableCapability(capabilities.getUnresolvedCapabilites().entrySet().stream()
+ .map(unresolved -> new UnavailableCapabilityBuilder()
+ // FIXME: better conversion than 'toString' ?
+ .setCapability(unresolved.getKey().toString())
+ .setFailureReason(unresolved.getValue())
+ .build())
+ .collect(Collectors.toUnmodifiableList()))
+ .build());
}
private void commitTransaction(final WriteTransaction transaction, final String txType) {
- LOG.trace("{}: Committing Transaction {}:{}", id, txType,
- transaction.getIdentifier());
+ LOG.trace("{}: Committing Transaction {}:{}", id, txType, transaction.getIdentifier());
transaction.commit().addCallback(new FutureCallback<CommitInfo>() {
@Override
public void onSuccess(final CommitInfo result) {
- LOG.trace("{}: Transaction({}) {} SUCCESSFUL", id, txType,
- transaction.getIdentifier());
+ LOG.trace("{}: Transaction({}) {} SUCCESSFUL", id, txType, transaction.getIdentifier());
}
@Override
public void onFailure(final Throwable throwable) {
- LOG.error("{}: Transaction({}) {} FAILED!", id, txType,
- transaction.getIdentifier(), throwable);
- throw new IllegalStateException(
- id + " Transaction(" + txType + ") not committed correctly", throwable);
+ LOG.error("{}: Transaction({}) {} FAILED!", id, txType, transaction.getIdentifier(), throwable);
}
}, MoreExecutors.directExecutor());
}
private static NodeBuilder getNodeIdBuilder(final RemoteDeviceId id) {
- final NodeBuilder nodeBuilder = new NodeBuilder();
- nodeBuilder.withKey(new NodeKey(new NodeId(id.getName())));
- return nodeBuilder;
+ return new NodeBuilder().withKey(new NodeKey(new NodeId(id.getName())));
}
@Override
public void close() {
- removeDeviceConfiguration();
- }
+ final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
+ LOG.trace("{}: Close device state transaction {} removing all data started.", id, writeTx.getIdentifier());
+ writeTx.delete(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath());
+ LOG.trace("{}: Close device state transaction {} removing all data ended.", id, writeTx.getIdentifier());
+ commitTransaction(writeTx, "close");
+
+ txChain.close();
- public void setTxChain(final BindingTransactionChain txChain) {
- this.txChain = Preconditions.checkNotNull(txChain);
+ try {
+ closeFuture.get();
+ } catch (InterruptedException | ExecutionException e) {
+ LOG.error("{}: Transaction(close) {} FAILED!", id, writeTx.getIdentifier(), e);
+ throw new IllegalStateException(id + " Transaction(close) not committed correctly", e);
+ }
}
}
Code Review / netconf.git / blobdiff