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.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
  28  * @author michal.polkorab
  29  * @author timotej.kubas
  30  */
  31 public class SerializerRegistryImpl implements SerializerRegistry {
  32
  33     private static final Logger LOGGER = LoggerFactory.getLogger(SerializerRegistryImpl.class);
  34     private static final short OF10 = EncodeConstants.OF10_VERSION_ID;
  35     private static final short OF13 = EncodeConstants.OF13_VERSION_ID;
  36     private Map<MessageTypeKey<?>, OFGeneralSerializer> registry;
  37
  38
  39     @Override
  40     public void init() {
  41         registry = new HashMap<>();
  42         // Openflow message type serializers
  43         MessageFactoryInitializer.registerMessageSerializers(this);
  44
  45         // match structure serializers
  46         registerSerializer(new MessageTypeKey<>(OF10, MatchV10.class), new OF10MatchSerializer());
  47         registerSerializer(new MessageTypeKey<>(OF13, Match.class), new OF13MatchSerializer());
  48
  49         // match entry serializers
  50         MatchEntriesInitializer.registerMatchEntrySerializers(this);
  51         // action serializers
  52         ActionsInitializer.registerActionSerializers(this);
  53         // instruction serializers
  54         InstructionsInitializer.registerInstructionSerializers(this);
  55     }
  56
  57     /**
  58      * @param msgTypeKey
  59      * @return encoder for current type of message (msgTypeKey)
  60      */
  61     @Override
  62     @SuppressWarnings("unchecked")
  63     public <KEY_TYPE, SERIALIZER_TYPE extends OFGeneralSerializer> SERIALIZER_TYPE getSerializer(
  64             MessageTypeKey<KEY_TYPE> msgTypeKey) {
  65         OFGeneralSerializer serializer = registry.get(msgTypeKey);
  66         if (serializer == null) {
  67             throw new IllegalStateException("Serializer for key: " + msgTypeKey
  68                     + " was not found - please verify that you are using correct message"
  69                     + " combination (e.g. OF v1.0 message to OF v1.0 device)");
  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 IllegalArgumentException("MessageTypeKey or Serializer is null");
  79         }
  80         OFGeneralSerializer serInRegistry = registry.put(msgTypeKey, serializer);
  81         if (serInRegistry != null) {
  82             LOGGER.debug("Serializer for key " + msgTypeKey + " overwritten. Old serializer: "
  83                     + serInRegistry.getClass().getName() + ", new serializer: "
  84                     + serializer.getClass().getName() );
  85         }
  86         if (serializer instanceof SerializerRegistryInjector) {
  87             ((SerializerRegistryInjector) serializer).injectSerializerRegistry(this);
  88         }
  89     }
  90
  91     @Override
  92     public <KEY_TYPE> boolean unregisterSerializer(MessageTypeKey<KEY_TYPE> msgTypeKey) {
  93         if (msgTypeKey == null) {
  94             throw new IllegalArgumentException("MessageTypeKey is null");
  95         }
  96         OFGeneralSerializer serializer = registry.remove(msgTypeKey);
  97         if (serializer == null) {
  98             return false;
  99         }
 100         return true;
 101     }
 102 }