openflowjava/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/deserialization/factories/PacketInMessageFactory.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 edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  12 import io.netty.buffer.ByteBuf;
  13 import java.math.BigInteger;
  14 import java.util.Objects;
  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.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PacketInReason;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.TableId;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.grouping.Match;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessageBuilder;
  25
  26 /**
  27  * Translates PacketIn messages.
  28  *
  29  * @author michal.polkorab
  30  * @author timotej.kubas
  31  */
  32 public class PacketInMessageFactory implements OFDeserializer<PacketInMessage>,
  33         DeserializerRegistryInjector {
  34
  35     private static final byte PADDING_IN_PACKET_IN_HEADER = 2;
  36     private static final MessageCodeKey MATCH_KEY = new MessageCodeKey(
  37             EncodeConstants.OF13_VERSION_ID, EncodeConstants.EMPTY_VALUE, Match.class);
  38     private DeserializerRegistry registry;
  39
  40     @Override
  41     @SuppressFBWarnings("UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR") // FB doesn't recognize Objects.requireNonNull
  42     public PacketInMessage deserialize(final ByteBuf rawMessage) {
  43         Objects.requireNonNull(registry);
  44
  45         PacketInMessageBuilder builder = new PacketInMessageBuilder();
  46         builder.setVersion((short) EncodeConstants.OF13_VERSION_ID);
  47         builder.setXid(rawMessage.readUnsignedInt());
  48         builder.setBufferId(rawMessage.readUnsignedInt());
  49         builder.setTotalLen(rawMessage.readUnsignedShort());
  50         builder.setReason(PacketInReason.forValue(rawMessage.readUnsignedByte()));
  51         builder.setTableId(new TableId((long)rawMessage.readUnsignedByte()));
  52         byte[] cookie = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
  53         rawMessage.readBytes(cookie);
  54         builder.setCookie(new BigInteger(1, cookie));
  55         OFDeserializer<Match> matchDeserializer = registry.getDeserializer(MATCH_KEY);
  56         builder.setMatch(matchDeserializer.deserialize(rawMessage));
  57         rawMessage.skipBytes(PADDING_IN_PACKET_IN_HEADER);
  58         byte[] data = new byte[rawMessage.readableBytes()];
  59         rawMessage.readBytes(data);
  60         builder.setData(data);
  61         return builder.build();
  62     }
  63
  64     @Override
  65     public void injectDeserializerRegistry(final DeserializerRegistry deserializerRegistry) {
  66         registry = deserializerRegistry;
  67     }
  68 }