renderers/ios-xe/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ios_xe_provider/impl/writer/PolicyWriter.java

   1 /*
   2  * Copyright (c) 2016 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
   9 package org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.impl.writer;
  10
  11 import java.util.HashSet;
  12 import java.util.Set;
  13 import com.google.common.base.Preconditions;
  14 import com.google.common.util.concurrent.CheckedFuture;
  15 import com.google.common.util.concurrent.Futures;
  16 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  17 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  18 import org.opendaylight.yang.gen.v1.urn.ios.rev160308._native.ClassMap;
  19 import org.opendaylight.yang.gen.v1.urn.ios.rev160308._native.ServiceChain;
  20 import org.opendaylight.yang.gen.v1.urn.ios.rev160308._native.policy.map.Class;
  21 import org.opendaylight.yang.gen.v1.urn.ios.rev160308._native.service.chain.service.function.forwarder.ServiceFfName;
  22 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  23 import org.slf4j.Logger;
  24 import org.slf4j.LoggerFactory;
  25
  26 public class PolicyWriter {
  27
  28     private static final Logger LOG = LoggerFactory.getLogger(PolicyWriter.class);
  29
  30     private final DataBroker mountpoint;
  31     // Local cache
  32     private final Set<ClassMap> classMapEntries;
  33     private final Set<Class> policyMapEntries;
  34     private final Set<ServiceFfName> remoteForwarders;
  35     private final Set<ServiceChain> serviceChains;
  36     private final NodeId nodeId;
  37     private final String interfaceName;
  38     private final String policyMapName;
  39     private final String managementIpAddress;
  40
  41     public PolicyWriter(final DataBroker dataBroker, final String interfaceName, final String ipAddress,
  42                         final String policyMapName, final NodeId nodeId) {
  43         classMapEntries = new HashSet<>();
  44         policyMapEntries = new HashSet<>();
  45         remoteForwarders = new HashSet<>();
  46         serviceChains = new HashSet<>();
  47
  48         this.nodeId = Preconditions.checkNotNull(nodeId);
  49         mountpoint = Preconditions.checkNotNull(dataBroker);
  50         managementIpAddress = Preconditions.checkNotNull(ipAddress);
  51         this.interfaceName = Preconditions.checkNotNull(interfaceName);
  52         this.policyMapName = Preconditions.checkNotNull(policyMapName);
  53     }
  54
  55     public CheckedFuture<Boolean, TransactionCommitFailedException> commitToDatastore() {
  56         LOG.debug("Configuring policy on node {}, interface {} ... ", nodeId.getValue(), interfaceName);
  57         if (policyMapEntries.isEmpty()) {
  58             LOG.debug("Policy map {} is empty, skipping", policyMapName);
  59             return Futures.immediateCheckedFuture(true);
  60         }
  61         // SFC
  62         boolean remoteResult = PolicyWriterUtil.writeRemote(remoteForwarders, nodeId, mountpoint);
  63         boolean servicePathsResult = PolicyWriterUtil.writeServicePaths(serviceChains, nodeId, mountpoint);
  64         // GBP - maintain order!
  65         boolean classMapResult = PolicyWriterUtil.writeClassMaps(classMapEntries, nodeId, mountpoint);
  66         boolean policyMapResult = PolicyWriterUtil.writePolicyMap(policyMapName, policyMapEntries, nodeId, mountpoint);
  67         boolean interfaceResult = PolicyWriterUtil.writeInterface(policyMapName, interfaceName, nodeId, mountpoint);
  68         // Result
  69         LOG.info("Policy-map created on node {}, interface {}", nodeId.getValue(), interfaceName);
  70         return Futures.immediateCheckedFuture(classMapResult && policyMapResult && interfaceResult && remoteResult
  71                 && servicePathsResult);
  72     }
  73
  74     public CheckedFuture<Boolean, TransactionCommitFailedException> removeFromDatastore() {
  75         LOG.debug("Removing policy from node {}, interface {} ... ", nodeId.getValue(), interfaceName);
  76         if (policyMapEntries.isEmpty()) {
  77             LOG.debug("Policy map {} is empty, nothing to remove", policyMapName);
  78             return Futures.immediateCheckedFuture(true);
  79         }
  80         // GBP - maintain order!
  81         boolean policyMapEntriesResult = PolicyWriterUtil.removePolicyMapEntries(policyMapName, policyMapEntries,
  82                 nodeId, mountpoint);
  83         boolean classMapResult = PolicyWriterUtil.removeClassMaps(classMapEntries, nodeId, mountpoint);
  84         // SFC
  85         boolean remoteSffResult = PolicyWriterUtil.removeRemote(remoteForwarders, nodeId, mountpoint);
  86         boolean servicePathsResult = PolicyWriterUtil.removeServicePaths(serviceChains, nodeId, mountpoint);
  87         // Result
  88         LOG.info("Policy-map removed from node {}, interface {}", nodeId.getValue(), interfaceName);
  89         return Futures.immediateCheckedFuture(classMapResult && policyMapEntriesResult && servicePathsResult
  90                 && remoteSffResult);
  91     }
  92
  93     public void cache(ClassMap classMap) {
  94         classMapEntries.add(classMap);
  95     }
  96
  97     public void cache(Class policyMapEntry) {
  98         this.policyMapEntries.add(policyMapEntry);
  99     }
 100
 101     public void cache(ServiceFfName remoteForwarder) {
 102         remoteForwarders.add(remoteForwarder);
 103     }
 104
 105     public void cache(ServiceChain serviceChain) {
 106         serviceChains.add(serviceChain);
 107     }
 108
 109     public String getManagementIpAddress() {
 110         return managementIpAddress;
 111     }
 112
 113     public DataBroker getMountpoint() {
 114         return mountpoint;
 115     }
 116
 117     public NodeId getNodeId() {
 118         return nodeId;
 119     }
 120 }