Updated experimenter model
[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
13 import java.math.BigInteger;
14 import java.util.ArrayList;
15 import java.util.List;
16
17 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistry;
18 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistryInjector;
19 import org.opendaylight.openflowjava.protocol.api.extensibility.MessageCodeKey;
20 import org.opendaylight.openflowjava.protocol.api.extensibility.OFDeserializer;
21 import org.opendaylight.openflowjava.util.ByteBufUtils;
22 import org.opendaylight.openflowjava.protocol.impl.util.CodeKeyMaker;
23 import org.opendaylight.openflowjava.protocol.impl.util.CodeKeyMakerFactory;
24 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
25 import org.opendaylight.openflowjava.protocol.impl.util.ListDeserializer;
26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.MacAddress;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ActionRelatedTableFeatureProperty;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ActionRelatedTableFeaturePropertyBuilder;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.InstructionRelatedTableFeatureProperty;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.InstructionRelatedTableFeaturePropertyBuilder;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.NextTableRelatedTableFeatureProperty;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.NextTableRelatedTableFeaturePropertyBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.OxmRelatedTableFeatureProperty;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.OxmRelatedTableFeaturePropertyBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.table.features.properties.container.table.feature.properties.NextTableIds;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.table.features.properties.container.table.feature.properties.NextTableIdsBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.actions.grouping.Action;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instructions.grouping.Instruction;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.ActionType;
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.rev130731.match.grouping.Match;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.oxm.fields.grouping.MatchEntries;
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.meter.band.header.meter.band.MeterBandDropCaseBuilder;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandDscpRemarkCaseBuilder;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandExperimenterCaseBuilder;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.meter.band.drop._case.MeterBandDropBuilder;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.meter.band.dscp.remark._case.MeterBandDscpRemarkBuilder;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.meter.band.experimenter._case.MeterBandExperimenterBuilder;
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  * @author timotej.kubas
146  * @author michal.polkorab
147  */
148 public class MultipartReplyMessageFactory implements OFDeserializer<MultipartReplyMessage>,
149         DeserializerRegistryInjector {
150
151     private static final byte PADDING_IN_MULTIPART_REPLY_HEADER = 4;
152     private static final int DESC_STR_LEN = 256;
153     private static final int SERIAL_NUM_LEN = 32;
154     private static final byte PADDING_IN_FLOW_STATS_HEADER_01 = 1;
155     private static final byte PADDING_IN_FLOW_STATS_HEADER_02 = 4;
156     private static final byte PADDING_IN_AGGREGATE_HEADER = 4;
157     private static final byte PADDING_IN_TABLE_HEADER = 3;
158     private static final byte PADDING_IN_MULTIPART_REPLY_TABLE_FEATURES = 5;
159     private static final byte MAX_TABLE_NAME_LENGTH = 32;
160     private static final byte MULTIPART_REPLY_TABLE_FEATURES_STRUCTURE_LENGTH = 64;
161     private static final byte COMMON_PROPERTY_LENGTH = 4;
162     private static final byte PADDING_IN_PORT_STATS_HEADER = 4;
163     private static final byte PADDING_IN_GROUP_HEADER_01 = 2;
164     private static final byte PADDING_IN_GROUP_HEADER_02 = 4;
165     private static final byte BUCKET_COUNTER_LENGTH = 16;
166     private static final byte GROUP_BODY_LENGTH = 40;
167     private static final byte PADDING_IN_METER_FEATURES_HEADER = 2;
168     private static final byte PADDING_IN_METER_STATS_HEADER = 6;
169     private static final byte METER_BAND_STATS_LENGTH = 16;
170     private static final byte METER_BODY_LENGTH = 40;
171     private static final byte METER_CONFIG_LENGTH = 8;
172     private static final byte PADDING_IN_METER_BAND_DROP_HEADER = 4;
173     private static final byte PADDING_IN_METER_BAND_DSCP_HEADER = 3;
174     private static final byte PADDING_IN_PORT_DESC_HEADER_01 = 4;
175     private static final byte PADDING_IN_PORT_DESC_HEADER_02 = 2;
176     private static final int GROUP_TYPES = 4;
177     private static final byte PADDING_IN_GROUP_DESC_HEADER = 1;
178     private static final byte PADDING_IN_BUCKETS_HEADER = 4;
179     private static final byte GROUP_DESC_HEADER_LENGTH = 8;
180     private static final byte BUCKETS_HEADER_LENGTH = 16;
181     private DeserializerRegistry registry;
182
183     @Override
184     public MultipartReplyMessage deserialize(ByteBuf rawMessage) {
185         MultipartReplyMessageBuilder builder = new MultipartReplyMessageBuilder();
186         builder.setVersion((short) EncodeConstants.OF13_VERSION_ID);
187         builder.setXid(rawMessage.readUnsignedInt());
188         int type = rawMessage.readUnsignedShort();
189         builder.setType(MultipartType.forValue(type));
190         builder.setFlags(new MultipartRequestFlags((rawMessage.readUnsignedShort() & 0x01) != 0));
191         rawMessage.skipBytes(PADDING_IN_MULTIPART_REPLY_HEADER);
192
193         switch (type) {
194         case 0:  builder.setMultipartReplyBody(setDesc(rawMessage));
195                  break;
196         case 1:  builder.setMultipartReplyBody(setFlow(rawMessage));
197                  break;
198         case 2:  builder.setMultipartReplyBody(setAggregate(rawMessage));
199                  break;
200         case 3:  builder.setMultipartReplyBody(setTable(rawMessage));
201                  break;         
202         case 4:  builder.setMultipartReplyBody(setPortStats(rawMessage));
203                  break;
204         case 5:  builder.setMultipartReplyBody(setQueue(rawMessage));
205                  break;         
206         case 6:  builder.setMultipartReplyBody(setGroup(rawMessage));
207                  break;
208         case 7:  builder.setMultipartReplyBody(setGroupDesc(rawMessage));
209                  break;
210         case 8:  builder.setMultipartReplyBody(setGroupFeatures(rawMessage));
211                  break;
212         case 9:  builder.setMultipartReplyBody(setMeter(rawMessage));
213                  break;
214         case 10: builder.setMultipartReplyBody(setMeterConfig(rawMessage));
215                  break;
216         case 11: builder.setMultipartReplyBody(setMeterFeatures(rawMessage));
217                  break;
218         case 12: builder.setMultipartReplyBody(setTableFeatures(rawMessage));
219                  break;
220         case 13: builder.setMultipartReplyBody(setPortDesc(rawMessage));
221                  break;
222         case 0xFFFF: builder.setMultipartReplyBody(setExperimenter(rawMessage));
223                  break;
224         default: 
225                  break;
226         }
227         
228         return builder.build();
229     }
230     
231     private static MultipartReplyDescCase setDesc(ByteBuf input) {
232         MultipartReplyDescCaseBuilder caseBuilder = new MultipartReplyDescCaseBuilder();
233         MultipartReplyDescBuilder descBuilder = new MultipartReplyDescBuilder();
234         byte[] mfrDescBytes = new byte[DESC_STR_LEN];
235         input.readBytes(mfrDescBytes);
236         String mfrDesc = new String(mfrDescBytes);
237         descBuilder.setMfrDesc(mfrDesc.trim());
238         byte[] hwDescBytes = new byte[DESC_STR_LEN];
239         input.readBytes(hwDescBytes);
240         String hwDesc = new String(hwDescBytes);
241         descBuilder.setHwDesc(hwDesc.trim());
242         byte[] swDescBytes = new byte[DESC_STR_LEN];
243         input.readBytes(swDescBytes);
244         String swDesc = new String(swDescBytes);
245         descBuilder.setSwDesc(swDesc.trim());
246         byte[] serialNumBytes = new byte[SERIAL_NUM_LEN];
247         input.readBytes(serialNumBytes);
248         String serialNum = new String(serialNumBytes);
249         descBuilder.setSerialNum(serialNum.trim());
250         byte[] dpDescBytes = new byte[DESC_STR_LEN];
251         input.readBytes(dpDescBytes);
252         String dpDesc = new String(dpDescBytes);
253         descBuilder.setDpDesc(dpDesc.trim());
254         caseBuilder.setMultipartReplyDesc(descBuilder.build());
255         return caseBuilder.build();
256     }
257     
258     private MultipartReplyFlowCase setFlow(ByteBuf input) {
259         MultipartReplyFlowCaseBuilder caseBuilder = new MultipartReplyFlowCaseBuilder();
260         MultipartReplyFlowBuilder flowBuilder = new MultipartReplyFlowBuilder();
261         List<FlowStats> flowStatsList = new ArrayList<>();
262         while (input.readableBytes() > 0) {
263             FlowStatsBuilder flowStatsBuilder = new FlowStatsBuilder();
264             int flowRecordLength = input.readUnsignedShort();
265             ByteBuf subInput = input.readSlice(flowRecordLength - EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
266             flowStatsBuilder.setTableId(subInput.readUnsignedByte());
267             subInput.skipBytes(PADDING_IN_FLOW_STATS_HEADER_01);
268             flowStatsBuilder.setDurationSec(subInput.readUnsignedInt());
269             flowStatsBuilder.setDurationNsec(subInput.readUnsignedInt());
270             flowStatsBuilder.setPriority(subInput.readUnsignedShort());
271             flowStatsBuilder.setIdleTimeout(subInput.readUnsignedShort());
272             flowStatsBuilder.setHardTimeout(subInput.readUnsignedShort());
273             flowStatsBuilder.setFlags(createFlowModFlagsFromBitmap(subInput.readUnsignedShort()));
274             subInput.skipBytes(PADDING_IN_FLOW_STATS_HEADER_02);
275             byte[] cookie = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
276             subInput.readBytes(cookie);
277             flowStatsBuilder.setCookie(new BigInteger(1, cookie));
278             byte[] packetCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
279             subInput.readBytes(packetCount);
280             flowStatsBuilder.setPacketCount(new BigInteger(1, packetCount));
281             byte[] byteCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
282             subInput.readBytes(byteCount);
283             flowStatsBuilder.setByteCount(new BigInteger(1, byteCount));
284             OFDeserializer<Match> matchDeserializer = registry.getDeserializer(new MessageCodeKey(
285                     EncodeConstants.OF13_VERSION_ID, EncodeConstants.EMPTY_VALUE, Match.class));
286             flowStatsBuilder.setMatch(matchDeserializer.deserialize(subInput));
287             CodeKeyMaker keyMaker = CodeKeyMakerFactory
288                     .createInstructionsKeyMaker(EncodeConstants.OF13_VERSION_ID);
289             List<Instruction> instructions = ListDeserializer.deserializeList(
290                     EncodeConstants.OF13_VERSION_ID, subInput.readableBytes(), subInput, keyMaker, registry);
291             flowStatsBuilder.setInstruction(instructions);
292             flowStatsList.add(flowStatsBuilder.build());
293         }
294         flowBuilder.setFlowStats(flowStatsList);
295         caseBuilder.setMultipartReplyFlow(flowBuilder.build());
296         return caseBuilder.build();
297     }
298     
299     private static FlowModFlags createFlowModFlagsFromBitmap(int input){
300         final Boolean _oFPFFSENDFLOWREM = (input & (1 << 0)) != 0;
301         final Boolean _oFPFFCHECKOVERLAP = (input & (1 << 1)) != 0;
302         final Boolean _oFPFFRESETCOUNTS = (input & (1 << 2)) != 0; 
303         final Boolean _oFPFFNOPKTCOUNTS = (input & (1 << 3)) != 0;
304         final Boolean _oFPFFNOBYTCOUNTS = (input & (1 << 4)) != 0;
305         return new FlowModFlags(_oFPFFCHECKOVERLAP, _oFPFFNOBYTCOUNTS, _oFPFFNOPKTCOUNTS, _oFPFFRESETCOUNTS, _oFPFFSENDFLOWREM);
306     }
307     
308     private static MultipartReplyAggregateCase setAggregate(ByteBuf input) {
309         MultipartReplyAggregateCaseBuilder caseBuilder = new MultipartReplyAggregateCaseBuilder();
310         MultipartReplyAggregateBuilder builder = new MultipartReplyAggregateBuilder();
311         byte[] packetCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
312         input.readBytes(packetCount);
313         builder.setPacketCount(new BigInteger(1, packetCount));
314         byte[] byteCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
315         input.readBytes(byteCount);
316         builder.setByteCount(new BigInteger(1, byteCount));
317         builder.setFlowCount(input.readUnsignedInt());
318         input.skipBytes(PADDING_IN_AGGREGATE_HEADER);
319         caseBuilder.setMultipartReplyAggregate(builder.build());
320         return caseBuilder.build();
321     }
322     
323     private static MultipartReplyTableCase setTable(ByteBuf input) {
324         MultipartReplyTableCaseBuilder caseBuilder = new MultipartReplyTableCaseBuilder();
325         MultipartReplyTableBuilder builder = new MultipartReplyTableBuilder();
326         List<TableStats> tableStatsList = new ArrayList<>();
327         while (input.readableBytes() > 0) {
328             TableStatsBuilder tableStatsBuilder = new TableStatsBuilder();
329             tableStatsBuilder.setTableId(input.readUnsignedByte());
330             input.skipBytes(PADDING_IN_TABLE_HEADER);
331             tableStatsBuilder.setActiveCount(input.readUnsignedInt());
332             byte[] lookupCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
333             input.readBytes(lookupCount);
334             tableStatsBuilder.setLookupCount(new BigInteger(1, lookupCount));
335             byte[] matchedCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
336             input.readBytes(matchedCount);
337             tableStatsBuilder.setMatchedCount(new BigInteger(1, matchedCount));
338             tableStatsList.add(tableStatsBuilder.build());
339         }
340         builder.setTableStats(tableStatsList);
341         caseBuilder.setMultipartReplyTable(builder.build());
342         return caseBuilder.build();
343     }
344     
345     private MultipartReplyTableFeaturesCase setTableFeatures(ByteBuf input) {
346         MultipartReplyTableFeaturesCaseBuilder caseBuilder = new MultipartReplyTableFeaturesCaseBuilder();
347         MultipartReplyTableFeaturesBuilder builder = new MultipartReplyTableFeaturesBuilder();
348         List<TableFeatures> features = new ArrayList<>();
349         while (input.readableBytes() > 0) {
350             TableFeaturesBuilder featuresBuilder = new TableFeaturesBuilder();
351             int length = input.readUnsignedShort();
352             featuresBuilder.setTableId(input.readUnsignedByte());
353             input.skipBytes(PADDING_IN_MULTIPART_REPLY_TABLE_FEATURES);
354             featuresBuilder.setName(input.readBytes(MAX_TABLE_NAME_LENGTH).toString());
355             byte[] metadataMatch = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
356             input.readBytes(metadataMatch);
357             featuresBuilder.setMetadataMatch(metadataMatch);
358             byte[] metadataWrite = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
359             input.readBytes(metadataWrite);
360             featuresBuilder.setMetadataWrite(metadataWrite);
361             featuresBuilder.setConfig(createTableConfig(input.readUnsignedInt()));
362             featuresBuilder.setMaxEntries(input.readUnsignedInt());
363             featuresBuilder.setTableFeatureProperties(createTableFeaturesProperties(input, 
364                     length - MULTIPART_REPLY_TABLE_FEATURES_STRUCTURE_LENGTH));
365             features.add(featuresBuilder.build());
366         }
367         builder.setTableFeatures(features);
368         caseBuilder.setMultipartReplyTableFeatures(builder.build());
369         return caseBuilder.build();
370     }
371     
372     private static TableConfig createTableConfig(long input) {
373         boolean deprecated = (input & 3) != 0;
374         return new TableConfig(deprecated);
375     }
376     
377     private List<TableFeatureProperties> createTableFeaturesProperties(ByteBuf input, int length) {
378         List<TableFeatureProperties> properties = new ArrayList<>();
379         int tableFeaturesLength = length;
380         while (tableFeaturesLength > 0) {
381             TableFeaturePropertiesBuilder builder = new TableFeaturePropertiesBuilder();
382             TableFeaturesPropType type = TableFeaturesPropType.forValue(input.readUnsignedShort());
383             builder.setType(type);
384             int propertyLength = input.readUnsignedShort();
385             int paddingRemainder = propertyLength % EncodeConstants.PADDING;
386             tableFeaturesLength -= propertyLength;
387             if (type.equals(TableFeaturesPropType.OFPTFPTINSTRUCTIONS)
388                     || type.equals(TableFeaturesPropType.OFPTFPTINSTRUCTIONSMISS)) {
389                 InstructionRelatedTableFeaturePropertyBuilder insBuilder = new InstructionRelatedTableFeaturePropertyBuilder();
390                 CodeKeyMaker keyMaker = CodeKeyMakerFactory.createInstructionsKeyMaker(EncodeConstants.OF13_VERSION_ID);
391                 List<Instruction> instructions = ListDeserializer.deserializeHeaders(EncodeConstants.OF13_VERSION_ID,
392                         propertyLength - COMMON_PROPERTY_LENGTH, input, keyMaker, registry);
393                 insBuilder.setInstruction(instructions);
394                 builder.addAugmentation(InstructionRelatedTableFeatureProperty.class, insBuilder.build());
395             } else if (type.equals(TableFeaturesPropType.OFPTFPTNEXTTABLES)
396                     || type.equals(TableFeaturesPropType.OFPTFPTNEXTTABLESMISS)) {
397                 propertyLength -= COMMON_PROPERTY_LENGTH;
398                 NextTableRelatedTableFeaturePropertyBuilder tableBuilder = new NextTableRelatedTableFeaturePropertyBuilder();
399                 List<NextTableIds> ids = new ArrayList<>();
400                 while (propertyLength > 0) {
401                     NextTableIdsBuilder nextTableIdsBuilder = new NextTableIdsBuilder();
402                     nextTableIdsBuilder.setTableId(input.readUnsignedByte());
403                     ids.add(nextTableIdsBuilder.build());
404                     propertyLength--;
405                 }
406                 tableBuilder.setNextTableIds(ids);
407                 builder.addAugmentation(NextTableRelatedTableFeatureProperty.class, tableBuilder.build());
408             } else if (type.equals(TableFeaturesPropType.OFPTFPTWRITEACTIONS)
409                     || type.equals(TableFeaturesPropType.OFPTFPTWRITEACTIONSMISS)
410                     || type.equals(TableFeaturesPropType.OFPTFPTAPPLYACTIONS)
411                     || type.equals(TableFeaturesPropType.OFPTFPTAPPLYACTIONSMISS)) {
412                 ActionRelatedTableFeaturePropertyBuilder actionBuilder = new ActionRelatedTableFeaturePropertyBuilder();
413                 CodeKeyMaker keyMaker = CodeKeyMakerFactory.createActionsKeyMaker(EncodeConstants.OF13_VERSION_ID);
414                 List<Action> actions = ListDeserializer.deserializeHeaders(EncodeConstants.OF13_VERSION_ID,
415                         propertyLength - COMMON_PROPERTY_LENGTH, input, keyMaker, registry);
416                 actionBuilder.setAction(actions);
417                 builder.addAugmentation(ActionRelatedTableFeatureProperty.class, actionBuilder.build());
418             } else if (type.equals(TableFeaturesPropType.OFPTFPTMATCH)
419                     || type.equals(TableFeaturesPropType.OFPTFPTWILDCARDS)
420                     || type.equals(TableFeaturesPropType.OFPTFPTWRITESETFIELD)
421                     || type.equals(TableFeaturesPropType.OFPTFPTWRITESETFIELDMISS)
422                     || type.equals(TableFeaturesPropType.OFPTFPTAPPLYSETFIELD)
423                     || type.equals(TableFeaturesPropType.OFPTFPTAPPLYSETFIELDMISS)) {
424                 OxmRelatedTableFeaturePropertyBuilder oxmBuilder = new OxmRelatedTableFeaturePropertyBuilder();
425                 CodeKeyMaker keyMaker = CodeKeyMakerFactory
426                         .createMatchEntriesKeyMaker(EncodeConstants.OF13_VERSION_ID);
427                 List<MatchEntries> entries = ListDeserializer.deserializeHeaders(EncodeConstants.OF13_VERSION_ID,
428                         propertyLength - COMMON_PROPERTY_LENGTH, input, keyMaker, registry);
429                 oxmBuilder.setMatchEntries(entries);
430                 builder.addAugmentation(OxmRelatedTableFeatureProperty.class, oxmBuilder.build());
431             } else if (type.equals(TableFeaturesPropType.OFPTFPTEXPERIMENTER)
432                     || type.equals(TableFeaturesPropType.OFPTFPTEXPERIMENTERMISS)) {
433                 // return index to property start, so that the experimenter properties are deserialized
434                 // correctly - as whole ofp_table_feature_prop_experimenter property
435                 input.readerIndex(input.readerIndex() - 2 * EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
436                 OFDeserializer<TableFeatureProperties> propDeserializer = registry.getDeserializer(
437                         new MessageCodeKey(EncodeConstants.OF13_VERSION_ID,
438                                 type.getIntValue(), TableFeatureProperties.class));
439                 TableFeatureProperties expProp = propDeserializer.deserialize(input);
440                 properties.add(expProp);
441                 continue;
442             }
443             if (paddingRemainder != 0) {
444                 input.skipBytes(EncodeConstants.PADDING - paddingRemainder);
445                 tableFeaturesLength -= EncodeConstants.PADDING - paddingRemainder;
446             }
447             properties.add(builder.build());
448         }
449         return properties;
450     }
451     
452     private static MultipartReplyPortStatsCase setPortStats(ByteBuf input) {
453         MultipartReplyPortStatsCaseBuilder caseBuilder = new MultipartReplyPortStatsCaseBuilder();
454         MultipartReplyPortStatsBuilder builder = new MultipartReplyPortStatsBuilder();
455         List<PortStats> portStatsList = new ArrayList<>();
456         while (input.readableBytes() > 0) {
457             PortStatsBuilder portStatsBuilder = new PortStatsBuilder();
458             portStatsBuilder.setPortNo(input.readUnsignedInt());
459             input.skipBytes(PADDING_IN_PORT_STATS_HEADER);
460             byte[] rxPackets = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
461             input.readBytes(rxPackets);
462             portStatsBuilder.setRxPackets(new BigInteger(1, rxPackets));
463             byte[] txPackets = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
464             input.readBytes(txPackets);
465             portStatsBuilder.setTxPackets(new BigInteger(1, txPackets));
466             byte[] rxBytes = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
467             input.readBytes(rxBytes);
468             portStatsBuilder.setRxBytes(new BigInteger(1, rxBytes));
469             byte[] txBytes = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
470             input.readBytes(txBytes);
471             portStatsBuilder.setTxBytes(new BigInteger(1, txBytes));
472             byte[] rxDropped = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
473             input.readBytes(rxDropped);
474             portStatsBuilder.setRxDropped(new BigInteger(1, rxDropped));
475             byte[] txDropped = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
476             input.readBytes(txDropped);
477             portStatsBuilder.setTxDropped(new BigInteger(1, txDropped));
478             byte[] rxErrors = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
479             input.readBytes(rxErrors);
480             portStatsBuilder.setRxErrors(new BigInteger(1, rxErrors));
481             byte[] txErrors = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
482             input.readBytes(txErrors);
483             portStatsBuilder.setTxErrors(new BigInteger(1, txErrors));
484             byte[] rxFrameErr = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
485             input.readBytes(rxFrameErr);
486             portStatsBuilder.setRxFrameErr(new BigInteger(1, rxFrameErr));
487             byte[] rxOverErr = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
488             input.readBytes(rxOverErr);
489             portStatsBuilder.setRxOverErr(new BigInteger(1, rxOverErr));
490             byte[] rxCrcErr = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
491             input.readBytes(rxCrcErr);
492             portStatsBuilder.setRxCrcErr(new BigInteger(1, rxCrcErr));
493             byte[] collisions = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
494             input.readBytes(collisions);
495             portStatsBuilder.setCollisions(new BigInteger(1, collisions));
496             portStatsBuilder.setDurationSec(input.readUnsignedInt());
497             portStatsBuilder.setDurationNsec(input.readUnsignedInt());
498             portStatsList.add(portStatsBuilder.build());
499         }
500         builder.setPortStats(portStatsList);
501         caseBuilder.setMultipartReplyPortStats(builder.build());
502         return caseBuilder.build();
503     }
504     
505     private static MultipartReplyQueueCase setQueue(ByteBuf input) {
506         MultipartReplyQueueCaseBuilder caseBuilder = new MultipartReplyQueueCaseBuilder();
507         MultipartReplyQueueBuilder builder = new MultipartReplyQueueBuilder();
508         List<QueueStats> queueStatsList = new ArrayList<>();
509         while (input.readableBytes() > 0) {
510             QueueStatsBuilder queueStatsBuilder = new QueueStatsBuilder();
511             queueStatsBuilder.setPortNo(input.readUnsignedInt());
512             queueStatsBuilder.setQueueId(input.readUnsignedInt());
513             byte[] txBytes = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
514             input.readBytes(txBytes);
515             queueStatsBuilder.setTxBytes(new BigInteger(1, txBytes));
516             byte[] txPackets = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
517             input.readBytes(txPackets);
518             queueStatsBuilder.setTxPackets(new BigInteger(1, txPackets));
519             byte[] txErrors = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
520             input.readBytes(txErrors);
521             queueStatsBuilder.setTxErrors(new BigInteger(1, txErrors));
522             queueStatsBuilder.setDurationSec(input.readUnsignedInt());
523             queueStatsBuilder.setDurationNsec(input.readUnsignedInt());
524             queueStatsList.add(queueStatsBuilder.build());
525         }
526         builder.setQueueStats(queueStatsList);
527         caseBuilder.setMultipartReplyQueue(builder.build());
528         return caseBuilder.build();
529     }
530     
531     private static MultipartReplyGroupCase setGroup(ByteBuf input) {
532         MultipartReplyGroupCaseBuilder caseBuilder = new MultipartReplyGroupCaseBuilder();
533         MultipartReplyGroupBuilder builder = new MultipartReplyGroupBuilder();
534         List<GroupStats> groupStatsList = new ArrayList<>();
535         while (input.readableBytes() > 0) {
536             GroupStatsBuilder groupStatsBuilder = new GroupStatsBuilder();
537             int bodyLength = input.readUnsignedShort();
538             input.skipBytes(PADDING_IN_GROUP_HEADER_01);
539             groupStatsBuilder.setGroupId(new GroupId(input.readUnsignedInt()));
540             groupStatsBuilder.setRefCount(input.readUnsignedInt());
541             input.skipBytes(PADDING_IN_GROUP_HEADER_02);
542             byte[] packetCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
543             input.readBytes(packetCount);
544             groupStatsBuilder.setPacketCount(new BigInteger(1, packetCount));
545             byte[] byteCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
546             input.readBytes(byteCount);
547             groupStatsBuilder.setByteCount(new BigInteger(1, byteCount));
548             groupStatsBuilder.setDurationSec(input.readUnsignedInt());
549             groupStatsBuilder.setDurationNsec(input.readUnsignedInt());
550             int actualLength = GROUP_BODY_LENGTH;
551             List<BucketStats> bucketStatsList = new ArrayList<>();
552             while (actualLength < bodyLength) {
553                 BucketStatsBuilder bucketStatsBuilder = new BucketStatsBuilder();
554                 byte[] packetCountBucket = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
555                 input.readBytes(packetCountBucket);
556                 bucketStatsBuilder.setPacketCount(new BigInteger(1, packetCountBucket));
557                 byte[] byteCountBucket = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
558                 input.readBytes(byteCountBucket);
559                 bucketStatsBuilder.setByteCount(new BigInteger(1, byteCountBucket));
560                 bucketStatsList.add(bucketStatsBuilder.build());
561                 actualLength += BUCKET_COUNTER_LENGTH;
562             } 
563             groupStatsBuilder.setBucketStats(bucketStatsList);
564             groupStatsList.add(groupStatsBuilder.build());
565         }
566         builder.setGroupStats(groupStatsList);
567         caseBuilder.setMultipartReplyGroup(builder.build());
568         return caseBuilder.build();
569     }
570     
571     private static MultipartReplyMeterFeaturesCase setMeterFeatures(ByteBuf input) {
572         MultipartReplyMeterFeaturesCaseBuilder caseBuilder = new MultipartReplyMeterFeaturesCaseBuilder();
573         MultipartReplyMeterFeaturesBuilder builder = new MultipartReplyMeterFeaturesBuilder();
574         builder.setMaxMeter(input.readUnsignedInt());
575         builder.setBandTypes(createMeterBandsBitmap(input.readUnsignedInt()));
576         builder.setCapabilities(createMeterFlags(input.readUnsignedInt()));
577         builder.setMaxBands(input.readUnsignedByte());
578         builder.setMaxColor(input.readUnsignedByte());
579         input.skipBytes(PADDING_IN_METER_FEATURES_HEADER);
580         caseBuilder.setMultipartReplyMeterFeatures(builder.build());
581         return caseBuilder.build();
582     }
583     
584     private static MeterFlags createMeterFlags(long input){
585         final Boolean _oFPMFKBPS = (input & (1 << 0)) != 0;
586         final Boolean _oFPMFPKTPS = (input & (1 << 1)) != 0;
587         final Boolean _oFPMFBURST = (input & (1 << 2)) != 0;
588         final Boolean _oFPMFSTATS = (input & (1 << 3)) != 0;
589         return new MeterFlags(_oFPMFBURST, _oFPMFKBPS, _oFPMFPKTPS, _oFPMFSTATS);
590     }
591     
592     private static MeterBandTypeBitmap createMeterBandsBitmap(long input) {
593         final Boolean _oFPMBTDROP = (input & (1 << 0)) != 0;
594         final Boolean _oFPMBTDSCPREMARK = (input & (1 << 1)) != 0;
595         return new MeterBandTypeBitmap(_oFPMBTDROP, _oFPMBTDSCPREMARK);
596     }
597     
598     private static MultipartReplyMeterCase setMeter(ByteBuf input) {
599         MultipartReplyMeterCaseBuilder caseBuilder = new MultipartReplyMeterCaseBuilder();
600         MultipartReplyMeterBuilder builder = new MultipartReplyMeterBuilder();
601         List<MeterStats> meterStatsList = new ArrayList<>();
602         while (input.readableBytes() > 0) {
603             MeterStatsBuilder meterStatsBuilder = new MeterStatsBuilder();
604             meterStatsBuilder.setMeterId(new MeterId(input.readUnsignedInt()));
605             int meterStatsBodyLength = input.readUnsignedShort();
606             input.skipBytes(PADDING_IN_METER_STATS_HEADER);
607             meterStatsBuilder.setFlowCount(input.readUnsignedInt());
608             byte[] packetInCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
609             input.readBytes(packetInCount);
610             meterStatsBuilder.setPacketInCount(new BigInteger(1, packetInCount));
611             byte[] byteInCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
612             input.readBytes(byteInCount);
613             meterStatsBuilder.setByteInCount(new BigInteger(1, byteInCount));
614             meterStatsBuilder.setDurationSec(input.readUnsignedInt());
615             meterStatsBuilder.setDurationNsec(input.readUnsignedInt());
616             int actualLength = METER_BODY_LENGTH;
617             List<MeterBandStats> meterBandStatsList = new ArrayList<>();
618             while (actualLength < meterStatsBodyLength) {
619                 MeterBandStatsBuilder meterBandStatsBuilder = new MeterBandStatsBuilder();
620                 byte[] packetBandCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
621                 input.readBytes(packetBandCount);
622                 meterBandStatsBuilder.setPacketBandCount(new BigInteger(1, packetBandCount));
623                 byte[] byteBandCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
624                 input.readBytes(byteBandCount);
625                 meterBandStatsBuilder.setByteBandCount(new BigInteger(1, byteBandCount));
626                 meterBandStatsList.add(meterBandStatsBuilder.build());
627                 actualLength += METER_BAND_STATS_LENGTH;
628             }
629             meterStatsBuilder.setMeterBandStats(meterBandStatsList);
630             meterStatsList.add(meterStatsBuilder.build());
631         }
632         builder.setMeterStats(meterStatsList);
633         caseBuilder.setMultipartReplyMeter(builder.build());
634         return caseBuilder.build();
635     }
636     
637     private static MultipartReplyMeterConfigCase setMeterConfig(ByteBuf input) {
638         MultipartReplyMeterConfigCaseBuilder caseBuilder = new MultipartReplyMeterConfigCaseBuilder();
639         MultipartReplyMeterConfigBuilder builder = new MultipartReplyMeterConfigBuilder();
640         List<MeterConfig> meterConfigList = new ArrayList<>();
641         while (input.readableBytes() > 0) {
642             MeterConfigBuilder meterConfigBuilder = new MeterConfigBuilder();
643             int meterConfigBodyLength = input.readUnsignedShort();
644             meterConfigBuilder.setFlags(createMeterFlags(input.readUnsignedShort()));
645             meterConfigBuilder.setMeterId(new MeterId(input.readUnsignedInt()));
646             int actualLength = METER_CONFIG_LENGTH;
647             List<Bands> bandsList = new ArrayList<>();
648             while (actualLength < meterConfigBodyLength) {
649                 BandsBuilder bandsBuilder = new BandsBuilder();
650                 int bandType = input.readUnsignedShort();
651                 switch (bandType) {
652                     case 1:
653                         MeterBandDropCaseBuilder bandDropCaseBuilder = new MeterBandDropCaseBuilder();
654                         MeterBandDropBuilder bandDropBuilder = new MeterBandDropBuilder();
655                         bandDropBuilder.setType(MeterBandType.forValue(bandType));
656                         actualLength += input.readUnsignedShort();
657                         bandDropBuilder.setRate(input.readUnsignedInt());
658                         bandDropBuilder.setBurstSize(input.readUnsignedInt());
659                         input.skipBytes(PADDING_IN_METER_BAND_DROP_HEADER);
660                         bandDropCaseBuilder.setMeterBandDrop(bandDropBuilder.build());
661                         bandsBuilder.setMeterBand(bandDropCaseBuilder.build());
662                         break;
663                     case 2:
664                         MeterBandDscpRemarkCaseBuilder bandDscpRemarkCaseBuilder = new MeterBandDscpRemarkCaseBuilder();
665                         MeterBandDscpRemarkBuilder bandDscpRemarkBuilder = new MeterBandDscpRemarkBuilder();
666                         bandDscpRemarkBuilder.setType(MeterBandType.forValue(bandType));
667                         actualLength += input.readUnsignedShort();
668                         bandDscpRemarkBuilder.setRate(input.readUnsignedInt());
669                         bandDscpRemarkBuilder.setBurstSize(input.readUnsignedInt());
670                         bandDscpRemarkBuilder.setPrecLevel(input.readUnsignedByte());
671                         input.skipBytes(PADDING_IN_METER_BAND_DSCP_HEADER);
672                         bandDscpRemarkCaseBuilder.setMeterBandDscpRemark(bandDscpRemarkBuilder.build());
673                         bandsBuilder.setMeterBand(bandDscpRemarkCaseBuilder.build());
674                         break;
675                     case 0xFFFF:
676                         MeterBandExperimenterCaseBuilder bandExperimenterCaseBuilder = new MeterBandExperimenterCaseBuilder();
677                         MeterBandExperimenterBuilder bandExperimenterBuilder = new MeterBandExperimenterBuilder();
678                         // TODO - implement lookup into registry
679 //                        bandExperimenterBuilder.setType(MeterBandType.forValue(bandType));
680 //                        actualLength += input.readUnsignedShort();
681 //                        bandExperimenterBuilder.setRate(input.readUnsignedInt());
682 //                        bandExperimenterBuilder.setBurstSize(input.readUnsignedInt());
683 //                        bandExperimenterBuilder.setExperimenter(input.readUnsignedInt());
684 //                        bandExperimenterCaseBuilder.setMeterBandExperimenter(bandExperimenterBuilder.build());
685                         bandsBuilder.setMeterBand(bandExperimenterCaseBuilder.build());
686                         break;
687                     default:
688                         break;
689                 }
690                 bandsList.add(bandsBuilder.build());
691             }
692             meterConfigBuilder.setBands(bandsList);
693             meterConfigList.add(meterConfigBuilder.build());
694         }
695         builder.setMeterConfig(meterConfigList);
696         caseBuilder.setMultipartReplyMeterConfig(builder.build());
697         return caseBuilder.build();
698     }
699     
700     private static MultipartReplyExperimenterCase setExperimenter(ByteBuf input) {
701      // TODO - implement lookup into registry
702         MultipartReplyExperimenterCaseBuilder caseBuilder = new MultipartReplyExperimenterCaseBuilder();
703         MultipartReplyExperimenterBuilder builder = new MultipartReplyExperimenterBuilder();
704 //        builder.setExperimenter(input.readUnsignedInt());
705 //        builder.setExpType(input.readUnsignedInt());
706 //        byte[] data = new byte[input.readableBytes()];
707 //        input.readBytes(data);
708 //        builder.setData(data);
709         caseBuilder.setMultipartReplyExperimenter(builder.build());
710         return caseBuilder.build();
711     }
712     
713     private static MultipartReplyPortDescCase setPortDesc(ByteBuf input) {
714         MultipartReplyPortDescCaseBuilder caseBuilder = new MultipartReplyPortDescCaseBuilder();
715         MultipartReplyPortDescBuilder builder = new MultipartReplyPortDescBuilder();
716         List<Ports> portsList = new ArrayList<>();
717         while (input.readableBytes() > 0) {
718             PortsBuilder portsBuilder = new PortsBuilder();
719             portsBuilder.setPortNo(input.readUnsignedInt());
720             input.skipBytes(PADDING_IN_PORT_DESC_HEADER_01);
721             byte[] hwAddress = new byte[EncodeConstants.MAC_ADDRESS_LENGTH];
722             input.readBytes(hwAddress);
723             portsBuilder.setHwAddr(new MacAddress(ByteBufUtils.macAddressToString(hwAddress)));
724             input.skipBytes(PADDING_IN_PORT_DESC_HEADER_02);
725             portsBuilder.setName(ByteBufUtils.decodeNullTerminatedString(input, EncodeConstants.MAX_PORT_NAME_LENGTH));
726             portsBuilder.setConfig(createPortConfig(input.readUnsignedInt()));
727             portsBuilder.setState(createPortState(input.readUnsignedInt()));
728             portsBuilder.setCurrentFeatures(createPortFeatures(input.readUnsignedInt()));
729             portsBuilder.setAdvertisedFeatures(createPortFeatures(input.readUnsignedInt()));
730             portsBuilder.setSupportedFeatures(createPortFeatures(input.readUnsignedInt()));
731             portsBuilder.setPeerFeatures(createPortFeatures(input.readUnsignedInt()));
732             portsBuilder.setCurrSpeed(input.readUnsignedInt());
733             portsBuilder.setMaxSpeed(input.readUnsignedInt());
734             portsList.add(portsBuilder.build());
735         }
736         builder.setPorts(portsList);
737         caseBuilder.setMultipartReplyPortDesc(builder.build());
738         return caseBuilder.build();
739     }
740     
741     private static PortConfig createPortConfig(long input){
742         final Boolean _portDown   = ((input) & (1<<0)) != 0;
743         final Boolean _noRecv    = ((input) & (1<<2)) != 0;
744         final Boolean _noFwd       = ((input) & (1<<5)) != 0;
745         final Boolean _noPacketIn = ((input) & (1<<6)) != 0;
746         return new PortConfig(_noFwd, _noPacketIn, _noRecv, _portDown);
747     }
748     
749     private static PortState createPortState(long input){
750         final Boolean _linkDown = ((input) & (1<<0)) != 0;
751         final Boolean _blocked  = ((input) & (1<<1)) != 0;
752         final Boolean _live     = ((input) & (1<<2)) != 0;
753         return new PortState(_blocked, _linkDown, _live);
754     }
755     
756     private static PortFeatures createPortFeatures(long input){
757         final Boolean _10mbHd = ((input) & (1<<0)) != 0;
758         final Boolean _10mbFd = ((input) & (1<<1)) != 0;
759         final Boolean _100mbHd = ((input) & (1<<2)) != 0;
760         final Boolean _100mbFd = ((input) & (1<<3)) != 0;
761         final Boolean _1gbHd = ((input) & (1<<4)) != 0;
762         final Boolean _1gbFd = ((input) & (1<<5)) != 0;
763         final Boolean _10gbFd = ((input) & (1<<6)) != 0;
764         final Boolean _40gbFd = ((input) & (1<<7)) != 0;
765         final Boolean _100gbFd = ((input) & (1<<8)) != 0;
766         final Boolean _1tbFd = ((input) & (1<<9)) != 0;
767         final Boolean _other = ((input) & (1<<10)) != 0;
768         final Boolean _copper = ((input) & (1<<11)) != 0;
769         final Boolean _fiber = ((input) & (1<<12)) != 0;
770         final Boolean _autoneg = ((input) & (1<<13)) != 0;
771         final Boolean _pause = ((input) & (1<<14)) != 0;
772         final Boolean _pauseAsym = ((input) & (1<<15)) != 0;
773         return new PortFeatures(_100gbFd, _100mbFd, _100mbHd, _10gbFd, _10mbFd, _10mbHd, _1gbFd,
774                 _1gbHd, _1tbFd, _40gbFd, _autoneg, _copper, _fiber, _other, _pause, _pauseAsym);
775     }
776     
777     private static MultipartReplyGroupFeaturesCase setGroupFeatures(ByteBuf rawMessage) {
778         MultipartReplyGroupFeaturesCaseBuilder caseBuilder = new MultipartReplyGroupFeaturesCaseBuilder();
779         MultipartReplyGroupFeaturesBuilder featuresBuilder = new MultipartReplyGroupFeaturesBuilder();
780         featuresBuilder.setTypes(createGroupType(rawMessage.readUnsignedInt()));
781         featuresBuilder.setCapabilities(createCapabilities(rawMessage.readUnsignedInt()));
782         List<Long> maxGroupsList = new ArrayList<>();
783         for (int i = 0; i < GROUP_TYPES ; i++) {
784             maxGroupsList.add(rawMessage.readUnsignedInt());
785         }
786         featuresBuilder.setMaxGroups(maxGroupsList);
787         List<ActionType> actionBitmaps = new ArrayList<>();
788         for (int i = 0; i < GROUP_TYPES ; i++) {
789             actionBitmaps.add(createActionBitmap(rawMessage.readUnsignedInt()));
790         }
791         featuresBuilder.setActionsBitmap(actionBitmaps);
792         caseBuilder.setMultipartReplyGroupFeatures(featuresBuilder.build());
793         return caseBuilder.build();
794     }
795     
796     private static ActionType createActionBitmap(long input) {
797         final Boolean OFPAT_OUTPUT = ((input) & (1<<0)) != 0;
798         final Boolean OFPAT_COPY_TTL_OUT = ((input) & (1<<1)) != 0;
799         final Boolean OFPAT_COPY_TTL_IN = ((input) & (1<<2)) != 0;
800         final Boolean OFPAT_SET_MPLS_TTL = ((input) & (1<<3)) != 0;
801         final Boolean OFPAT_DEC_MPLS_TTL = ((input) & (1<<4)) != 0;
802         final Boolean OFPAT_PUSH_VLAN = ((input) & (1<<5)) != 0;
803         final Boolean OFPAT_POP_VLAN = ((input) & (1<<6)) != 0;
804         final Boolean OFPAT_PUSH_MPLS = ((input) & (1<<7)) != 0;
805         final Boolean OFPAT_POP_MPLS = ((input) & (1<<8)) != 0;
806         final Boolean OFPAT_SET_QUEUE = ((input) & (1<<9)) != 0;
807         final Boolean OFPAT_GROUP = ((input) & (1<<10)) != 0;
808         final Boolean OFPAT_SET_NW_TTL = ((input) & (1<<11)) != 0;
809         final Boolean OFPAT_DEC_NW_TTL = ((input) & (1<<12)) != 0;
810         final Boolean OFPAT_SET_FIELD = ((input) & (1<<13)) != 0;
811         final Boolean OFPAT_PUSH_PBB = ((input) & (1<<14)) != 0;
812         final Boolean OFPAT_POP_PBB = ((input) & (1<<15)) != 0;
813         final Boolean OFPAT_EXPERIMENTER = ((input) & (1<<16)) != 0;
814         return new ActionType(OFPAT_COPY_TTL_IN, OFPAT_COPY_TTL_OUT, OFPAT_DEC_MPLS_TTL,
815                 OFPAT_DEC_NW_TTL, OFPAT_EXPERIMENTER, OFPAT_GROUP, OFPAT_OUTPUT, OFPAT_POP_MPLS,
816                 OFPAT_POP_PBB, OFPAT_POP_VLAN, OFPAT_PUSH_MPLS, OFPAT_PUSH_PBB, OFPAT_PUSH_VLAN,
817                 OFPAT_SET_FIELD, OFPAT_SET_MPLS_TTL, OFPAT_SET_NW_TTL, OFPAT_SET_QUEUE);
818     }
819
820     private static GroupCapabilities createCapabilities(long input) {
821         final Boolean OFOFPGFC_SELECT_WEIGHT = ((input) & (1<<0)) != 0;
822         final Boolean OFPGFC_SELECT_LIVENESS = ((input) & (1<<1)) != 0;
823         final Boolean OFPGFC_CHAINING = ((input) & (1<<2)) != 0;
824         final Boolean OFPGFC_CHAINING_CHECKS = ((input) & (1<<3)) != 0;
825         return new GroupCapabilities(OFPGFC_CHAINING, OFPGFC_CHAINING_CHECKS, OFPGFC_SELECT_LIVENESS, OFOFPGFC_SELECT_WEIGHT);
826     }
827
828     private static GroupTypes createGroupType(long input) {
829         final Boolean OFPGT_ALL = ((input) & (1<<0)) != 0;
830         final Boolean OFPGT_SELECT = ((input) & (1<<1)) != 0;
831         final Boolean OFPGT_INDIRECT = ((input) & (1<<2)) != 0;
832         final Boolean OFPGT_FF = ((input) & (1<<3)) != 0;
833         return new GroupTypes(OFPGT_ALL, OFPGT_FF, OFPGT_INDIRECT, OFPGT_SELECT);
834     }
835     
836     private MultipartReplyGroupDescCase setGroupDesc(ByteBuf input) {
837         MultipartReplyGroupDescCaseBuilder caseBuilder = new MultipartReplyGroupDescCaseBuilder();
838         MultipartReplyGroupDescBuilder builder = new MultipartReplyGroupDescBuilder();
839         List<GroupDesc> groupDescsList = new ArrayList<>();
840         while (input.readableBytes() > 0) {
841             GroupDescBuilder groupDescBuilder = new GroupDescBuilder();
842             int bodyLength = input.readUnsignedShort();
843             groupDescBuilder.setType(GroupType.forValue(input.readUnsignedByte()));
844             input.skipBytes(PADDING_IN_GROUP_DESC_HEADER);
845             groupDescBuilder.setGroupId(new GroupId(input.readUnsignedInt()));
846             int actualLength = GROUP_DESC_HEADER_LENGTH;
847             List<BucketsList> bucketsList = new ArrayList<>();
848             while (actualLength < bodyLength) {
849                 BucketsListBuilder bucketsBuilder = new BucketsListBuilder();
850                 int bucketsLength = input.readUnsignedShort();
851                 bucketsBuilder.setWeight(input.readUnsignedShort());
852                 bucketsBuilder.setWatchPort(new PortNumber(input.readUnsignedInt()));
853                 bucketsBuilder.setWatchGroup(input.readUnsignedInt());
854                 input.skipBytes(PADDING_IN_BUCKETS_HEADER);
855                 CodeKeyMaker keyMaker = CodeKeyMakerFactory.createActionsKeyMaker(EncodeConstants.OF13_VERSION_ID);
856                 List<Action> actions = ListDeserializer.deserializeList(EncodeConstants.OF13_VERSION_ID,
857                         bucketsLength - BUCKETS_HEADER_LENGTH, input, keyMaker, registry);
858                 bucketsBuilder.setAction(actions);
859                 bucketsList.add(bucketsBuilder.build());
860                 actualLength += bucketsLength;
861             }
862             groupDescBuilder.setBucketsList(bucketsList);
863             groupDescsList.add(groupDescBuilder.build());
864         }
865         builder.setGroupDesc(groupDescsList);
866         caseBuilder.setMultipartReplyGroupDesc(builder.build());
867         return caseBuilder.build();
868     }
869
870     @Override
871     public void injectDeserializerRegistry(
872             DeserializerRegistry deserializerRegistry) {
873         registry = deserializerRegistry;
874     }
875 }