Issue #450. First commit. Queue Based Load Leveling

pom.xml

@@ -17,9 +17,7 @@
     LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
     OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
     THE SOFTWARE.
--->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+--><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.iluwatar</groupId>
     <artifactId>java-design-patterns</artifactId>
@@ -133,6 +131,7 @@
         <module>promise</module>
         <module>page-object</module>
         <module>event-asynchronous</module>
+        <module>queue-load-leveling</module>
         <module>object-mother</module>
     </modules>
 
@@ -312,7 +311,7 @@
                                 		</goals>
                                 	</pluginExecutionFilter>
                                 	<action>
-                                		<ignore></ignore>
+                                		<ignore/>
                                 	</action>
                                 </pluginExecution>
                             </pluginExecutions>
@@ -466,4 +465,4 @@
         </plugins>
     </reporting>
 
-</project>
+</project>

queue-load-leveling/README.md

@@ -0,0 +1,34 @@
+---
+layout: pattern
+title: Queue based load leveling
+folder: queue-load-leveling
+permalink: /patterns/queue-load-leveling/
+pumlid: 
+categories: Other
+tags:
+ - Java
+ - Difficulty-Intermediate
+ - Performance
+---
+
+## Intent
+Use a queue that acts as a buffer between a task and a service that it invokes in order to smooth 
+intermittent heavy loads that may otherwise cause the service to fail or the task to time out. 
+This pattern can help to minimize the impact of peaks in demand on availability and responsiveness 
+for both the task and the service.
+
+![alt text](./etc/queue-load-leveling.gif "queue-load-leveling")
+
+
+## Applicability
+
+* This pattern is ideally suited to any type of application that uses services that may be subject to overloading.
+* This pattern might not be suitable if the application expects a response from the service with minimal latency.
+
+## Real world example
+
+* A Microsoft Azure web role stores data by using a separate storage service. If a large number of instances of the web role run concurrently, it is possible that the storage service could be overwhelmed and be unable to respond to requests quickly enough to prevent these requests from timing out or failing. 
+
+## Credits
+
+* [Microsoft Cloud Design Patterns: Queue-Based Load Leveling Pattern](https://msdn.microsoft.com/en-us/library/dn589783.aspx)

queue-load-leveling/etc/queue-load-leveling.ucls

@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<class-diagram version="1.1.11" icons="true" always-add-relationships="false" generalizations="true" realizations="true" 
+  associations="true" dependencies="false" nesting-relationships="true" router="FAN">  
+  <class id="1" language="java" name="org.queue.load.leveling.TaskGenerator" project="queue-load-leveling" 
+    file="/queue-load-leveling/src/main/java/org/queue/load/leveling/TaskGenerator.java" binary="false" 
+    corner="BOTTOM_RIGHT">    
+    <position height="-1" width="-1" x="470" y="213"/>    
+    <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
+      sort-features="false" accessors="true" visibility="true">      
+      <attributes public="true" package="true" protected="true" private="true" static="true"/>      
+      <operations public="true" package="true" protected="true" private="true" static="true"/>    
+    </display>  
+  </class>  
+  <interface id="2" language="java" name="org.queue.load.leveling.Task" project="queue-load-leveling" 
+    file="/queue-load-leveling/src/main/java/org/queue/load/leveling/Task.java" binary="false" corner="BOTTOM_RIGHT">    
+    <position height="-1" width="-1" x="426" y="389"/>    
+    <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
+      sort-features="false" accessors="true" visibility="true">      
+      <attributes public="true" package="true" protected="true" private="true" static="true"/>      
+      <operations public="true" package="true" protected="true" private="true" static="true"/>    
+    </display>  
+  </interface>  
+  <class id="3" language="java" name="org.queue.load.leveling.MessageQueue" project="queue-load-leveling" 
+    file="/queue-load-leveling/src/main/java/org/queue/load/leveling/MessageQueue.java" binary="false" 
+    corner="BOTTOM_RIGHT">    
+    <position height="-1" width="-1" x="661" y="419"/>    
+    <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
+      sort-features="false" accessors="true" visibility="true">      
+      <attributes public="true" package="true" protected="true" private="true" static="true"/>      
+      <operations public="true" package="true" protected="true" private="true" static="true"/>    
+    </display>  
+  </class>  
+  <class id="4" language="java" name="org.queue.load.leveling.Message" project="queue-load-leveling" 
+    file="/queue-load-leveling/src/main/java/org/queue/load/leveling/Message.java" binary="false" corner="BOTTOM_RIGHT">    
+    <position height="-1" width="-1" x="594" y="657"/>    
+    <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
+      sort-features="false" accessors="true" visibility="true">      
+      <attributes public="true" package="true" protected="true" private="true" static="true"/>      
+      <operations public="true" package="true" protected="true" private="true" static="true"/>    
+    </display>  
+  </class>  
+  <class id="5" language="java" name="org.queue.load.leveling.ServiceExecutor" project="queue-load-leveling" 
+    file="/queue-load-leveling/src/main/java/org/queue/load/leveling/ServiceExecutor.java" binary="false" 
+    corner="BOTTOM_RIGHT">    
+    <position height="-1" width="-1" x="775" y="193"/>    
+    <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
+      sort-features="false" accessors="true" visibility="true">      
+      <attributes public="true" package="true" protected="true" private="true" static="true"/>      
+      <operations public="true" package="true" protected="true" private="true" static="true"/>    
+    </display>  
+  </class>  
+  <realization id="6">    
+    <end type="SOURCE" refId="1"/>    
+    <end type="TARGET" refId="2"/>  
+  </realization>  
+  <association id="7">    
+    <end type="SOURCE" refId="1" navigable="false">      
+      <attribute id="8" name="msgQueue"/>      
+      <multiplicity id="9" minimum="0" maximum="1"/>    
+    </end>    
+    <end type="TARGET" refId="3" navigable="true"/>    
+    <display labels="true" multiplicity="true"/>  
+  </association>  
+  <association id="10">    
+    <end type="SOURCE" refId="3" navigable="false">      
+      <attribute id="11" name="blkQueue"/>      
+      <multiplicity id="12" minimum="0" maximum="2147483647"/>    
+    </end>    
+    <end type="TARGET" refId="4" navigable="true"/>    
+    <display labels="true" multiplicity="true"/>  
+  </association>  
+  <association id="13">    
+    <end type="SOURCE" refId="5" navigable="false">      
+      <attribute id="14" name="msgQueue"/>      
+      <multiplicity id="15" minimum="0" maximum="1"/>    
+    </end>    
+    <end type="TARGET" refId="3" navigable="true"/>    
+    <display labels="true" multiplicity="true"/>  
+  </association>  
+  <classifier-display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
+    sort-features="false" accessors="true" visibility="true">    
+    <attributes public="true" package="true" protected="true" private="true" static="true"/>    
+    <operations public="true" package="true" protected="true" private="true" static="true"/>  
+  </classifier-display>  
+  <association-display labels="true" multiplicity="true"/>
+</class-diagram>

queue-load-leveling/etc/queue-load-leveling.urm.puml

@@ -0,0 +1,2 @@
+@startuml
+@enduml

queue-load-leveling/pom.xml

@@ -0,0 +1,42 @@
+<?xml version="1.0"?>
+<!--
+
+    The MIT License
+    Copyright (c) 2014 Ilkka Seppälä
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in
+    all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+    THE SOFTWARE.
+
+-->
+<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>com.iluwatar</groupId>
+    <artifactId>java-design-patterns</artifactId>
+    <version>1.14.0-SNAPSHOT</version>
+  </parent>
+  <artifactId>queue-load-leveling</artifactId>
+  <dependencies>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+</project>

queue-load-leveling/src/main/java/org/queue/load/leveling/App.java

@@ -0,0 +1,119 @@
+/**
+ * The MIT License
+ * Copyright (c) 2014 Ilkka Seppälä
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package org.queue.load.leveling;
+
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.TimeUnit;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * 
+ * Many solutions in the cloud involve running tasks that invoke services. In this environment, 
+ * if a service is subjected to intermittent heavy loads, it can cause performance or reliability issues.
+ * <p>
+ * A service could be a component that is part of the same solution as the tasks that utilize it, or it 
+ * could be a third-party service providing access to frequently used resources such as a cache or a storage service.
+ * If the same service is utilized by a number of tasks running concurrently, it can be difficult to predict the 
+ * volume of requests to which the service might be subjected at any given point in time.
+ * <p>
+ * We will build a queue-based-load-leveling to solve above problem. 
+ * Refactor the solution and introduce a queue between the task and the service. 
+ * The task and the service run asynchronously. The task posts a message containing the data required 
+ * by the service to a queue. The queue acts as a buffer, storing the message until it is retrieved 
+ * by the service. The service retrieves the messages from the queue and processes them. 
+ * Requests from a number of tasks, which can be generated at a highly variable rate, can be passed 
+ * to the service through the same message queue.
+ * <p>
+ * The queue effectively decouples the tasks from the service, and the service can handle the messages 
+ * at its own pace irrespective of the volume of requests from concurrent tasks. Additionally, 
+ * there is no delay to a task if the service is not available at the time it posts a message to the queue.
+ * <p>
+ * In this example we have a class {@link MessageQueue} to hold the message {@link Message} objects. 
+ * All the worker threads {@link TaskGenerator} will submit the messages to the MessageQueue. 
+ * The service executor class {@link ServiceExecutor} will pick up one task at a time from the Queue and 
+ * execute them.
+ *  
+ */
+public class App {
+
+  private static final Logger LOGGER = LoggerFactory.getLogger(App.class);
+
+  //Executor shut down time limit.
+  private static final int SHUTDOWN_TIME = 15;
+
+  /**
+   * Program entry point
+   * 
+   * @param args command line args
+   */
+  public static void main(String[] args) {
+
+    // An Executor that provides methods to manage termination and methods that can 
+    // produce a Future for tracking progress of one or more asynchronous tasks.
+    ExecutorService executor = null;
+
+    try {
+      // Create a MessageQueue object.
+      MessageQueue msgQueue = new MessageQueue();
+
+      LOGGER.info("Submitting TaskGenerators and ServiceExecutor threads.");
+
+      // Create three TaskGenerator threads. Each of them will submit different number of jobs.
+      Runnable taskRunnable1 = new TaskGenerator(msgQueue, 5);
+      Runnable taskRunnable2 = new TaskGenerator(msgQueue, 1);
+      Runnable taskRunnable3 = new TaskGenerator(msgQueue, 2);
+
+      // Create e service which should process the submitted jobs.
+      Runnable srvRunnable = new ServiceExecutor(msgQueue);
+
+      // Create a ThreadPool of 2 threads and
+      // submit all Runnable task for execution to executor..
+      executor = Executors.newFixedThreadPool(2);
+      executor.submit(taskRunnable1);
+      executor.submit(taskRunnable2);
+      executor.submit(taskRunnable3);
+
+      // submitting serviceExecutor thread to the Executor service.
+      executor.submit(srvRunnable);
+
+      // Initiates an orderly shutdown.
+      LOGGER.info("Intiating shutdown. Executor will shutdown only after all the Threads are completed.");
+      executor.shutdown();
+
+      // Wait for SHUTDOWN_TIME seconds for all the threads to complete 
+      // their tasks and then shut down the executor and then exit. 
+      if ( !executor.awaitTermination(SHUTDOWN_TIME, TimeUnit.SECONDS) ) {
+        LOGGER.info("Executor was shut down and Exiting.");
+        executor.shutdownNow();
+      }
+    } catch (InterruptedException ie) {
+      LOGGER.error(ie.getMessage());
+    } catch (Exception e) {
+      LOGGER.error(e.getMessage());
+    }
+  }
+}

queue-load-leveling/src/main/java/org/queue/load/leveling/Message.java

@@ -0,0 +1,47 @@
+/**
+ * The MIT License
+ * Copyright (c) 2014 Ilkka Seppälä
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package org.queue.load.leveling;
+
+/**
+ *  Message class with only one parameter.
+ *
+*/
+public class Message {
+  private final String msg;
+
+  // Parameter constructor.
+  public Message(String msg) {
+    super();
+    this.msg = msg;
+  }
+
+  // Get Method for attribute msg.
+  public String getMsg() {
+    return msg;
+  }
+
+  @Override
+  public String toString() {
+    return msg;
+  }
+}