openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/deserialization/TypeToClassMapInitializer.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 java.util.Map;
  11 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
  12 import org.opendaylight.openflowjava.protocol.impl.util.TypeToClassInitHelper;
  13 import org.opendaylight.openflowjava.protocol.api.keys.TypeToClassKey;
  14 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BarrierInput;
  15 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BarrierOutput;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoOutput;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoRequestMessage;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessage;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowModInput;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemovedMessage;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetAsyncInput;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetAsyncOutput;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetConfigInput;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetConfigOutput;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesInput;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetQueueConfigInput;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetQueueConfigOutput;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GroupModInput;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloMessage;
  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.MultipartRequestInput;
  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.PacketOutInput;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortModInput;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.RoleRequestInput;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.RoleRequestOutput;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.SetAsyncInput;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.SetConfigInput;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.TableModInput;
  44
  45 /**
  46  * Util class for init OF message type to class mapping.
  47  * @author michal.polkorab
  48  * @author giuseppex.petralia@intel.com
  49  */
  50 public final class TypeToClassMapInitializer {
  51
  52     private TypeToClassMapInitializer() {
  53         throw new UnsupportedOperationException("Utility class shouldn't be instantiated");
  54     }
  55
  56     /**
  57      * Initializes standard types mapping.
  58      * @param messageClassMap type to class map
  59      */
  60     public static void initializeTypeToClassMap(final Map<TypeToClassKey, Class<?>> messageClassMap) {
  61         TypeToClassInitHelper helper;
  62
  63         // init OF v1.0 mapping
  64         helper = new TypeToClassInitHelper(EncodeConstants.OF10_VERSION_ID, messageClassMap);
  65         helper.registerTypeToClass((short) 0, HelloMessage.class);
  66         helper.registerTypeToClass((short) 1, ErrorMessage.class);
  67         helper.registerTypeToClass((short) 2, EchoRequestMessage.class);
  68         helper.registerTypeToClass((short) 3, EchoOutput.class);
  69         helper.registerTypeToClass((short) 4, ExperimenterMessage.class);
  70         helper.registerTypeToClass((short) 6, GetFeaturesOutput.class);
  71         helper.registerTypeToClass((short) 8, GetConfigOutput.class);
  72         helper.registerTypeToClass((short) 10, PacketInMessage.class);
  73         helper.registerTypeToClass((short) 11, FlowRemovedMessage.class);
  74         helper.registerTypeToClass((short) 12, PortStatusMessage.class);
  75         helper.registerTypeToClass((short) 17, MultipartReplyMessage.class);
  76         helper.registerTypeToClass((short) 19, BarrierOutput.class);
  77         helper.registerTypeToClass((short) 21, GetQueueConfigOutput.class);
  78
  79         // init OF v1.3 mapping
  80         helper = new TypeToClassInitHelper(EncodeConstants.OF13_VERSION_ID, messageClassMap);
  81         helper.registerTypeToClass((short) 0, HelloMessage.class);
  82         helper.registerTypeToClass((short) 1, ErrorMessage.class);
  83         helper.registerTypeToClass((short) 2, EchoRequestMessage.class);
  84         helper.registerTypeToClass((short) 3, EchoOutput.class);
  85         helper.registerTypeToClass((short) 4, ExperimenterMessage.class);
  86         helper.registerTypeToClass((short) 6, GetFeaturesOutput.class);
  87         helper.registerTypeToClass((short) 8, GetConfigOutput.class);
  88         helper.registerTypeToClass((short) 10, PacketInMessage.class);
  89         helper.registerTypeToClass((short) 11, FlowRemovedMessage.class);
  90         helper.registerTypeToClass((short) 12, PortStatusMessage.class);
  91         helper.registerTypeToClass((short) 19, MultipartReplyMessage.class);
  92         helper.registerTypeToClass((short) 21, BarrierOutput.class);
  93         helper.registerTypeToClass((short) 23, GetQueueConfigOutput.class);
  94         helper.registerTypeToClass((short) 25, RoleRequestOutput.class);
  95         helper.registerTypeToClass((short) 27, GetAsyncOutput.class);
  96
  97         // init OF v1.4 mapping
  98         helper = new TypeToClassInitHelper(EncodeConstants.OF14_VERSION_ID, messageClassMap);
  99         helper.registerTypeToClass((short) 0, HelloMessage.class);
 100         helper.registerTypeToClass((short) 2, EchoRequestMessage.class);
 101         helper.registerTypeToClass((short) 3, EchoOutput.class);
 102         helper.registerTypeToClass((short) 8, GetConfigOutput.class);
 103         helper.registerTypeToClass((short) 21, BarrierOutput.class);
 104
 105         // init OF v1.5 mapping
 106         helper = new TypeToClassInitHelper(EncodeConstants.OF15_VERSION_ID, messageClassMap);
 107         helper.registerTypeToClass((short) 0, HelloMessage.class);
 108         helper.registerTypeToClass((short) 2, EchoRequestMessage.class);
 109         helper.registerTypeToClass((short) 3, EchoOutput.class);
 110         helper.registerTypeToClass((short) 8, GetConfigOutput.class);
 111         helper.registerTypeToClass((short) 21, BarrierOutput.class);
 112     }
 113
 114     /**
 115      * Initializes additional types mapping.
 116      * @param messageClassMap type to class map
 117      */
 118     public static void initializeAdditionalTypeToClassMap(final Map<TypeToClassKey, Class<?>> messageClassMap) {
 119         TypeToClassInitHelper helper;
 120
 121         // init OF v1.0 mapping
 122         helper = new TypeToClassInitHelper(EncodeConstants.OF10_VERSION_ID, messageClassMap);
 123         helper.registerTypeToClass((short) 5, GetFeaturesInput.class);
 124         helper.registerTypeToClass((short) 7, GetConfigInput.class);
 125         helper.registerTypeToClass((short) 9, SetConfigInput.class);
 126         helper.registerTypeToClass((short) 13, PacketOutInput.class);
 127         helper.registerTypeToClass((short) 14, FlowModInput.class);
 128         helper.registerTypeToClass((short) 15, PortModInput.class);
 129         helper.registerTypeToClass((short) 16, MultipartRequestInput.class);
 130         helper.registerTypeToClass((short) 18, BarrierInput.class);
 131         helper.registerTypeToClass((short) 20, GetQueueConfigInput.class);
 132
 133         // init OF v1.3 mapping
 134         helper = new TypeToClassInitHelper(EncodeConstants.OF13_VERSION_ID, messageClassMap);
 135         helper.registerTypeToClass((short) 5, GetFeaturesInput.class);
 136         helper.registerTypeToClass((short) 7, GetConfigInput.class);
 137         helper.registerTypeToClass((short) 9, SetConfigInput.class);
 138         helper.registerTypeToClass((short) 13, PacketOutInput.class);
 139         helper.registerTypeToClass((short) 14, FlowModInput.class);
 140         helper.registerTypeToClass((short) 15, GroupModInput.class);
 141         helper.registerTypeToClass((short) 16, PortModInput.class);
 142         helper.registerTypeToClass((short) 17, TableModInput.class);
 143         helper.registerTypeToClass((short) 18, MultipartRequestInput.class);
 144         helper.registerTypeToClass((short) 20, BarrierInput.class);
 145         helper.registerTypeToClass((short) 22, GetQueueConfigInput.class);
 146         helper.registerTypeToClass((short) 24, RoleRequestInput.class);
 147         helper.registerTypeToClass((short) 26, GetAsyncInput.class);
 148         helper.registerTypeToClass((short) 28, SetAsyncInput.class);
 149         helper.registerTypeToClass((short) 29, MeterModInput.class);
 150
 151         // init OF v1.4 mapping
 152         helper = new TypeToClassInitHelper(EncodeConstants.OF14_VERSION_ID, messageClassMap);
 153         helper.registerTypeToClass((short) 7, GetConfigInput.class);
 154         helper.registerTypeToClass((short) 9, SetConfigInput.class);
 155         helper.registerTypeToClass((short) 20, BarrierInput.class);
 156
 157         // init OF v1.5 mapping
 158         helper = new TypeToClassInitHelper(EncodeConstants.OF15_VERSION_ID, messageClassMap);
 159         helper.registerTypeToClass((short) 7, GetConfigInput.class);
 160         helper.registerTypeToClass((short) 9, SetConfigInput.class);
 161         helper.registerTypeToClass((short) 20, BarrierInput.class);
 162     }
 163 }