Add methods for modifying deserializer mapping

[openflowjava.git] / openflow-protocol-impl / src / main / java / org / opendaylight / openflowjava / protocol / impl / deserialization / DeserializationFactory.java

diff --git a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/deserialization/DeserializationFactory.java b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/deserialization/DeserializationFactory.java
index db137fb7dd54d97c37eb50dd21c418c5dfec5574..de631b11fa0ec52f09f367af04335b27bb26c897 100644 (file)
--- a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/deserialization/DeserializationFactory.java
+++ b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/deserialization/DeserializationFactory.java
@@ -1,39 +1,88 @@
-/* Copyright (C)2013 Pantheon Technologies, s.r.o. All rights reserved. */\r
-package org.opendaylight.openflowjava.protocol.impl.deserialization;\r
-\r
-import io.netty.buffer.ByteBuf;\r
-\r
-import org.opendaylight.yangtools.yang.binding.DataObject;\r
-import org.slf4j.Logger;\r
-import org.slf4j.LoggerFactory;\r
-\r
-/**\r
- * @author michal.polkorab\r
- * @author timotej.kubas\r
- */\r
-public abstract class DeserializationFactory {\r
-    \r
-    private static final Logger LOGGER = LoggerFactory\r
-            .getLogger(DeserializationFactory.class);\r
-\r
-    /**\r
-     * Transforms ByteBuf into correct POJO message\r
-     * @param rawMessage \r
-     * @param version version decoded from OpenFlow protocol message\r
-     * @return correct POJO as DataObject\r
-     */\r
-    public static DataObject bufferToMessage(ByteBuf rawMessage, short version) {\r
-        DataObject dataObject = null;\r
-        short type = rawMessage.readUnsignedByte();\r
-        rawMessage.skipBytes(Short.SIZE / Byte.SIZE);\r
-\r
-        MessageTypeCodeKey msgTypeCodeKey = new MessageTypeCodeKey(version, type);\r
-        OFDeserializer<?> decoder = DecoderTable.getInstance().getDecoder(msgTypeCodeKey);\r
-        if (decoder != null) {\r
-            dataObject = decoder.bufferToMessage(rawMessage, version);\r
-        } else {\r
-            LOGGER.warn("No correct decoder found in DecoderTable for arguments: " + msgTypeCodeKey.toString());\r
-        }\r
-        return dataObject;\r
-    }\r
-}\r
+/*
+ * Copyright (c) 2013 Pantheon Technologies s.r.o. and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
+package org.opendaylight.openflowjava.protocol.impl.deserialization;
+
+import io.netty.buffer.ByteBuf;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistry;
+import org.opendaylight.openflowjava.protocol.api.extensibility.OFDeserializer;
+import org.opendaylight.openflowjava.protocol.api.keys.MessageCodeKey;
+import org.opendaylight.openflowjava.protocol.api.keys.TypeToClassKey;
+import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+
+/**
+ * @author michal.polkorab
+ * @author timotej.kubas
+ * @author giuseppex.petralia@intel.com
+ */
+public class DeserializationFactory {
+
+    private final Map<TypeToClassKey, Class<?>> messageClassMap = new ConcurrentHashMap<>();
+    private DeserializerRegistry registry;
+
+    /**
+     * Constructor
+     */
+    public DeserializationFactory() {
+        TypeToClassMapInitializer.initializeTypeToClassMap(messageClassMap);
+
+        // Register type to class map for additional deserializers
+        TypeToClassMapInitializer.initializeAdditionalTypeToClassMap(messageClassMap);
+    }
+
+    /**
+     * Transforms ByteBuf into correct POJO message
+     *
+     * @param rawMessage
+     * @param version
+     *            version decoded from OpenFlow protocol message
+     * @return correct POJO as DataObject
+     */
+    public DataObject deserialize(final ByteBuf rawMessage, final short version) {
+        DataObject dataObject = null;
+        int type = rawMessage.readUnsignedByte();
+        Class<?> clazz = messageClassMap.get(new TypeToClassKey(version, type));
+        rawMessage.skipBytes(EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
+        OFDeserializer<DataObject> deserializer = registry.getDeserializer(new MessageCodeKey(version, type, clazz));
+        dataObject = deserializer.deserialize(rawMessage);
+        return dataObject;
+    }
+
+    /**
+     * Register new type to class mapping used to assign return type when deserializing message
+     * @param key type to class key
+     * @param clazz return class
+     */
+    public void registerMapping(final TypeToClassKey key, final Class<?> clazz) {
+        messageClassMap.put(key, clazz);
+    }
+
+    /**
+     * Unregister type to class mapping used to assign return type when deserializing message
+     * @param key type to class key
+     * @return true if mapping was successfully removed
+     */
+    public boolean unregisterMapping(final TypeToClassKey key) {
+        if (key == null) {
+            throw new IllegalArgumentException("TypeToClassKey is null");
+        }
+
+        return messageClassMap.remove(key) != null;
+    }
+
+    /**
+     * @param registry
+     */
+    public void setRegistry(final DeserializerRegistry registry) {
+        this.registry = registry;
+    }
+
+}