org.opendaylight.sfc.pot.provider.SfcPotRspProcessor Maven / Gradle / Ivy
/*
* Copyright (c) 2016, 2017 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.sfc.pot.provider;
import javax.inject.Inject;
import javax.inject.Singleton;
import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
import org.opendaylight.sfc.provider.api.SfcDataStoreAPI;
import org.opendaylight.sfc.provider.api.SfcProviderRenderedPathAPI;
import org.opendaylight.sfc.provider.api.SfcProviderServiceChainAPI;
import org.opendaylight.sfc.provider.api.SfcProviderServicePathAPI;
import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.common.rev151017.RspName;
import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.common.rev151017.SfcName;
import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.common.rev151017.SfpName;
import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.ioam.nb.pot.rev161122.BitMaskOptions;
import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.ioam.nb.pot.rev161122.RspIoamPotAugmentation;
import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.ioam.nb.pot.rev161122.RspIoamPotAugmentationBuilder;
import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.ioam.nb.pot.rev161122.TimeResolution;
import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.rsp.rev140701.RenderedServicePaths;
import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.rsp.rev140701.rendered.service.paths.RenderedServicePath;
import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.rsp.rev140701.rendered.service.paths.RenderedServicePathBuilder;
import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.rsp.rev140701.rendered.service.paths.RenderedServicePathKey;
import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sfc.rev140701.service.function.chain.grouping.ServiceFunctionChain;
import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sfp.rev140701.service.function.paths.ServiceFunctionPath;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* This class is used to handle RPC for SFC iOAM Proof of Transit
* (https://github.com/CiscoDevNet/iOAM) enable and disable.
*
*
*
* @author Srihari Raghavan ([email protected])
* @version 0.1
* @since 2016-06-01
*/
@Singleton
public final class SfcPotRspProcessor {
private static final Logger LOG = LoggerFactory.getLogger(SfcPotRspProcessor.class);
@Inject
public SfcPotRspProcessor() {
}
/**
* This utility method adds augmentations to the RSP with a record to enable
* iOAM Proof of Transit and related parameters.
*
*
*
* @param rsp Rendered service path (SFC) to enable trace on.
* @param refreshPeriodTimeUnits iOAM PoT configuration refresh period time units.
* @param refreshPeriodValue iOAM PoT configuration refresh period.
* @param ioamPotProfileBitMask iOAM internal configuration parameter.
* @param ioamPotNumProfiles iOAM number of PoT profiles per node.
* @return success or failure.
*/
public boolean enableSfcPot(RenderedServicePath rsp,
final java.lang.Class refreshPeriodTimeUnits,
Long refreshPeriodValue, BitMaskOptions ioamPotProfileBitMask,
Long ioamPotNumProfiles) {
SfpName sfpName;
RenderedServicePathBuilder renderedServicePathBuilder;
RspIoamPotAugmentationBuilder rspIoamPotAugmentationBuilder;
rspIoamPotAugmentationBuilder = new RspIoamPotAugmentationBuilder();
renderedServicePathBuilder = new RenderedServicePathBuilder(rsp);
sfpName = rsp.getParentServiceFunctionPath();
if (sfpName == null) {
LOG.warn("iOAM:PoT:Enable:ServiceFunctionPath is invalid.");
return false;
}
ServiceFunctionPath sfp = SfcProviderServicePathAPI.readServiceFunctionPath(sfpName);
SfcName serviceFunctionChainNameObj;
serviceFunctionChainNameObj = sfp.getServiceChainName();
ServiceFunctionChain serviceFunctionChain;
serviceFunctionChain = serviceFunctionChainNameObj != null ? SfcProviderServiceChainAPI
.readServiceFunctionChain(serviceFunctionChainNameObj) : null;
if (serviceFunctionChain == null) {
LOG.error("iOAM:PoT:Enable:ServiceFunctionChain for Path:{} is invalid.", sfp.getName());
return false;
}
/* Set the iOAM PoT parameters */
rspIoamPotAugmentationBuilder.setIoamPotEnable(true);
rspIoamPotAugmentationBuilder.setRefreshPeriodTimeUnits(refreshPeriodTimeUnits);
rspIoamPotAugmentationBuilder.setRefreshPeriodValue(refreshPeriodValue);
rspIoamPotAugmentationBuilder.setIoamPotBitMask(ioamPotProfileBitMask);
rspIoamPotAugmentationBuilder.setIoamPotNumProfiles(ioamPotNumProfiles);
/* remove the existing augmentation, if any */
renderedServicePathBuilder.removeAugmentation(RspIoamPotAugmentation.class);
/* add augmentation */
renderedServicePathBuilder.addAugmentation(RspIoamPotAugmentation.class, rspIoamPotAugmentationBuilder.build());
/*
* Re-create the RSP with the fresh details and store back to the
* datastore.
*/
RenderedServicePathKey renderedServicePathKey = new RenderedServicePathKey(
renderedServicePathBuilder.getName());
InstanceIdentifier rspIID;
rspIID = InstanceIdentifier.builder(RenderedServicePaths.class)
.child(RenderedServicePath.class, renderedServicePathKey).build();
RenderedServicePath renderedServicePath = renderedServicePathBuilder.build();
/* Write to datastore */
if (SfcDataStoreAPI.writeMergeTransactionAPI(rspIID, renderedServicePath, LogicalDatastoreType.OPERATIONAL)) {
LOG.debug("iOAM:PoT:Enable:Updated RSP: {}", sfp.getName());
} else {
LOG.warn("iOAM:PoT:Enable:{}:Failed to update Rendered Service Path:{}",
Thread.currentThread().getStackTrace()[1], sfp.getName());
return false;
}
return true;
}
public boolean enableSfcPot(RspName rspName, final java.lang.Class refreshPeriodTimeUnits,
Long refreshPeriodValue, BitMaskOptions ioamPotProfileBitMask,
Long ioamPotNumProfiles) {
RenderedServicePath rsp = SfcProviderRenderedPathAPI.readRenderedServicePath(rspName);
if (rsp == null) {
LOG.error("iOAM:PoT:Enable:Rendered service path by name:{} does not exist.", rspName);
return false;
}
return enableSfcPot(rsp, refreshPeriodTimeUnits, refreshPeriodValue, ioamPotProfileBitMask, ioamPotNumProfiles);
}
public boolean disableSfcPot(RspName rspName) {
RenderedServicePath rsp = SfcProviderRenderedPathAPI.readRenderedServicePath(rspName);
if (rsp == null) {
LOG.error("iOAM:PoT:Disable:Rendered service path by name:{} does not exist.", rspName);
return false;
}
return disableSfcPot(rsp);
}
/**
* This method updates iOAM augmentations to the RSP to disable iOAM Proof
* of Transit feature.
*
*
* @param rsp Rendered service path (SFC) to disable trace on.
* @return success or failure.
*/
public boolean disableSfcPot(RenderedServicePath rsp) {
RenderedServicePathBuilder renderedServicePathBuilder;
RspIoamPotAugmentationBuilder rspIoamPotAugmentationBuilder;
SfpName sfpName;
rspIoamPotAugmentationBuilder = new RspIoamPotAugmentationBuilder();
renderedServicePathBuilder = new RenderedServicePathBuilder(rsp);
sfpName = rsp.getParentServiceFunctionPath();
if (sfpName == null) {
LOG.error("iOAM:PoT:Disable:ServiceFunctionPath: parentServiceFunctionPath for {} is null.", rsp);
return false;
}
ServiceFunctionPath sfp;
sfp = SfcProviderServicePathAPI.readServiceFunctionPath(sfpName);
SfcName serviceFunctionChainNameObj = sfp.getServiceChainName();
ServiceFunctionChain serviceFunctionChain;
serviceFunctionChain = serviceFunctionChainNameObj != null ? SfcProviderServiceChainAPI
.readServiceFunctionChain(serviceFunctionChainNameObj) : null;
if (serviceFunctionChain == null) {
LOG.error("iOAM:PoT:Disable:ServiceFunctionChain name for Path {} is null.", sfp.getName());
return false;
}
/*
* update the iOAM PoT record to disable the PoT. Note: Not deleting the
* record, as some parameters might be needed SB for handling disable.
*/
rspIoamPotAugmentationBuilder.setIoamPotEnable(false);
/* update the augmentation */
renderedServicePathBuilder.removeAugmentation(RspIoamPotAugmentation.class);
renderedServicePathBuilder.addAugmentation(RspIoamPotAugmentation.class, rspIoamPotAugmentationBuilder.build());
/*
* Re-create the RSP with the fresh details and store back to the
* datastore.
*/
RenderedServicePathKey renderedServicePathKey = new RenderedServicePathKey(
renderedServicePathBuilder.getName());
InstanceIdentifier rspIID;
rspIID = InstanceIdentifier.builder(RenderedServicePaths.class)
.child(RenderedServicePath.class, renderedServicePathKey).build();
RenderedServicePath renderedServicePath = renderedServicePathBuilder.build();
/* Write to datastore */
if (SfcDataStoreAPI.writeMergeTransactionAPI(rspIID, renderedServicePath, LogicalDatastoreType.OPERATIONAL)) {
LOG.debug("iOAM:PoT:Disable:Updated RSP: {}", sfp.getName());
} else {
LOG.warn("iOAM:PoT:Disable:{}:Failed to update Rendered Service Path: {}",
Thread.currentThread().getStackTrace()[1], sfp.getName());
return false;
}
return true;
}
}