openflowjava/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/SerializerRegistry.java

   1 /*
   2  * Copyright (c) 2013 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 package org.opendaylight.openflowjava.protocol.api.extensibility;
   9
  10 import org.opendaylight.openflowjava.protocol.api.keys.MessageTypeKey;
  11
  12 /**
  13  * Stores and handles serializers. <br>
  14  * K - {@link MessageTypeKey} parameter type,<br>
  15  * S - returned serializer type
  16  * @author michal.polkorab
  17  */
  18 public interface SerializerRegistry {
  19     /**
  20      * Serializer registry provisioning.
  21      */
  22     void init();
  23
  24     /**
  25      * Gets the serializer for the given type.
  26      *
  27      * @param <K> input key type
  28      * @param <S> type of resulting serializer
  29      * @param msgTypeKey lookup key
  30      * @return serializer or NullPointerException if no serializer was found
  31      */
  32     <K, S extends OFGeneralSerializer> S getSerializer(MessageTypeKey<K> msgTypeKey);
  33
  34     /**
  35      * Registers a serializer.
  36      *
  37      * Throws IllegalStateException when there is
  38      * a serializer already registered under given key.
  39      *
  40      * If the serializer implements {@link SerializerRegistryInjector} interface,
  41      * the serializer is injected with SerializerRegistry instance.
  42      *
  43      * @param <K> serializer key type
  44      * @param key used for serializer lookup
  45      * @param serializer serializer implementation
  46      */
  47     <K> void registerSerializer(MessageTypeKey<K> key,
  48             OFGeneralSerializer serializer);
  49
  50     /**
  51      * Unregisters a serializer.
  52      *
  53      * @param <K> serializer key type
  54      * @param key used for serializer lookup
  55      * @return true if serializer was removed,
  56      *  false if no serializer was found under specified key
  57      */
  58     <K> boolean unregisterSerializer(MessageTypeKey<K> key);
  59
  60     /**
  61      * Checks if group add mod messages are enabled.
  62      * @return true if group add mod messages are enabled
  63      */
  64     boolean isGroupAddModEnabled();
  65
  66     /**
  67      *
  68      * @param isGroupAddModEnabled true if group add mod messages are enabled
  69      */
  70     void setGroupAddModConfig(boolean isGroupAddModEnabled);
  71 }