-/*\r
- * Copyright (c) 2014 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
-\r
-package org.opendaylight.openflowjava.protocol.api.extensibility;\r
-\r
-import org.opendaylight.openflowjava.protocol.api.keys.MatchEntryDeserializerKey;\r
-import org.opendaylight.openflowjava.protocol.api.keys.experimenter.ExperimenterActionDeserializerKey;\r
-import org.opendaylight.openflowjava.protocol.api.keys.experimenter.ExperimenterDeserializerKey;\r
-import org.opendaylight.openflowjava.protocol.api.keys.experimenter.ExperimenterIdDeserializerKey;\r
-import org.opendaylight.openflowjava.protocol.api.keys.experimenter.ExperimenterInstructionDeserializerKey;\r
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessage;\r
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;\r
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessage;\r
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandExperimenterCase;\r
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.queue.property.header.QueueProperty;\r
-\r
-/**\r
- * Provides methods for deserialization part of extensibility.\r
- * In case of handling multiple multiple structures of same type (actions,\r
- * instructions, match entries, ... ) which are differentiated by\r
- * vendor / experimenter subtype, vendor has to switch / choose between\r
- * these subtypes. <br />\r
- * \r
- * This has to be done in this way because of experimenter headers, which\r
- * provide only vendor / experimenter ID. Subtype position may be different\r
- * for different vendors (or not present at all) - that's why vendor has to\r
- * handle it in his own implementations.\r
- * @author michal.polkorab\r
- */\r
-public interface DeserializerExtensionProvider {\r
-\r
- /**\r
- * Unregisters custom deserializer\r
- * @param key used for deserializer lookup\r
- * @return true if deserializer was removed,\r
- * false if no deserializer was found under specified key\r
- */\r
- public boolean unregisterDeserializer(ExperimenterDeserializerKey key);\r
-\r
- /**\r
- * Registers action deserializer\r
- * @param key used for deserializer lookup\r
- * @param deserializer deserializer instance\r
- */\r
- public void registerActionDeserializer(ExperimenterActionDeserializerKey key,\r
- OFGeneralDeserializer deserializer);\r
-\r
- /**\r
- * Registers instruction deserializer\r
- * @param key used for deserializer lookup\r
- * @param deserializer deserializer instance\r
- */\r
- public void registerInstructionDeserializer(ExperimenterInstructionDeserializerKey key,\r
- OFGeneralDeserializer deserializer);\r
-\r
- /**\r
- * Registers match entry deserializer\r
- * @param key used for deserializer lookup\r
- * @param deserializer deserializer instance\r
- */\r
- public void registerMatchEntryDeserializer(MatchEntryDeserializerKey key,\r
- OFGeneralDeserializer deserializer);\r
-\r
- /**\r
- * Registers error message deserializer\r
- * @param key used for deserializer lookup\r
- * @param deserializer deserializer instance\r
- */\r
- void registerErrorDeserializer(ExperimenterIdDeserializerKey key,\r
- OFDeserializer<ErrorMessage> deserializer);\r
-\r
- /**\r
- * Registers experimenter (vendor) message deserializer\r
- * @param key used for deserializer lookup\r
- * @param deserializer deserializer instance\r
- */\r
- void registerExperimenterMessageDeserializer(ExperimenterIdDeserializerKey key,\r
- OFDeserializer<ExperimenterMessage> deserializer);\r
-\r
- /**\r
- * Registers multipart-reply (stats) message deserializer\r
- * @param key used for deserializer lookup\r
- * @param deserializer deserializer instance\r
- */\r
- void registerMultipartReplyMessageDeserializer(ExperimenterIdDeserializerKey key,\r
- OFDeserializer<MultipartReplyMessage> deserializer);\r
-\r
- /**\r
- * Registers multipart-reply table-features message deserializer\r
- * @param key used for deserializer lookup\r
- * @param deserializer deserializer instance\r
- */\r
- void registerMultipartReplyTFDeserializer(ExperimenterIdDeserializerKey key,\r
- OFGeneralDeserializer deserializer);\r
-\r
- /**\r
- * Registers meter band deserializer (used in multipart-reply meter-config)\r
- * @param key used for deserializer lookup\r
- * @param deserializer deserializer instance\r
- */\r
- void registerMeterBandDeserializer(ExperimenterIdDeserializerKey key,\r
- OFDeserializer<MeterBandExperimenterCase> deserializer);\r
-\r
- /**\r
- * Registers queue property (QUEUE_GET_CONFIG_REPLY message) deserializer\r
- * @param key used for deserializer lookup\r
- * @param deserializer deserializer instance\r
- */\r
- void registerQueuePropertyDeserializer(ExperimenterIdDeserializerKey key,\r
- OFDeserializer<QueueProperty> deserializer);\r
-}
\ No newline at end of file
+/*
+ * Copyright (c) 2014 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.api.extensibility;
+
+import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterActionDeserializerKey;
+import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterDeserializerKey;
+import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterIdDeserializerKey;
+import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterInstructionDeserializerKey;
+import org.opendaylight.openflowjava.protocol.api.keys.MatchEntryDeserializerKey;
+import org.opendaylight.openflowjava.protocol.api.keys.MessageCodeKey;
+import org.opendaylight.openflowjava.protocol.api.keys.TypeToClassKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessage;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.experimenter.core.ExperimenterDataOfChoice;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandExperimenterCase;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.queue.property.header.QueueProperty;
+
+/**
+ * Provides methods for deserialization part of extensibility.
+ * In case of handling multiple multiple structures of same type (actions,
+ * instructions, match entries, ... ) which are differentiated by
+ * vendor / experimenter subtype, vendor has to switch / choose between
+ * these subtypes.<br>
+ *
+ * This has to be done in this way because of experimenter headers, which
+ * provide only vendor / experimenter ID. Subtype position may be different
+ * for different vendors (or not present at all) - that's why vendor has to
+ * handle it in his own implementations.
+ * @author michal.polkorab
+ */
+public interface DeserializerExtensionProvider {
+
+ /**
+ * Registers deserializer.
+ * Throws IllegalStateException when there is
+ * a deserializer already registered under given key.
+ * <p>
+ * If the deserializer implements {@link DeserializerRegistryInjector} interface,
+ * the deserializer is injected with DeserializerRegistry instance.
+ *
+ * @param key used for deserializer lookup
+ * @param deserializer deserializer instance
+ */
+ void registerDeserializer(MessageCodeKey key,
+ OFGeneralDeserializer deserializer);
+
+ /**
+ * Unregisters custom deserializer
+ * @param key used for deserializer lookup
+ * @return true if deserializer was removed,
+ * false if no deserializer was found under specified key
+ */
+ boolean unregisterDeserializer(ExperimenterDeserializerKey key);
+
+ /**
+ * Registers action deserializer
+ * @param key used for deserializer lookup
+ * @param deserializer deserializer instance
+ */
+ void registerActionDeserializer(ExperimenterActionDeserializerKey key,
+ OFGeneralDeserializer deserializer);
+
+ /**
+ * Registers instruction deserializer
+ * @param key used for deserializer lookup
+ * @param deserializer deserializer instance
+ */
+ void registerInstructionDeserializer(ExperimenterInstructionDeserializerKey key,
+ OFGeneralDeserializer deserializer);
+
+ /**
+ * Registers match entry deserializer
+ * @param key used for deserializer lookup
+ * @param deserializer deserializer instance
+ */
+ void registerMatchEntryDeserializer(MatchEntryDeserializerKey key,
+ OFGeneralDeserializer deserializer);
+
+ /**
+ * Registers error message deserializer
+ * @param key used for deserializer lookup
+ * @param deserializer deserializer instance
+ */
+ void registerErrorDeserializer(ExperimenterIdDeserializerKey key,
+ OFDeserializer<ErrorMessage> deserializer);
+
+ /**
+ * Registers experimenter (vendor) message deserializer
+ * @param key used for deserializer lookup
+ * @param deserializer deserializer instance
+ */
+ void registerExperimenterMessageDeserializer(ExperimenterIdDeserializerKey key,
+ OFDeserializer<? extends ExperimenterDataOfChoice> deserializer);
+
+ /**
+ * Registers multipart-reply (stats) message deserializer
+ * @param key used for deserializer lookup
+ * @param deserializer deserializer instance
+ */
+ void registerMultipartReplyMessageDeserializer(ExperimenterIdDeserializerKey key,
+ OFDeserializer<? extends ExperimenterDataOfChoice> deserializer);
+
+ /**
+ * Registers multipart-reply table-features message deserializer
+ * @param key used for deserializer lookup
+ * @param deserializer deserializer instance
+ */
+ void registerMultipartReplyTFDeserializer(ExperimenterIdDeserializerKey key,
+ OFGeneralDeserializer deserializer);
+
+ /**
+ * Registers meter band deserializer (used in multipart-reply meter-config)
+ * @param key used for deserializer lookup
+ * @param deserializer deserializer instance
+ */
+ void registerMeterBandDeserializer(ExperimenterIdDeserializerKey key,
+ OFDeserializer<MeterBandExperimenterCase> deserializer);
+
+ /**
+ * Registers queue property (QUEUE_GET_CONFIG_REPLY message) deserializer
+ * @param key used for deserializer lookup
+ * @param deserializer deserializer instance
+ */
+ void registerQueuePropertyDeserializer(ExperimenterIdDeserializerKey key,
+ OFDeserializer<QueueProperty> deserializer);
+
+ /**
+ * Registers type to class mapping used to assign return type when deserializing message
+ * @param key type to class key
+ * @param clazz return class
+ */
+ void registerDeserializerMapping(TypeToClassKey key, Class<?> clazz);
+
+ /**
+ * Unregisters 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
+ */
+ boolean unregisterDeserializerMapping(TypeToClassKey key);
+}
Code Review / openflowjava.git / blobdiff