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