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