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