2 * Copyright (c) 2016 Pantheon Technologies s.r.o. and others. All rights reserved.
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
9 package org.opendaylight.openflowplugin.impl.protocol.serialization;
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.SerializerExtensionProvider;
15 import org.opendaylight.openflowjava.protocol.api.keys.MessageTypeKey;
16 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
17 import org.opendaylight.openflowjava.protocol.api.util.OxmMatchConstants;
18 import org.opendaylight.openflowplugin.api.openflow.protocol.serialization.MatchEntrySerializer;
19 import org.opendaylight.openflowplugin.api.openflow.protocol.serialization.MatchEntrySerializerRegistry;
20 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.ArpOpEntrySerializer;
21 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.ArpSourceHardwareAddressEntrySerializer;
22 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.ArpSourceTransportAddressEntrySerializer;
23 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.ArpTargetHardwareAddressEntrySerializer;
24 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.ArpTargetTransportAddressEntrySerializer;
25 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.EthernetDestinationEntrySerializer;
26 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.EthernetSourceEntrySerializer;
27 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.EthernetTypeEntrySerializer;
28 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.Icmpv4CodeEntrySerializer;
29 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.Icmpv4TypeEntrySerializer;
30 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.Icmpv6CodeEntrySerializer;
31 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.Icmpv6TypeEntrySerializer;
32 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.InPhyPortEntrySerializer;
33 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.InPortEntrySerializer;
34 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.IpDscpEntrySerializer;
35 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.IpEcnEntrySerializer;
36 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.IpProtoEntrySerializer;
37 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.Ipv4DestinationEntrySerializer;
38 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.Ipv4SourceEntrySerializer;
39 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.Ipv6DestinationEntrySerializer;
40 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.Ipv6ExtHeaderEntrySerializer;
41 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.Ipv6LabelEntrySerializer;
42 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.Ipv6NdSllEntrySerializer;
43 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.Ipv6NdTargetEntrySerializer;
44 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.Ipv6NdTllEntrySerializer;
45 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.Ipv6SourceEntrySerializer;
46 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.MatchEntrySerializerKeyImpl;
47 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.MatchSerializer;
48 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.MetadataEntrySerializer;
49 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.MplsBosEntrySerializer;
50 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.MplsLabelEntrySerializer;
51 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.MplsTcEntrySerializer;
52 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.PbbEntrySerializer;
53 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.SctpDestinationPortEntrySerializer;
54 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.SctpSourcePortEntrySerializer;
55 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.TcpDestinationPortEntrySerializer;
56 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.TcpFlagsEntrySerializer;
57 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.TcpSourcePortEntrySerializer;
58 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.TunnelIdEntrySerializer;
59 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.TunnelIpv4DestinationEntrySerializer;
60 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.TunnelIpv4SourceEntrySerializer;
61 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.UdpDestinationPortEntrySerializer;
62 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.UdpSourcePortEntrySerializer;
63 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.VlanPcpEntrySerializer;
64 import org.opendaylight.openflowplugin.impl.protocol.serialization.match.VlanVidEntrySerializer;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.Match;
68 * Util class for injecting new match serializers into OpenflowJava
70 class MatchSerializerInjector {
73 * Injects match serializers into provided {@link org.opendaylight.openflowjava.protocol.api.extensibility.SerializerExtensionProvider}
74 * @param provider OpenflowJava serializer extension provider
76 static void injectSerializers(final SerializerExtensionProvider provider) {
77 final MatchSerializer serializer = new MatchSerializer();
78 provider.registerSerializer(
79 new MessageTypeKey<>(EncodeConstants.OF13_VERSION_ID, Match.class),
82 // Inject all match entry serializers to match serializers using injector created by createInjector method
83 final Function<Integer, Function<Integer, Consumer<MatchEntrySerializer>>> injector =
84 createInjector(serializer, EncodeConstants.OF13_VERSION_ID);
86 final Function<Integer, Consumer<MatchEntrySerializer>> basicInjector =
87 injector.apply(OxmMatchConstants.OPENFLOW_BASIC_CLASS);
89 final Function<Integer, Consumer<MatchEntrySerializer>> experInjector =
90 injector.apply(OxmMatchConstants.EXPERIMENTER_CLASS);
92 basicInjector.apply(OxmMatchConstants.IN_PORT).accept(new InPortEntrySerializer());
93 basicInjector.apply(OxmMatchConstants.IN_PHY_PORT).accept(new InPhyPortEntrySerializer());
94 basicInjector.apply(OxmMatchConstants.METADATA).accept(new MetadataEntrySerializer());
95 basicInjector.apply(OxmMatchConstants.ETH_DST).accept(new EthernetDestinationEntrySerializer());
96 basicInjector.apply(OxmMatchConstants.ETH_SRC).accept(new EthernetSourceEntrySerializer());
97 basicInjector.apply(OxmMatchConstants.ETH_TYPE).accept(new EthernetTypeEntrySerializer());
98 basicInjector.apply(OxmMatchConstants.VLAN_VID).accept(new VlanVidEntrySerializer());
99 basicInjector.apply(OxmMatchConstants.VLAN_PCP).accept(new VlanPcpEntrySerializer());
100 basicInjector.apply(OxmMatchConstants.IP_DSCP).accept(new IpDscpEntrySerializer());
101 basicInjector.apply(OxmMatchConstants.IP_ECN).accept(new IpEcnEntrySerializer());
102 basicInjector.apply(OxmMatchConstants.IP_PROTO).accept(new IpProtoEntrySerializer());
103 basicInjector.apply(OxmMatchConstants.TCP_SRC).accept(new TcpSourcePortEntrySerializer());
104 basicInjector.apply(OxmMatchConstants.TCP_DST).accept(new TcpDestinationPortEntrySerializer());
105 basicInjector.apply(OxmMatchConstants.UDP_SRC).accept(new UdpSourcePortEntrySerializer());
106 basicInjector.apply(OxmMatchConstants.UDP_DST).accept(new UdpDestinationPortEntrySerializer());
107 basicInjector.apply(OxmMatchConstants.SCTP_SRC).accept(new SctpSourcePortEntrySerializer());
108 basicInjector.apply(OxmMatchConstants.SCTP_DST).accept(new SctpDestinationPortEntrySerializer());
109 basicInjector.apply(OxmMatchConstants.ICMPV4_TYPE).accept(new Icmpv4TypeEntrySerializer());
110 basicInjector.apply(OxmMatchConstants.ICMPV4_CODE).accept(new Icmpv4CodeEntrySerializer());
111 basicInjector.apply(OxmMatchConstants.ICMPV6_TYPE).accept(new Icmpv6TypeEntrySerializer());
112 basicInjector.apply(OxmMatchConstants.ICMPV6_CODE).accept(new Icmpv6CodeEntrySerializer());
113 basicInjector.apply(OxmMatchConstants.IPV4_SRC).accept(new Ipv4SourceEntrySerializer());
114 basicInjector.apply(OxmMatchConstants.IPV4_DST).accept(new Ipv4DestinationEntrySerializer());
115 experInjector.apply(OxmMatchConstants.NXM_NX_TUN_IPV4_SRC).accept(new TunnelIpv4SourceEntrySerializer());
116 experInjector.apply(OxmMatchConstants.NXM_NX_TUN_IPV4_DST).accept(new TunnelIpv4DestinationEntrySerializer());
117 basicInjector.apply(OxmMatchConstants.ARP_OP).accept(new ArpOpEntrySerializer());
118 basicInjector.apply(OxmMatchConstants.ARP_SPA).accept(new ArpSourceTransportAddressEntrySerializer());
119 basicInjector.apply(OxmMatchConstants.ARP_TPA).accept(new ArpTargetTransportAddressEntrySerializer());
120 basicInjector.apply(OxmMatchConstants.ARP_SHA).accept(new ArpSourceHardwareAddressEntrySerializer());
121 basicInjector.apply(OxmMatchConstants.ARP_THA).accept(new ArpTargetHardwareAddressEntrySerializer());
122 basicInjector.apply(OxmMatchConstants.IPV6_SRC).accept(new Ipv6SourceEntrySerializer());
123 basicInjector.apply(OxmMatchConstants.IPV6_DST).accept(new Ipv6DestinationEntrySerializer());
124 basicInjector.apply(OxmMatchConstants.IPV6_FLABEL).accept(new Ipv6LabelEntrySerializer());
125 basicInjector.apply(OxmMatchConstants.IPV6_ND_TARGET).accept(new Ipv6NdTargetEntrySerializer());
126 basicInjector.apply(OxmMatchConstants.IPV6_ND_SLL).accept(new Ipv6NdSllEntrySerializer());
127 basicInjector.apply(OxmMatchConstants.IPV6_ND_TLL).accept(new Ipv6NdTllEntrySerializer());
128 basicInjector.apply(OxmMatchConstants.IPV6_EXTHDR).accept(new Ipv6ExtHeaderEntrySerializer());
129 basicInjector.apply(OxmMatchConstants.MPLS_LABEL).accept(new MplsLabelEntrySerializer());
130 basicInjector.apply(OxmMatchConstants.MPLS_BOS).accept(new MplsBosEntrySerializer());
131 basicInjector.apply(OxmMatchConstants.MPLS_TC).accept(new MplsTcEntrySerializer());
132 basicInjector.apply(OxmMatchConstants.PBB_ISID).accept(new PbbEntrySerializer());
133 basicInjector.apply(OxmMatchConstants.TUNNEL_ID).accept(new TunnelIdEntrySerializer());
134 experInjector.apply(EncodeConstants.ONFOXM_ET_TCP_FLAGS).accept(new TcpFlagsEntrySerializer());
138 * Create injector that will inject new match entry serializers into #{@link org.opendaylight.openflowplugin.api.openflow.protocol.serialization.MatchEntrySerializerRegistry}
139 * @param registry Match entry serializer registry
140 * @param version Openflow version
144 static Function<Integer, Function<Integer, Consumer<MatchEntrySerializer>>> createInjector(
145 final MatchEntrySerializerRegistry registry,
146 final byte version) {
147 return oxmClass -> oxmField -> serializer ->
148 registry.registerEntrySerializer(
149 new MatchEntrySerializerKeyImpl(version, oxmClass, oxmField),