openflowjava/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/deserialization/factories/OF10FlowModInputMessageFactory.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 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
  14 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  15 import io.netty.buffer.ByteBuf;
  16 import java.util.List;
  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.openflowjava.protocol.impl.util.CodeKeyMaker;
  24 import org.opendaylight.openflowjava.protocol.impl.util.CodeKeyMakerFactory;
  25 import org.opendaylight.openflowjava.protocol.impl.util.ListDeserializer;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.actions.grouping.Action;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.FlowModCommand;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.FlowModFlagsV10;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortNumber;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.v10.grouping.MatchV10;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowModInput;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowModInputBuilder;
  33
  34 /**
  35  * Translates FlowModInput messages.
  36  *
  37  * @author giuseppex.petralia@intel.com
  38  */
  39 public class OF10FlowModInputMessageFactory implements OFDeserializer<FlowModInput>, DeserializerRegistryInjector {
  40
  41     private DeserializerRegistry registry;
  42
  43     @Override
  44     public void injectDeserializerRegistry(DeserializerRegistry deserializerRegistry) {
  45         registry = deserializerRegistry;
  46     }
  47
  48     @Override
  49     @SuppressFBWarnings("UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR") // FB doesn't recognize Objects.requireNonNull
  50     public FlowModInput deserialize(ByteBuf rawMessage) {
  51         Objects.requireNonNull(registry);
  52
  53         FlowModInputBuilder builder = new FlowModInputBuilder()
  54                 .setVersion(EncodeConstants.OF_VERSION_1_0)
  55                 .setXid(readUint32(rawMessage));
  56         OFDeserializer<MatchV10> matchDeserializer = registry.getDeserializer(
  57                 new MessageCodeKey(EncodeConstants.OF10_VERSION_ID, EncodeConstants.EMPTY_VALUE, MatchV10.class));
  58         builder.setMatchV10(matchDeserializer.deserialize(rawMessage));
  59         builder.setCookie(readUint64(rawMessage));
  60         builder.setCommand(FlowModCommand.forValue(rawMessage.readUnsignedShort()));
  61         builder.setIdleTimeout(readUint16(rawMessage));
  62         builder.setHardTimeout(readUint16(rawMessage));
  63         builder.setPriority(readUint16(rawMessage));
  64         builder.setBufferId(readUint32(rawMessage));
  65         builder.setOutPort(new PortNumber(readUint16(rawMessage).toUint32()));
  66         builder.setFlagsV10(createFlowModFlagsFromBitmap(rawMessage.readUnsignedShort()));
  67         CodeKeyMaker keyMaker = CodeKeyMakerFactory.createActionsKeyMaker(EncodeConstants.OF10_VERSION_ID);
  68
  69         List<Action> actions = ListDeserializer.deserializeList(EncodeConstants.OF10_VERSION_ID,
  70                 rawMessage.readableBytes(), rawMessage, keyMaker, registry);
  71         builder.setAction(actions);
  72         return builder.build();
  73     }
  74
  75     @SuppressWarnings("checkstyle:AbbreviationAsWordInName")
  76     private static FlowModFlagsV10 createFlowModFlagsFromBitmap(int input) {
  77         final Boolean _oFPFFSENDFLOWREM = (input & 1 << 0) != 0;
  78         final Boolean _oFPFFCHECKOVERLAP = (input & 1 << 1) != 0;
  79         final Boolean _oFPFFEMERG = (input & 1 << 2) != 0;
  80         return new FlowModFlagsV10(_oFPFFCHECKOVERLAP, _oFPFFEMERG, _oFPFFSENDFLOWREM);
  81     }
  82 }