openstack/net-virt-sfc/impl/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/sfc/NetvirtSfcAclListener.java

   1 /*
   2  * Copyright © 2015 Dell, 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
   9 package org.opendaylight.ovsdb.openstack.netvirt.sfc;
  10
  11 import com.google.common.base.Preconditions;
  12 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  13 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
  14 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  15 import org.opendaylight.ovsdb.openstack.netvirt.sfc.openflow13.INetvirtSfcOF13Provider;
  16 import org.opendaylight.ovsdb.utils.mdsal.utils.MdsalUtils;
  17 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev150317.AccessLists;
  18 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev150317.access.lists.Acl;
  19 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev150317.access.lists.AclKey;
  20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev150317.access.lists.acl.AccessListEntries;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev150317.access.lists.acl.access.list.entries.Ace;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev150317.access.lists.acl.access.list.entries.AceKey;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.sfc.classifier.rev150105.Classifiers;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.sfc.classifier.rev150105.classifiers.Classifier;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.sfc.classifier.rev150105.classifiers.classifier.sffs.Sff;
  26 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  27 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  28 import org.slf4j.Logger;
  29 import org.slf4j.LoggerFactory;
  30
  31 /**
  32  * Data tree listener for AccessList.
  33  */
  34 public class NetvirtSfcAclListener extends AbstractDataTreeListener<Acl> {
  35     private static final Logger LOG = LoggerFactory.getLogger(NetvirtSfcAclListener.class);
  36     private ListenerRegistration<NetvirtSfcAclListener> listenerRegistration;
  37     private MdsalUtils dbutils;
  38
  39     /**
  40      * {@link NetvirtSfcAclListener} constructor.
  41      * @param provider OpenFlow 1.3 Provider
  42      * @param db MdSal {@link DataBroker}
  43      */
  44     public NetvirtSfcAclListener(final INetvirtSfcOF13Provider provider, final DataBroker db) {
  45         super(provider, Acl.class);
  46         Preconditions.checkNotNull(db, "DataBroker can not be null!");
  47
  48         dbutils = new MdsalUtils(db);
  49         registrationListener(db);
  50     }
  51
  52     private void registrationListener(final DataBroker db) {
  53         final DataTreeIdentifier<Acl> treeId =
  54                 new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION, getIetfAclIid());
  55         try {
  56             LOG.info("Registering Data Change Listener for NetvirtSfc AccesList configuration.");
  57             listenerRegistration = db.registerDataTreeChangeListener(treeId, this);
  58         } catch (final Exception e) {
  59             LOG.warn("Netvirt AccesList DataChange listener registration fail!");
  60             LOG.debug("Netvirt AccesList DataChange listener registration fail!", e);
  61             throw new IllegalStateException("NetvirtSfcAccesListListener startup fail! System needs restart.", e);
  62         }
  63     }
  64
  65     @Override
  66     public void close() {
  67         if (listenerRegistration != null) {
  68             try {
  69                 listenerRegistration.close();
  70             } catch (final Exception e) {
  71                 LOG.warn("Error while stopping IETF ACL ChangeListener: {}", e.getMessage());
  72                 LOG.debug("Error while stopping IETF ACL ChangeListener..", e);
  73             }
  74             listenerRegistration = null;
  75         }
  76     }
  77
  78     @Override
  79     public void remove(final InstanceIdentifier<Acl> identifier,
  80                        final Acl removeDataObj) {
  81         Preconditions.checkNotNull(removeDataObj, "Removed object can not be null!");
  82         String aclName = removeDataObj.getAclName();
  83
  84         Classifiers classifiers = dbutils.read(LogicalDatastoreType.CONFIGURATION, getClassifierIid());
  85         if (classifiers != null) {
  86             for (Classifier classifier : classifiers.getClassifier()) {
  87                 if (classifier.getAcl().equalsIgnoreCase(aclName)) {
  88                     if (classifier.getSffs() != null) {
  89                         for (Sff sff : classifier.getSffs().getSff()) {
  90                             provider.removeClassifierRules(sff, removeDataObj);
  91                         }
  92                     }
  93                 }
  94             }
  95         }
  96     }
  97
  98     @Override
  99     public void update(final InstanceIdentifier<Acl> identifier,
 100                        final Acl original, final Acl update) {
 101     }
 102
 103     @Override
 104     public void add(final InstanceIdentifier<Acl> identifier,
 105                     final Acl addDataObj) {
 106         Preconditions.checkNotNull(addDataObj, "Added object can not be null!");
 107         String aclName = addDataObj.getAclName();
 108         LOG.debug("Adding accesslist iid = {}, dataObj = {}", identifier, addDataObj);
 109         Classifiers classifiers = dbutils.read(LogicalDatastoreType.CONFIGURATION, getClassifierIid());
 110         if (classifiers != null) {
 111             LOG.debug("add: Classifiers: {}", classifiers);
 112             for (Classifier classifier : classifiers.getClassifier()) {
 113                 if (classifier.getAcl().equalsIgnoreCase(aclName)) {
 114                     if (classifier.getSffs() != null) {
 115                         for (Sff sff : classifier.getSffs().getSff()) {
 116                             provider.addClassifierRules(sff, addDataObj);
 117                         }
 118                     }
 119                 }
 120             }
 121         } else {
 122             LOG.debug("add: No Classifiers found");
 123         }
 124     }
 125
 126     private InstanceIdentifier<Classifiers> getClassifierIid() {
 127         return InstanceIdentifier.create(Classifiers.class);
 128     }
 129
 130     public InstanceIdentifier<Acl> getIetfAclIid() {
 131         return InstanceIdentifier.create(AccessLists.class).child(Acl.class);
 132     }
 133
 134     /**
 135      * Create an {@link Ace} {@link InstanceIdentifier}.
 136      * @param aclName is the name of the ACL
 137      * @param ruleName is the name of the rule
 138      * @return the {@link Ace} {@link InstanceIdentifier}
 139      */
 140     public InstanceIdentifier<Ace> getIetfAclEntryIid(String aclName, String ruleName) {
 141         return InstanceIdentifier.create(AccessLists.class).child(Acl.class,
 142                 new AclKey(aclName)).child(AccessListEntries.class).child(Ace.class,
 143                 new AceKey(ruleName));
 144     }
 145 }