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