openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/protocol/serialization/MultipartTableFeaturesSerializerInjector.java

   1 /*
   2  * Copyright (c) 2017 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.serialization;
  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.OFSerializer;
  15 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerExtensionProvider;
  16 import org.opendaylight.openflowjava.protocol.api.keys.MessageTypeKey;
  17 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
  18 import org.opendaylight.openflowplugin.impl.protocol.serialization.multipart.tablefeatures.ApplyActionsMissTablePropertySerializer;
  19 import org.opendaylight.openflowplugin.impl.protocol.serialization.multipart.tablefeatures.ApplyActionsTablePropertySerializer;
  20 import org.opendaylight.openflowplugin.impl.protocol.serialization.multipart.tablefeatures.ApplySetfieldMissTablePropertySerializer;
  21 import org.opendaylight.openflowplugin.impl.protocol.serialization.multipart.tablefeatures.ApplySetfieldTablePropertySerializer;
  22 import org.opendaylight.openflowplugin.impl.protocol.serialization.multipart.tablefeatures.InstructionsMissTablePropertySerializer;
  23 import org.opendaylight.openflowplugin.impl.protocol.serialization.multipart.tablefeatures.InstructionsTablePropertySerializer;
  24 import org.opendaylight.openflowplugin.impl.protocol.serialization.multipart.tablefeatures.MatchTablePropertySerializer;
  25 import org.opendaylight.openflowplugin.impl.protocol.serialization.multipart.tablefeatures.NextTableMissTablePropertySerializer;
  26 import org.opendaylight.openflowplugin.impl.protocol.serialization.multipart.tablefeatures.NextTableTablePropertySerializer;
  27 import org.opendaylight.openflowplugin.impl.protocol.serialization.multipart.tablefeatures.WildcardsTablePropertySerializer;
  28 import org.opendaylight.openflowplugin.impl.protocol.serialization.multipart.tablefeatures.WriteActionsMissTablePropertySerializer;
  29 import org.opendaylight.openflowplugin.impl.protocol.serialization.multipart.tablefeatures.WriteActionsTablePropertySerializer;
  30 import org.opendaylight.openflowplugin.impl.protocol.serialization.multipart.tablefeatures.WriteSetfieldMissTablePropertySerializer;
  31 import org.opendaylight.openflowplugin.impl.protocol.serialization.multipart.tablefeatures.WriteSetfieldTablePropertySerializer;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.feature.prop.type.TableFeaturePropType;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.feature.prop.type.table.feature.prop.type.ApplyActions;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.feature.prop.type.table.feature.prop.type.ApplyActionsMiss;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.feature.prop.type.table.feature.prop.type.ApplySetfield;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.feature.prop.type.table.feature.prop.type.ApplySetfieldMiss;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.feature.prop.type.table.feature.prop.type.Instructions;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.feature.prop.type.table.feature.prop.type.InstructionsMiss;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.feature.prop.type.table.feature.prop.type.Match;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.feature.prop.type.table.feature.prop.type.NextTable;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.feature.prop.type.table.feature.prop.type.NextTableMiss;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.feature.prop.type.table.feature.prop.type.Wildcards;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.feature.prop.type.table.feature.prop.type.WriteActions;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.feature.prop.type.table.feature.prop.type.WriteActionsMiss;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.feature.prop.type.table.feature.prop.type.WriteSetfield;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.feature.prop.type.table.feature.prop.type.WriteSetfieldMiss;
  47
  48 /**
  49  * Util class for injecting new multipart table features serializers into OpenflowJava.
  50  */
  51 class MultipartTableFeaturesSerializerInjector {
  52
  53     /**
  54      * Injects multipart table features serializers into provided
  55      * {@link org.opendaylight.openflowjava.protocol.api.extensibility.SerializerExtensionProvider}.
  56      *
  57      * @param provider OpenflowJava serializer extension provider
  58      */
  59     static void injectSerializers(final SerializerExtensionProvider provider) {
  60         // Inject new message serializers here using injector created by createInjector method
  61         final Function<Class<? extends TableFeaturePropType>, Consumer<OFSerializer<TableFeaturePropType>>> injector =
  62                 createInjector(provider, EncodeConstants.OF13_VERSION_ID);
  63
  64         injector.apply(Instructions.class).accept(new InstructionsTablePropertySerializer());
  65         injector.apply(InstructionsMiss.class).accept(new InstructionsMissTablePropertySerializer());
  66         injector.apply(NextTable.class).accept(new NextTableTablePropertySerializer());
  67         injector.apply(NextTableMiss.class).accept(new NextTableMissTablePropertySerializer());
  68         injector.apply(ApplyActions.class).accept(new ApplyActionsTablePropertySerializer());
  69         injector.apply(ApplyActionsMiss.class).accept(new ApplyActionsMissTablePropertySerializer());
  70         injector.apply(WriteActions.class).accept(new WriteActionsTablePropertySerializer());
  71         injector.apply(WriteActionsMiss.class).accept(new WriteActionsMissTablePropertySerializer());
  72         injector.apply(Match.class).accept(new MatchTablePropertySerializer());
  73         injector.apply(Wildcards.class).accept(new WildcardsTablePropertySerializer());
  74         injector.apply(WriteSetfield.class).accept(new WriteSetfieldTablePropertySerializer());
  75         injector.apply(WriteSetfieldMiss.class).accept(new WriteSetfieldMissTablePropertySerializer());
  76         injector.apply(ApplySetfield.class).accept(new ApplySetfieldTablePropertySerializer());
  77         injector.apply(ApplySetfieldMiss.class).accept(new ApplySetfieldMissTablePropertySerializer());
  78         // TODO: Add support for experimenters
  79     }
  80
  81     /**
  82      * Create injector that will inject new multipart table features serializers into
  83      * #{@link org.opendaylight.openflowjava.protocol.api.extensibility.SerializerExtensionProvider}.
  84      *
  85      * @param provider OpenflowJava serializer extension provider
  86      * @param version  Openflow version
  87      * @return injector
  88      */
  89     @VisibleForTesting
  90     static Function<Class<? extends TableFeaturePropType>, Consumer<OFSerializer<TableFeaturePropType>>> createInjector(
  91             final SerializerExtensionProvider provider,
  92             final byte version) {
  93         return type -> serializer ->
  94                 provider.registerSerializer(
  95                         new MessageTypeKey<>(version, type),
  96                         serializer);
  97     }
  98
  99 }