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