openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/DeserializerExtensionProvider.java

   1 /*
   2  * Copyright (c) 2014 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.api.extensibility;
  10
  11 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterActionDeserializerKey;
  12 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterDeserializerKey;
  13 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterIdDeserializerKey;
  14 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterInstructionDeserializerKey;
  15 import org.opendaylight.openflowjava.protocol.api.keys.MatchEntryDeserializerKey;
  16 import org.opendaylight.openflowjava.protocol.api.keys.MessageCodeKey;
  17 import org.opendaylight.openflowjava.protocol.api.keys.TypeToClassKey;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessage;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.experimenter.core.ExperimenterDataOfChoice;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandExperimenterCase;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.queue.property.header.QueueProperty;
  22
  23 /**
  24  * Provides methods for deserialization part of extensibility.
  25  * In case of handling multiple multiple structures of same type (actions,
  26  * instructions, match entries, ... ) which are differentiated by
  27  * vendor / experimenter subtype, vendor has to switch / choose between
  28  * these subtypes.<br>
  29  *
  30  * This has to be done in this way because of experimenter headers, which
  31  * provide only vendor / experimenter ID. Subtype position may be different
  32  * for different vendors (or not present at all) - that's why vendor has to
  33  * handle it in his own implementations.
  34  * @author michal.polkorab
  35  */
  36 public interface DeserializerExtensionProvider {
  37
  38     /**
  39      * Registers deserializer.
  40      * Throws IllegalStateException when there is
  41      * a deserializer already registered under given key.
  42      * <p>
  43      * If the deserializer implements {@link DeserializerRegistryInjector} interface,
  44      * the deserializer is injected with DeserializerRegistry instance.
  45      *
  46      * @param key          used for deserializer lookup
  47      * @param deserializer deserializer instance
  48      */
  49     void registerDeserializer(MessageCodeKey key,
  50                               OFGeneralDeserializer deserializer);
  51
  52     /**
  53      * Unregisters custom deserializer
  54      * @param key used for deserializer lookup
  55      * @return true if deserializer was removed,
  56      *  false if no deserializer was found under specified key
  57      */
  58     boolean unregisterDeserializer(ExperimenterDeserializerKey key);
  59
  60     /**
  61      * Registers action deserializer
  62      * @param key used for deserializer lookup
  63      * @param deserializer deserializer instance
  64      */
  65     void registerActionDeserializer(ExperimenterActionDeserializerKey key,
  66             OFGeneralDeserializer deserializer);
  67
  68     /**
  69      * Registers instruction deserializer
  70      * @param key used for deserializer lookup
  71      * @param deserializer deserializer instance
  72      */
  73     void registerInstructionDeserializer(ExperimenterInstructionDeserializerKey key,
  74             OFGeneralDeserializer deserializer);
  75
  76     /**
  77      * Registers match entry deserializer
  78      * @param key used for deserializer lookup
  79      * @param deserializer deserializer instance
  80      */
  81     void registerMatchEntryDeserializer(MatchEntryDeserializerKey key,
  82             OFGeneralDeserializer deserializer);
  83
  84     /**
  85      * Registers error message deserializer
  86      * @param key used for deserializer lookup
  87      * @param deserializer deserializer instance
  88      */
  89     void registerErrorDeserializer(ExperimenterIdDeserializerKey key,
  90             OFDeserializer<ErrorMessage> deserializer);
  91
  92     /**
  93      * Registers experimenter (vendor) message deserializer
  94      * @param key used for deserializer lookup
  95      * @param deserializer deserializer instance
  96      */
  97     void registerExperimenterMessageDeserializer(ExperimenterIdDeserializerKey key,
  98                                                  OFDeserializer<? extends ExperimenterDataOfChoice> deserializer);
  99
 100     /**
 101      * Registers multipart-reply (stats) message deserializer
 102      * @param key used for deserializer lookup
 103      * @param deserializer deserializer instance
 104      */
 105     void registerMultipartReplyMessageDeserializer(ExperimenterIdDeserializerKey key,
 106                                                    OFDeserializer<? extends ExperimenterDataOfChoice> deserializer);
 107
 108     /**
 109      * Registers multipart-reply table-features message deserializer
 110      * @param key used for deserializer lookup
 111      * @param deserializer deserializer instance
 112      */
 113     void registerMultipartReplyTFDeserializer(ExperimenterIdDeserializerKey key,
 114             OFGeneralDeserializer deserializer);
 115
 116     /**
 117      * Registers meter band deserializer (used in multipart-reply meter-config)
 118      * @param key used for deserializer lookup
 119      * @param deserializer deserializer instance
 120      */
 121     void registerMeterBandDeserializer(ExperimenterIdDeserializerKey key,
 122             OFDeserializer<MeterBandExperimenterCase> deserializer);
 123
 124     /**
 125      * Registers queue property (QUEUE_GET_CONFIG_REPLY message) deserializer
 126      * @param key used for deserializer lookup
 127      * @param deserializer deserializer instance
 128      */
 129     void registerQueuePropertyDeserializer(ExperimenterIdDeserializerKey key,
 130             OFDeserializer<QueueProperty> deserializer);
 131
 132     /**
 133      * Registers type to class mapping used to assign return type when deserializing message
 134      * @param key type to class key
 135      * @param clazz return class
 136      */
 137     void registerDeserializerMapping(TypeToClassKey key, Class<?> clazz);
 138
 139     /**
 140      * Unregisters type to class mapping used to assign return type when deserializing message
 141      * @param key type to class key
 142      * @return true if mapping was successfully removed
 143      */
 144     boolean unregisterDeserializerMapping(TypeToClassKey key);
 145 }