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.OFGeneralSerializer;
  15 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistry;
  16 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistryInjector;
  17 import org.opendaylight.openflowjava.protocol.api.keys.MessageTypeKey;
  18 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
  19 import org.opendaylight.openflowjava.protocol.impl.util.OF10MatchSerializer;
  20 import org.opendaylight.openflowjava.protocol.impl.util.OF13MatchSerializer;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.match.grouping.Match;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.match.v10.grouping.MatchV10;
  23 import org.slf4j.Logger;
  24 import org.slf4j.LoggerFactory;
  25
  26 /**
  27  * Stores and handles serializers <br/>
  28  * K - {@link MessageTypeKey} type <br/>
  29  * S - returned serializer type
  30  * @author michal.polkorab
  31  * @author timotej.kubas
  32  */
  33 public class SerializerRegistryImpl implements SerializerRegistry {
  34
  35     private static final Logger LOGGER = LoggerFactory.getLogger(SerializerRegistryImpl.class);
  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         // match structure serializers
  48         registerSerializer(new MessageTypeKey<>(OF10, MatchV10.class), new OF10MatchSerializer());
  49         registerSerializer(new MessageTypeKey<>(OF13, Match.class), new OF13MatchSerializer());
  50
  51         // match entry serializers
  52         MatchEntriesInitializer.registerMatchEntrySerializers(this);
  53         // action serializers
  54         ActionsInitializer.registerActionSerializers(this);
  55         // instruction serializers
  56         InstructionsInitializer.registerInstructionSerializers(this);
  57     }
  58
  59     /**
  60      * @param msgTypeKey
  61      * @return encoder for current type of message (msgTypeKey)
  62      */
  63     @Override
  64     @SuppressWarnings("unchecked")
  65     public <K, S extends OFGeneralSerializer> S getSerializer(
  66             MessageTypeKey<K> msgTypeKey) {
  67         OFGeneralSerializer serializer = registry.get(msgTypeKey);
  68         if (serializer == null) {
  69             throw new IllegalStateException("Serializer for key: " + msgTypeKey
  70                     + " was not found - please verify that you are using correct message"
  71                     + " combination (e.g. OF v1.0 message to OF v1.0 device)");
  72         }
  73         return (S) serializer;
  74     }
  75
  76     @Override
  77     public <K> void registerSerializer(
  78             MessageTypeKey<K> msgTypeKey, OFGeneralSerializer serializer) {
  79         if ((msgTypeKey == null) || (serializer == null)) {
  80             throw new IllegalArgumentException("MessageTypeKey or Serializer is null");
  81         }
  82         OFGeneralSerializer serInRegistry = registry.put(msgTypeKey, serializer);
  83         if (serInRegistry != null) {
  84             LOGGER.debug("Serializer for key " + msgTypeKey + " overwritten. Old serializer: "
  85                     + serInRegistry.getClass().getName() + ", new serializer: "
  86                     + serializer.getClass().getName() );
  87         }
  88         if (serializer instanceof SerializerRegistryInjector) {
  89             ((SerializerRegistryInjector) serializer).injectSerializerRegistry(this);
  90         }
  91     }
  92
  93     @Override
  94     public <K> boolean unregisterSerializer(MessageTypeKey<K> msgTypeKey) {
  95         if (msgTypeKey == null) {
  96             throw new IllegalArgumentException("MessageTypeKey is null");
  97         }
  98         OFGeneralSerializer serializer = registry.remove(msgTypeKey);
  99         if (serializer == null) {
 100             return false;
 101         }
 102         return true;
 103     }
 104 }