openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/protocol/deserialization/util/ActionUtil.java

   1 /*
   2  * Copyright (c) 2016 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.openflowplugin.impl.protocol.deserialization.util;
  10
  11 import java.util.Objects;
  12
  13 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistry;
  14 import org.opendaylight.openflowjava.protocol.api.extensibility.HeaderDeserializer;
  15 import org.opendaylight.openflowjava.protocol.api.extensibility.OFDeserializer;
  16 import org.opendaylight.openflowjava.protocol.api.keys.ActionDeserializerKey;
  17 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterActionDeserializerKey;
  18 import org.opendaylight.openflowjava.protocol.api.keys.MessageCodeKey;
  19 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
  20 import org.opendaylight.openflowplugin.api.openflow.md.util.OpenflowVersion;
  21 import org.opendaylight.openflowplugin.api.openflow.protocol.deserialization.MessageCodeExperimenterKey;
  22 import org.opendaylight.openflowplugin.extension.api.path.ActionPath;
  23 import org.opendaylight.openflowplugin.openflow.md.core.extension.ActionExtensionHelper;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action;
  25
  26 import io.netty.buffer.ByteBuf;
  27
  28 /**
  29  * Utility class for action deserialization
  30  */
  31 public class ActionUtil {
  32
  33     /**
  34      * Deserialize OpenFlow action, using extension converter if available
  35      * TODO: Remove also extension converters
  36      *
  37      * @param version OpenFlow version
  38      * @param message OpenFlow buffered message
  39      * @param registry deserializer registry
  40      * @param path Action path
  41      */
  42     public static Action readAction(short version, ByteBuf message, DeserializerRegistry registry,
  43             ActionPath path) {
  44         int type = message.getUnsignedShort(message.readerIndex());
  45         Long expId = null;
  46
  47         if (type == EncodeConstants.EXPERIMENTER_VALUE) {
  48             expId = message.getUnsignedInt(message.readerIndex()
  49                     + 2 * EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
  50         }
  51
  52         try {
  53             final MessageCodeExperimenterKey key = new MessageCodeExperimenterKey(
  54                 version, type, Action.class, expId);
  55
  56             final OFDeserializer<Action> deserializer = registry.getDeserializer(key);
  57
  58             return deserializer.deserialize(message);
  59         } catch (ClassCastException | IllegalStateException e) {
  60             final MessageCodeKey key = Objects.nonNull(expId)
  61                 ? new ExperimenterActionDeserializerKey(version, expId)
  62                 : new ActionDeserializerKey(version, type, expId);
  63
  64             final OFDeserializer<org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203
  65                 .actions.grouping.Action> deserializer = registry.getDeserializer(key);
  66
  67             return ActionExtensionHelper.processAlienAction(deserializer.deserialize(message),
  68                     OpenflowVersion.get(version), path);
  69         }
  70     }
  71
  72     /**
  73      * Deserialize OpenFlow action header, using extension converter if available
  74      * TODO: Remove also extension converters
  75      *
  76      * @param version OpenFlow version
  77      * @param message OpenFlow buffered message
  78      * @param registry deserializer registry
  79      * @param path Action path
  80      */
  81     public static Action readActionHeader(short version, ByteBuf message, DeserializerRegistry registry,
  82             ActionPath path) {
  83         int type = message.getUnsignedShort(message.readerIndex());
  84         Long expId = null;
  85
  86         if (type == EncodeConstants.EXPERIMENTER_VALUE) {
  87             expId = message.getUnsignedInt(message.readerIndex()
  88                     + 2 * EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
  89         }
  90
  91         try {
  92             final MessageCodeExperimenterKey key = new MessageCodeExperimenterKey(
  93                 version, type, Action.class, expId);
  94
  95             final HeaderDeserializer<Action> deserializer = registry.getDeserializer(key);
  96
  97             return deserializer.deserializeHeader(message);
  98         } catch (ClassCastException | IllegalStateException e) {
  99             final MessageCodeKey key = Objects.nonNull(expId)
 100                 ? new ExperimenterActionDeserializerKey(version, expId)
 101                 : new ActionDeserializerKey(version, type, expId);
 102
 103             final HeaderDeserializer<org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203
 104                 .actions.grouping.Action> deserializer = registry.getDeserializer(key);
 105
 106             return ActionExtensionHelper.processAlienAction(deserializer.deserializeHeader(message),
 107                     OpenflowVersion.get(version), path);
 108         }
 109     }
 110
 111 }