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.ArrayList;
  25 import java.util.List;
  26
  27 public class PolicyWriter {
  28
  29     private static final Logger LOG = LoggerFactory.getLogger(PolicyWriter.class);
  30
  31     private final DataBroker mountpoint;
  32     // Local cache
  33     private final List<ClassMap> classMapEntries;
  34     private final List<Class> policyMapEntries;
  35     private final List<ServiceFfName> remoteForwarders;
  36     private final List<ServiceChain> serviceChains;
  37     private final NodeId nodeId;
  38     private final String interfaceName;
  39     private final String policyMapName;
  40     private final String managementIpAddress;
  41
  42     public PolicyWriter(final DataBroker dataBroker, final String interfaceName, final String ipAddress,
  43                         final String policyMapName, final NodeId nodeId) {
  44         classMapEntries = new ArrayList<>();
  45         policyMapEntries = new ArrayList<>();
  46         remoteForwarders = new ArrayList<>();
  47         serviceChains = new ArrayList<>();
  48
  49         this.nodeId = Preconditions.checkNotNull(nodeId);
  50         mountpoint = Preconditions.checkNotNull(dataBroker);
  51         managementIpAddress = Preconditions.checkNotNull(ipAddress);
  52         this.interfaceName = Preconditions.checkNotNull(interfaceName);
  53         this.policyMapName = Preconditions.checkNotNull(policyMapName);
  54     }
  55
  56     public void cache(ClassMap classMap) {
  57         classMapEntries.add(classMap);
  58     }
  59
  60     public void cache(List<Class> policyMapEntries) {
  61         this.policyMapEntries.addAll(policyMapEntries);
  62     }
  63
  64     public void cache(ServiceFfName remoteForwarder) {
  65         remoteForwarders.add(remoteForwarder);
  66     }
  67
  68     public void cache(ServiceChain serviceChain) {
  69         serviceChains.add(serviceChain);
  70     }
  71
  72     public CheckedFuture<Boolean, TransactionCommitFailedException> commitToDatastore() {
  73         LOG.info("Configuring policy on node {} ... ", nodeId.getValue());
  74         // SFC
  75         boolean remoteResult = PolicyWriterUtil.writeRemote(remoteForwarders, nodeId, mountpoint);
  76         boolean servicePathsResult = PolicyWriterUtil.writeServicePaths(serviceChains, nodeId, mountpoint);
  77         // GBP - maintain order!
  78         boolean classMapResult = PolicyWriterUtil.writeClassMaps(classMapEntries, nodeId, mountpoint);
  79         boolean policyMapResult = PolicyWriterUtil.writePolicyMap(policyMapName, policyMapEntries, nodeId, mountpoint);
  80         boolean interfaceResult = PolicyWriterUtil.writeInterface(policyMapName, interfaceName, nodeId, mountpoint);
  81         // Result
  82         LOG.info("Policy configuration on node {} completed", nodeId.getValue());
  83         return Futures.immediateCheckedFuture(classMapResult && policyMapResult && interfaceResult && remoteResult
  84                 && servicePathsResult);
  85     }
  86
  87     public CheckedFuture<Boolean, TransactionCommitFailedException> removeFromDatastore() {
  88         LOG.info("Removing policy from node {} ... ", nodeId.getValue());
  89         // GBP - maintain order!
  90         boolean policyMapEntriesResult = PolicyWriterUtil.removePolicyMapEntries(policyMapName, policyMapEntries,
  91                 nodeId, mountpoint);
  92         boolean classMapResult = PolicyWriterUtil.removeClassMaps(classMapEntries, nodeId, mountpoint);
  93         // TODO remove class map?
  94         // SFC
  95         boolean servicePathsResult = PolicyWriterUtil.removeServicePaths(serviceChains, nodeId, mountpoint);
  96         // TODO remove remote forwarders
  97         // Result
  98         LOG.info("Policy removed from node {}", nodeId.getValue());
  99         return Futures.immediateCheckedFuture(classMapResult && policyMapEntriesResult && servicePathsResult);
 100     }
 101
 102     public String getManagementIpAddress() {
 103         return managementIpAddress;
 104     }
 105
 106     public DataBroker getCurrentMountpoint() {
 107         return mountpoint;
 108     }
 109
 110     public NodeId getCurrentNodeId() {
 111         return nodeId;
 112     }
 113 }