openflowjava/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/deserialization/factories/OF10StatsRequestInputFactory.java

   1 /*
   2  * Copyright (c) 2015 NetIDE Consortium 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 package org.opendaylight.openflowjava.protocol.impl.deserialization.factories;
   9
  10 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  11 import io.netty.buffer.ByteBuf;
  12 import java.util.Objects;
  13 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistry;
  14 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistryInjector;
  15 import org.opendaylight.openflowjava.protocol.api.extensibility.OFDeserializer;
  16 import org.opendaylight.openflowjava.protocol.api.keys.MessageCodeKey;
  17 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartRequestFlags;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.v10.grouping.MatchV10;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInput;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInputBuilder;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestAggregateCase;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestAggregateCaseBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestDescCase;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestDescCaseBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestExperimenterCase;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestExperimenterCaseBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestFlowCase;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestFlowCaseBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestPortStatsCase;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestPortStatsCaseBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestQueueCase;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestQueueCaseBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestTableCase;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestTableCaseBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.aggregate._case.MultipartRequestAggregateBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.desc._case.MultipartRequestDescBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.experimenter._case.MultipartRequestExperimenterBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.flow._case.MultipartRequestFlowBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.port.stats._case.MultipartRequestPortStatsBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.queue._case.MultipartRequestQueueBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.table._case.MultipartRequestTableBuilder;
  44
  45 /**
  46  * Translates MultipartRequestInput messages.
  47  *
  48  * @author giuseppex.petralia@intel.com
  49  */
  50 @SuppressFBWarnings("UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR") // FB doesn't recognize Objects.requireNonNull
  51 public class OF10StatsRequestInputFactory
  52         implements OFDeserializer<MultipartRequestInput>, DeserializerRegistryInjector {
  53     private DeserializerRegistry registry;
  54     private static final byte FLOW_PADDING_1 = 1;
  55     private static final byte AGGREGATE_PADDING_1 = 1;
  56
  57     @Override
  58     public MultipartRequestInput deserialize(ByteBuf rawMessage) {
  59         Objects.requireNonNull(registry);
  60
  61         MultipartRequestInputBuilder builder = new MultipartRequestInputBuilder();
  62         builder.setVersion((short) EncodeConstants.OF10_VERSION_ID);
  63         builder.setXid(rawMessage.readUnsignedInt());
  64         int type = rawMessage.readUnsignedShort();
  65         builder.setType(getMultipartType(type));
  66         builder.setFlags(getMultipartRequestFlags(rawMessage.readUnsignedShort()));
  67         switch (getMultipartType(type)) {
  68             case OFPMPDESC:
  69                 builder.setMultipartRequestBody(setDesc(rawMessage));
  70                 break;
  71             case OFPMPFLOW:
  72                 builder.setMultipartRequestBody(setFlow(rawMessage));
  73                 break;
  74             case OFPMPAGGREGATE:
  75                 builder.setMultipartRequestBody(setAggregate(rawMessage));
  76                 break;
  77             case OFPMPTABLE:
  78                 builder.setMultipartRequestBody(setTable(rawMessage));
  79                 break;
  80             case OFPMPPORTSTATS:
  81                 builder.setMultipartRequestBody(setPortStats(rawMessage));
  82                 break;
  83             case OFPMPQUEUE:
  84                 builder.setMultipartRequestBody(setQueue(rawMessage));
  85                 break;
  86             case OFPMPEXPERIMENTER:
  87                 builder.setMultipartRequestBody(setExperimenter(rawMessage));
  88                 break;
  89             default:
  90                 break;
  91         }
  92         return builder.build();
  93     }
  94
  95     private MultipartRequestExperimenterCase setExperimenter(ByteBuf input) {
  96         MultipartRequestExperimenterCaseBuilder caseBuilder = new MultipartRequestExperimenterCaseBuilder();
  97         MultipartRequestExperimenterBuilder experimenterBuilder = new MultipartRequestExperimenterBuilder();
  98         caseBuilder.setMultipartRequestExperimenter(experimenterBuilder.build());
  99         return caseBuilder.build();
 100     }
 101
 102     private MultipartRequestQueueCase setQueue(ByteBuf input) {
 103         final MultipartRequestQueueCaseBuilder caseBuilder = new MultipartRequestQueueCaseBuilder();
 104         MultipartRequestQueueBuilder queueBuilder = new MultipartRequestQueueBuilder();
 105         queueBuilder.setPortNo((long) input.readUnsignedShort());
 106         input.skipBytes(2);
 107         queueBuilder.setQueueId(input.readUnsignedInt());
 108         caseBuilder.setMultipartRequestQueue(queueBuilder.build());
 109         return caseBuilder.build();
 110     }
 111
 112     private MultipartRequestPortStatsCase setPortStats(ByteBuf input) {
 113         MultipartRequestPortStatsCaseBuilder caseBuilder = new MultipartRequestPortStatsCaseBuilder();
 114         MultipartRequestPortStatsBuilder portBuilder = new MultipartRequestPortStatsBuilder();
 115         portBuilder.setPortNo((long) input.readUnsignedShort());
 116         caseBuilder.setMultipartRequestPortStats(portBuilder.build());
 117         return caseBuilder.build();
 118     }
 119
 120     private MultipartRequestTableCase setTable(ByteBuf input) {
 121         MultipartRequestTableCaseBuilder caseBuilder = new MultipartRequestTableCaseBuilder();
 122         MultipartRequestTableBuilder tableBuilder = new MultipartRequestTableBuilder();
 123         tableBuilder.setEmpty(true);
 124         caseBuilder.setMultipartRequestTable(tableBuilder.build());
 125         return caseBuilder.build();
 126     }
 127
 128     private MultipartRequestAggregateCase setAggregate(ByteBuf input) {
 129         final MultipartRequestAggregateCaseBuilder caseBuilder = new MultipartRequestAggregateCaseBuilder();
 130         MultipartRequestAggregateBuilder aggregateBuilder = new MultipartRequestAggregateBuilder();
 131         OFDeserializer<MatchV10> matchDeserializer = registry.getDeserializer(
 132                 new MessageCodeKey(EncodeConstants.OF10_VERSION_ID, EncodeConstants.EMPTY_VALUE, MatchV10.class));
 133         aggregateBuilder.setMatchV10(matchDeserializer.deserialize(input));
 134         aggregateBuilder.setTableId(input.readUnsignedByte());
 135         input.skipBytes(AGGREGATE_PADDING_1);
 136         aggregateBuilder.setOutPort((long) input.readUnsignedShort());
 137         caseBuilder.setMultipartRequestAggregate(aggregateBuilder.build());
 138         return caseBuilder.build();
 139     }
 140
 141     private MultipartRequestFlowCase setFlow(ByteBuf input) {
 142         final MultipartRequestFlowCaseBuilder caseBuilder = new MultipartRequestFlowCaseBuilder();
 143         MultipartRequestFlowBuilder flowBuilder = new MultipartRequestFlowBuilder();
 144         OFDeserializer<MatchV10> matchDeserializer = registry.getDeserializer(
 145                 new MessageCodeKey(EncodeConstants.OF10_VERSION_ID, EncodeConstants.EMPTY_VALUE, MatchV10.class));
 146         flowBuilder.setMatchV10(matchDeserializer.deserialize(input));
 147         flowBuilder.setTableId(input.readUnsignedByte());
 148         input.skipBytes(FLOW_PADDING_1);
 149         flowBuilder.setOutPort((long) input.readUnsignedShort());
 150         caseBuilder.setMultipartRequestFlow(flowBuilder.build());
 151         return caseBuilder.build();
 152     }
 153
 154     private MultipartRequestDescCase setDesc(ByteBuf input) {
 155         MultipartRequestDescCaseBuilder caseBuilder = new MultipartRequestDescCaseBuilder();
 156         MultipartRequestDescBuilder descBuilder = new MultipartRequestDescBuilder();
 157         descBuilder.setEmpty(true);
 158         caseBuilder.setMultipartRequestDesc(descBuilder.build());
 159         return caseBuilder.build();
 160     }
 161
 162     @SuppressWarnings("checkstyle:AbbreviationAsWordInName")
 163     private static MultipartRequestFlags getMultipartRequestFlags(int input) {
 164         final Boolean _oFPMPFREQMORE = (input & 1 << 0) != 0;
 165         MultipartRequestFlags flag = new MultipartRequestFlags(_oFPMPFREQMORE);
 166         return flag;
 167     }
 168
 169     private static MultipartType getMultipartType(int input) {
 170         return MultipartType.forValue(input);
 171     }
 172
 173     @Override
 174     public void injectDeserializerRegistry(DeserializerRegistry deserializerRegistry) {
 175         registry = deserializerRegistry;
 176     }
 177 }