aclservice/impl/src/main/java/org/opendaylight/netvirt/aclservice/listeners/AclNodeListener.java

   1 /*
   2  * Copyright (c) 2016 Ericsson India Global Services Pvt Ltd. 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.netvirt.aclservice.listeners;
  10
  11 import java.math.BigInteger;
  12 import java.util.Collections;
  13 import javax.annotation.PostConstruct;
  14 import javax.inject.Inject;
  15 import javax.inject.Singleton;
  16 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  17 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  18 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  19 import org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase;
  20 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  21 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  22 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
  23 import org.opendaylight.netvirt.aclservice.utils.AclConstants;
  24 import org.opendaylight.netvirt.aclservice.utils.AclNodeDefaultFlowsTxBuilder;
  25 import org.opendaylight.netvirt.aclservice.utils.AclServiceUtils;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.config.rev160806.AclserviceConfig;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.config.rev160806.AclserviceConfig.SecurityGroupMode;
  32 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  33 import org.slf4j.Logger;
  34 import org.slf4j.LoggerFactory;
  35
  36 /**
  37  * Listener to handle flow capable node updates. Configures default ACL flows
  38  * during when node is discovered.
  39  */
  40 @Singleton
  41 public class AclNodeListener extends AsyncDataTreeChangeListenerBase<FlowCapableNode, AclNodeListener> {
  42
  43     private static final Logger LOG = LoggerFactory.getLogger(AclNodeListener.class);
  44
  45     private final IMdsalApiManager mdsalManager;
  46     private final AclserviceConfig config;
  47     private final DataBroker dataBroker;
  48     private final AclServiceUtils aclServiceUtils;
  49     private final JobCoordinator jobCoordinator;
  50
  51     private SecurityGroupMode securityGroupMode = null;
  52
  53     @Inject
  54     public AclNodeListener(final IMdsalApiManager mdsalManager, DataBroker dataBroker, AclserviceConfig config,
  55             AclServiceUtils aclServiceUtils, JobCoordinator jobCoordinator) {
  56         super(FlowCapableNode.class, AclNodeListener.class);
  57
  58         this.mdsalManager = mdsalManager;
  59         this.dataBroker = dataBroker;
  60         this.config = config;
  61         this.aclServiceUtils = aclServiceUtils;
  62         this.jobCoordinator = jobCoordinator;
  63     }
  64
  65     @Override
  66     @PostConstruct
  67     public void init() {
  68         LOG.info("{} start", getClass().getSimpleName());
  69         if (config != null) {
  70             this.securityGroupMode = config.getSecurityGroupMode();
  71         }
  72         this.aclServiceUtils.createRemoteAclIdPool();
  73         registerListener(LogicalDatastoreType.OPERATIONAL, dataBroker);
  74         LOG.info("AclserviceConfig: {}", this.config);
  75     }
  76
  77     @Override
  78     public void close() {
  79         super.close();
  80         this.aclServiceUtils.deleteRemoteAclIdPool();
  81     }
  82
  83     @Override
  84     protected InstanceIdentifier<FlowCapableNode> getWildCardPath() {
  85         return InstanceIdentifier.create(Nodes.class).child(Node.class).augmentation(FlowCapableNode.class);
  86     }
  87
  88     @Override
  89     protected void remove(InstanceIdentifier<FlowCapableNode> key, FlowCapableNode dataObjectModification) {
  90         // do nothing
  91     }
  92
  93     @Override
  94     protected void update(InstanceIdentifier<FlowCapableNode> key, FlowCapableNode dataObjectModificationBefore,
  95             FlowCapableNode dataObjectModificationAfter) {
  96         // do nothing
  97     }
  98
  99     @Override
 100     protected void add(InstanceIdentifier<FlowCapableNode> key, FlowCapableNode dataObjectModification) {
 101         NodeKey nodeKey = key.firstKeyOf(Node.class);
 102         BigInteger dpId = MDSALUtil.getDpnIdFromNodeName(nodeKey.getId());
 103         LOG.info("Received ACL node [{}] add event", dpId);
 104
 105         if (securityGroupMode != null && securityGroupMode != SecurityGroupMode.Stateful) {
 106             LOG.error("Invalid security group mode ({}) obtained from AclserviceConfig. dpId={}", securityGroupMode,
 107                     dpId);
 108             return;
 109         }
 110         jobCoordinator.enqueueJob(String.valueOf(dpId), () -> {
 111             WriteTransaction tx = this.dataBroker.newWriteOnlyTransaction();
 112             new AclNodeDefaultFlowsTxBuilder(dpId, mdsalManager, config, tx).build();
 113
 114             LOG.info("Adding default ACL flows for dpId={}", dpId);
 115             return Collections.singletonList(tx.submit());
 116         }, AclConstants.JOB_MAX_RETRIES);
 117
 118         LOG.trace("FlowCapableNode (dpid: {}) add event is processed.", dpId);
 119     }
 120
 121     @Override
 122     protected AclNodeListener getDataTreeChangeListener() {
 123         return AclNodeListener.this;
 124     }
 125 }