openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/protocol/deserialization/InstructionDeserializerInjector.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 java.util.Objects;
  12 import java.util.function.Consumer;
  13 import java.util.function.Function;
  14
  15 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerExtensionProvider;
  16 import org.opendaylight.openflowjava.protocol.api.extensibility.OFDeserializer;
  17 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
  18 import org.opendaylight.openflowjava.protocol.impl.util.InstructionConstants;
  19 import org.opendaylight.openflowplugin.api.openflow.protocol.deserialization.MessageCodeExperimenterKey;
  20 import org.opendaylight.openflowplugin.extension.api.path.ActionPath;
  21 import org.opendaylight.openflowplugin.impl.protocol.deserialization.key.MessageCodeActionExperimenterKey;
  22 import org.opendaylight.openflowplugin.impl.protocol.deserialization.instruction.ApplyActionsInstructionDeserializer;
  23 import org.opendaylight.openflowplugin.impl.protocol.deserialization.instruction.ClearActionsInstructionDeserializer;
  24 import org.opendaylight.openflowplugin.impl.protocol.deserialization.instruction.GoToTableInstructionDeserializer;
  25 import org.opendaylight.openflowplugin.impl.protocol.deserialization.instruction.MeterInstructionDeserializer;
  26 import org.opendaylight.openflowplugin.impl.protocol.deserialization.instruction.WriteActionsInstructionDeserializer;
  27 import org.opendaylight.openflowplugin.impl.protocol.deserialization.instruction.WriteMetadataInstructionDeserializer;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.Instruction;
  29
  30 import com.google.common.annotations.VisibleForTesting;
  31
  32 public class InstructionDeserializerInjector {
  33
  34     /**
  35      * Injects instruction deserializers into provided {@link org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerExtensionProvider}
  36      * @param provider OpenflowJava deserializer extension provider
  37      */
  38     static void injectDeserializers(final DeserializerExtensionProvider provider) {
  39         // Inject new instruction deserializers here using injector created by createInjector method
  40         final Function<Byte, Function<ActionPath, Consumer<OFDeserializer<Instruction>>>> injector =
  41                 createInjector(provider, EncodeConstants.OF13_VERSION_ID);
  42
  43         injector.apply(InstructionConstants.GOTO_TABLE_TYPE).apply(null).accept(new GoToTableInstructionDeserializer());
  44         injector.apply(InstructionConstants.WRITE_METADATA_TYPE).apply(null).accept(new WriteMetadataInstructionDeserializer());
  45         injector.apply(InstructionConstants.CLEAR_ACTIONS_TYPE).apply(null).accept(new ClearActionsInstructionDeserializer());
  46         injector.apply(InstructionConstants.METER_TYPE).apply(null).accept(new MeterInstructionDeserializer());
  47
  48         for (ActionPath path : ActionPath.values()) {
  49             injector.apply(InstructionConstants.WRITE_ACTIONS_TYPE).apply(path).accept(new WriteActionsInstructionDeserializer(path));
  50             injector.apply(InstructionConstants.APPLY_ACTIONS_TYPE).apply(path).accept(new ApplyActionsInstructionDeserializer(path));
  51         }
  52     }
  53
  54     /**
  55      * Create injector that will inject new deserializers into #{@link org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerExtensionProvider}
  56      * @param provider OpenflowJava deserializer extension provider
  57      * @param version Openflow version
  58      * @return injector
  59      */
  60     @VisibleForTesting
  61     static Function<Byte, Function<ActionPath, Consumer<OFDeserializer<Instruction>>>> createInjector(
  62             final DeserializerExtensionProvider provider,
  63             final short version) {
  64         return code -> actionPath -> deserializer -> {
  65             provider.registerDeserializer((Objects.nonNull(actionPath)
  66                     ? new MessageCodeActionExperimenterKey(version, code, Instruction.class, actionPath, null)
  67                     : new MessageCodeExperimenterKey(version, code, Instruction.class, null)),
  68                     deserializer);
  69         };
  70     }
  71
  72 }