extension/openflowplugin-extension-onf/src/main/java/org/opendaylight/openflowplugin/extension/onf/converter/BundleAddMessageConverter.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies s.r.o. 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.openflowplugin.extension.onf.converter;
  10
  11 import java.util.List;
  12 import java.util.Optional;
  13 import org.opendaylight.openflowplugin.extension.api.ConverterMessageToOFJava;
  14 import org.opendaylight.openflowplugin.extension.api.ConvertorMessageFromOFJava;
  15 import org.opendaylight.openflowplugin.extension.api.ExtensionConvertorData;
  16 import org.opendaylight.openflowplugin.extension.api.exception.ConversionException;
  17 import org.opendaylight.openflowplugin.extension.api.path.MessagePath;
  18 import org.opendaylight.openflowplugin.extension.onf.OnfConstants;
  19 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
  20 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManagerFactory;
  21 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.data.XidConvertorData;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInputBuilder;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInputBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.flow.update.UpdatedFlowBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.port.mod.port.PortBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.AddGroupInputBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.RemoveGroupInputBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.group.update.UpdatedGroupBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.ExperimenterId;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowModInputBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GroupModInputBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortModInput;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.BundleInnerMessage;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleAddFlowCase;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleAddGroupCase;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleRemoveFlowCase;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleRemoveGroupCase;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleUpdateFlowCase;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleUpdateGroupCase;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleUpdatePortCase;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.send.experimenter.input.experimenter.message.of.choice.BundleAddMessageSal;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.send.experimenter.input.experimenter.message.of.choice.BundleAddMessageSalBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.send.experimenter.input.experimenter.message.of.choice.bundle.add.message.sal.SalAddMessageDataBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.bundle.add.message.grouping.bundle.inner.message.BundleFlowModCase;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.bundle.add.message.grouping.bundle.inner.message.BundleFlowModCaseBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.bundle.add.message.grouping.bundle.inner.message.BundleGroupModCase;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.bundle.add.message.grouping.bundle.inner.message.BundleGroupModCaseBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.bundle.add.message.grouping.bundle.inner.message.BundlePortModCase;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.bundle.add.message.grouping.bundle.inner.message.BundlePortModCaseBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.bundle.add.message.grouping.bundle.inner.message.bundle.flow.mod._case.FlowModCaseDataBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.bundle.add.message.grouping.bundle.inner.message.bundle.group.mod._case.GroupModCaseDataBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.bundle.add.message.grouping.bundle.inner.message.bundle.port.mod._case.PortModCaseDataBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.experimenter.input.experimenter.data.of.choice.BundleAddMessageOnf;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.experimenter.input.experimenter.data.of.choice.BundleAddMessageOnfBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.experimenter.input.experimenter.data.of.choice.bundle.add.message.onf.OnfAddMessageGroupingDataBuilder;
  56 import org.slf4j.Logger;
  57 import org.slf4j.LoggerFactory;
  58
  59 /**
  60  * Converter for BundleAddMessage messages (ONF approved extension #230).
  61  */
  62 public class BundleAddMessageConverter implements
  63         ConverterMessageToOFJava<BundleAddMessageSal, BundleAddMessageOnf, ExtensionConvertorData>,
  64         ConvertorMessageFromOFJava<BundleAddMessageOnf, MessagePath> {
  65
  66     private static final Logger LOG = LoggerFactory.getLogger(BundleAddMessageConverter.class);
  67     private static final ConvertorExecutor CONVERTER_EXECUTOR = ConvertorManagerFactory.createDefaultManager();
  68
  69     @Override
  70     public BundleAddMessageOnf convert(BundleAddMessageSal experimenterMessageCase,
  71             ExtensionConvertorData extensionData) throws ConversionException {
  72         final OnfAddMessageGroupingDataBuilder dataBuilder = new OnfAddMessageGroupingDataBuilder();
  73         dataBuilder.setBundleId(experimenterMessageCase.getSalAddMessageData().getBundleId());
  74         dataBuilder.setFlags(experimenterMessageCase.getSalAddMessageData().getFlags());
  75         dataBuilder.setBundleProperty(experimenterMessageCase.getSalAddMessageData().getBundleProperty());
  76         final BundleInnerMessage innerMessage = experimenterMessageCase.getSalAddMessageData().getBundleInnerMessage();
  77         final XidConvertorData data = new XidConvertorData(extensionData.getVersion());
  78         data.setDatapathId(extensionData.getDatapathId());
  79         data.setXid(extensionData.getXid());
  80         LOG.trace("Flow or group pushed to the node: {} with transaction id : {} is {}",
  81                 data.getDatapathId(), data.getXid(),
  82                 experimenterMessageCase.getSalAddMessageData().getBundleInnerMessage());
  83         if (innerMessage.implementedInterface().equals(BundleAddFlowCase.class)
  84                 || innerMessage.implementedInterface().equals(BundleUpdateFlowCase.class)
  85                 || innerMessage.implementedInterface().equals(BundleRemoveFlowCase.class)) {
  86             dataBuilder.setBundleInnerMessage(convertBundleFlowCase(innerMessage, data));
  87         } else if (innerMessage.implementedInterface().equals(BundleAddGroupCase.class)
  88                 || innerMessage.implementedInterface().equals(BundleUpdateGroupCase.class)
  89                 || innerMessage.implementedInterface().equals(BundleRemoveGroupCase.class)) {
  90             dataBuilder.setBundleInnerMessage(convertBundleGroupCase(innerMessage, data));
  91         } else if (innerMessage.implementedInterface().equals(BundleUpdatePortCase.class)) {
  92             dataBuilder.setBundleInnerMessage(convertBundlePortCase(innerMessage, data));
  93         } else {
  94             throw new ConversionException("Unsupported inner message");
  95         }
  96
  97         return new BundleAddMessageOnfBuilder().setOnfAddMessageGroupingData(dataBuilder.build()).build();
  98     }
  99
 100     @Override
 101     public BundleAddMessageSal convert(final BundleAddMessageOnf input, final MessagePath path) {
 102         return new BundleAddMessageSalBuilder()
 103                 .setSalAddMessageData(new SalAddMessageDataBuilder(input.getOnfAddMessageGroupingData())
 104                         .build())
 105                 .build();
 106     }
 107
 108     private BundleFlowModCase convertBundleFlowCase(final BundleInnerMessage messageCase,
 109             final XidConvertorData data) throws ConversionException {
 110         Optional<List<FlowModInputBuilder>> flowModInputs = Optional.empty();
 111         final Class clazz = messageCase.implementedInterface();
 112         if (clazz.equals(BundleAddFlowCase.class)) {
 113             flowModInputs = CONVERTER_EXECUTOR.convert(
 114                     new AddFlowInputBuilder(((BundleAddFlowCase) messageCase).getAddFlowCaseData()).build(), data);
 115         } else if (clazz.equals(BundleUpdateFlowCase.class)) {
 116             flowModInputs = CONVERTER_EXECUTOR.convert(
 117                     new UpdatedFlowBuilder(((BundleUpdateFlowCase) messageCase).getUpdateFlowCaseData()).build(), data);
 118         } else if (clazz.equals(BundleRemoveFlowCase.class)) {
 119             flowModInputs = CONVERTER_EXECUTOR.convert(
 120                     new RemoveFlowInputBuilder(((BundleRemoveFlowCase) messageCase).getRemoveFlowCaseData()).build(),
 121                     data);
 122         }
 123
 124         if (flowModInputs.isPresent()) {
 125             if (flowModInputs.get().size() == 1) {
 126                 return new BundleFlowModCaseBuilder()
 127                         .setFlowModCaseData(
 128                                 new FlowModCaseDataBuilder(
 129                                         flowModInputs
 130                                                 .get()
 131                                                 .get(0)
 132                                                 .setXid(data.getXid())
 133                                                 .build())
 134                                         .build())
 135                         .build();
 136             } else {
 137                 throw new ConversionException(
 138                         "BundleFlowCase conversion unsuccessful - not able to convert to multiple flows.");
 139             }
 140         } else {
 141             throw new ConversionException("BundleFlowCase conversion unsuccessful.");
 142         }
 143     }
 144
 145     private BundleGroupModCase convertBundleGroupCase(final BundleInnerMessage messageCase,
 146             final XidConvertorData data) throws ConversionException {
 147         Optional<GroupModInputBuilder> groupModInput = Optional.empty();
 148         final Class clazz = messageCase.implementedInterface();
 149         if (clazz.equals(BundleAddGroupCase.class)) {
 150             groupModInput = CONVERTER_EXECUTOR.convert(
 151                     new AddGroupInputBuilder(((BundleAddGroupCase) messageCase).getAddGroupCaseData()).build(), data);
 152         } else if (clazz.equals(BundleUpdateGroupCase.class)) {
 153             groupModInput = CONVERTER_EXECUTOR.convert(
 154                     new UpdatedGroupBuilder(((BundleUpdateGroupCase) messageCase).getUpdateGroupCaseData()).build(),
 155                     data);
 156         } else if (clazz.equals(BundleRemoveGroupCase.class)) {
 157             groupModInput = CONVERTER_EXECUTOR.convert(
 158                     new RemoveGroupInputBuilder(((BundleRemoveGroupCase) messageCase).getRemoveGroupCaseData()).build(),
 159                     data);
 160         }
 161
 162         if (groupModInput.isPresent()) {
 163             return new BundleGroupModCaseBuilder()
 164                     .setGroupModCaseData(
 165                             new GroupModCaseDataBuilder(groupModInput.get()
 166                                     .setXid(data.getXid())
 167                                     .build())
 168                             .build()
 169                     )
 170                     .build();
 171         } else {
 172             throw new ConversionException("BundleGroupCase conversion unsuccessful.");
 173         }
 174     }
 175
 176     private BundlePortModCase convertBundlePortCase(final BundleInnerMessage messageCase,
 177             final XidConvertorData data) throws ConversionException {
 178         Optional<PortModInput> portModInput = Optional.empty();
 179         final Class<?> clazz = messageCase.implementedInterface();
 180         if (clazz.equals(BundleUpdatePortCase.class)) {
 181             portModInput = CONVERTER_EXECUTOR.convert(new PortBuilder(
 182                     ((BundleUpdatePortCase) messageCase).getUpdatePortCaseData().getPort().getPort().get(0)).build(),
 183                     data);
 184         }
 185
 186         if (portModInput.isPresent()) {
 187             return new BundlePortModCaseBuilder()
 188                     .setPortModCaseData(
 189                             new PortModCaseDataBuilder(portModInput.get())
 190                                     .setXid(data.getXid())
 191                                     .build()
 192                     )
 193                     .build();
 194         } else {
 195             throw new ConversionException("BundlePortCase conversion unsuccessful.");
 196         }
 197     }
 198
 199     @Override
 200     public ExperimenterId getExperimenterId() {
 201         return new ExperimenterId(OnfConstants.ONF_EXPERIMENTER_ID);
 202     }
 203
 204     @Override
 205     public long getType() {
 206         return OnfConstants.ONF_ET_BUNDLE_ADD_MESSAGE;
 207     }
 208 }