2 * Copyright (c) 2013 Pantheon Technologies s.r.o. and others. All rights reserved.
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
9 package org.opendaylight.openflowjava.protocol.impl.serialization;
11 import java.util.HashMap;
13 import org.opendaylight.openflowjava.protocol.api.extensibility.OFGeneralSerializer;
14 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistry;
15 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistryInjector;
16 import org.opendaylight.openflowjava.protocol.api.keys.MessageTypeKey;
17 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
18 import org.opendaylight.openflowjava.protocol.impl.util.OF10MatchSerializer;
19 import org.opendaylight.openflowjava.protocol.impl.util.OF13MatchSerializer;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.grouping.Match;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.v10.grouping.MatchV10;
22 import org.slf4j.Logger;
23 import org.slf4j.LoggerFactory;
26 * Stores and handles serializers<br>
27 * K - {@link MessageTypeKey} type<br>
28 * S - returned serializer type
30 * @author michal.polkorab
31 * @author timotej.kubas
32 * @author giuseppex.petralia@intel.com
35 public class SerializerRegistryImpl implements SerializerRegistry {
37 private static final Logger LOG = LoggerFactory.getLogger(SerializerRegistryImpl.class);
38 private static final short OF10 = EncodeConstants.OF10_VERSION_ID;
39 private static final short OF13 = EncodeConstants.OF13_VERSION_ID;
40 private Map<MessageTypeKey<?>, OFGeneralSerializer> registry;
44 registry = new HashMap<>();
45 // Openflow message type serializers
46 MessageFactoryInitializer.registerMessageSerializers(this);
48 // Register Additional serializers
49 AdditionalMessageFactoryInitializer.registerMessageSerializers(this);
51 // match structure serializers
52 registerSerializer(new MessageTypeKey<>(OF10, MatchV10.class), new OF10MatchSerializer());
53 registerSerializer(new MessageTypeKey<>(OF13, Match.class), new OF13MatchSerializer());
55 // match entry serializers
56 MatchEntriesInitializer.registerMatchEntrySerializers(this);
58 ActionsInitializer.registerActionSerializers(this);
59 // instruction serializers
60 InstructionsInitializer.registerInstructionSerializers(this);
65 * @return encoder for current type of message (msgTypeKey)
68 @SuppressWarnings("unchecked")
69 public <K, S extends OFGeneralSerializer> S getSerializer(MessageTypeKey<K> msgTypeKey) {
70 OFGeneralSerializer serializer = registry.get(msgTypeKey);
71 if (serializer == null) {
72 throw new IllegalStateException("Serializer for key: " + msgTypeKey
73 + " was not found - please verify that you are using correct message"
74 + " combination (e.g. OF v1.0 message to OF v1.0 device)");
76 return (S) serializer;
80 public <K> void registerSerializer(MessageTypeKey<K> msgTypeKey, OFGeneralSerializer serializer) {
81 if ((msgTypeKey == null) || (serializer == null)) {
82 throw new IllegalArgumentException("MessageTypeKey or Serializer is null");
84 OFGeneralSerializer serInRegistry = registry.put(msgTypeKey, serializer);
85 if (serInRegistry != null) {
86 LOG.debug("Serializer for key {} overwritten. Old serializer: {}, new serializer: {}", msgTypeKey,
87 serInRegistry.getClass().getName(), serializer.getClass().getName());
89 if (serializer instanceof SerializerRegistryInjector) {
90 ((SerializerRegistryInjector) serializer).injectSerializerRegistry(this);
95 public <K> boolean unregisterSerializer(MessageTypeKey<K> msgTypeKey) {
96 if (msgTypeKey == null) {
97 throw new IllegalArgumentException("MessageTypeKey is null");
99 OFGeneralSerializer serializer = registry.remove(msgTypeKey);
100 if (serializer == null) {