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.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessage;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.experimenter.core.ExperimenterDataOfChoice;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandExperimenterCase;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.queue.property.header.QueueProperty;
  20
  21 /**
  22  * Provides methods for deserialization part of extensibility.
  23  * In case of handling multiple multiple structures of same type (actions,
  24  * instructions, match entries, ... ) which are differentiated by
  25  * vendor / experimenter subtype, vendor has to switch / choose between
  26  * these subtypes.<br>
  27  *
  28  * This has to be done in this way because of experimenter headers, which
  29  * provide only vendor / experimenter ID. Subtype position may be different
  30  * for different vendors (or not present at all) - that's why vendor has to
  31  * handle it in his own implementations.
  32  * @author michal.polkorab
  33  */
  34 public interface DeserializerExtensionProvider {
  35
  36     /**
  37      * Unregisters custom deserializer
  38      * @param key used for deserializer lookup
  39      * @return true if deserializer was removed,
  40      *  false if no deserializer was found under specified key
  41      */
  42     boolean unregisterDeserializer(ExperimenterDeserializerKey key);
  43
  44     /**
  45      * Registers action deserializer
  46      * @param key used for deserializer lookup
  47      * @param deserializer deserializer instance
  48      */
  49     void registerActionDeserializer(ExperimenterActionDeserializerKey key,
  50             OFGeneralDeserializer deserializer);
  51
  52     /**
  53      * Registers instruction deserializer
  54      * @param key used for deserializer lookup
  55      * @param deserializer deserializer instance
  56      */
  57     void registerInstructionDeserializer(ExperimenterInstructionDeserializerKey key,
  58             OFGeneralDeserializer deserializer);
  59
  60     /**
  61      * Registers match entry deserializer
  62      * @param key used for deserializer lookup
  63      * @param deserializer deserializer instance
  64      */
  65     void registerMatchEntryDeserializer(MatchEntryDeserializerKey key,
  66             OFGeneralDeserializer deserializer);
  67
  68     /**
  69      * Registers error message deserializer
  70      * @param key used for deserializer lookup
  71      * @param deserializer deserializer instance
  72      */
  73     void registerErrorDeserializer(ExperimenterIdDeserializerKey key,
  74             OFDeserializer<ErrorMessage> deserializer);
  75
  76     /**
  77      * Registers experimenter (vendor) message deserializer
  78      * @param key used for deserializer lookup
  79      * @param deserializer deserializer instance
  80      */
  81     void registerExperimenterMessageDeserializer(ExperimenterIdDeserializerKey key,
  82                                                  OFDeserializer<? extends ExperimenterDataOfChoice> deserializer);
  83
  84     /**
  85      * Registers multipart-reply (stats) message deserializer
  86      * @param key used for deserializer lookup
  87      * @param deserializer deserializer instance
  88      */
  89     void registerMultipartReplyMessageDeserializer(ExperimenterIdDeserializerKey key,
  90                                                    OFDeserializer<? extends ExperimenterDataOfChoice> deserializer);
  91
  92     /**
  93      * Registers multipart-reply table-features message deserializer
  94      * @param key used for deserializer lookup
  95      * @param deserializer deserializer instance
  96      */
  97     void registerMultipartReplyTFDeserializer(ExperimenterIdDeserializerKey key,
  98             OFGeneralDeserializer deserializer);
  99
 100     /**
 101      * Registers meter band deserializer (used in multipart-reply meter-config)
 102      * @param key used for deserializer lookup
 103      * @param deserializer deserializer instance
 104      */
 105     void registerMeterBandDeserializer(ExperimenterIdDeserializerKey key,
 106             OFDeserializer<MeterBandExperimenterCase> deserializer);
 107
 108     /**
 109      * Registers queue property (QUEUE_GET_CONFIG_REPLY message) deserializer
 110      * @param key used for deserializer lookup
 111      * @param deserializer deserializer instance
 112      */
 113     void registerQueuePropertyDeserializer(ExperimenterIdDeserializerKey key,
 114             OFDeserializer<QueueProperty> deserializer);
 115 }