extension/openflowplugin-extension-api/src/main/java/org/opendaylight/openflowplugin/extension/api/ExtensionConverterRegistrator.java

   1 /**
   2  * Copyright (c) 2014 Cisco Systems, Inc. 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 package org.opendaylight.openflowplugin.extension.api;
   9
  10 import org.opendaylight.openflowjava.protocol.api.keys.ActionSerializerKey;
  11 import org.opendaylight.openflowjava.protocol.api.keys.MatchEntrySerializerKey;
  12 import org.opendaylight.openflowjava.protocol.api.keys.MessageTypeKey;
  13 import org.opendaylight.openflowplugin.extension.api.path.ActionPath;
  14 import org.opendaylight.openflowplugin.extension.api.path.MatchPath;
  15 import org.opendaylight.openflowplugin.extension.api.path.MessagePath;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.actions.grouping.Action;
  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.oxm.rev150225.match.entries.grouping.MatchEntry;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.experimenter.core.ExperimenterDataOfChoice;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.experimenter.types.rev151020.experimenter.core.message.ExperimenterMessageOfChoice;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.general.rev140714.ExtensionKey;
  23 import org.opendaylight.yangtools.concepts.ObjectRegistration;
  24 import org.opendaylight.yangtools.yang.binding.DataContainer;
  25
  26 /**
  27  * registration place for message converters provided by vendor extension
  28  */
  29 public interface ExtensionConverterRegistrator {
  30
  31
  32     ObjectRegistration<ConvertorToOFJava<MatchEntry>> registerMatchConvertor(
  33             ConverterExtensionKey<? extends ExtensionKey> key, ConvertorToOFJava<MatchEntry> convertor);
  34
  35     ObjectRegistration<ConvertorFromOFJava<MatchEntry, MatchPath>> registerMatchConvertor(
  36             MatchEntrySerializerKey<? extends OxmClassBase, ? extends MatchField> key,
  37             ConvertorFromOFJava<MatchEntry, MatchPath> convertor);
  38
  39     /**
  40      * @param key       action case type + ofp-version
  41      * @param convertor
  42      * @return closable registration
  43      */
  44     ObjectRegistration<ConvertorActionToOFJava<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action, Action>>
  45     registerActionConvertor(
  46             TypeVersionKey<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action> key,
  47             ConvertorActionToOFJava<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action, Action> convertor);
  48
  49     /**
  50      * @param key       actionSubType, action type (Experimenter), experimenterId, version
  51      * @param convertor
  52      * @return closable registration
  53      */
  54     ObjectRegistration<ConvertorActionFromOFJava<Action, ActionPath>> registerActionConvertor(
  55             ActionSerializerKey<?> key, ConvertorActionFromOFJava<Action, ActionPath> convertor);
  56
  57     /**
  58      * @param key       consists of: experimenter type, version
  59      * @param convertor TO OFJava (suitable for both: symmetric and multipart)
  60      * @return closeable registration
  61      */
  62     ObjectRegistration<ConvertorMessageToOFJava<ExperimenterMessageOfChoice, DataContainer>> registerMessageConvertor(
  63             TypeVersionKey<? extends ExperimenterMessageOfChoice> key, ConvertorMessageToOFJava<ExperimenterMessageOfChoice, DataContainer> convertor);
  64
  65     /**
  66      * @param key       consists of: experimenter type, version
  67      * @param convertor FROM OFJava (suitable for both: symmetric and multipart)
  68      * @return closeable registration
  69      */
  70     ObjectRegistration<ConvertorMessageFromOFJava<ExperimenterDataOfChoice, MessagePath>> registerMessageConvertor(
  71             MessageTypeKey<?> key,
  72             ConvertorMessageFromOFJava<ExperimenterDataOfChoice, MessagePath> convertor);
  73 }