openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/protocol/deserialization/MessageDeserializerInjector.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;
  10
  11 import com.google.common.annotations.VisibleForTesting;
  12 import java.util.function.Consumer;
  13 import java.util.function.Function;
  14 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerExtensionProvider;
  15 import org.opendaylight.openflowjava.protocol.api.extensibility.OFDeserializer;
  16 import org.opendaylight.openflowjava.protocol.api.keys.MessageCodeKey;
  17 import org.opendaylight.openflowjava.protocol.api.keys.TypeToClassKey;
  18 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
  19 import org.opendaylight.openflowplugin.impl.protocol.deserialization.messages.FlowMessageDeserializer;
  20 import org.opendaylight.openflowplugin.impl.protocol.deserialization.messages.GroupMessageDeserializer;
  21 import org.opendaylight.openflowplugin.impl.protocol.deserialization.messages.MeterMessageDeserializer;
  22 import org.opendaylight.openflowplugin.impl.protocol.deserialization.messages.PacketInMessageDeserializer;
  23 import org.opendaylight.openflowplugin.impl.protocol.deserialization.messages.PortMessageDeserializer;
  24 import org.opendaylight.openflowplugin.impl.protocol.deserialization.multipart.MultipartReplyMessageDeserializer;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.PortMessage;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowMessage;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupMessage;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterMessage;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.multipart.types.rev170112.MultipartReply;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowModInput;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GroupModInput;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MeterModInput;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessage;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortModInput;
  37
  38 class MessageDeserializerInjector {
  39
  40     /**
  41      * Injects message deserializers into provided {@link org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerExtensionProvider}
  42      * @param provider OpenflowJava deserializer extension provider
  43      */
  44     static void injectDeserializers(final DeserializerExtensionProvider provider) {
  45         // Inject new message deserializers here using injector created by createInjector method
  46         final Function<Integer, Function<Class<? extends OfHeader>, Consumer<OFDeserializer<? extends OfHeader>>>> injector =
  47                 createInjector(provider, EncodeConstants.OF13_VERSION_ID);
  48
  49         injector.apply(10).apply(org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709
  50                 .PacketInMessage.class).accept(new PacketInMessageDeserializer());
  51         injector.apply(19).apply(MultipartReply.class).accept(new MultipartReplyMessageDeserializer());
  52     }
  53
  54     /**
  55      * Reverts original message deserializers in provided {@link org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerExtensionProvider}
  56      * @param provider OpenflowJava deserializer extension provider
  57      */
  58     static void revertDeserializers(final DeserializerExtensionProvider provider) {
  59         provider.unregisterDeserializerMapping(new TypeToClassKey(EncodeConstants.OF13_VERSION_ID, 10));
  60         provider.registerDeserializerMapping(new TypeToClassKey(EncodeConstants.OF13_VERSION_ID, 10), PacketInMessage.class);
  61         provider.unregisterDeserializerMapping(new TypeToClassKey(EncodeConstants.OF13_VERSION_ID, 19));
  62         provider.registerDeserializerMapping(new TypeToClassKey(EncodeConstants.OF13_VERSION_ID, 19), MultipartReplyMessage.class);
  63     }
  64
  65     /**
  66      * Create injector that will inject new deserializers into #{@link org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerExtensionProvider}
  67      * @param provider OpenflowJava deserializer extension provider
  68      * @param version Openflow version
  69      * @return injector
  70      */
  71     @VisibleForTesting
  72     static Function<Integer, Function<Class<? extends OfHeader>, Consumer<OFDeserializer<? extends OfHeader>>>> createInjector(
  73             final DeserializerExtensionProvider provider,
  74             final short version) {
  75         return code -> retType -> deserializer -> {
  76             provider.unregisterDeserializerMapping(new TypeToClassKey(version, code));
  77             provider.registerDeserializerMapping(new TypeToClassKey(version, code), retType);
  78             provider.registerDeserializer(
  79                     new MessageCodeKey(version, code, retType),
  80                     deserializer);
  81         };
  82     }
  83
  84     @VisibleForTesting
  85     static void injectLegacyDeserializers(final DeserializerExtensionProvider provider) {
  86         final Function<Integer, Function<Class<? extends OfHeader>, Consumer<OFDeserializer<? extends OfHeader>>>> injector =
  87             createInjector(provider, EncodeConstants.OF13_VERSION_ID);
  88
  89          injector.apply(14).apply(FlowMessage.class).accept(new FlowMessageDeserializer());
  90          injector.apply(15).apply(GroupMessage.class).accept(new GroupMessageDeserializer());
  91          injector.apply(29).apply(MeterMessage.class).accept(new MeterMessageDeserializer());
  92          injector.apply(16).apply(PortMessage.class).accept(new PortMessageDeserializer());
  93     }
  94
  95     @VisibleForTesting
  96     static void revertLegacyDeserializers(final DeserializerExtensionProvider provider) {
  97         provider.unregisterDeserializerMapping(new TypeToClassKey(EncodeConstants.OF13_VERSION_ID, 14));
  98         provider.registerDeserializerMapping(new TypeToClassKey(EncodeConstants.OF13_VERSION_ID, 14), FlowModInput.class);
  99         provider.unregisterDeserializerMapping(new TypeToClassKey(EncodeConstants.OF13_VERSION_ID, 15));
 100         provider.registerDeserializerMapping(new TypeToClassKey(EncodeConstants.OF13_VERSION_ID, 15), GroupModInput.class);
 101         provider.unregisterDeserializerMapping(new TypeToClassKey(EncodeConstants.OF13_VERSION_ID, 29));
 102         provider.registerDeserializerMapping(new TypeToClassKey(EncodeConstants.OF13_VERSION_ID, 29), MeterModInput.class);
 103         provider.unregisterDeserializerMapping(new TypeToClassKey(EncodeConstants.OF13_VERSION_ID, 16));
 104         provider.registerDeserializerMapping(new TypeToClassKey(EncodeConstants.OF13_VERSION_ID, 16), PortModInput.class);
 105         provider.unregisterDeserializerMapping(new TypeToClassKey(EncodeConstants.OF13_VERSION_ID, 19));
 106     }
 107
 108 }