Merge "Bug 1277 - Move ByteBuffUtils to separate bundle"
[openflowjava.git] / openflow-protocol-impl / src / main / java / org / opendaylight / openflowjava / protocol / impl / serialization / factories / MultipartRequestInputFactory.java
index 6edd6fa4b7266f19146fbf91e9e4355bf94869ec..7aaeb74de1c4d8eba97703693583388b25a1b137 100644 (file)
@@ -10,21 +10,20 @@ package org.opendaylight.openflowjava.protocol.impl.serialization.factories;
 
 import io.netty.buffer.ByteBuf;
 
-import java.util.HashMap;
 import java.util.List;
-import java.util.Map;
 
 import org.opendaylight.openflowjava.protocol.api.extensibility.EnhancedMessageTypeKey;
 import org.opendaylight.openflowjava.protocol.api.extensibility.HeaderSerializer;
 import org.opendaylight.openflowjava.protocol.api.extensibility.MessageTypeKey;
 import org.opendaylight.openflowjava.protocol.api.extensibility.OFSerializer;
-import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistryInjector;
 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistry;
-import org.opendaylight.openflowjava.protocol.impl.util.ByteBufUtils;
-import org.opendaylight.openflowjava.protocol.impl.util.CodingUtils;
-import org.opendaylight.openflowjava.protocol.impl.util.EncodeConstants;
+import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistryInjector;
+import org.opendaylight.openflowjava.util.ByteBufUtils;
+import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
+import org.opendaylight.openflowjava.protocol.impl.util.EnhancedTypeKeyMaker;
+import org.opendaylight.openflowjava.protocol.impl.util.EnhancedTypeKeyMakerFactory;
+import org.opendaylight.openflowjava.protocol.impl.util.ListSerializer;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ActionRelatedTableFeatureProperty;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ExperimenterRelatedTableFeatureProperty;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.InstructionRelatedTableFeatureProperty;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.NextTableRelatedTableFeatureProperty;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.OxmRelatedTableFeatureProperty;
@@ -41,6 +40,7 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.MultipartRequestBody;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestAggregateCase;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestDescCase;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestExperimenterCase;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestFlowCase;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestGroupCase;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestGroupDescCase;
@@ -54,6 +54,7 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestTableCase;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestTableFeaturesCase;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.aggregate._case.MultipartRequestAggregate;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.experimenter._case.MultipartRequestExperimenter;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.flow._case.MultipartRequestFlow;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.group._case.MultipartRequestGroup;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.meter._case.MultipartRequestMeter;
@@ -87,8 +88,6 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
     private static final byte WRITE_SETFIELD_MISS_CODE = 13;
     private static final byte APPLY_SETFIELD_CODE = 14;
     private static final byte APPLY_SETFIELD_MISS_CODE = 15;
-    private static final int EXPERIMENTER_CODE = 65534; // 0xFFFE
-    private static final int EXPERIMENTER_MISS_CODE = 65535; // 0xFFFF
     private static final byte STRUCTURE_HEADER_LENGTH = 4;
     private static final byte PADDING_IN_MULTIPART_REQUEST_FLOW_BODY_01 = 3;
     private static final byte PADDING_IN_MULTIPART_REQUEST_FLOW_BODY_02 = 4;
@@ -102,7 +101,7 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
     private SerializerRegistry registry;
 
     @Override
-    public void serialize(MultipartRequestInput message, ByteBuf outBuffer) {
+    public void serialize(final MultipartRequestInput message, final ByteBuf outBuffer) {
         ByteBufUtils.writeOFHeader(MESSAGE_TYPE, message, outBuffer, EncodeConstants.EMPTY_LENGTH);
         outBuffer.writeShort(message.getType().getIntValue());
         outBuffer.writeShort(createMultipartRequestFlagsBitmask(message.getFlags()));
@@ -136,25 +135,32 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
             serializeTableFeaturesBody(message.getMultipartRequestBody(), outBuffer);
         } else if (message.getMultipartRequestBody() instanceof MultipartRequestPortDescCase) {
             serializePortDescBody(message.getMultipartRequestBody(), outBuffer);
+        } else if (message.getMultipartRequestBody() instanceof MultipartRequestExperimenterCase) {
+               serializeExperimenterBody(message, outBuffer);
         }
         ByteBufUtils.updateOFHeaderLength(outBuffer);
     }
 
