openstack/sfc-translator/impl/src/main/java/org/opendaylight/netvirt/openstack/sfc/translator/portchain/PortChainTranslator.java

   1 /*
   2  * Copyright (c) 2016 Brocade Communications 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 package org.opendaylight.netvirt.openstack.sfc.translator.portchain;
   9
  10 import com.google.common.base.Preconditions;
  11 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.common.rev151017.SfcName;
  12 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.common.rev151017.SfpName;
  13 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.rsp.rev140701.CreateRenderedPathInput;
  14 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.rsp.rev140701.CreateRenderedPathInputBuilder;
  15 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sf.rev140701.service.functions.ServiceFunction;
  16 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sfc.rev140701.service.function.chain.grouping.ServiceFunctionChain;
  17 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sfc.rev140701.service.function.chain.grouping.ServiceFunctionChainBuilder;
  18 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sfc.rev140701.service.function.chain.grouping.ServiceFunctionChainKey;
  19 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sfc.rev140701.service.function.chain.grouping.service.function.chain.SfcServiceFunction;
  20 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sfc.rev140701.service.function.chain.grouping.service.function.chain.SfcServiceFunctionBuilder;
  21 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sfc.rev140701.service.function.chain.grouping.service.function.chain.SfcServiceFunctionKey;
  22 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sfp.rev140701.service.function.paths.ServiceFunctionPath;
  23 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sfp.rev140701.service.function.paths.ServiceFunctionPathBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.sfc.rev160511.port.chain.attributes.ChainParameters;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.sfc.rev160511.sfc.attributes.port.chains.PortChain;
  26 import org.slf4j.Logger;
  27 import org.slf4j.LoggerFactory;
  28
  29 import java.util.ArrayList;
  30 import java.util.List;
  31
  32 /**
  33  * Class will convert OpenStack Port Chain API yang models present in
  34  * neutron northbound project to OpenDaylight SFC yang models.
  35  */
  36 public class PortChainTranslator {
  37     private static final Logger LOG = LoggerFactory.getLogger(PortChainTranslator.class);
  38     private static final String SYMMETRIC_PARAM = "symmetric";
  39     private static final String SFP_NAME_PREFIX = "Path-";
  40
  41     public static ServiceFunctionChain buildServiceFunctionChain(
  42             PortChain portChain, List<ServiceFunction> sfList) {
  43         ServiceFunctionChainBuilder sfcBuilder = new ServiceFunctionChainBuilder();
  44         sfcBuilder.setName(new SfcName(portChain.getName()));
  45         sfcBuilder.setKey(new ServiceFunctionChainKey(sfcBuilder.getName()));
  46
  47         //By default set it to false. If user specify it in chain parameters, it
  48         //will be overridden.
  49         sfcBuilder.setSymmetric(false);
  50
  51         //Set service functions
  52         List<SfcServiceFunction> sfcSfList = new ArrayList<>();
  53         for(ServiceFunction sf : sfList) {
  54             SfcServiceFunctionBuilder sfcSfBuilder = new SfcServiceFunctionBuilder();
  55             sfcSfBuilder.setName(sf.getName().getValue());
  56             sfcSfBuilder.setType(sf.getType());
  57             sfcSfBuilder.setKey(new SfcServiceFunctionKey(sfcSfBuilder.getName()));
  58
  59             //NOTE: no explicit order is set.
  60             sfcSfList.add(sfcSfBuilder.build());
  61         }
  62         List<ChainParameters> cpList = portChain.getChainParameters();
  63         if (cpList != null && !cpList.isEmpty()) {
  64             for (ChainParameters cp : cpList) {
  65                 if(cp.getChainParameter().equals(SYMMETRIC_PARAM)) {
  66                     //Override the symmetric default value.
  67                     sfcBuilder.setSymmetric(new Boolean(cp.getChainParameterValue()));
  68                     break;
  69                 }
  70             }
  71         }
  72         sfcBuilder.setSfcServiceFunction(sfcSfList);
  73         return sfcBuilder.build();
  74     }
  75
  76     public static ServiceFunctionPath buildServiceFunctionPath(ServiceFunctionChain sfc) {
  77         Preconditions.checkNotNull(sfc, "Service Function Chain must not be null");
  78         ServiceFunctionPathBuilder sfpBuilder = new ServiceFunctionPathBuilder();
  79
  80         //Set the name
  81         sfpBuilder.setName(new SfpName(SFP_NAME_PREFIX + sfc.getName().getValue()));
  82
  83         sfpBuilder.setSymmetric(sfc.isSymmetric());
  84         //Set related SFC name
  85         sfpBuilder.setServiceChainName(sfc.getName());
  86         return sfpBuilder.build();
  87     }
  88
  89     public static CreateRenderedPathInput buildRenderedServicePathInput(ServiceFunctionPath sfp) {
  90         CreateRenderedPathInputBuilder rpInputBuilder = new CreateRenderedPathInputBuilder();
  91         rpInputBuilder.setName(sfp.getName().getValue());
  92         rpInputBuilder.setSymmetric(sfp.isSymmetric());
  93         rpInputBuilder.setParentServiceFunctionPath(sfp.getName().getValue());
  94         return rpInputBuilder.build();
  95     }
  96
  97     public static ServiceFunctionChainKey getSFCKey(PortChain portChain) {
  98         return new ServiceFunctionChainKey(new SfcName(portChain.getName()));
  99     }
 100 }