applications/forwardingrules-manager/src/main/java/org/opendaylight/openflowplugin/applications/frm/impl/FlowForwarder.java

   1 /**
   2  * Copyright (c) 2014 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.openflowplugin.applications.frm.impl;
   9
  10 import com.google.common.base.Preconditions;
  11 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  12 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
  13 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  14 import org.opendaylight.openflowplugin.applications.frm.ForwardingRulesManager;
  15 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Uri;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInputBuilder;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowTableRef;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInputBuilder;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.UpdateFlowInputBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.flow.update.OriginalFlowBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.flow.update.UpdatedFlowBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowRef;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  30 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  31 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  32 import org.slf4j.Logger;
  33 import org.slf4j.LoggerFactory;
  34
  35 /**
  36  * GroupForwarder
  37  * It implements {@link org.opendaylight.controller.md.sal.binding.api.DataChangeListener}}
  38  * for WildCardedPath to {@link Flow} and ForwardingRulesCommiter interface for methods:
  39  *  add, update and remove {@link Flow} processing for
  40  *  {@link org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent}.
  41  *
  42  * @author <a href="mailto:vdemcak@cisco.com">Vaclav Demcak</a>
  43  *
  44  */
  45 public class FlowForwarder extends AbstractListeningCommiter<Flow> {
  46
  47     private static final Logger LOG = LoggerFactory.getLogger(FlowForwarder.class);
  48
  49     private ListenerRegistration<FlowForwarder> listenerRegistration;
  50
  51     public FlowForwarder (final ForwardingRulesManager manager, final DataBroker db) {
  52         super(manager, Flow.class);
  53         Preconditions.checkNotNull(db, "DataBroker can not be null!");
  54         registrationListener(db);
  55     }
  56
  57     private void registrationListener(final DataBroker db) {
  58         final DataTreeIdentifier<Flow> treeId = new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION, getWildCardPath());
  59         try {
  60             listenerRegistration = db.registerDataTreeChangeListener(treeId, FlowForwarder.this);
  61         } catch (final Exception e) {
  62             LOG.warn("FRM Flow DataChange listener registration fail!");
  63             LOG.debug("FRM Flow DataChange listener registration fail ..", e);
  64             throw new IllegalStateException("FlowForwarder registration Listener fail! System needs restart.", e);
  65         }
  66     }
  67
  68     @Override
  69     public void close() {
  70         if (listenerRegistration != null) {
  71             try {
  72                 listenerRegistration.close();
  73             } catch (final Exception e) {
  74                 LOG.error("Error by stop FRM FlowChangeListener.", e);
  75             }
  76             listenerRegistration = null;
  77         }
  78     }
  79
  80     @Override
  81     public void remove(final InstanceIdentifier<Flow> identifier,
  82                        final Flow removeDataObj,
  83                        final InstanceIdentifier<FlowCapableNode> nodeIdent) {
  84
  85         final TableKey tableKey = identifier.firstKeyOf(Table.class, TableKey.class);
  86         if (tableIdValidationPrecondition(tableKey, removeDataObj)) {
  87             final RemoveFlowInputBuilder builder = new RemoveFlowInputBuilder(removeDataObj);
  88             builder.setFlowRef(new FlowRef(identifier));
  89             builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
  90             builder.setFlowTable(new FlowTableRef(nodeIdent.child(Table.class, tableKey)));
  91
  92             // This method is called only when a given flow object has been
  93             // removed from datastore. So FRM always needs to set strict flag
  94             // into remove-flow input so that only a flow entry associated with
  95             // a given flow object is removed.
  96             builder.setTransactionUri(new Uri(provider.getNewTransactionId())).
  97                 setStrict(Boolean.TRUE);
  98             provider.getSalFlowService().removeFlow(builder.build());
  99         }
 100     }
 101
 102     @Override
 103     public void update(final InstanceIdentifier<Flow> identifier,
 104                        final Flow original, final Flow update,
 105                        final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 106
 107         final TableKey tableKey = identifier.firstKeyOf(Table.class, TableKey.class);
 108         if (tableIdValidationPrecondition(tableKey, update)) {
 109             final UpdateFlowInputBuilder builder = new UpdateFlowInputBuilder();
 110
 111             builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 112             builder.setFlowRef(new FlowRef(identifier));
 113             builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 114
 115             // This method is called only when a given flow object in datastore
 116             // has been updated. So FRM always needs to set strict flag into
 117             // update-flow input so that only a flow entry associated with
 118             // a given flow object is updated.
 119             builder.setUpdatedFlow((new UpdatedFlowBuilder(update)).setStrict(Boolean.TRUE).build());
 120             builder.setOriginalFlow((new OriginalFlowBuilder(original)).setStrict(Boolean.TRUE).build());
 121
 122             provider.getSalFlowService().updateFlow(builder.build());
 123         }
 124     }
 125
 126     @Override
 127     public void add(final InstanceIdentifier<Flow> identifier,
 128                     final Flow addDataObj,
 129                     final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 130
 131         final TableKey tableKey = identifier.firstKeyOf(Table.class, TableKey.class);
 132         if (tableIdValidationPrecondition(tableKey, addDataObj)) {
 133             final AddFlowInputBuilder builder = new AddFlowInputBuilder(addDataObj);
 134
 135             builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 136             builder.setFlowRef(new FlowRef(identifier));
 137             builder.setFlowTable(new FlowTableRef(nodeIdent.child(Table.class, tableKey)));
 138             builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 139             provider.getSalFlowService().addFlow(builder.build());
 140         }
 141     }
 142
 143     @Override
 144     protected InstanceIdentifier<Flow> getWildCardPath() {
 145         return InstanceIdentifier.create(Nodes.class).child(Node.class)
 146                 .augmentation(FlowCapableNode.class).child(Table.class).child(Flow.class);
 147     }
 148
 149     private static boolean tableIdValidationPrecondition (final TableKey tableKey, final Flow flow) {
 150         Preconditions.checkNotNull(tableKey, "TableKey can not be null or empty!");
 151         Preconditions.checkNotNull(flow, "Flow can not be null or empty!");
 152         if (! tableKey.getId().equals(flow.getTableId())) {
 153             LOG.error("TableID in URI tableId={} and in palyload tableId={} is not same.",
 154                     flow.getTableId(), tableKey.getId());
 155             return false;
 156         }
 157         return true;
 158     }
 159 }
 160