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.ExperimenterInput;
  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.multipart.request.multipart.request.body.MultipartRequestExperimenterCase;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.table.features.properties.grouping.TableFeatureProperties;
  22
  23
  24 /**
  25  * Provides methods for serialization part of extensibility.
  26  * In case of handling multiple structures of same type (actions,
  27  * instructions, match entries, ... ) which are differentiated by
  28  * vendor / experimenter subtype, vendor has to switch / choose between
  29  * these subtypes.<br>
  30  *
  31  * This has to be done in this way because of unknown augmentations
  32  * - that's why vendor has to handle it in his own implementations.
  33  * @author michal.polkorab
  34  */
  35 public interface SerializerExtensionProvider {
  36
  37     /**
  38      * Unregisters custom serializer
  39      * @param key used for serializer lookup
  40      * @return true if serializer was removed,
  41      *  false if no serializer was found under specified key
  42      */
  43     boolean unregisterSerializer(ExperimenterSerializerKey key);
  44
  45     /**
  46      * Registers action serializer
  47      * @param key used for serializer lookup
  48      * @param serializer serializer implementation
  49      */
  50     void registerActionSerializer(ActionSerializerKey<?> key,
  51             OFGeneralSerializer serializer);
  52
  53     /**
  54      * Registers instruction serializer
  55      * @param key used for serializer lookup
  56      * @param serializer serializer implementation
  57      */
  58     void registerInstructionSerializer(InstructionSerializerKey<?> key,
  59             OFGeneralSerializer serializer);
  60
  61     /**
  62      * Registers match entry serializer
  63      * @param <C> oxm type
  64      * @param <F> match field type
  65      * @param key used for serializer lookup
  66      * @param serializer serializer implementation
  67      */
  68     <C extends OxmClassBase, F extends MatchField> void registerMatchEntrySerializer(
  69             MatchEntrySerializerKey<C, F> key,OFGeneralSerializer serializer);
  70
  71     /**
  72      * Registers experimenter (vendor) message serializer
  73      * @param key used for serializer lookup
  74      * @param serializer serializer implementation
  75      */
  76     void registerExperimenterMessageSerializer(ExperimenterIdSerializerKey<ExperimenterInput> key,
  77             OFSerializer<ExperimenterInput> serializer);
  78
  79     /**
  80      * Registers multipart-request (stats-request) serializer
  81      * @param key used for serializer lookup
  82      * @param serializer serializer implementation
  83      */
  84     void registerMultipartRequestSerializer(ExperimenterIdSerializerKey<MultipartRequestExperimenterCase> key,
  85             OFSerializer<MultipartRequestExperimenterCase> serializer);
  86
  87     /**
  88      * Registers multipart-request table-features serializer
  89      * @param key used for serializer lookup
  90      * @param serializer serializer implementation
  91      */
  92     void registerMultipartRequestTFSerializer(ExperimenterIdSerializerKey<TableFeatureProperties> key,
  93             OFGeneralSerializer serializer);
  94
  95     /**
  96      * Registers meter band serializer (used in meter-mod messages)
  97      * @param key used for serializer lookup
  98      * @param serializer serializer implementation
  99      */
 100     void registerMeterBandSerializer(ExperimenterIdSerializerKey<MeterBandExperimenterCase> key,
 101             OFSerializer<MeterBandExperimenterCase> serializer);
 102 }