2 * Copyright (c) 2014, 2017 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.openflowplugin.applications.frm.impl;
10 import com.google.common.base.Preconditions;
11 import java.util.Collection;
12 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
13 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
14 import org.opendaylight.openflowplugin.applications.frm.ForwardingRulesCommiter;
15 import org.opendaylight.openflowplugin.applications.frm.ForwardingRulesManager;
16 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
17 import org.opendaylight.yangtools.yang.binding.DataObject;
18 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
19 import org.slf4j.Logger;
20 import org.slf4j.LoggerFactory;
23 * AbstractChangeListner implemented basic {@link org.opendaylight.controller.md.sal.binding.api.DataTreeModification}
24 * processing for flow node subDataObject (flows, groups and meters).
26 public abstract class AbstractListeningCommiter<T extends DataObject> implements ForwardingRulesCommiter<T> {
28 private static final Logger LOG = LoggerFactory.getLogger(AbstractListeningCommiter.class);
29 ForwardingRulesManager provider;
31 public AbstractListeningCommiter(ForwardingRulesManager provider) {
32 this.provider = Preconditions.checkNotNull(provider, "ForwardingRulesManager can not be null!");
36 public void onDataTreeChanged(Collection<DataTreeModification<T>> changes) {
37 Preconditions.checkNotNull(changes, "Changes may not be null!");
38 LOG.trace("Received data changes :{}", changes);
40 for (DataTreeModification<T> change : changes) {
41 final InstanceIdentifier<T> key = change.getRootPath().getRootIdentifier();
42 final DataObjectModification<T> mod = change.getRootNode();
43 final InstanceIdentifier<FlowCapableNode> nodeIdent =
44 key.firstIdentifierOf(FlowCapableNode.class);
45 if (preConfigurationCheck(nodeIdent)) {
46 switch (mod.getModificationType()) {
48 remove(key, mod.getDataBefore(), nodeIdent);
50 case SUBTREE_MODIFIED:
51 update(key, mod.getDataBefore(), mod.getDataAfter(), nodeIdent);
54 if (mod.getDataBefore() == null) {
55 add(key, mod.getDataAfter(), nodeIdent);
57 update(key, mod.getDataBefore(), mod.getDataAfter(), nodeIdent);
61 throw new IllegalArgumentException("Unhandled modification type " + mod.getModificationType());
64 if (provider.isStaleMarkingEnabled()) {
65 LOG.info("Stale-Marking ENABLED and switch {} is NOT connected, storing stale entities",
66 nodeIdent.toString());
67 // Switch is NOT connected
68 switch (mod.getModificationType()) {
70 createStaleMarkEntity(key, mod.getDataBefore(), nodeIdent);
72 case SUBTREE_MODIFIED:
78 IllegalArgumentException("Unhandled modification type " + mod.getModificationType());
86 * Method return wildCardPath for Listener registration
87 * and for identify the correct KeyInstanceIdentifier from data.
89 protected abstract InstanceIdentifier<T> getWildCardPath();
91 private boolean preConfigurationCheck(final InstanceIdentifier<FlowCapableNode> nodeIdent) {
92 Preconditions.checkNotNull(nodeIdent, "FlowCapableNode identifier can not be null!");
93 // In single node cluster, node should be in local cache before we get any flow/group/meter
94 // data change event from data store. So first check should pass.
95 // In case of 3-node cluster, when shard leader changes, clustering will send blob of data
96 // present in operational data store and config data store. So ideally local node cache
97 // should get populated. But to handle a scenario where flow request comes before the blob
98 // of config/operational data gets processes, it won't find node in local cache and it will
99 // skip the flow/group/meter operational. This requires an addition check, where it reads
100 // node from operational data store and if it's present it calls flowNodeConnected to explicitly
101 // trigger the event of new node connected.
102 return provider.isNodeOwner(nodeIdent)
103 && (provider.isNodeActive(nodeIdent) || provider.checkNodeInOperationalDataStore(nodeIdent));