openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/SerializerExtensionProvider.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.ActionSerializerKey;
  12 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterIdSerializerKey;
  13 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterSerializerKey;
  14 import org.opendaylight.openflowjava.protocol.api.keys.InstructionSerializerKey;
  15 import org.opendaylight.openflowjava.protocol.api.keys.MatchEntrySerializerKey;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchField;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.OxmClassBase;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.experimenter.core.ExperimenterDataOfChoice;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandExperimenterCase;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.table.features.properties.grouping.TableFeatureProperties;
  21
  22
  23 /**
  24  * Provides methods for serialization part of extensibility.
  25  * In case of handling 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 unknown augmentations
  31  * - that's why vendor has to handle it in his own implementations.
  32  * @author michal.polkorab
  33  */
  34 public interface SerializerExtensionProvider {
  35
  36     /**
  37      * Unregisters custom serializer
  38      * @param key used for serializer lookup
  39      * @return true if serializer was removed,
  40      *  false if no serializer was found under specified key
  41      */
  42     boolean unregisterSerializer(ExperimenterSerializerKey key);
  43
  44     /**
  45      * Registers action serializer
  46      * @param key used for serializer lookup
  47      * @param serializer serializer implementation
  48      */
  49     void registerActionSerializer(ActionSerializerKey<?> key,
  50             OFGeneralSerializer serializer);
  51
  52     /**
  53      * Registers instruction serializer
  54      * @param key used for serializer lookup
  55      * @param serializer serializer implementation
  56      */
  57     void registerInstructionSerializer(InstructionSerializerKey<?> key,
  58             OFGeneralSerializer serializer);
  59
  60     /**
  61      * Registers match entry serializer
  62      * @param <C> oxm type
  63      * @param <F> match field type
  64      * @param key used for serializer lookup
  65      * @param serializer serializer implementation
  66      */
  67     <C extends OxmClassBase, F extends MatchField> void registerMatchEntrySerializer(
  68             MatchEntrySerializerKey<C, F> key,OFGeneralSerializer serializer);
  69
  70     /**
  71      * Registers experimenter (vendor) message serializer
  72      * @param key used for serializer lookup
  73      * @param serializer serializer implementation
  74      */
  75     void registerExperimenterMessageSerializer(ExperimenterIdSerializerKey<? extends ExperimenterDataOfChoice> key,
  76                                                OFSerializer<? extends ExperimenterDataOfChoice> serializer);
  77
  78     /**
  79      * Registers multipart-request (stats-request) serializer
  80      * @param key used for serializer lookup
  81      * @param serializer serializer implementation
  82      */
  83     void registerMultipartRequestSerializer(ExperimenterIdSerializerKey<? extends ExperimenterDataOfChoice> key,
  84                                             OFSerializer<? extends ExperimenterDataOfChoice> serializer);
  85
  86     /**
  87      * Registers multipart-request table-features serializer
  88      * @param key used for serializer lookup
  89      * @param serializer serializer implementation
  90      */
  91     void registerMultipartRequestTFSerializer(ExperimenterIdSerializerKey<TableFeatureProperties> key,
  92             OFGeneralSerializer serializer);
  93
  94     /**
  95      * Registers meter band serializer (used in meter-mod messages)
  96      * @param key used for serializer lookup
  97      * @param serializer serializer implementation
  98      */
  99     void registerMeterBandSerializer(ExperimenterIdSerializerKey<MeterBandExperimenterCase> key,
 100             OFSerializer<MeterBandExperimenterCase> serializer);
 101 }