BUG-4283: experimenter msg support - deserialization part
[openflowjava.git] / openflow-protocol-impl / src / main / java / org / opendaylight / openflowjava / protocol / impl / deserialization / factories / MultipartReplyMessageFactory.java
1 /*
2  * Copyright (c) 2013 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.openflowjava.protocol.impl.deserialization.factories;
10
11 import io.netty.buffer.ByteBuf;
12 import java.math.BigInteger;
13 import java.util.ArrayList;
14 import java.util.List;
15 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistry;
16 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistryInjector;
17 import org.opendaylight.openflowjava.protocol.api.extensibility.OFDeserializer;
18 import org.opendaylight.openflowjava.protocol.api.keys.MessageCodeKey;
19 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
20 import org.opendaylight.openflowjava.protocol.impl.util.CodeKeyMaker;
21 import org.opendaylight.openflowjava.protocol.impl.util.CodeKeyMakerFactory;
22 import org.opendaylight.openflowjava.protocol.impl.util.ListDeserializer;
23 import org.opendaylight.openflowjava.util.ByteBufUtils;
24 import org.opendaylight.openflowjava.util.ExperimenterDeserializerKeyFactory;
25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.MacAddress;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.ActionRelatedTableFeatureProperty;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.ActionRelatedTableFeaturePropertyBuilder;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.InstructionRelatedTableFeatureProperty;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.InstructionRelatedTableFeaturePropertyBuilder;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.NextTableRelatedTableFeatureProperty;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.NextTableRelatedTableFeaturePropertyBuilder;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.OxmRelatedTableFeatureProperty;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.OxmRelatedTableFeaturePropertyBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.table.features.properties.container.table.feature.properties.NextTableIds;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.table.features.properties.container.table.feature.properties.NextTableIdsBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.actions.grouping.Action;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instructions.grouping.Instruction;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.ActionType;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.ExperimenterId;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.FlowModFlags;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.GroupCapabilities;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.GroupId;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.GroupType;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.GroupTypes;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MeterBandType;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MeterBandTypeBitmap;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MeterFlags;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MeterId;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartRequestFlags;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortConfig;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortFeatures;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortNumber;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortState;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.TableConfig;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.TableFeaturesPropType;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entries.grouping.MatchEntry;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.grouping.Match;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessage;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessageBuilder;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.buckets.grouping.BucketsList;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.buckets.grouping.BucketsListBuilder;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.experimenter.core.ExperimenterDataOfChoice;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandDropCaseBuilder;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandDscpRemarkCaseBuilder;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandExperimenterCase;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.meter.band.drop._case.MeterBandDropBuilder;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.meter.band.dscp.remark._case.MeterBandDscpRemarkBuilder;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyAggregateCase;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyAggregateCaseBuilder;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyDescCase;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyDescCaseBuilder;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyExperimenterCase;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyExperimenterCaseBuilder;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyFlowCase;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyFlowCaseBuilder;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyGroupCase;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyGroupCaseBuilder;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyGroupDescCase;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyGroupDescCaseBuilder;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyGroupFeaturesCase;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyGroupFeaturesCaseBuilder;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyMeterCase;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyMeterCaseBuilder;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyMeterConfigCase;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyMeterConfigCaseBuilder;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyMeterFeaturesCase;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyMeterFeaturesCaseBuilder;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyPortDescCase;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyPortDescCaseBuilder;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyPortStatsCase;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyPortStatsCaseBuilder;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyQueueCase;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyQueueCaseBuilder;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyTableCase;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyTableCaseBuilder;
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyTableFeaturesCase;
98 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyTableFeaturesCaseBuilder;
99 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.aggregate._case.MultipartReplyAggregateBuilder;
100 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.desc._case.MultipartReplyDescBuilder;
101 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.experimenter._case.MultipartReplyExperimenterBuilder;
102 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.flow._case.MultipartReplyFlowBuilder;
103 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.flow._case.multipart.reply.flow.FlowStats;
104 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.flow._case.multipart.reply.flow.FlowStatsBuilder;
105 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group._case.MultipartReplyGroupBuilder;
106 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group._case.multipart.reply.group.GroupStats;
107 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group._case.multipart.reply.group.GroupStatsBuilder;
108 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group._case.multipart.reply.group.group.stats.BucketStats;
109 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group._case.multipart.reply.group.group.stats.BucketStatsBuilder;
110 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group.desc._case.MultipartReplyGroupDescBuilder;
111 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group.desc._case.multipart.reply.group.desc.GroupDesc;
112 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group.desc._case.multipart.reply.group.desc.GroupDescBuilder;
113 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group.features._case.MultipartReplyGroupFeaturesBuilder;
114 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter._case.MultipartReplyMeterBuilder;
115 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter._case.multipart.reply.meter.MeterStats;
116 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter._case.multipart.reply.meter.MeterStatsBuilder;
117 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter._case.multipart.reply.meter.meter.stats.MeterBandStats;
118 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter._case.multipart.reply.meter.meter.stats.MeterBandStatsBuilder;
119 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter.config._case.MultipartReplyMeterConfigBuilder;
120 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter.config._case.multipart.reply.meter.config.MeterConfig;
121 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter.config._case.multipart.reply.meter.config.MeterConfigBuilder;
122 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter.config._case.multipart.reply.meter.config.meter.config.Bands;
123 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter.config._case.multipart.reply.meter.config.meter.config.BandsBuilder;
124 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter.features._case.MultipartReplyMeterFeaturesBuilder;
125 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.desc._case.MultipartReplyPortDescBuilder;
126 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.desc._case.multipart.reply.port.desc.Ports;
127 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.desc._case.multipart.reply.port.desc.PortsBuilder;
128 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.stats._case.MultipartReplyPortStatsBuilder;
129 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.stats._case.multipart.reply.port.stats.PortStats;
130 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.stats._case.multipart.reply.port.stats.PortStatsBuilder;
131 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.queue._case.MultipartReplyQueueBuilder;
132 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.queue._case.multipart.reply.queue.QueueStats;
133 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.queue._case.multipart.reply.queue.QueueStatsBuilder;
134 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table._case.MultipartReplyTableBuilder;
135 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table._case.multipart.reply.table.TableStats;
136 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table._case.multipart.reply.table.TableStatsBuilder;
137 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table.features._case.MultipartReplyTableFeaturesBuilder;
138 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table.features._case.multipart.reply.table.features.TableFeatures;
139 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table.features._case.multipart.reply.table.features.TableFeaturesBuilder;
140 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.table.features.properties.grouping.TableFeatureProperties;
141 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.table.features.properties.grouping.TableFeaturePropertiesBuilder;
142
143 /**
144  * Translates MultipartReply messages
145  *
146  * @author timotej.kubas
147  * @author michal.polkorab
148  */
149 public class MultipartReplyMessageFactory implements OFDeserializer<MultipartReplyMessage>,
150         DeserializerRegistryInjector {
151
152     private static final byte PADDING_IN_MULTIPART_REPLY_HEADER = 4;
153     private static final int DESC_STR_LEN = 256;
154     private static final int SERIAL_NUM_LEN = 32;
155     private static final byte PADDING_IN_FLOW_STATS_HEADER_01 = 1;
156     private static final byte PADDING_IN_FLOW_STATS_HEADER_02 = 4;
157     private static final byte PADDING_IN_AGGREGATE_HEADER = 4;
158     private static final byte PADDING_IN_TABLE_HEADER = 3;
159     private static final byte PADDING_IN_MULTIPART_REPLY_TABLE_FEATURES = 5;
160     private static final byte MAX_TABLE_NAME_LENGTH = 32;
161     private static final byte MULTIPART_REPLY_TABLE_FEATURES_STRUCTURE_LENGTH = 64;
162     private static final byte COMMON_PROPERTY_LENGTH = 4;
163     private static final byte PADDING_IN_PORT_STATS_HEADER = 4;
164     private static final byte PADDING_IN_GROUP_HEADER_01 = 2;
165     private static final byte PADDING_IN_GROUP_HEADER_02 = 4;
166     private static final byte BUCKET_COUNTER_LENGTH = 16;
167     private static final byte GROUP_BODY_LENGTH = 40;
168     private static final byte PADDING_IN_METER_FEATURES_HEADER = 2;
169     private static final byte PADDING_IN_METER_STATS_HEADER = 6;
170     private static final byte METER_BAND_STATS_LENGTH = 16;
171     private static final byte METER_BODY_LENGTH = 40;
172     private static final byte METER_CONFIG_LENGTH = 8;
173     private static final byte PADDING_IN_METER_BAND_DROP_HEADER = 4;
174     private static final byte PADDING_IN_METER_BAND_DSCP_HEADER = 3;
175     private static final byte PADDING_IN_PORT_DESC_HEADER_01 = 4;
176     private static final byte PADDING_IN_PORT_DESC_HEADER_02 = 2;
177     private static final int GROUP_TYPES = 4;
178     private static final byte PADDING_IN_GROUP_DESC_HEADER = 1;
179     private static final byte PADDING_IN_BUCKETS_HEADER = 4;
180     private static final byte GROUP_DESC_HEADER_LENGTH = 8;
181     private static final byte BUCKETS_HEADER_LENGTH = 16;
182     private DeserializerRegistry registry;
183
184     @Override
185     public MultipartReplyMessage deserialize(ByteBuf rawMessage) {
186         MultipartReplyMessageBuilder builder = new MultipartReplyMessageBuilder();
187         builder.setVersion((short) EncodeConstants.OF13_VERSION_ID);
188         builder.setXid(rawMessage.readUnsignedInt());
189         int type = rawMessage.readUnsignedShort();
190         builder.setType(MultipartType.forValue(type));
191         builder.setFlags(new MultipartRequestFlags((rawMessage.readUnsignedShort() & 0x01) != 0));
192         rawMessage.skipBytes(PADDING_IN_MULTIPART_REPLY_HEADER);
193
194         switch (MultipartType.forValue(type)) {
195             case OFPMPDESC:
196                 builder.setMultipartReplyBody(setDesc(rawMessage));
197                 break;
198             case OFPMPFLOW:
199                 builder.setMultipartReplyBody(setFlow(rawMessage));
200                 break;
201             case OFPMPAGGREGATE:
202                 builder.setMultipartReplyBody(setAggregate(rawMessage));
203                 break;
204             case OFPMPTABLE:
205                 builder.setMultipartReplyBody(setTable(rawMessage));
206                 break;
207             case OFPMPPORTSTATS:
208                 builder.setMultipartReplyBody(setPortStats(rawMessage));
209                 break;
210             case OFPMPQUEUE:
211                 builder.setMultipartReplyBody(setQueue(rawMessage));
212                 break;
213             case OFPMPGROUP:
214                 builder.setMultipartReplyBody(setGroup(rawMessage));
215                 break;
216             case OFPMPGROUPDESC:
217                 builder.setMultipartReplyBody(setGroupDesc(rawMessage));
218                 break;
219             case OFPMPGROUPFEATURES:
220                 builder.setMultipartReplyBody(setGroupFeatures(rawMessage));
221                 break;
222             case OFPMPMETER:
223                 builder.setMultipartReplyBody(setMeter(rawMessage));
224                 break;
225             case OFPMPMETERCONFIG:
226                 builder.setMultipartReplyBody(setMeterConfig(rawMessage));
227                 break;
228             case OFPMPMETERFEATURES:
229                 builder.setMultipartReplyBody(setMeterFeatures(rawMessage));
230                 break;
231             case OFPMPTABLEFEATURES:
232                 builder.setMultipartReplyBody(setTableFeatures(rawMessage));
233                 break;
234             case OFPMPPORTDESC:
235                 builder.setMultipartReplyBody(setPortDesc(rawMessage));
236                 break;
237             case OFPMPEXPERIMENTER:
238                 builder.setMultipartReplyBody(setExperimenter(rawMessage));
239                 break;
240             default:
241                 break;
242         }
243
244         return builder.build();
245     }
246
247     private static MultipartReplyDescCase setDesc(ByteBuf input) {
248         MultipartReplyDescCaseBuilder caseBuilder = new MultipartReplyDescCaseBuilder();
249         MultipartReplyDescBuilder descBuilder = new MultipartReplyDescBuilder();
250         byte[] mfrDescBytes = new byte[DESC_STR_LEN];
251         input.readBytes(mfrDescBytes);
252         String mfrDesc = new String(mfrDescBytes);
253         descBuilder.setMfrDesc(mfrDesc.trim());
254         byte[] hwDescBytes = new byte[DESC_STR_LEN];
255         input.readBytes(hwDescBytes);
256         String hwDesc = new String(hwDescBytes);
257         descBuilder.setHwDesc(hwDesc.trim());
258         byte[] swDescBytes = new byte[DESC_STR_LEN];
259         input.readBytes(swDescBytes);
260         String swDesc = new String(swDescBytes);
261         descBuilder.setSwDesc(swDesc.trim());
262         byte[] serialNumBytes = new byte[SERIAL_NUM_LEN];
263         input.readBytes(serialNumBytes);
264         String serialNum = new String(serialNumBytes);
265         descBuilder.setSerialNum(serialNum.trim());
266         byte[] dpDescBytes = new byte[DESC_STR_LEN];
267         input.readBytes(dpDescBytes);
268         String dpDesc = new String(dpDescBytes);
269         descBuilder.setDpDesc(dpDesc.trim());
270         caseBuilder.setMultipartReplyDesc(descBuilder.build());
271         return caseBuilder.build();
272     }
273
274     private MultipartReplyFlowCase setFlow(ByteBuf input) {
275         MultipartReplyFlowCaseBuilder caseBuilder = new MultipartReplyFlowCaseBuilder();
276         MultipartReplyFlowBuilder flowBuilder = new MultipartReplyFlowBuilder();
277         List<FlowStats> flowStatsList = new ArrayList<>();
278         while (input.readableBytes() > 0) {
279             FlowStatsBuilder flowStatsBuilder = new FlowStatsBuilder();
280             int flowRecordLength = input.readUnsignedShort();
281             ByteBuf subInput = input.readSlice(flowRecordLength - EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
282             flowStatsBuilder.setTableId(subInput.readUnsignedByte());
283             subInput.skipBytes(PADDING_IN_FLOW_STATS_HEADER_01);
284             flowStatsBuilder.setDurationSec(subInput.readUnsignedInt());
285             flowStatsBuilder.setDurationNsec(subInput.readUnsignedInt());
286             flowStatsBuilder.setPriority(subInput.readUnsignedShort());
287             flowStatsBuilder.setIdleTimeout(subInput.readUnsignedShort());
288             flowStatsBuilder.setHardTimeout(subInput.readUnsignedShort());
289             flowStatsBuilder.setFlags(createFlowModFlagsFromBitmap(subInput.readUnsignedShort()));
290             subInput.skipBytes(PADDING_IN_FLOW_STATS_HEADER_02);
291             byte[] cookie = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
292             subInput.readBytes(cookie);
293             flowStatsBuilder.setCookie(new BigInteger(1, cookie));
294             byte[] packetCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
295             subInput.readBytes(packetCount);
296             flowStatsBuilder.setPacketCount(new BigInteger(1, packetCount));
297             byte[] byteCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
298             subInput.readBytes(byteCount);
299             flowStatsBuilder.setByteCount(new BigInteger(1, byteCount));
300             OFDeserializer<Match> matchDeserializer = registry.getDeserializer(new MessageCodeKey(
301                     EncodeConstants.OF13_VERSION_ID, EncodeConstants.EMPTY_VALUE, Match.class));
302             flowStatsBuilder.setMatch(matchDeserializer.deserialize(subInput));
303             CodeKeyMaker keyMaker = CodeKeyMakerFactory
304                     .createInstructionsKeyMaker(EncodeConstants.OF13_VERSION_ID);
305             List<Instruction> instructions = ListDeserializer.deserializeList(
306                     EncodeConstants.OF13_VERSION_ID, subInput.readableBytes(), subInput, keyMaker, registry);
307             flowStatsBuilder.setInstruction(instructions);
308             flowStatsList.add(flowStatsBuilder.build());
309         }
310         flowBuilder.setFlowStats(flowStatsList);
311         caseBuilder.setMultipartReplyFlow(flowBuilder.build());
312         return caseBuilder.build();
313     }
314
315     private static FlowModFlags createFlowModFlagsFromBitmap(int input) {
316         final Boolean fmfSENDFLOWREM = (input & (1 << 0)) != 0;
317         final Boolean fmfCHECKOVERLAP = (input & (1 << 1)) != 0;
318         final Boolean fmfRESETCOUNTS = (input & (1 << 2)) != 0;
319         final Boolean fmfNOPKTCOUNTS = (input & (1 << 3)) != 0;
320         final Boolean fmfNOBYTCOUNTS = (input & (1 << 4)) != 0;
321         return new FlowModFlags(fmfCHECKOVERLAP, fmfNOBYTCOUNTS, fmfNOPKTCOUNTS, fmfRESETCOUNTS, fmfSENDFLOWREM);
322     }
323
324     private static MultipartReplyAggregateCase setAggregate(ByteBuf input) {
325         MultipartReplyAggregateCaseBuilder caseBuilder = new MultipartReplyAggregateCaseBuilder();
326         MultipartReplyAggregateBuilder builder = new MultipartReplyAggregateBuilder();
327         byte[] packetCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
328         input.readBytes(packetCount);
329         builder.setPacketCount(new BigInteger(1, packetCount));
330         byte[] byteCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
331         input.readBytes(byteCount);
332         builder.setByteCount(new BigInteger(1, byteCount));
333         builder.setFlowCount(input.readUnsignedInt());
334         input.skipBytes(PADDING_IN_AGGREGATE_HEADER);
335         caseBuilder.setMultipartReplyAggregate(builder.build());
336         return caseBuilder.build();
337     }
338
339     private static MultipartReplyTableCase setTable(ByteBuf input) {
340         MultipartReplyTableCaseBuilder caseBuilder = new MultipartReplyTableCaseBuilder();
341         MultipartReplyTableBuilder builder = new MultipartReplyTableBuilder();
342         List<TableStats> tableStatsList = new ArrayList<>();
343         while (input.readableBytes() > 0) {
344             TableStatsBuilder tableStatsBuilder = new TableStatsBuilder();
345             tableStatsBuilder.setTableId(input.readUnsignedByte());
346             input.skipBytes(PADDING_IN_TABLE_HEADER);
347             tableStatsBuilder.setActiveCount(input.readUnsignedInt());
348             byte[] lookupCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
349             input.readBytes(lookupCount);
350             tableStatsBuilder.setLookupCount(new BigInteger(1, lookupCount));
351             byte[] matchedCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
352             input.readBytes(matchedCount);
353             tableStatsBuilder.setMatchedCount(new BigInteger(1, matchedCount));
354             tableStatsList.add(tableStatsBuilder.build());
355         }
356         builder.setTableStats(tableStatsList);
357         caseBuilder.setMultipartReplyTable(builder.build());
358         return caseBuilder.build();
359     }
360
361     private MultipartReplyTableFeaturesCase setTableFeatures(ByteBuf input) {
362         MultipartReplyTableFeaturesCaseBuilder caseBuilder = new MultipartReplyTableFeaturesCaseBuilder();
363         MultipartReplyTableFeaturesBuilder builder = new MultipartReplyTableFeaturesBuilder();
364         List<TableFeatures> features = new ArrayList<>();
365         while (input.readableBytes() > 0) {
366             TableFeaturesBuilder featuresBuilder = new TableFeaturesBuilder();
367             int length = input.readUnsignedShort();
368             featuresBuilder.setTableId(input.readUnsignedByte());
369             input.skipBytes(PADDING_IN_MULTIPART_REPLY_TABLE_FEATURES);
370             featuresBuilder.setName(ByteBufUtils.decodeNullTerminatedString(input, MAX_TABLE_NAME_LENGTH));
371             byte[] metadataMatch = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
372             input.readBytes(metadataMatch);
373             featuresBuilder.setMetadataMatch(metadataMatch);
374             byte[] metadataWrite = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
375             input.readBytes(metadataWrite);
376             featuresBuilder.setMetadataWrite(metadataWrite);
377             featuresBuilder.setConfig(createTableConfig(input.readUnsignedInt()));
378             featuresBuilder.setMaxEntries(input.readUnsignedInt());
379             featuresBuilder.setTableFeatureProperties(createTableFeaturesProperties(input,
380                     length - MULTIPART_REPLY_TABLE_FEATURES_STRUCTURE_LENGTH));
381             features.add(featuresBuilder.build());
382         }
383         builder.setTableFeatures(features);
384         caseBuilder.setMultipartReplyTableFeatures(builder.build());
385         return caseBuilder.build();
386     }
387
388     private static TableConfig createTableConfig(long input) {
389         boolean deprecated = (input & 3) != 0;
390         return new TableConfig(deprecated);
391     }
392
393     private List<TableFeatureProperties> createTableFeaturesProperties(ByteBuf input, int length) {
394         List<TableFeatureProperties> properties = new ArrayList<>();
395         int tableFeaturesLength = length;
396         while (tableFeaturesLength > 0) {
397             int propStartIndex = input.readerIndex();
398             TableFeaturePropertiesBuilder builder = new TableFeaturePropertiesBuilder();
399             TableFeaturesPropType type = TableFeaturesPropType.forValue(input.readUnsignedShort());
400             builder.setType(type);
401             int propertyLength = input.readUnsignedShort();
402             int paddingRemainder = propertyLength % EncodeConstants.PADDING;
403             tableFeaturesLength -= propertyLength;
404             if (type.equals(TableFeaturesPropType.OFPTFPTINSTRUCTIONS)
405                     || type.equals(TableFeaturesPropType.OFPTFPTINSTRUCTIONSMISS)) {
406                 InstructionRelatedTableFeaturePropertyBuilder insBuilder = new InstructionRelatedTableFeaturePropertyBuilder();
407                 CodeKeyMaker keyMaker = CodeKeyMakerFactory.createInstructionsKeyMaker(EncodeConstants.OF13_VERSION_ID);
408                 List<Instruction> instructions = ListDeserializer.deserializeHeaders(EncodeConstants.OF13_VERSION_ID,
409                         propertyLength - COMMON_PROPERTY_LENGTH, input, keyMaker, registry);
410                 insBuilder.setInstruction(instructions);
411                 builder.addAugmentation(InstructionRelatedTableFeatureProperty.class, insBuilder.build());
412             } else if (type.equals(TableFeaturesPropType.OFPTFPTNEXTTABLES)
413                     || type.equals(TableFeaturesPropType.OFPTFPTNEXTTABLESMISS)) {
414                 propertyLength -= COMMON_PROPERTY_LENGTH;
415                 NextTableRelatedTableFeaturePropertyBuilder tableBuilder = new NextTableRelatedTableFeaturePropertyBuilder();
416                 List<NextTableIds> ids = new ArrayList<>();
417                 while (propertyLength > 0) {
418                     NextTableIdsBuilder nextTableIdsBuilder = new NextTableIdsBuilder();
419                     nextTableIdsBuilder.setTableId(input.readUnsignedByte());
420                     ids.add(nextTableIdsBuilder.build());
421                     propertyLength--;
422                 }
423                 tableBuilder.setNextTableIds(ids);
424                 builder.addAugmentation(NextTableRelatedTableFeatureProperty.class, tableBuilder.build());
425             } else if (type.equals(TableFeaturesPropType.OFPTFPTWRITEACTIONS)
426                     || type.equals(TableFeaturesPropType.OFPTFPTWRITEACTIONSMISS)
427                     || type.equals(TableFeaturesPropType.OFPTFPTAPPLYACTIONS)
428                     || type.equals(TableFeaturesPropType.OFPTFPTAPPLYACTIONSMISS)) {
429                 ActionRelatedTableFeaturePropertyBuilder actionBuilder = new ActionRelatedTableFeaturePropertyBuilder();
430                 CodeKeyMaker keyMaker = CodeKeyMakerFactory.createActionsKeyMaker(EncodeConstants.OF13_VERSION_ID);
431                 List<Action> actions = ListDeserializer.deserializeHeaders(EncodeConstants.OF13_VERSION_ID,
432                         propertyLength - COMMON_PROPERTY_LENGTH, input, keyMaker, registry);
433                 actionBuilder.setAction(actions);
434                 builder.addAugmentation(ActionRelatedTableFeatureProperty.class, actionBuilder.build());
435             } else if (type.equals(TableFeaturesPropType.OFPTFPTMATCH)
436                     || type.equals(TableFeaturesPropType.OFPTFPTWILDCARDS)
437                     || type.equals(TableFeaturesPropType.OFPTFPTWRITESETFIELD)
438                     || type.equals(TableFeaturesPropType.OFPTFPTWRITESETFIELDMISS)
439                     || type.equals(TableFeaturesPropType.OFPTFPTAPPLYSETFIELD)
440                     || type.equals(TableFeaturesPropType.OFPTFPTAPPLYSETFIELDMISS)) {
441                 OxmRelatedTableFeaturePropertyBuilder oxmBuilder = new OxmRelatedTableFeaturePropertyBuilder();
442                 CodeKeyMaker keyMaker = CodeKeyMakerFactory
443                         .createMatchEntriesKeyMaker(EncodeConstants.OF13_VERSION_ID);
444                 List<MatchEntry> entries = ListDeserializer.deserializeHeaders(EncodeConstants.OF13_VERSION_ID,
445                         propertyLength - COMMON_PROPERTY_LENGTH, input, keyMaker, registry);
446                 oxmBuilder.setMatchEntry(entries);
447                 builder.addAugmentation(OxmRelatedTableFeatureProperty.class, oxmBuilder.build());
448             } else if (type.equals(TableFeaturesPropType.OFPTFPTEXPERIMENTER)
449                     || type.equals(TableFeaturesPropType.OFPTFPTEXPERIMENTERMISS)) {
450                 long expId = input.readUnsignedInt();
451                 input.readerIndex(propStartIndex);
452                 OFDeserializer<TableFeatureProperties> propDeserializer = registry.getDeserializer(
453                         ExperimenterDeserializerKeyFactory.createMultipartReplyTFDeserializerKey(
454                                 EncodeConstants.OF13_VERSION_ID, expId));
455                 TableFeatureProperties expProp = propDeserializer.deserialize(input);
456                 properties.add(expProp);
457                 continue;
458             }
459             if (paddingRemainder != 0) {
460                 input.skipBytes(EncodeConstants.PADDING - paddingRemainder);
461                 tableFeaturesLength -= EncodeConstants.PADDING - paddingRemainder;
462             }
463             properties.add(builder.build());
464         }
465         return properties;
466     }
467
468     private static MultipartReplyPortStatsCase setPortStats(ByteBuf input) {
469         MultipartReplyPortStatsCaseBuilder caseBuilder = new MultipartReplyPortStatsCaseBuilder();
470         MultipartReplyPortStatsBuilder builder = new MultipartReplyPortStatsBuilder();
471         List<PortStats> portStatsList = new ArrayList<>();
472         while (input.readableBytes() > 0) {
473             PortStatsBuilder portStatsBuilder = new PortStatsBuilder();
474             portStatsBuilder.setPortNo(input.readUnsignedInt());
475             input.skipBytes(PADDING_IN_PORT_STATS_HEADER);
476             byte[] rxPackets = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
477             input.readBytes(rxPackets);
478             portStatsBuilder.setRxPackets(new BigInteger(1, rxPackets));
479             byte[] txPackets = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
480             input.readBytes(txPackets);
481             portStatsBuilder.setTxPackets(new BigInteger(1, txPackets));
482             byte[] rxBytes = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
483             input.readBytes(rxBytes);
484             portStatsBuilder.setRxBytes(new BigInteger(1, rxBytes));
485             byte[] txBytes = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
486             input.readBytes(txBytes);
487             portStatsBuilder.setTxBytes(new BigInteger(1, txBytes));
488             byte[] rxDropped = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
489             input.readBytes(rxDropped);
490             portStatsBuilder.setRxDropped(new BigInteger(1, rxDropped));
491             byte[] txDropped = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
492             input.readBytes(txDropped);
493             portStatsBuilder.setTxDropped(new BigInteger(1, txDropped));
494             byte[] rxErrors = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
495             input.readBytes(rxErrors);
496             portStatsBuilder.setRxErrors(new BigInteger(1, rxErrors));
497             byte[] txErrors = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
498             input.readBytes(txErrors);
499             portStatsBuilder.setTxErrors(new BigInteger(1, txErrors));
500             byte[] rxFrameErr = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
501             input.readBytes(rxFrameErr);
502             portStatsBuilder.setRxFrameErr(new BigInteger(1, rxFrameErr));
503             byte[] rxOverErr = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
504             input.readBytes(rxOverErr);
505             portStatsBuilder.setRxOverErr(new BigInteger(1, rxOverErr));
506             byte[] rxCrcErr = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
507             input.readBytes(rxCrcErr);
508             portStatsBuilder.setRxCrcErr(new BigInteger(1, rxCrcErr));
509             byte[] collisions = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
510             input.readBytes(collisions);
511             portStatsBuilder.setCollisions(new BigInteger(1, collisions));
512             portStatsBuilder.setDurationSec(input.readUnsignedInt());
513             portStatsBuilder.setDurationNsec(input.readUnsignedInt());
514             portStatsList.add(portStatsBuilder.build());
515         }
516         builder.setPortStats(portStatsList);
517         caseBuilder.setMultipartReplyPortStats(builder.build());
518         return caseBuilder.build();
519     }
520
521     private static MultipartReplyQueueCase setQueue(ByteBuf input) {
522         MultipartReplyQueueCaseBuilder caseBuilder = new MultipartReplyQueueCaseBuilder();
523         MultipartReplyQueueBuilder builder = new MultipartReplyQueueBuilder();
524         List<QueueStats> queueStatsList = new ArrayList<>();
525         while (input.readableBytes() > 0) {
526             QueueStatsBuilder queueStatsBuilder = new QueueStatsBuilder();
527             queueStatsBuilder.setPortNo(input.readUnsignedInt());
528             queueStatsBuilder.setQueueId(input.readUnsignedInt());
529             byte[] txBytes = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
530             input.readBytes(txBytes);
531             queueStatsBuilder.setTxBytes(new BigInteger(1, txBytes));
532             byte[] txPackets = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
533             input.readBytes(txPackets);
534             queueStatsBuilder.setTxPackets(new BigInteger(1, txPackets));
535             byte[] txErrors = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
536             input.readBytes(txErrors);
537             queueStatsBuilder.setTxErrors(new BigInteger(1, txErrors));
538             queueStatsBuilder.setDurationSec(input.readUnsignedInt());
539             queueStatsBuilder.setDurationNsec(input.readUnsignedInt());
540             queueStatsList.add(queueStatsBuilder.build());
541         }
542         builder.setQueueStats(queueStatsList);
543         caseBuilder.setMultipartReplyQueue(builder.build());
544         return caseBuilder.build();
545     }
546
547     private static MultipartReplyGroupCase setGroup(ByteBuf input) {
548         MultipartReplyGroupCaseBuilder caseBuilder = new MultipartReplyGroupCaseBuilder();
549         MultipartReplyGroupBuilder builder = new MultipartReplyGroupBuilder();
550         List<GroupStats> groupStatsList = new ArrayList<>();
551         while (input.readableBytes() > 0) {
552             GroupStatsBuilder groupStatsBuilder = new GroupStatsBuilder();
553             int bodyLength = input.readUnsignedShort();
554             input.skipBytes(PADDING_IN_GROUP_HEADER_01);
555             groupStatsBuilder.setGroupId(new GroupId(input.readUnsignedInt()));
556             groupStatsBuilder.setRefCount(input.readUnsignedInt());
557             input.skipBytes(PADDING_IN_GROUP_HEADER_02);
558             byte[] packetCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
559             input.readBytes(packetCount);
560             groupStatsBuilder.setPacketCount(new BigInteger(1, packetCount));
561             byte[] byteCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
562             input.readBytes(byteCount);
563             groupStatsBuilder.setByteCount(new BigInteger(1, byteCount));
564             groupStatsBuilder.setDurationSec(input.readUnsignedInt());
565             groupStatsBuilder.setDurationNsec(input.readUnsignedInt());
566             int actualLength = GROUP_BODY_LENGTH;
567             List<BucketStats> bucketStatsList = new ArrayList<>();
568             while (actualLength < bodyLength) {
569                 BucketStatsBuilder bucketStatsBuilder = new BucketStatsBuilder();
570                 byte[] packetCountBucket = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
571                 input.readBytes(packetCountBucket);
572                 bucketStatsBuilder.setPacketCount(new BigInteger(1, packetCountBucket));
573                 byte[] byteCountBucket = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
574                 input.readBytes(byteCountBucket);
575                 bucketStatsBuilder.setByteCount(new BigInteger(1, byteCountBucket));
576                 bucketStatsList.add(bucketStatsBuilder.build());
577                 actualLength += BUCKET_COUNTER_LENGTH;
578             }
579             groupStatsBuilder.setBucketStats(bucketStatsList);
580             groupStatsList.add(groupStatsBuilder.build());
581         }
582         builder.setGroupStats(groupStatsList);
583         caseBuilder.setMultipartReplyGroup(builder.build());
584         return caseBuilder.build();
585     }
586
587     private static MultipartReplyMeterFeaturesCase setMeterFeatures(ByteBuf input) {
588         MultipartReplyMeterFeaturesCaseBuilder caseBuilder = new MultipartReplyMeterFeaturesCaseBuilder();
589         MultipartReplyMeterFeaturesBuilder builder = new MultipartReplyMeterFeaturesBuilder();
590         builder.setMaxMeter(input.readUnsignedInt());
591         builder.setBandTypes(createMeterBandsBitmap(input.readUnsignedInt()));
592         builder.setCapabilities(createMeterFlags(input.readUnsignedInt()));
593         builder.setMaxBands(input.readUnsignedByte());
594         builder.setMaxColor(input.readUnsignedByte());
595         input.skipBytes(PADDING_IN_METER_FEATURES_HEADER);
596         caseBuilder.setMultipartReplyMeterFeatures(builder.build());
597         return caseBuilder.build();
598     }
599
600     private static MeterFlags createMeterFlags(long input) {
601         final Boolean mfKBPS = (input & (1 << 0)) != 0;
602         final Boolean mfPKTPS = (input & (1 << 1)) != 0;
603         final Boolean mfBURST = (input & (1 << 2)) != 0;
604         final Boolean mfSTATS = (input & (1 << 3)) != 0;
605         return new MeterFlags(mfBURST, mfKBPS, mfPKTPS, mfSTATS);
606     }
607
608     private static MeterBandTypeBitmap createMeterBandsBitmap(long input) {
609         final Boolean mbtDROP = (input & (1 << 1)) != 0;
610         final Boolean mbtDSCPREMARK = (input & (1 << 2)) != 0;
611         return new MeterBandTypeBitmap(mbtDROP, mbtDSCPREMARK);
612     }
613
614     private static MultipartReplyMeterCase setMeter(ByteBuf input) {
615         MultipartReplyMeterCaseBuilder caseBuilder = new MultipartReplyMeterCaseBuilder();
616         MultipartReplyMeterBuilder builder = new MultipartReplyMeterBuilder();
617         List<MeterStats> meterStatsList = new ArrayList<>();
618         while (input.readableBytes() > 0) {
619             MeterStatsBuilder meterStatsBuilder = new MeterStatsBuilder();
620             meterStatsBuilder.setMeterId(new MeterId(input.readUnsignedInt()));
621             int meterStatsBodyLength = input.readUnsignedShort();
622             input.skipBytes(PADDING_IN_METER_STATS_HEADER);
623             meterStatsBuilder.setFlowCount(input.readUnsignedInt());
624             byte[] packetInCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
625             input.readBytes(packetInCount);
626             meterStatsBuilder.setPacketInCount(new BigInteger(1, packetInCount));
627             byte[] byteInCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
628             input.readBytes(byteInCount);
629             meterStatsBuilder.setByteInCount(new BigInteger(1, byteInCount));
630             meterStatsBuilder.setDurationSec(input.readUnsignedInt());
631             meterStatsBuilder.setDurationNsec(input.readUnsignedInt());
632             int actualLength = METER_BODY_LENGTH;
633             List<MeterBandStats> meterBandStatsList = new ArrayList<>();
634             while (actualLength < meterStatsBodyLength) {
635                 MeterBandStatsBuilder meterBandStatsBuilder = new MeterBandStatsBuilder();
636                 byte[] packetBandCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
637                 input.readBytes(packetBandCount);
638                 meterBandStatsBuilder.setPacketBandCount(new BigInteger(1, packetBandCount));
639                 byte[] byteBandCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
640                 input.readBytes(byteBandCount);
641                 meterBandStatsBuilder.setByteBandCount(new BigInteger(1, byteBandCount));
642                 meterBandStatsList.add(meterBandStatsBuilder.build());
643                 actualLength += METER_BAND_STATS_LENGTH;
644             }
645             meterStatsBuilder.setMeterBandStats(meterBandStatsList);
646             meterStatsList.add(meterStatsBuilder.build());
647         }
648         builder.setMeterStats(meterStatsList);
649         caseBuilder.setMultipartReplyMeter(builder.build());
650         return caseBuilder.build();
651     }
652
653     private MultipartReplyMeterConfigCase setMeterConfig(ByteBuf input) {
654         MultipartReplyMeterConfigCaseBuilder caseBuilder = new MultipartReplyMeterConfigCaseBuilder();
655         MultipartReplyMeterConfigBuilder builder = new MultipartReplyMeterConfigBuilder();
656         List<MeterConfig> meterConfigList = new ArrayList<>();
657         while (input.readableBytes() > 0) {
658             MeterConfigBuilder meterConfigBuilder = new MeterConfigBuilder();
659             int meterConfigBodyLength = input.readUnsignedShort();
660             meterConfigBuilder.setFlags(createMeterFlags(input.readUnsignedShort()));
661             meterConfigBuilder.setMeterId(new MeterId(input.readUnsignedInt()));
662             int actualLength = METER_CONFIG_LENGTH;
663             List<Bands> bandsList = new ArrayList<>();
664             while (actualLength < meterConfigBodyLength) {
665                 int bandStartIndex = input.readerIndex();
666                 BandsBuilder bandsBuilder = new BandsBuilder();
667                 int bandType = input.readUnsignedShort();
668                 switch (bandType) {
669                     case 1:
670                         MeterBandDropCaseBuilder bandDropCaseBuilder = new MeterBandDropCaseBuilder();
671                         MeterBandDropBuilder bandDropBuilder = new MeterBandDropBuilder();
672                         bandDropBuilder.setType(MeterBandType.forValue(bandType));
673                         actualLength += input.readUnsignedShort();
674                         bandDropBuilder.setRate(input.readUnsignedInt());
675                         bandDropBuilder.setBurstSize(input.readUnsignedInt());
676                         input.skipBytes(PADDING_IN_METER_BAND_DROP_HEADER);
677                         bandDropCaseBuilder.setMeterBandDrop(bandDropBuilder.build());
678                         bandsBuilder.setMeterBand(bandDropCaseBuilder.build());
679                         break;
680                     case 2:
681                         MeterBandDscpRemarkCaseBuilder bandDscpRemarkCaseBuilder = new MeterBandDscpRemarkCaseBuilder();
682                         MeterBandDscpRemarkBuilder bandDscpRemarkBuilder = new MeterBandDscpRemarkBuilder();
683                         bandDscpRemarkBuilder.setType(MeterBandType.forValue(bandType));
684                         actualLength += input.readUnsignedShort();
685                         bandDscpRemarkBuilder.setRate(input.readUnsignedInt());
686                         bandDscpRemarkBuilder.setBurstSize(input.readUnsignedInt());
687                         bandDscpRemarkBuilder.setPrecLevel(input.readUnsignedByte());
688                         input.skipBytes(PADDING_IN_METER_BAND_DSCP_HEADER);
689                         bandDscpRemarkCaseBuilder.setMeterBandDscpRemark(bandDscpRemarkBuilder.build());
690                         bandsBuilder.setMeterBand(bandDscpRemarkCaseBuilder.build());
691                         break;
692                     case 0xFFFF:
693                         actualLength += input.readUnsignedShort();
694                         long expId = input.getUnsignedInt(input.readerIndex() + 2 * EncodeConstants.SIZE_OF_INT_IN_BYTES);
695                         input.readerIndex(bandStartIndex);
696                         OFDeserializer<MeterBandExperimenterCase> deserializer = registry.getDeserializer(
697                                 ExperimenterDeserializerKeyFactory.createMeterBandDeserializerKey(
698                                         EncodeConstants.OF13_VERSION_ID, expId));
699                         bandsBuilder.setMeterBand(deserializer.deserialize(input));
700                         break;
701                     default:
702                         break;
703                 }
704                 bandsList.add(bandsBuilder.build());
705             }
706             meterConfigBuilder.setBands(bandsList);
707             meterConfigList.add(meterConfigBuilder.build());
708         }
709         builder.setMeterConfig(meterConfigList);
710         caseBuilder.setMultipartReplyMeterConfig(builder.build());
711         return caseBuilder.build();
712     }
713
714     private MultipartReplyExperimenterCase setExperimenter(ByteBuf input) {
715         final long expId = input.readUnsignedInt();
716         final long expType = input.readUnsignedInt();
717
718         final OFDeserializer<ExperimenterDataOfChoice> deserializer = registry.getDeserializer(
719                 ExperimenterDeserializerKeyFactory.createMultipartReplyMessageDeserializerKey(
720                         EncodeConstants.OF13_VERSION_ID, expId, expType));
721
722         final MultipartReplyExperimenterBuilder mpExperimenterBld = new MultipartReplyExperimenterBuilder()
723                 .setExperimenter(new ExperimenterId(expId))
724                 .setExpType(expType)
725                 .setExperimenterDataOfChoice(deserializer.deserialize(input));
726         final MultipartReplyExperimenterCaseBuilder mpReplyExperimenterCaseBld = new MultipartReplyExperimenterCaseBuilder()
727                 .setMultipartReplyExperimenter(mpExperimenterBld.build());
728         return mpReplyExperimenterCaseBld.build();
729     }
730
731     private static MultipartReplyPortDescCase setPortDesc(ByteBuf input) {
732         MultipartReplyPortDescCaseBuilder caseBuilder = new MultipartReplyPortDescCaseBuilder();
733         MultipartReplyPortDescBuilder builder = new MultipartReplyPortDescBuilder();
734         List<Ports> portsList = new ArrayList<>();
735         while (input.readableBytes() > 0) {
736             PortsBuilder portsBuilder = new PortsBuilder();
737             portsBuilder.setPortNo(input.readUnsignedInt());
738             input.skipBytes(PADDING_IN_PORT_DESC_HEADER_01);
739             byte[] hwAddress = new byte[EncodeConstants.MAC_ADDRESS_LENGTH];
740             input.readBytes(hwAddress);
741             portsBuilder.setHwAddr(new MacAddress(ByteBufUtils.macAddressToString(hwAddress)));
742             input.skipBytes(PADDING_IN_PORT_DESC_HEADER_02);
743             portsBuilder.setName(ByteBufUtils.decodeNullTerminatedString(input, EncodeConstants.MAX_PORT_NAME_LENGTH));
744             portsBuilder.setConfig(createPortConfig(input.readUnsignedInt()));
745             portsBuilder.setState(createPortState(input.readUnsignedInt()));
746             portsBuilder.setCurrentFeatures(createPortFeatures(input.readUnsignedInt()));
747             portsBuilder.setAdvertisedFeatures(createPortFeatures(input.readUnsignedInt()));
748             portsBuilder.setSupportedFeatures(createPortFeatures(input.readUnsignedInt()));
749             portsBuilder.setPeerFeatures(createPortFeatures(input.readUnsignedInt()));
750             portsBuilder.setCurrSpeed(input.readUnsignedInt());
751             portsBuilder.setMaxSpeed(input.readUnsignedInt());
752             portsList.add(portsBuilder.build());
753         }
754         builder.setPorts(portsList);
755         caseBuilder.setMultipartReplyPortDesc(builder.build());
756         return caseBuilder.build();
757     }
758
759     private static PortConfig createPortConfig(long input) {
760         final Boolean pcPortDown = ((input) & (1 << 0)) != 0;
761         final Boolean pcNRecv = ((input) & (1 << 2)) != 0;
762         final Boolean pcNFwd = ((input) & (1 << 5)) != 0;
763         final Boolean pcNPacketIn = ((input) & (1 << 6)) != 0;
764         return new PortConfig(pcNFwd, pcNPacketIn, pcNRecv, pcPortDown);
765     }
766
767     private static PortState createPortState(long input) {
768         final Boolean psLinkDown = ((input) & (1 << 0)) != 0;
769         final Boolean psBlocked = ((input) & (1 << 1)) != 0;
770         final Boolean psLive = ((input) & (1 << 2)) != 0;
771         return new PortState(psBlocked, psLinkDown, psLive);
772     }
773
774     private static PortFeatures createPortFeatures(long input) {
775         final Boolean pf10mbHd = ((input) & (1 << 0)) != 0;
776         final Boolean pf10mbFd = ((input) & (1 << 1)) != 0;
777         final Boolean pf100mbHd = ((input) & (1 << 2)) != 0;
778         final Boolean pf100mbFd = ((input) & (1 << 3)) != 0;
779         final Boolean pf1gbHd = ((input) & (1 << 4)) != 0;
780         final Boolean pf1gbFd = ((input) & (1 << 5)) != 0;
781         final Boolean pf10gbFd = ((input) & (1 << 6)) != 0;
782         final Boolean pf40gbFd = ((input) & (1 << 7)) != 0;
783         final Boolean pf100gbFd = ((input) & (1 << 8)) != 0;
784         final Boolean pf1tbFd = ((input) & (1 << 9)) != 0;
785         final Boolean pfOther = ((input) & (1 << 10)) != 0;
786         final Boolean pfCopper = ((input) & (1 << 11)) != 0;
787         final Boolean pfFiber = ((input) & (1 << 12)) != 0;
788         final Boolean pfAutoneg = ((input) & (1 << 13)) != 0;
789         final Boolean pfPause = ((input) & (1 << 14)) != 0;
790         final Boolean pfPauseAsym = ((input) & (1 << 15)) != 0;
791         return new PortFeatures(pf100gbFd, pf100mbFd, pf100mbHd, pf10gbFd, pf10mbFd, pf10mbHd, pf1gbFd,
792                 pf1gbHd, pf1tbFd, pf40gbFd, pfAutoneg, pfCopper, pfFiber, pfOther, pfPause, pfPauseAsym);
793     }
794
795     private static MultipartReplyGroupFeaturesCase setGroupFeatures(ByteBuf rawMessage) {
796         MultipartReplyGroupFeaturesCaseBuilder caseBuilder = new MultipartReplyGroupFeaturesCaseBuilder();
797         MultipartReplyGroupFeaturesBuilder featuresBuilder = new MultipartReplyGroupFeaturesBuilder();
798         featuresBuilder.setTypes(createGroupType(rawMessage.readUnsignedInt()));
799         featuresBuilder.setCapabilities(createCapabilities(rawMessage.readUnsignedInt()));
800         List<Long> maxGroupsList = new ArrayList<>();
801         for (int i = 0; i < GROUP_TYPES; i++) {
802             maxGroupsList.add(rawMessage.readUnsignedInt());
803         }
804         featuresBuilder.setMaxGroups(maxGroupsList);
805         List<ActionType> actionBitmaps = new ArrayList<>();
806         for (int i = 0; i < GROUP_TYPES; i++) {
807             actionBitmaps.add(createActionBitmap(rawMessage.readUnsignedInt()));
808         }
809         featuresBuilder.setActionsBitmap(actionBitmaps);
810         caseBuilder.setMultipartReplyGroupFeatures(featuresBuilder.build());
811         return caseBuilder.build();
812     }
813
814     private static ActionType createActionBitmap(long input) {
815         final Boolean atOutput = ((input) & (1 << 0)) != 0;
816         final Boolean atCopyTTLout = ((input) & (1 << 11)) != 0;
817         final Boolean atCopyTTLin = ((input) & (1 << 12)) != 0;
818         final Boolean atSetMplsTTL = ((input) & (1 << 15)) != 0;
819         final Boolean atDecMplsTTL = ((input) & (1 << 16)) != 0;
820         final Boolean atPushVLAN = ((input) & (1 << 17)) != 0;
821         final Boolean atPopVLAN = ((input) & (1 << 18)) != 0;
822         final Boolean atPushMPLS = ((input) & (1 << 19)) != 0;
823         final Boolean atPopMPLS = ((input) & (1 << 20)) != 0;
824         final Boolean atSetQueue = ((input) & (1 << 21)) != 0;
825         final Boolean atGroup = ((input) & (1 << 22)) != 0;
826         final Boolean atSetNWTTL = ((input) & (1 << 23)) != 0;
827         final Boolean atDecNWTTL = ((input) & (1 << 24)) != 0;
828         final Boolean atSetField = ((input) & (1 << 25)) != 0;
829         final Boolean atPushPBB = ((input) & (1 << 26)) != 0;
830         final Boolean atPopPBB = ((input) & (1 << 27)) != 0;
831         final Boolean atExperimenter = false;
832         return new ActionType(atCopyTTLin, atCopyTTLout, atDecMplsTTL,
833                 atDecNWTTL, atExperimenter, atGroup, atOutput, atPopMPLS,
834                 atPopPBB, atPopVLAN, atPushMPLS, atPushPBB, atPushVLAN,
835                 atSetField, atSetMplsTTL, atSetNWTTL, atSetQueue);
836     }
837
838     private static GroupCapabilities createCapabilities(long input) {
839         final Boolean gcSelectWeight = ((input) & (1 << 0)) != 0;
840         final Boolean gcSelectLiveness = ((input) & (1 << 1)) != 0;
841         final Boolean gcChaining = ((input) & (1 << 2)) != 0;
842         final Boolean gcChainingChecks = ((input) & (1 << 3)) != 0;
843         return new GroupCapabilities(gcChaining, gcChainingChecks, gcSelectLiveness, gcSelectWeight);
844     }
845
846     private static GroupTypes createGroupType(long input) {
847         final Boolean gtAll = ((input) & (1 << 0)) != 0;
848         final Boolean gtSelect = ((input) & (1 << 1)) != 0;
849         final Boolean gtIndirect = ((input) & (1 << 2)) != 0;
850         final Boolean gtFF = ((input) & (1 << 3)) != 0;
851         return new GroupTypes(gtAll, gtFF, gtIndirect, gtSelect);
852     }
853
854     private MultipartReplyGroupDescCase setGroupDesc(ByteBuf input) {
855         MultipartReplyGroupDescCaseBuilder caseBuilder = new MultipartReplyGroupDescCaseBuilder();
856         MultipartReplyGroupDescBuilder builder = new MultipartReplyGroupDescBuilder();
857         List<GroupDesc> groupDescsList = new ArrayList<>();
858         while (input.readableBytes() > 0) {
859             GroupDescBuilder groupDescBuilder = new GroupDescBuilder();
860             int bodyLength = input.readUnsignedShort();
861             groupDescBuilder.setType(GroupType.forValue(input.readUnsignedByte()));
862             input.skipBytes(PADDING_IN_GROUP_DESC_HEADER);
863             groupDescBuilder.setGroupId(new GroupId(input.readUnsignedInt()));
864             int actualLength = GROUP_DESC_HEADER_LENGTH;
865             List<BucketsList> bucketsList = new ArrayList<>();
866             while (actualLength < bodyLength) {
867                 BucketsListBuilder bucketsBuilder = new BucketsListBuilder();
868                 int bucketsLength = input.readUnsignedShort();
869                 bucketsBuilder.setWeight(input.readUnsignedShort());
870                 bucketsBuilder.setWatchPort(new PortNumber(input.readUnsignedInt()));
871                 bucketsBuilder.setWatchGroup(input.readUnsignedInt());
872                 input.skipBytes(PADDING_IN_BUCKETS_HEADER);
873                 CodeKeyMaker keyMaker = CodeKeyMakerFactory.createActionsKeyMaker(EncodeConstants.OF13_VERSION_ID);
874                 List<Action> actions = ListDeserializer.deserializeList(EncodeConstants.OF13_VERSION_ID,
875                         bucketsLength - BUCKETS_HEADER_LENGTH, input, keyMaker, registry);
876                 bucketsBuilder.setAction(actions);
877                 bucketsList.add(bucketsBuilder.build());
878                 actualLength += bucketsLength;
879             }
880             groupDescBuilder.setBucketsList(bucketsList);
881             groupDescsList.add(groupDescBuilder.build());
882         }
883         builder.setGroupDesc(groupDescsList);
884         caseBuilder.setMultipartReplyGroupDesc(builder.build());
885         return caseBuilder.build();
886     }
887
888     @Override
889     public void injectDeserializerRegistry(
890             DeserializerRegistry deserializerRegistry) {
891         registry = deserializerRegistry;
892     }
893 }