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