Fix Logger use

[openflowjava.git] / simple-client / src / main / java / org / opendaylight / openflowjava / protocol / impl / clients / ScenarioHandler.java

diff --git a/simple-client/src/main/java/org/opendaylight/openflowjava/protocol/impl/clients/ScenarioHandler.java b/simple-client/src/main/java/org/opendaylight/openflowjava/protocol/impl/clients/ScenarioHandler.java
index 9e8a8025d299399f248c79d49b92979d48d2d90d..57865d88601b10b333e51c538c7a83cc08746ee5 100644 (file)
--- a/simple-client/src/main/java/org/opendaylight/openflowjava/protocol/impl/clients/ScenarioHandler.java
+++ b/simple-client/src/main/java/org/opendaylight/openflowjava/protocol/impl/clients/ScenarioHandler.java
@@ -1,9 +1,16 @@
-/* Copyright (C)2013 Pantheon Technologies, s.r.o. All rights reserved. */
+/*
+ * Copyright (c) 2013 Pantheon Technologies s.r.o. and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
 package org.opendaylight.openflowjava.protocol.impl.clients;
 
 import io.netty.channel.ChannelHandlerContext;
 
-import java.util.Stack;
+import java.util.Deque;
 import java.util.concurrent.BlockingQueue;
 import java.util.concurrent.LinkedBlockingQueue;
 import java.util.concurrent.TimeUnit;
@@ -11,19 +18,25 @@ import java.util.concurrent.TimeUnit;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-
+/**
+ *
+ * @author michal.polkorab
+ *
+ */
 public class ScenarioHandler extends Thread {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(ScenarioHandler.class);
-    private Stack<ClientEvent> scenario;
+    private Deque<ClientEvent> scenario;
     private BlockingQueue<byte[]> ofMsg;
     private ChannelHandlerContext ctx;
+    private int eventNumber;
+    private boolean scenarioFinished = false;
 
     /**
-     * 
+     *
      * @param scenario
      */
-    public ScenarioHandler(Stack<ClientEvent> scenario) {
+    public ScenarioHandler(Deque<ClientEvent> scenario) {
         this.scenario = scenario;
         ofMsg = new LinkedBlockingQueue<>();
     }
@@ -32,7 +45,8 @@ public class ScenarioHandler extends Thread {
     public void run() {
         int freezeCounter = 0;
         while (!scenario.isEmpty()) {
-            ClientEvent peek = scenario.peek();
+            LOGGER.debug("Running event #{}", eventNumber);
+            ClientEvent peek = scenario.peekLast();
             if (peek instanceof WaitForMessageEvent) {
                 LOGGER.debug("WaitForMessageEvent");
                 try {
@@ -48,13 +62,14 @@ public class ScenarioHandler extends Thread {
                 event.setCtx(ctx);
             }
             if (peek.eventExecuted()) {
-                scenario.pop();
+                scenario.removeLast();
+                eventNumber++;
                 freezeCounter = 0;
             } else {
                 freezeCounter++;
             }
             if (freezeCounter > 2) {
-                LOGGER.warn("Scenario freezed: " + freezeCounter);
+                LOGGER.warn("Scenario frozen: {}", freezeCounter);
                 break;
             }
             try {
@@ -63,29 +78,52 @@ public class ScenarioHandler extends Thread {
                 LOGGER.error(e.getMessage(), e);
             }
         }
-        LOGGER.info("Scenario finished");
+        LOGGER.debug("Scenario finished");
         synchronized (this) {
-            notify();
+            scenarioFinished = true;
+            this.notify();
         }
     }
 
+    /**
+     * @return true if scenario is done / empty
+     */
     public boolean isEmpty() {
         return scenario.isEmpty();
     }
 
-    public Stack<ClientEvent> getScenario() {
+    /**
+     * @return scenario
+     */
+    public Deque<ClientEvent> getScenario() {
         return scenario;
     }
 
-    public void setScenario(Stack<ClientEvent> scenario) {
+    /**
+     * @param scenario scenario filled with desired events
+     */
+    public void setScenario(Deque<ClientEvent> scenario) {
         this.scenario = scenario;
     }
 
+    /**
+     * @param ctx context which will be used for sending messages (SendEvents)
+     */
     public void setCtx(ChannelHandlerContext ctx) {
         this.ctx = ctx;
     }
 
+    /**
+     * @param message received message that is compared to expected message
+     */
     public void addOfMsg(byte[] message) {
         ofMsg.add(message);
     }
+
+    /**
+     * @return true is scenario is finished
+     */
+    public boolean isScenarioFinished() {
+        return scenarioFinished;
+    }
 }