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 import org.opendaylight.yangtools.yang.common.Empty;
  45
  46 /**
  47  * Translates MultipartRequestInput messages.
  48  *
  49  * @author giuseppex.petralia@intel.com
  50  */
  51 @SuppressFBWarnings("UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR") // FB doesn't recognize Objects.requireNonNull
  52 public class OF10StatsRequestInputFactory
  53         implements OFDeserializer<MultipartRequestInput>, DeserializerRegistryInjector {
  54     private DeserializerRegistry registry;
  55     private static final byte FLOW_PADDING_1 = 1;
  56     private static final byte AGGREGATE_PADDING_1 = 1;
  57
  58     @Override
  59     public MultipartRequestInput deserialize(ByteBuf rawMessage) {
  60         Objects.requireNonNull(registry);
  61
  62         MultipartRequestInputBuilder builder = new MultipartRequestInputBuilder();
  63         builder.setVersion((short) EncodeConstants.OF10_VERSION_ID);
  64         builder.setXid(rawMessage.readUnsignedInt());
  65         int type = rawMessage.readUnsignedShort();
  66         builder.setType(getMultipartType(type));
  67         builder.setFlags(getMultipartRequestFlags(rawMessage.readUnsignedShort()));
  68         switch (getMultipartType(type)) {
  69             case OFPMPDESC:
  70                 builder.setMultipartRequestBody(setDesc(rawMessage));
  71                 break;
  72             case OFPMPFLOW:
  73                 builder.setMultipartRequestBody(setFlow(rawMessage));
  74                 break;
  75             case OFPMPAGGREGATE:
  76                 builder.setMultipartRequestBody(setAggregate(rawMessage));
  77                 break;
  78             case OFPMPTABLE:
  79                 builder.setMultipartRequestBody(setTable(rawMessage));
  80                 break;
  81             case OFPMPPORTSTATS:
  82                 builder.setMultipartRequestBody(setPortStats(rawMessage));
  83                 break;
  84             case OFPMPQUEUE:
  85                 builder.setMultipartRequestBody(setQueue(rawMessage));
  86                 break;
  87             case OFPMPEXPERIMENTER:
  88                 builder.setMultipartRequestBody(setExperimenter(rawMessage));
  89                 break;
  90             default:
  91                 break;
  92         }
  93         return builder.build();
  94     }
  95
  96     private MultipartRequestExperimenterCase setExperimenter(ByteBuf input) {
  97         MultipartRequestExperimenterCaseBuilder caseBuilder = new MultipartRequestExperimenterCaseBuilder();
  98         MultipartRequestExperimenterBuilder experimenterBuilder = new MultipartRequestExperimenterBuilder();
  99         caseBuilder.setMultipartRequestExperimenter(experimenterBuilder.build());
 100         return caseBuilder.build();
 101     }
 102
 103     private MultipartRequestQueueCase setQueue(ByteBuf input) {
 104         final MultipartRequestQueueCaseBuilder caseBuilder = new MultipartRequestQueueCaseBuilder();
 105         MultipartRequestQueueBuilder queueBuilder = new MultipartRequestQueueBuilder();
 106         queueBuilder.setPortNo((long) input.readUnsignedShort());
 107         input.skipBytes(2);
 108         queueBuilder.setQueueId(input.readUnsignedInt());
 109         caseBuilder.setMultipartRequestQueue(queueBuilder.build());
 110         return caseBuilder.build();
 111     }
 112
 113     private MultipartRequestPortStatsCase setPortStats(ByteBuf input) {
 114         MultipartRequestPortStatsCaseBuilder caseBuilder = new MultipartRequestPortStatsCaseBuilder();
 115         MultipartRequestPortStatsBuilder portBuilder = new MultipartRequestPortStatsBuilder();
 116         portBuilder.setPortNo((long) input.readUnsignedShort());
 117         caseBuilder.setMultipartRequestPortStats(portBuilder.build());
 118         return caseBuilder.build();
 119     }
 120
 121     private MultipartRequestTableCase setTable(ByteBuf input) {
 122         MultipartRequestTableCaseBuilder caseBuilder = new MultipartRequestTableCaseBuilder();
 123         MultipartRequestTableBuilder tableBuilder = new MultipartRequestTableBuilder();
 124         tableBuilder.setEmpty(Empty.getInstance());
 125         caseBuilder.setMultipartRequestTable(tableBuilder.build());
 126         return caseBuilder.build();
 127     }
 128
 129     private MultipartRequestAggregateCase setAggregate(ByteBuf input) {
 130         final MultipartRequestAggregateCaseBuilder caseBuilder = new MultipartRequestAggregateCaseBuilder();
 131         MultipartRequestAggregateBuilder aggregateBuilder = new MultipartRequestAggregateBuilder();
 132         OFDeserializer<MatchV10> matchDeserializer = registry.getDeserializer(
 133                 new MessageCodeKey(EncodeConstants.OF10_VERSION_ID, EncodeConstants.EMPTY_VALUE, MatchV10.class));
 134         aggregateBuilder.setMatchV10(matchDeserializer.deserialize(input));
 135         aggregateBuilder.setTableId(input.readUnsignedByte());
 136         input.skipBytes(AGGREGATE_PADDING_1);
 137         aggregateBuilder.setOutPort((long) input.readUnsignedShort());
 138         caseBuilder.setMultipartRequestAggregate(aggregateBuilder.build());
 139         return caseBuilder.build();
 140     }
 141
 142     private MultipartRequestFlowCase setFlow(ByteBuf input) {
 143         final MultipartRequestFlowCaseBuilder caseBuilder = new MultipartRequestFlowCaseBuilder();
 144         MultipartRequestFlowBuilder flowBuilder = new MultipartRequestFlowBuilder();
 145         OFDeserializer<MatchV10> matchDeserializer = registry.getDeserializer(
 146                 new MessageCodeKey(EncodeConstants.OF10_VERSION_ID, EncodeConstants.EMPTY_VALUE, MatchV10.class));
 147         flowBuilder.setMatchV10(matchDeserializer.deserialize(input));
 148         flowBuilder.setTableId(input.readUnsignedByte());
 149         input.skipBytes(FLOW_PADDING_1);
 150         flowBuilder.setOutPort((long) input.readUnsignedShort());
 151         caseBuilder.setMultipartRequestFlow(flowBuilder.build());
 152         return caseBuilder.build();
 153     }
 154
 155     private MultipartRequestDescCase setDesc(ByteBuf input) {
 156         MultipartRequestDescCaseBuilder caseBuilder = new MultipartRequestDescCaseBuilder();
 157         MultipartRequestDescBuilder descBuilder = new MultipartRequestDescBuilder();
 158         descBuilder.setEmpty(Empty.getInstance());
 159         caseBuilder.setMultipartRequestDesc(descBuilder.build());
 160         return caseBuilder.build();
 161     }
 162
 163     @SuppressWarnings("checkstyle:AbbreviationAsWordInName")
 164     private static MultipartRequestFlags getMultipartRequestFlags(int input) {
 165         final Boolean _oFPMPFREQMORE = (input & 1 << 0) != 0;
 166         MultipartRequestFlags flag = new MultipartRequestFlags(_oFPMPFREQMORE);
 167         return flag;
 168     }
 169
 170     private static MultipartType getMultipartType(int input) {
 171         return MultipartType.forValue(input);
 172     }
 173
 174     @Override
 175     public void injectDeserializerRegistry(DeserializerRegistry deserializerRegistry) {
 176         registry = deserializerRegistry;
 177     }
 178 }