openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/queue/TicketProcessorFactory.java

   1 /**
   2  * Copyright (c) 2013 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.openflow.md.queue;
   9
  10 import java.util.Collection;
  11 import java.util.List;
  12 import java.util.Map;
  13
  14 import org.opendaylight.openflowplugin.api.openflow.md.core.IMDMessageTranslator;
  15 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
  16 import org.opendaylight.openflowplugin.api.statistics.MessageSpy;
  17 import org.opendaylight.yangtools.yang.binding.DataContainer;
  18 import org.opendaylight.yangtools.yang.binding.DataObject;
  19
  20 /**
  21  * @param <IN>
  22  * @param <OUT>
  23  */
  24 public interface TicketProcessorFactory<IN extends DataObject, OUT extends DataObject> {
  25
  26     /**
  27      * @param ticket
  28      * @return runnable ticket processor
  29      */
  30     Runnable createProcessor(final Ticket<IN, OUT> ticket);
  31
  32     /**
  33      * @param ticket
  34      * @return runnable ticket processor
  35      */
  36     Runnable createSyncProcessor(final Ticket<IN, OUT> ticket);
  37
  38     /**
  39      * @param ticket
  40      * @return translated messages
  41      *
  42      */
  43     List<OUT> translate(Ticket<IN, OUT> ticket);
  44
  45     /**
  46      * @param ticketFinisher setter
  47      */
  48     void setTicketFinisher(TicketFinisher<OUT> ticketFinisher);
  49
  50     /**
  51      * @param spy setter
  52      */
  53     void setSpy(MessageSpy<DataContainer> spy);
  54
  55     /**
  56      * @param translatorMapping setter
  57      */
  58     void setTranslatorMapping(Map<TranslatorKey, Collection<IMDMessageTranslator<IN, List<OUT>>>> translatorMapping);
  59 }