2 * Copyright (c) 2014 Pantheon Technologies s.r.o. and others. All rights reserved.
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
9 package org.opendaylight.openflowjava.protocol.api.extensibility;
11 import org.opendaylight.openflowjava.protocol.api.keys.ActionSerializerKey;
12 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterIdMeterSubTypeSerializerKey;
13 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterIdSerializerKey;
14 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterSerializerKey;
15 import org.opendaylight.openflowjava.protocol.api.keys.InstructionSerializerKey;
16 import org.opendaylight.openflowjava.protocol.api.keys.MatchEntrySerializerKey;
17 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchField;
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.OxmClassBase;
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.table.features.properties.grouping.TableFeatureProperties;
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
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
35 public interface SerializerExtensionProvider {
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
43 boolean unregisterSerializer(ExperimenterSerializerKey key);
46 * Registers action serializer
47 * @param key used for serializer lookup
48 * @param serializer serializer implementation
50 void registerActionSerializer(ActionSerializerKey<?> key,
51 OFGeneralSerializer serializer);
54 * Registers instruction serializer
55 * @param key used for serializer lookup
56 * @param serializer serializer implementation
58 void registerInstructionSerializer(InstructionSerializerKey<?> key,
59 OFGeneralSerializer serializer);
62 * Registers match entry serializer
64 * @param <F> match field type
65 * @param key used for serializer lookup
66 * @param serializer serializer implementation
68 <C extends OxmClassBase, F extends MatchField> void registerMatchEntrySerializer(
69 MatchEntrySerializerKey<C, F> key,OFGeneralSerializer serializer);
72 * Registers experimenter (vendor) message serializer
73 * @param key used for serializer lookup
74 * @param serializer serializer implementation
76 void registerExperimenterMessageSerializer(ExperimenterIdSerializerKey<? extends ExperimenterDataOfChoice> key,
77 OFSerializer<? extends ExperimenterDataOfChoice> serializer);
80 * Registers multipart-request (stats-request) serializer
81 * @param key used for serializer lookup
82 * @param serializer serializer implementation
84 void registerMultipartRequestSerializer(ExperimenterIdSerializerKey<? extends ExperimenterDataOfChoice> key,
85 OFSerializer<? extends ExperimenterDataOfChoice> serializer);
88 * Registers multipart-request table-features serializer
89 * @param key used for serializer lookup
90 * @param serializer serializer implementation
92 void registerMultipartRequestTFSerializer(ExperimenterIdSerializerKey<TableFeatureProperties> key,
93 OFGeneralSerializer serializer);
96 * @deprecated Since we use ExperimenterIdMeterSubTypeSerializerKey as MeterBandSerializer's key, in order to avoid
97 * the occurrence of an error,we should discard this function
98 * Registers meter band serializer (used in meter-mod messages)
99 * @param key used for serializer lookup
100 * @param serializer serializer implementation
103 void registerMeterBandSerializer(ExperimenterIdSerializerKey<MeterBandExperimenterCase> key,
104 OFSerializer<MeterBandExperimenterCase> serializer);
107 * Registers meter band serializer (used in meter-mod messages)
108 * @param key used for serializer lookup
109 * @param serializer serializer implementation
111 void registerMeterBandSerializer(ExperimenterIdMeterSubTypeSerializerKey<MeterBandExperimenterCase> key,
112 OFSerializer<MeterBandExperimenterCase> serializer);