-    private static int createMultipartRequestFlagsBitmask(MultipartRequestFlags flags) {
-        int multipartRequestFlagsBitmask = 0;
-        Map<Integer, Boolean> multipartRequestFlagsMap = new HashMap<>();
-        multipartRequestFlagsMap.put(0, flags.isOFPMPFREQMORE());
+    private void serializeExperimenterBody(final MultipartRequestInput message,
+            final ByteBuf outBuffer) {
+        MultipartRequestExperimenterCase expCase =
+                (MultipartRequestExperimenterCase) message.getMultipartRequestBody();
+        MultipartRequestExperimenter experimenter = expCase.getMultipartRequestExperimenter();
+        OFSerializer<MultipartRequestExperimenter> serializer = registry.getSerializer(
+                new MessageTypeKey<>(EncodeConstants.OF13_VERSION_ID, MultipartRequestExperimenter.class));
+        serializer.serialize(experimenter, outBuffer);
+    }
 
-        multipartRequestFlagsBitmask = ByteBufUtils.fillBitMaskFromMap(multipartRequestFlagsMap);
-        return multipartRequestFlagsBitmask;
+    private static int createMultipartRequestFlagsBitmask(final MultipartRequestFlags flags) {
+        return ByteBufUtils.fillBitMask(0, flags.isOFPMPFREQMORE());
     }
 
     /**
      * @param multipartRequestBody
      * @param output
      */
-    private void serializeDescBody(MultipartRequestBody multipartRequestBody,
-            ByteBuf output) {
+    private void serializeDescBody(final MultipartRequestBody multipartRequestBody,
+            final ByteBuf output) {
         // The body of MultiPartRequestDesc is empty
     }
 
@@ -162,8 +168,8 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
      * @param multipartRequestBody
      * @param out
      */
-    private void serializeTableBody(MultipartRequestBody multipartRequestBody,
-            ByteBuf out) {
+    private void serializeTableBody(final MultipartRequestBody multipartRequestBody,
+            final ByteBuf out) {
      // The body of MultiPartTable is empty
     }
 
@@ -171,8 +177,8 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
      * @param multipartRequestBody
      * @param out
      */
-    private void serializeGroupDescBody(MultipartRequestBody multipartRequestBody,
-            ByteBuf out) {
+    private void serializeGroupDescBody(final MultipartRequestBody multipartRequestBody,
+            final ByteBuf out) {
      // The body of MultiPartRequestGroupDesc is empty
     }
 
@@ -181,7 +187,7 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
      * @param out
      */
     private void serializeGroupFeaturesBody(
-            MultipartRequestBody multipartRequestBody, ByteBuf out) {
+            final MultipartRequestBody multipartRequestBody, final ByteBuf out) {
      // The body of MultiPartRequestGroupFeatures is empty
     }
 
@@ -190,7 +196,7 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
      * @param out
      */
     private void serializeMeterFeaturesBody(
-            MultipartRequestBody multipartRequestBody, ByteBuf out) {
+            final MultipartRequestBody multipartRequestBody, final ByteBuf out) {
      // The body of MultiPartMeterFeatures is empty
     }
 
@@ -198,12 +204,12 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
      * @param multipartRequestBody
      * @param out
      */
-    private void serializePortDescBody(MultipartRequestBody multipartRequestBody,
-            ByteBuf out) {
+    private void serializePortDescBody(final MultipartRequestBody multipartRequestBody,
+            final ByteBuf out) {
      // The body of MultiPartPortDesc is empty
     }
 
-    private void serializeFlowBody(MultipartRequestBody multipartRequestBody, ByteBuf output) {
+    private void serializeFlowBody(final MultipartRequestBody multipartRequestBody, final ByteBuf output) {
         MultipartRequestFlowCase flowCase = (MultipartRequestFlowCase) multipartRequestBody;
         MultipartRequestFlow flow = flowCase.getMultipartRequestFlow();
         output.writeByte(flow.getTableId().byteValue());
@@ -218,7 +224,7 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
         serializer.serialize(flow.getMatch(), output);
     }
 
-    private void serializeAggregateBody(MultipartRequestBody multipartRequestBody, ByteBuf output) {
+    private void serializeAggregateBody(final MultipartRequestBody multipartRequestBody, final ByteBuf output) {
         MultipartRequestAggregateCase aggregateCase = (MultipartRequestAggregateCase) multipartRequestBody;
         MultipartRequestAggregate aggregate = aggregateCase.getMultipartRequestAggregate();
         output.writeByte(aggregate.getTableId().byteValue());
@@ -233,42 +239,42 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
         serializer.serialize(aggregate.getMatch(), output);
     }
 
-    private static void serializePortStatsBody(MultipartRequestBody multipartRequestBody, ByteBuf output) {
+    private static void serializePortStatsBody(final MultipartRequestBody multipartRequestBody, final ByteBuf output) {
         MultipartRequestPortStatsCase portstatsCase = (MultipartRequestPortStatsCase) multipartRequestBody;
         MultipartRequestPortStats portstats = portstatsCase.getMultipartRequestPortStats();
         output.writeInt(portstats.getPortNo().intValue());
         ByteBufUtils.padBuffer(PADDING_IN_MULTIPART_REQUEST_PORTSTATS_BODY, output);
     }
 
-    private static void serializeQueueBody(MultipartRequestBody multipartRequestBody, ByteBuf output) {
+    private static void serializeQueueBody(final MultipartRequestBody multipartRequestBody, final ByteBuf output) {
         MultipartRequestQueueCase queueCase = (MultipartRequestQueueCase) multipartRequestBody;
         MultipartRequestQueue queue = queueCase.getMultipartRequestQueue();
         output.writeInt(queue.getPortNo().intValue());
         output.writeInt(queue.getQueueId().intValue());
     }
 
-    private static void serializeeGroupStatsBody(MultipartRequestBody multipartRequestBody, ByteBuf output) {
+    private static void serializeeGroupStatsBody(final MultipartRequestBody multipartRequestBody, final ByteBuf output) {
         MultipartRequestGroupCase groupStatsCase = (MultipartRequestGroupCase) multipartRequestBody;
         MultipartRequestGroup groupStats = groupStatsCase.getMultipartRequestGroup();
         output.writeInt(groupStats.getGroupId().getValue().intValue());
         ByteBufUtils.padBuffer(PADDING_IN_MULTIPART_REQUEST_GROUP_BODY, output);
     }
 
-    private static void serializeMeterBody(MultipartRequestBody multipartRequestBody, ByteBuf output) {
+    private static void serializeMeterBody(final MultipartRequestBody multipartRequestBody, final ByteBuf output) {
         MultipartRequestMeterCase meterCase = (MultipartRequestMeterCase) multipartRequestBody;
         MultipartRequestMeter meter = meterCase.getMultipartRequestMeter();
         output.writeInt(meter.getMeterId().getValue().intValue());
         ByteBufUtils.padBuffer(PADDING_IN_MULTIPART_REQUEST_METER_BODY, output);
     }
 
-    private static void serializeMeterConfigBody(MultipartRequestBody multipartRequestBody, ByteBuf output) {
+    private static void serializeMeterConfigBody(final MultipartRequestBody multipartRequestBody, final ByteBuf output) {
         MultipartRequestMeterConfigCase meterConfigCase = (MultipartRequestMeterConfigCase) multipartRequestBody;
         MultipartRequestMeterConfig meterConfig = meterConfigCase.getMultipartRequestMeterConfig();
         output.writeInt(meterConfig.getMeterId().getValue().intValue());
         ByteBufUtils.padBuffer(PADDING_IN_MULTIPART_REQUEST_METER_CONFIG_BODY, output);
     }
 
-    private void serializeTableFeaturesBody(MultipartRequestBody multipartRequestBody, ByteBuf output) {
+    private void serializeTableFeaturesBody(final MultipartRequestBody multipartRequestBody, final ByteBuf output) {
         if (multipartRequestBody != null) {
             MultipartRequestTableFeaturesCase tableFeaturesCase = (MultipartRequestTableFeaturesCase) multipartRequestBody;
             MultipartRequestTableFeatures tableFeatures = tableFeaturesCase.getMultipartRequestTableFeatures();
@@ -291,7 +297,7 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
         }
     }
 
-    private void writeTableFeatureProperties(ByteBuf output, List<TableFeatureProperties> props) {
+    private void writeTableFeatureProperties(final ByteBuf output, final List<TableFeatureProperties> props) {
         if (props != null) {
             for (TableFeatureProperties property : props) {
                 TableFeaturesPropType type = property.getType();
@@ -324,16 +330,16 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
                 } else if (type.equals(TableFeaturesPropType.OFPTFPTAPPLYSETFIELDMISS)) {
                     writeOxmRelatedTableProperty(output, property, APPLY_SETFIELD_MISS_CODE);
                 } else if (type.equals(TableFeaturesPropType.OFPTFPTEXPERIMENTER)) {
-                    writeExperimenterRelatedTableProperty(output, property, EXPERIMENTER_CODE);
+                    writeExperimenterRelatedTableProperty(output, property);
                 } else if (type.equals(TableFeaturesPropType.OFPTFPTEXPERIMENTERMISS)) {
-                    writeExperimenterRelatedTableProperty(output, property, EXPERIMENTER_MISS_CODE);
+                    writeExperimenterRelatedTableProperty(output, property);
                 }
             }
         }
     }
 
-    private void writeInstructionRelatedTableProperty(ByteBuf output,
-            TableFeatureProperties property, byte code) {
+    private void writeInstructionRelatedTableProperty(final ByteBuf output,
+            final TableFeatureProperties property, final byte code) {
         output.writeShort(code);
         List<Instruction> instructions = property.
                 getAugmentation(InstructionRelatedTableFeatureProperty.class).getInstruction();
@@ -349,9 +355,9 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
             }
             padding = paddingNeeded(length);
             output.writeShort(length);
-            HeaderSerializer<Instruction> instructionSerializer = registry.getSerializer(
-                    new MessageTypeKey<>(EncodeConstants.OF13_VERSION_ID, Instruction.class));
-            CodingUtils.serializeHeaders(instructions, instructionSerializer, output);
+            EnhancedTypeKeyMaker<Instruction> keyMaker = EnhancedTypeKeyMakerFactory
+                    .createInstructionKeyMaker(EncodeConstants.OF13_VERSION_ID);
+            ListSerializer.serializeHeaderList(instructions, keyMaker, registry, output);
         } else {
             padding = paddingNeeded(length);
             output.writeShort(length);
@@ -359,8 +365,8 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
         ByteBufUtils.padBuffer(padding, output);
     }
 
-    private static void writeNextTableRelatedTableProperty(ByteBuf output,
-            TableFeatureProperties property, byte code) {
+    private static void writeNextTableRelatedTableProperty(final ByteBuf output,
+            final TableFeatureProperties property, final byte code) {
         output.writeShort(code);
         List<NextTableIds> nextTableIds = property.
                 getAugmentation(NextTableRelatedTableFeatureProperty.class).getNextTableIds();
@@ -374,13 +380,13 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
                 output.writeByte(next.getTableId());
             }
         } else {
-            padding = paddingNeeded(length); 
+            padding = paddingNeeded(length);
             output.writeShort(length + padding);
         }
         ByteBufUtils.padBuffer(padding, output);
     }
 
-    private static int paddingNeeded(int length) {
+    private static int paddingNeeded(final int length) {
         int paddingRemainder = length % EncodeConstants.PADDING;
         int result = 0;
         if (paddingRemainder != 0) {
@@ -389,8 +395,8 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
         return result;
     }
 
-    private void writeActionsRelatedTableProperty(ByteBuf output,
-            TableFeatureProperties property, byte code) {
+    private void writeActionsRelatedTableProperty(final ByteBuf output,
+            final TableFeatureProperties property, final byte code) {
         output.writeShort(code);
         List<Action> actions = property.
                 getAugmentation(ActionRelatedTableFeatureProperty.class).getAction();
@@ -407,9 +413,9 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
             length += actions.size() * STRUCTURE_HEADER_LENGTH;
             padding += paddingNeeded(length);
             output.writeShort(length);
-            HeaderSerializer<Action> actionSerializer = registry.getSerializer(
-                    new MessageTypeKey<>(EncodeConstants.OF13_VERSION_ID, Action.class));
-            CodingUtils.serializeHeaders(actions, actionSerializer, output);
+            EnhancedTypeKeyMaker<Action> keyMaker = EnhancedTypeKeyMakerFactory
+                    .createActionKeyMaker(EncodeConstants.OF13_VERSION_ID);
+            ListSerializer.serializeHeaderList(actions, keyMaker, registry, output);
         } else {
             padding = paddingNeeded(length);
             output.writeShort(length);
@@ -417,8 +423,8 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
         ByteBufUtils.padBuffer(padding, output);
     }
 
-    private void writeOxmRelatedTableProperty(ByteBuf output,
-            TableFeatureProperties property, byte code) {
+    private void writeOxmRelatedTableProperty(final ByteBuf output,
+            final TableFeatureProperties property, final byte code) {
         output.writeShort(code);
         List<MatchEntries> entries = property.
                 getAugmentation(OxmRelatedTableFeatureProperty.class).getMatchEntries();
@@ -429,7 +435,7 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
             length += entries.size() * STRUCTURE_HEADER_LENGTH;
             padding = paddingNeeded(length);
             output.writeShort(length);
-            
+
             for (MatchEntries entry : entries) {
                 HeaderSerializer<MatchEntries> entrySerializer = registry.getSerializer(
                         new EnhancedMessageTypeKey<>(EncodeConstants.OF13_VERSION_ID,
@@ -443,40 +449,19 @@ public class MultipartRequestInputFactory implements OFSerializer<MultipartReque
         ByteBufUtils.padBuffer(padding, output);
     }
 
-    private static void writeExperimenterRelatedTableProperty(ByteBuf output,
-            TableFeatureProperties property, int code) {
-        output.writeShort(code);
-        ExperimenterRelatedTableFeatureProperty exp = property.
-                getAugmentation(ExperimenterRelatedTableFeatureProperty.class);
-        byte[] data = exp.getData();
-        int length = TABLE_FEAT_HEADER_LENGTH + 2 * (EncodeConstants.SIZE_OF_INT_IN_BYTES);
-        int padding = 0;
-        if (data != null) {
-            output.writeShort(length + data.length);
-            padding = paddingNeeded(length + data.length);
-            output.writeInt(exp.getExperimenter().intValue());
-            output.writeInt(exp.getExpType().intValue());
-            output.writeBytes(data);
-        } else {
-            output.writeShort(length);
-            padding = paddingNeeded(length);
-            output.writeInt(exp.getExperimenter().intValue());
-            output.writeInt(exp.getExpType().intValue());
-        }
-        ByteBufUtils.padBuffer(padding, output);
+    private void writeExperimenterRelatedTableProperty(final ByteBuf output,
+            final TableFeatureProperties property) {
+       OFSerializer<TableFeatureProperties> serializer = registry.getSerializer(
+                       new MessageTypeKey<>(EncodeConstants.OF13_VERSION_ID, TableFeatureProperties.class));
+       serializer.serialize(property, output);
     }
 
-    private static int createTableConfigBitmask(TableConfig tableConfig) {
-        int tableConfigBitmask = 0;
-        Map<Integer, Boolean> tableConfigMap = new HashMap<>();
-        tableConfigMap.put(3, tableConfig.isOFPTCDEPRECATEDMASK());
-
-        tableConfigBitmask = ByteBufUtils.fillBitMaskFromMap(tableConfigMap);
-        return tableConfigBitmask;
+    private static int createTableConfigBitmask(final TableConfig tableConfig) {
+        return ByteBufUtils.fillBitMask(3, tableConfig.isOFPTCDEPRECATEDMASK());
     }
 
     @Override
-    public void injectSerializerRegistry(SerializerRegistry serializerRegistry) {
+    public void injectSerializerRegistry(final SerializerRegistry serializerRegistry) {
         this.registry = serializerRegistry;
     }
 }