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