openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/serialization/SerializerRegistryImpl.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
   9 package org.opendaylight.openflowjava.protocol.impl.serialization;
  10
  11 import java.util.HashMap;
  12 import java.util.Map;
  13
  14 import org.opendaylight.openflowjava.protocol.api.extensibility.MessageTypeKey;
  15 import org.opendaylight.openflowjava.protocol.api.extensibility.OFGeneralSerializer;
  16 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistry;
  17 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistryInjector;
  18 import org.opendaylight.openflowjava.protocol.impl.util.EncodeConstants;
  19 import org.opendaylight.openflowjava.protocol.impl.util.OF10MatchSerializer;
  20 import org.opendaylight.openflowjava.protocol.impl.util.OF13InstructionsSerializer;
  21 import org.opendaylight.openflowjava.protocol.impl.util.OF13MatchSerializer;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instructions.grouping.Instruction;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.match.grouping.Match;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.match.v10.grouping.MatchV10;
  25
  26 /**
  27  * Stores and handles serializers
  28  * @author michal.polkorab
  29  * @author timotej.kubas
  30  */
  31 public class SerializerRegistryImpl implements SerializerRegistry {
  32
  33     private static final short OF10 = EncodeConstants.OF10_VERSION_ID;
  34     private static final short OF13 = EncodeConstants.OF13_VERSION_ID;
  35     private Map<MessageTypeKey<?>, OFGeneralSerializer> registry;
  36
  37
  38     @Override
  39     public void init() {
  40         registry = new HashMap<>();
  41         // Openflow message type serializers
  42         MessageFactoryInitializer.registerMessageSerializers(this);
  43
  44         // common structure serializers
  45         registerSerializer(new MessageTypeKey<>(OF10, MatchV10.class), new OF10MatchSerializer());
  46         registerSerializer(new MessageTypeKey<>(OF13, Match.class), new OF13MatchSerializer());
  47         registerSerializer(new MessageTypeKey<>(OF13, Instruction.class), new OF13InstructionsSerializer());
  48
  49         // match entry serializers
  50         MatchEntriesInitializer.registerMatchEntrySerializers(this);
  51         // action serializers
  52         ActionsInitializer.registerActionSerializers(this);
  53
  54         // default vendor / experimenter serializers
  55         DefaultExperimenterInitializer.registerDefaultExperimenterSerializers(this);
  56     }
  57
  58     /**
  59      * @param msgTypeKey
  60      * @return encoder for current type of message (msgTypeKey)
  61      */
  62     @Override
  63     @SuppressWarnings("unchecked")
  64     public <KEY_TYPE, SERIALIZER_TYPE extends OFGeneralSerializer> SERIALIZER_TYPE getSerializer(
  65             MessageTypeKey<KEY_TYPE> msgTypeKey) {
  66         OFGeneralSerializer serializer = registry.get(msgTypeKey);
  67         if (serializer == null) {
  68             throw new NullPointerException("Serializer for key: " + msgTypeKey.toString()
  69                     + " was not found");
  70         }
  71         return (SERIALIZER_TYPE) serializer;
  72     }
  73
  74     @Override
  75     public <KEY_TYPE> void registerSerializer(
  76             MessageTypeKey<KEY_TYPE> msgTypeKey, OFGeneralSerializer serializer) {
  77         if ((msgTypeKey == null) || (serializer == null)) {
  78             throw new NullPointerException("MessageTypeKey or Serializer is null");
  79         }
  80         if (serializer instanceof SerializerRegistryInjector) {
  81             ((SerializerRegistryInjector) serializer).injectSerializerRegistry(this);
  82         }
  83         registry.put(msgTypeKey, serializer);
  84     }
  85 }