BUG-1075: ingress back pressure
[openflowplugin.git] / openflowplugin / src / main / java / org / opendaylight / openflowplugin / openflow / md / queue / TicketProcessorFactory.java
index ace82888294444b66b399db8f9a5c01bd7dbfbc7..17d753934308eb17e324ec78804030866d52703c 100644 (file)
  */
 package org.opendaylight.openflowplugin.openflow.md.queue;
 
-import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
 import java.util.Map;
 
-import org.opendaylight.openflowplugin.openflow.md.core.ConnectionConductor;
 import org.opendaylight.openflowplugin.openflow.md.core.IMDMessageTranslator;
-import org.opendaylight.openflowplugin.openflow.md.core.SwitchConnectionDistinguisher;
 import org.opendaylight.openflowplugin.openflow.md.core.TranslatorKey;
 import org.opendaylight.yangtools.yang.binding.DataContainer;
 import org.opendaylight.yangtools.yang.binding.DataObject;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 /**
  * @param <IN>
  * @param <OUT>
  */
-public class TicketProcessorFactory<IN extends DataObject, OUT extends DataObject> {
-
-    protected static final Logger LOG = LoggerFactory
-            .getLogger(TicketProcessorFactory.class);
-
-    protected VersionExtractor<IN> versionExtractor;
-    protected RegisteredTypeExtractor<IN> registeredTypeExtractor;
-    protected Map<TranslatorKey, Collection<IMDMessageTranslator<IN, List<OUT>>>> translatorMapping;
-    protected MessageSpy<DataContainer> spy;
+public interface TicketProcessorFactory<IN extends DataObject, OUT extends DataObject> {
 
     /**
-     * @param versionExtractor the versionExtractor to set
+     * @param ticket
+     * @return runnable ticket processor
      */
-    public void setVersionExtractor(VersionExtractor<IN> versionExtractor) {
-        this.versionExtractor = versionExtractor;
-    }
+    Runnable createProcessor(final Ticket<IN, OUT> ticket);
 
     /**
-     * @param registeredTypeExtractor the registeredTypeExtractor to set
+     * @param ticket
+     * @return runnable ticket processor
      */
-    public void setRegisteredTypeExtractor(
-            RegisteredTypeExtractor<IN> registeredTypeExtractor) {
-        this.registeredTypeExtractor = registeredTypeExtractor;
-    }
+    Runnable createSyncProcessor(final Ticket<IN, OUT> ticket);
 
     /**
-     * @param translatorMapping the translatorMapping to set
+     * @param ticket
+     * @return translated messages
+     * 
      */
-    public void setTranslatorMapping(
-            Map<TranslatorKey, Collection<IMDMessageTranslator<IN, List<OUT>>>> translatorMapping) {
-        this.translatorMapping = translatorMapping;
-    }
+    List<OUT> translate(Ticket<IN, OUT> ticket);
 
     /**
-     * @param spy the spy to set
+     * @param ticketFinisher setter
      */
-    public void setSpy(MessageSpy<DataContainer> spy) {
-        this.spy = spy;
-    }
-
+    void setTicketFinisher(TicketFinisher<OUT> ticketFinisher);
 
     /**
-     * @param ticket
-     * @return runnable ticket processor
+     * @param spy setter
      */
-    public Runnable createProcessor(final Ticket<IN, OUT> ticket) {
-
-        Runnable ticketProcessor = new Runnable() {
-            @Override
-            public void run() {
-                LOG.debug("message received, type: {}", registeredTypeExtractor.extractRegisteredType(
-                        ticket.getMessage()).getSimpleName());
-                List<OUT> translate;
-                try {
-                    translate = translate();
-                    ticket.getResult().set(translate);
-                    // spying on result
-                    if (spy != null) {
-                        spy.spyIn(ticket.getMessage());
-                        for (OUT outMessage : ticket.getResult().get()) {
-                            spy.spyOut(outMessage);
-                        }
-                    }
-                } catch (Exception e) {
-                    LOG.error("translation problem: {}", e.getMessage());
-                    ticket.getResult().setException(e);
-                }
-                LOG.debug("message processing done (type: {}, ticket: {})",
-                        registeredTypeExtractor.extractRegisteredType(ticket.getMessage()).getSimpleName(),
-                        System.identityHashCode(ticket));
-            }
-
-            /**
-             *
-             */
-            private List<OUT> translate() {
-                List<OUT> result = new ArrayList<>();
-
-                IN message = ticket.getMessage();
-                Class<? extends IN> messageType = registeredTypeExtractor.extractRegisteredType(ticket.getMessage());
-                ConnectionConductor conductor = ticket.getConductor();
-                Collection<IMDMessageTranslator<IN, List<OUT>>> translators = null;
-                LOG.debug("translating ticket: {}, ticket: {}", messageType.getSimpleName(), System.identityHashCode(ticket));
-
-                Short version = versionExtractor.extractVersion(message);
-                if (version == null) {
-                    throw new IllegalArgumentException("version is NULL");
-                }
-                TranslatorKey tKey = new TranslatorKey(version, messageType.getName());
-                translators = translatorMapping.get(tKey);
+    void setSpy(MessageSpy<DataContainer> spy);
 
-                LOG.debug("translatorKey: {} + {}", version, messageType.getName());
-
-                if (translators != null) {
-                    for (IMDMessageTranslator<IN, List<OUT>> translator : translators) {
-                        SwitchConnectionDistinguisher cookie = null;
-                        // Pass cookie only for PACKT_IN
-                        if (messageType.equals("PacketInMessage.class")) {
-                            cookie = conductor.getAuxiliaryKey();
-                        }
-                        long start = System.nanoTime();
-                        List<OUT> translatorOutput = translator.translate(cookie, conductor.getSessionContext(), message);
-                        long end = System.nanoTime();
-                        LOG.debug("translator: {} elapsed time {} ns",translator,end-start);
-                        if(translatorOutput != null && !translatorOutput.isEmpty()) {
-                            result.addAll(translatorOutput);
-                        }
-                    }
-                } else {
-                    LOG.warn("No translators for this message Type: {}", messageType);
-                }
-                return result;
-            }
-        };
-
-        return ticketProcessor;
-    }
+    /**
+     * @param translatorMapping setter
+     */
+    void setTranslatorMapping(Map<TranslatorKey, Collection<IMDMessageTranslator<IN, List<OUT>>>> translatorMapping);
 }