openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/deserialization/MessageDeserializerInitializer.java

   1 /*
   2  * Copyright (c) 2013 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.openflowjava.protocol.impl.deserialization;
   9
  10 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistry;
  11 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
  12 import org.opendaylight.openflowjava.protocol.impl.deserialization.experimenter.BundleControlFactory;
  13 import org.opendaylight.openflowjava.protocol.impl.deserialization.experimenter.OnfExperimenterErrorFactory;
  14 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.BarrierReplyMessageFactory;
  15 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.EchoReplyMessageFactory;
  16 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.EchoRequestMessageFactory;
  17 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.ErrorMessageFactory;
  18 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.ExperimenterMessageFactory;
  19 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.FeaturesReplyMessageFactory;
  20 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.FlowRemovedMessageFactory;
  21 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.GetAsyncReplyMessageFactory;
  22 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.GetConfigReplyMessageFactory;
  23 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.HelloMessageFactory;
  24 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.MultipartReplyMessageFactory;
  25 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.OF10ErrorMessageFactory;
  26 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.OF10FeaturesReplyMessageFactory;
  27 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.OF10FlowRemovedMessageFactory;
  28 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.OF10HelloMessageFactory;
  29 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.OF10PacketInMessageFactory;
  30 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.OF10PortStatusMessageFactory;
  31 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.OF10QueueGetConfigReplyMessageFactory;
  32 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.OF10StatsReplyMessageFactory;
  33 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.PacketInMessageFactory;
  34 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.PortStatusMessageFactory;
  35 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.QueueGetConfigReplyMessageFactory;
  36 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.RoleReplyMessageFactory;
  37 import org.opendaylight.openflowjava.protocol.impl.deserialization.factories.VendorMessageFactory;
  38 import org.opendaylight.openflowjava.protocol.impl.util.SimpleDeserializerRegistryHelper;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BarrierOutput;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoOutput;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoRequestMessage;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessage;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemovedMessage;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetAsyncOutput;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetConfigOutput;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetQueueConfigOutput;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloMessage;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessage;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.RoleRequestOutput;
  54
  55 /**
  56  * Util class for init registration of deserializers.
  57  * @author michal.polkorab
  58  */
  59 public final class MessageDeserializerInitializer {
  60
  61     private MessageDeserializerInitializer() {
  62         throw new UnsupportedOperationException("Utility class shouldn't be instantiated");
  63     }
  64
  65     /**
  66      * Registers message deserializers.
  67      * @param registry registry to be filled with deserializers
  68      */
  69     public static void registerMessageDeserializers(final DeserializerRegistry registry) {
  70         SimpleDeserializerRegistryHelper helper;
  71
  72         // register OF v1.0 message deserializers
  73         helper = new SimpleDeserializerRegistryHelper(EncodeConstants.OF10_VERSION_ID, registry);
  74         helper.registerDeserializer(0, HelloMessage.class, new OF10HelloMessageFactory());
  75         helper.registerDeserializer(1, ErrorMessage.class, new OF10ErrorMessageFactory());
  76         helper.registerDeserializer(2, EchoRequestMessage.class, new EchoRequestMessageFactory());
  77         helper.registerDeserializer(3, EchoOutput.class, new EchoReplyMessageFactory());
  78         helper.registerDeserializer(4, ExperimenterMessage.class, new VendorMessageFactory());
  79         helper.registerDeserializer(6, GetFeaturesOutput.class, new OF10FeaturesReplyMessageFactory());
  80         helper.registerDeserializer(8, GetConfigOutput.class, new GetConfigReplyMessageFactory());
  81         helper.registerDeserializer(10, PacketInMessage.class, new OF10PacketInMessageFactory());
  82         helper.registerDeserializer(11, FlowRemovedMessage.class, new OF10FlowRemovedMessageFactory());
  83         helper.registerDeserializer(12, PortStatusMessage.class, new OF10PortStatusMessageFactory());
  84         helper.registerDeserializer(17, MultipartReplyMessage.class, new OF10StatsReplyMessageFactory());
  85         helper.registerDeserializer(19, BarrierOutput.class, new BarrierReplyMessageFactory());
  86         helper.registerDeserializer(21, GetQueueConfigOutput.class, new OF10QueueGetConfigReplyMessageFactory());
  87
  88         // register OF v1.3 message deserializers
  89         helper = new SimpleDeserializerRegistryHelper(EncodeConstants.OF13_VERSION_ID, registry);
  90         helper.registerDeserializer(0, HelloMessage.class, new HelloMessageFactory());
  91         helper.registerDeserializer(1, ErrorMessage.class, new ErrorMessageFactory());
  92         helper.registerDeserializer(2, EchoRequestMessage.class, new EchoRequestMessageFactory());
  93         helper.registerDeserializer(3, EchoOutput.class, new EchoReplyMessageFactory());
  94         helper.registerDeserializer(4, ExperimenterMessage.class, new ExperimenterMessageFactory());
  95         helper.registerDeserializer(6, GetFeaturesOutput.class, new FeaturesReplyMessageFactory());
  96         helper.registerDeserializer(8, GetConfigOutput.class, new GetConfigReplyMessageFactory());
  97         helper.registerDeserializer(10, PacketInMessage.class, new PacketInMessageFactory());
  98         helper.registerDeserializer(11, FlowRemovedMessage.class, new FlowRemovedMessageFactory());
  99         helper.registerDeserializer(12, PortStatusMessage.class, new PortStatusMessageFactory());
 100         helper.registerDeserializer(19, MultipartReplyMessage.class, new MultipartReplyMessageFactory());
 101         helper.registerDeserializer(21, BarrierOutput.class, new BarrierReplyMessageFactory());
 102         helper.registerDeserializer(23, GetQueueConfigOutput.class, new QueueGetConfigReplyMessageFactory());
 103         helper.registerDeserializer(25, RoleRequestOutput.class, new RoleReplyMessageFactory());
 104         helper.registerDeserializer(27, GetAsyncOutput.class, new GetAsyncReplyMessageFactory());
 105
 106         // register ONF approved experimenter serializers
 107         helper.registerExperimenterErrorDeserializer(EncodeConstants.ONF_EXPERIMENTER_ID,
 108                 new OnfExperimenterErrorFactory());
 109         helper.registerExperimenterDeserializer(EncodeConstants.ONF_EXPERIMENTER_ID,
 110                 EncodeConstants.ONF_ET_BUNDLE_CONTROL, new BundleControlFactory());
 111
 112         // register OF v1.4 message deserializers
 113         helper = new SimpleDeserializerRegistryHelper(EncodeConstants.OF14_VERSION_ID, registry);
 114         helper.registerDeserializer(0, HelloMessage.class, new HelloMessageFactory());
 115         helper.registerDeserializer(2, EchoRequestMessage.class, new EchoRequestMessageFactory());
 116         helper.registerDeserializer(3, EchoOutput.class, new EchoReplyMessageFactory());
 117         helper.registerDeserializer(8, GetConfigOutput.class, new GetConfigReplyMessageFactory());
 118         helper.registerDeserializer(21, BarrierOutput.class, new BarrierReplyMessageFactory());
 119
 120         // register OF v1.5 message deserializers
 121         helper = new SimpleDeserializerRegistryHelper(EncodeConstants.OF15_VERSION_ID, registry);
 122         helper.registerDeserializer(0, HelloMessage.class, new HelloMessageFactory());
 123         helper.registerDeserializer(2, EchoRequestMessage.class, new EchoRequestMessageFactory());
 124         helper.registerDeserializer(3, EchoOutput.class, new EchoReplyMessageFactory());
 125         helper.registerDeserializer(8, GetConfigOutput.class, new GetConfigReplyMessageFactory());
 126         helper.registerDeserializer(21, BarrierOutput.class, new BarrierReplyMessageFactory());
 127     }
 128 }