Bug 5540 - PacketOutConvertor
[openflowplugin.git] / openflowplugin / src / main / java / org / opendaylight / openflowplugin / openflow / md / core / sal / convertor / PacketOutConvertor.java
index 50f834a46d523e514a74aa1f84b9fadfab32f9f2..3db52261d80b3ad97fc3f147d4376afe17ef5ec6 100644 (file)
@@ -1,14 +1,14 @@
-/**
+/*
  * Copyright (c) 2013 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.openflowplugin.openflow.md.core.sal.convertor;
 
 import com.google.common.collect.Iterables;
-import java.math.BigInteger;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
@@ -17,6 +17,8 @@ import org.opendaylight.controller.sal.common.util.Arguments;
 import org.opendaylight.openflowplugin.api.OFConstants;
 import org.opendaylight.openflowplugin.api.openflow.md.util.OpenflowVersion;
 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.action.data.ActionConvertorData;
+import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.common.ParametrizedConvertor;
+import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.data.PacketOutConvertorData;
 import org.opendaylight.openflowplugin.openflow.md.util.InventoryDataServiceUtil;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
@@ -33,62 +35,93 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public final class PacketOutConvertor {
+/**
+ * Converts a MD-SAL packet out data into the OF library packet out input.
+ *
+ * Example usage:
+ * <pre>
+ * {@code
+ * PacketOutConvertorData data = new PacketOutConvertorData(version);
+ * data.setDatapathId(datapathId);
+ * data.setXid(xid);
+ * Optional<PacketOutInput> ofPacketInput = ConvertorManager.getInstance().convert(salPacket, data);
+ * }
+ * </pre>
+ */
+public class PacketOutConvertor implements ParametrizedConvertor<TransmitPacketInput, PacketOutInput, PacketOutConvertorData> {
     private static final Logger LOG = LoggerFactory.getLogger(PacketOutConvertor.class);
 
-    private PacketOutConvertor() {
-
+    /**
+     * Create default empty meter mot input builder.
+     * Use this method, if result from convertor is empty.
+     *
+     * @param version Openflow version
+     * @return default empty meter mod input builder
+     */
+    public static PacketOutInput defaultResult(short version) {
+        return new PacketOutInputBuilder()
+                .setVersion(version)
+                .build();
     }
 
-    // Get all the data for the PacketOut from the Yang/SAL-Layer
+    private static PortNumber getPortNumber(final PathArgument pathArgument, final Short ofVersion) {
+        // FIXME VD P! find InstanceIdentifier helper
+        InstanceIdentifier.IdentifiableItem<?, ?> item = Arguments.checkInstanceOf(pathArgument,
+                InstanceIdentifier.IdentifiableItem.class);
+        NodeConnectorKey key = Arguments.checkInstanceOf(item.getKey(), NodeConnectorKey.class);
+        Long port = InventoryDataServiceUtil.portNumberfromNodeConnectorId(
+                OpenflowVersion.get(ofVersion), key.getId());
+        return new PortNumber(port);
+    }
 
-    /**
-     * @param version openflow version
-     * @param inputPacket input packet
-     * @param datapathid  datapath id
-     * @param xid tx id
-     * @return PacketOutInput required by OF Library
-     */
-    public static PacketOutInput toPacketOutInput(final TransmitPacketInput inputPacket, final short version, final Long xid,
-                                                  final BigInteger datapathid) {
+    @Override
+    public Class<?> getType() {
+        return TransmitPacketInput.class;
+    }
 
-        LOG.trace("toPacketOutInput for datapathId:{}, xid:{}", datapathid, xid);
+    @Override
+    public PacketOutInput convert(TransmitPacketInput source, PacketOutConvertorData data) {
+        LOG.trace("toPacketOutInput for datapathId:{}, xid:{}", data.getDatapathId(), data.getXid());
         // Build Port ID from TransmitPacketInput.Ingress
-        PortNumber inPortNr = null;
+        PortNumber inPortNr;
         Long bufferId = OFConstants.OFP_NO_BUFFER;
         Iterable<PathArgument> inArgs = null;
         PacketOutInputBuilder builder = new PacketOutInputBuilder();
-        if (inputPacket.getIngress() != null) {
-            inArgs = inputPacket.getIngress().getValue().getPathArguments();
+
+        if (source.getIngress() != null) {
+            inArgs = source.getIngress().getValue().getPathArguments();
         }
+
         if (inArgs != null && Iterables.size(inArgs) >= 3) {
-            inPortNr = getPortNumber(Iterables.get(inArgs, 2), version);
+            inPortNr = getPortNumber(Iterables.get(inArgs, 2), data.getVersion());
         } else {
             // The packetOut originated from the controller
             inPortNr = new PortNumber(0xfffffffdL);
         }
 
         // Build Buffer ID to be NO_OFP_NO_BUFFER
-        if (inputPacket.getBufferId() != null) {
-            bufferId = inputPacket.getBufferId();
+        if (source.getBufferId() != null) {
+            bufferId = source.getBufferId();
         }
 
         PortNumber outPort = null;
-        NodeConnectorRef outRef = inputPacket.getEgress();
+        NodeConnectorRef outRef = source.getEgress();
         Iterable<PathArgument> outArgs = outRef.getValue().getPathArguments();
+
         if (Iterables.size(outArgs) >= 3) {
-            outPort = getPortNumber(Iterables.get(outArgs, 2), version);
+            outPort = getPortNumber(Iterables.get(outArgs, 2), data.getVersion());
         } else {
             // TODO : P4 search for some normal exception
-            new Exception("PORT NR not exist in Egress");
+            // new Exception("PORT NR not exist in Egress");
+            LOG.error("PORT NR not exist in Egress");
         }
 
-        List<Action> actions = null;
-        List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action> inputActions =
-                inputPacket.getAction();
+        List<Action> actions = new ArrayList<>();
+        List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action> inputActions = source.getAction();
+
         if (inputActions != null) {
-            final ActionConvertorData actionConvertorData = new ActionConvertorData(version);
-            actionConvertorData.setDatapathId(datapathid);
+            final ActionConvertorData actionConvertorData = new ActionConvertorData(data.getVersion());
+            actionConvertorData.setDatapathId(data.getDatapathId());
 
             final Optional<List<Action>> convertedActions = ConvertorManager.getInstance().convert(
                     inputActions, actionConvertorData);
@@ -96,44 +129,24 @@ public final class PacketOutConvertor {
             actions = convertedActions.orElse(Collections.emptyList());
 
         } else {
-            actions = new ArrayList<>();
             // TODO VD P! wait for way to move Actions (e.g. augmentation)
             ActionBuilder aBuild = new ActionBuilder();
-
-            OutputActionCaseBuilder outputActionCaseBuilder =
-                    new OutputActionCaseBuilder();
-
-            OutputActionBuilder outputActionBuilder =
-                    new OutputActionBuilder();
-
+            OutputActionCaseBuilder outputActionCaseBuilder = new OutputActionCaseBuilder();
+            OutputActionBuilder outputActionBuilder = new OutputActionBuilder();
             outputActionBuilder.setPort(outPort);
             outputActionBuilder.setMaxLength(OFConstants.OFPCML_NO_BUFFER);
-
             outputActionCaseBuilder.setOutputAction(outputActionBuilder.build());
-
             aBuild.setActionChoice(outputActionCaseBuilder.build());
-
             actions.add(aBuild.build());
         }
 
         builder.setAction(actions);
-        builder.setData(inputPacket.getPayload());
-        builder.setVersion(version);
-        builder.setXid(xid);
+        builder.setData(source.getPayload());
+        builder.setVersion(data.getVersion());
+        builder.setXid(data.getXid());
         builder.setInPort(inPortNr);
         builder.setBufferId(bufferId);
-        // --------------------------------------------------------
 
         return builder.build();
     }
-
-    private static PortNumber getPortNumber(final PathArgument pathArgument, final Short ofVersion) {
-        // FIXME VD P! find InstanceIdentifier helper
-        InstanceIdentifier.IdentifiableItem<?, ?> item = Arguments.checkInstanceOf(pathArgument,
-                InstanceIdentifier.IdentifiableItem.class);
-        NodeConnectorKey key = Arguments.checkInstanceOf(item.getKey(), NodeConnectorKey.class);
-        Long port =  InventoryDataServiceUtil.portNumberfromNodeConnectorId(
-                OpenflowVersion.get(ofVersion), key.getId());
-        return new PortNumber(port);
-    }
-}
+}
\ No newline at end of file