-/**
+/*
* Copyright (c) 2014, 2017 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
*/
package org.opendaylight.openflowplugin.applications.frm.impl;
-import com.google.common.base.Preconditions;
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.util.concurrent.FutureCallback;
+import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.MoreExecutors;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.util.Collection;
-import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
-import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
+import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.mdsal.binding.api.DataBroker;
+import org.opendaylight.mdsal.binding.api.DataObjectModification;
+import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
+import org.opendaylight.mdsal.binding.api.DataTreeModification;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
import org.opendaylight.openflowplugin.applications.frm.ForwardingRulesCommiter;
import org.opendaylight.openflowplugin.applications.frm.ForwardingRulesManager;
+import org.opendaylight.openflowplugin.applications.frm.NodeConfigurator;
+import org.opendaylight.serviceutils.srm.RecoverableListener;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
+import org.opendaylight.yangtools.concepts.ListenerRegistration;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * AbstractChangeListner implemented basic {@link org.opendaylight.controller.md.sal.binding.api.DataTreeModification}
+ * AbstractChangeListner implemented basic {@link org.opendaylight.mdsal.binding.api.DataTreeModification}
* processing for flow node subDataObject (flows, groups and meters).
*/
-public abstract class AbstractListeningCommiter <T extends DataObject> implements ForwardingRulesCommiter<T> {
+public abstract class AbstractListeningCommiter<T extends DataObject>
+ implements ForwardingRulesCommiter<T>, RecoverableListener {
private static final Logger LOG = LoggerFactory.getLogger(AbstractListeningCommiter.class);
- ForwardingRulesManager provider;
- private final Class<T> clazz;
+ final ForwardingRulesManager provider;
+ NodeConfigurator nodeConfigurator;
+ protected final DataBroker dataBroker;
+ protected final ListenerRegistrationHelper registrationHelper;
+ protected ListenerRegistration<AbstractListeningCommiter> listenerRegistration;
+
+ @SuppressFBWarnings(value = "MC_OVERRIDABLE_METHOD_CALL_IN_CONSTRUCTOR", justification = "See FIXME below")
+ protected AbstractListeningCommiter(final ForwardingRulesManager provider, final DataBroker dataBroker,
+ final ListenerRegistrationHelper registrationHelper) {
+ this.provider = requireNonNull(provider, "ForwardingRulesManager can not be null!");
+ this.nodeConfigurator = requireNonNull(provider.getNodeConfigurator(), "NodeConfigurator can not be null!");
+ this.dataBroker = requireNonNull(dataBroker, "DataBroker can not be null!");
+ this.registrationHelper = requireNonNull(registrationHelper, "registrationHelper can not be null!");
- public AbstractListeningCommiter (ForwardingRulesManager provider, Class<T> clazz) {
- this.provider = Preconditions.checkNotNull(provider, "ForwardingRulesManager can not be null!");
- this.clazz = Preconditions.checkNotNull(clazz, "Class can not be null!");
+ // FIXME: this may start listening on an uninitialized object: clean up the lifecycle here
+ registerListener();
+ provider.addRecoverableListener(this);
}
+ @SuppressWarnings("checkstyle:IllegalCatch")
@Override
- public void onDataTreeChanged(Collection<DataTreeModification<T>> changes) {
- Preconditions.checkNotNull(changes, "Changes may not be null!");
- LOG.trace("Received data changes :{}", changes);
+ public void onDataTreeChanged(final Collection<DataTreeModification<T>> changes) {
+ LOG.trace("Received data changes :{}", requireNonNull(changes, "Changes may not be null!"));
for (DataTreeModification<T> change : changes) {
final InstanceIdentifier<T> key = change.getRootPath().getRootIdentifier();
final DataObjectModification<T> mod = change.getRootNode();
final InstanceIdentifier<FlowCapableNode> nodeIdent =
key.firstIdentifierOf(FlowCapableNode.class);
- if (preConfigurationCheck(nodeIdent)) {
- switch (mod.getModificationType()) {
- case DELETE:
- remove(key, mod.getDataBefore(), nodeIdent);
- break;
- case SUBTREE_MODIFIED:
- update(key, mod.getDataBefore(), mod.getDataAfter(), nodeIdent);
- break;
- case WRITE:
- if (mod.getDataBefore() == null) {
- add(key, mod.getDataAfter(), nodeIdent);
- } else {
- update(key, mod.getDataBefore(), mod.getDataAfter(), nodeIdent);
- }
- break;
- default:
- throw new IllegalArgumentException("Unhandled modification type " + mod.getModificationType());
- }
- }
- else{
- if (provider.getConfiguration().isStaleMarkingEnabled()) {
- LOG.info("Stale-Marking ENABLED and switch {} is NOT connected, storing stale entities",
- nodeIdent.toString());
- // Switch is NOT connected
+ try {
+ if (preConfigurationCheck(nodeIdent)) {
switch (mod.getModificationType()) {
case DELETE:
- createStaleMarkEntity(key, mod.getDataBefore(), nodeIdent);
+ remove(key, mod.getDataBefore(), nodeIdent);
break;
case SUBTREE_MODIFIED:
+ update(key, mod.getDataBefore(), mod.getDataAfter(), nodeIdent);
break;
case WRITE:
+ if (mod.getDataBefore() == null) {
+ add(key, mod.getDataAfter(), nodeIdent);
+ } else {
+ update(key, mod.getDataBefore(), mod.getDataAfter(), nodeIdent);
+ }
break;
default:
- throw new IllegalArgumentException("Unhandled modification type " + mod.getModificationType());
+ throw new
+ IllegalArgumentException("Unhandled modification type "
+ + mod.getModificationType());
+ }
+ } else {
+ if (provider.isStaleMarkingEnabled()) {
+ LOG.info("Stale-Marking ENABLED and switch {} is NOT connected, storing stale entities",
+ nodeIdent.toString());
+ // Switch is NOT connected
+ switch (mod.getModificationType()) {
+ case DELETE:
+ createStaleMarkEntity(key, mod.getDataBefore(), nodeIdent);
+ break;
+ case SUBTREE_MODIFIED:
+ break;
+ case WRITE:
+ break;
+ default:
+ throw new
+ IllegalArgumentException("Unhandled modification type "
+ + mod.getModificationType());
+ }
}
}
+ } catch (RuntimeException e) {
+ LOG.error("Failed to handle event {} key {} due to error ", mod.getModificationType(), key, e);
}
}
}
+ @Override
+ public final void registerListener() {
+ final DataTreeIdentifier<T> treeId =
+ DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION, getWildCardPath());
+ Futures.addCallback(registrationHelper.checkedRegisterListener(treeId, this),
+ new FutureCallback<ListenerRegistration<AbstractListeningCommiter>>() {
+ @Override
+ public void onSuccess(
+ @Nullable final ListenerRegistration<AbstractListeningCommiter> flowListenerRegistration) {
+ LOG.info("{} registered successfully", flowListenerRegistration.getInstance());
+ listenerRegistration = flowListenerRegistration;
+ }
+
+ @Override
+ public void onFailure(final Throwable throwable) {
+ LOG.error("Registration failed ", throwable);
+ }
+ }, MoreExecutors.directExecutor());
+ }
+
/**
* Method return wildCardPath for Listener registration
- * and for identify the correct KeyInstanceIdentifier from data;
+ * and for identify the correct KeyInstanceIdentifier from data.
*/
protected abstract InstanceIdentifier<T> getWildCardPath();
private boolean preConfigurationCheck(final InstanceIdentifier<FlowCapableNode> nodeIdent) {
- Preconditions.checkNotNull(nodeIdent, "FlowCapableNode identifier can not be null!");
+ requireNonNull(nodeIdent, "FlowCapableNode identifier can not be null!");
// In single node cluster, node should be in local cache before we get any flow/group/meter
// data change event from data store. So first check should pass.
// In case of 3-node cluster, when shard leader changes, clustering will send blob of data
// skip the flow/group/meter operational. This requires an addition check, where it reads
// node from operational data store and if it's present it calls flowNodeConnected to explicitly
// trigger the event of new node connected.
-
- if(!provider.isNodeOwner(nodeIdent)) { return false; }
-
- if (!provider.isNodeActive(nodeIdent)) {
- if (provider.checkNodeInOperationalDataStore(nodeIdent)) {
- return true;
- } else {
- return false;
- }
- }
- return true;
+ return provider.isNodeOwner(nodeIdent);
}
-}
-
+}
\ No newline at end of file