Add methods for experimenter (de)serializer registration
[openflowjava.git] / openflow-protocol-impl / src / main / java / org / opendaylight / openflowjava / protocol / impl / util / CommonMessageRegistryHelper.java
index 0ce8d54e5eaeafa64ca3c12c49a504a0b1c22c17..260d1b3f36df99ce1d935d9518e51dc2627bda88 100644 (file)
@@ -1,39 +1,53 @@
-/*\r
- * Copyright (c) 2013 Pantheon Technologies s.r.o. and others.  All rights reserved.\r
- *\r
- * This program and the accompanying materials are made available under the\r
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
- * and is available at http://www.eclipse.org/legal/epl-v10.html\r
- */\r
-package org.opendaylight.openflowjava.protocol.impl.util;\r
-\r
-import org.opendaylight.openflowjava.protocol.api.extensibility.MessageTypeKey;\r
-import org.opendaylight.openflowjava.protocol.api.extensibility.OFGeneralSerializer;\r
-import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistry;\r
-\r
-/**\r
- * @author michal.polkorab\r
- *\r
- */\r
-public class CommonMessageRegistryHelper {\r
-\r
-    private short version;\r
-    private SerializerRegistry serializerRegistry;\r
-\r
-    /**\r
-     * @param version\r
-     * @param serializerRegistry\r
-     */\r
-    public CommonMessageRegistryHelper(short version, SerializerRegistry serializerRegistry) {\r
-        this.version = version;\r
-        this.serializerRegistry = serializerRegistry;\r
-    }\r
-\r
-    /**\r
-     * @param msgType\r
-     * @param serializer\r
-     */\r
-    public void registerSerializer(Class<?> msgType, OFGeneralSerializer serializer) {\r
-        serializerRegistry.registerSerializer(new MessageTypeKey<>(version, msgType), serializer);\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.util;
+
+import org.opendaylight.openflowjava.protocol.api.extensibility.OFGeneralSerializer;
+import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistry;
+import org.opendaylight.openflowjava.protocol.api.keys.MessageTypeKey;
+import org.opendaylight.openflowjava.util.ExperimenterSerializerKeyFactory;
+
+/**
+ * Helper class for serializer registration.
+ * @author michal.polkorab
+ */
+public class CommonMessageRegistryHelper {
+
+    private short version;
+    private SerializerRegistry serializerRegistry;
+
+    /**
+     * @param version wire protocol version
+     * @param serializerRegistry registry to be filled with message serializers
+     */
+    public CommonMessageRegistryHelper(short version, SerializerRegistry serializerRegistry) {
+        this.version = version;
+        this.serializerRegistry = serializerRegistry;
+    }
+
+    /**
+     * Registers serializer in registry.
+     * @param msgType class of object that will be serialized by given serializer
+     * @param serializer serializer instance
+     */
+    public void registerSerializer(Class<?> msgType, OFGeneralSerializer serializer) {
+        serializerRegistry.registerSerializer(new MessageTypeKey<>(version, msgType), serializer);
+    }
+
+    /**
+     * Registers experimenter serializer in registry.
+     * @param experimenterId experimenterID of experimenter message
+     * @param type type of experimenter message
+     * @param serializer serializer instance
+     */
+    public void registerExperimenterSerializer(final long experimenterId, final long type,
+                                               final OFGeneralSerializer serializer) {
+        serializerRegistry.registerSerializer(ExperimenterSerializerKeyFactory
+                .createExperimenterMessageSerializerKey(version, experimenterId, type), serializer);
+    }
+}