├── .gitignore
├── pom.xml
├── src
    └── main
    │   └── java
    │       └── us
    │           └── dot
    │               └── faa
    │                   └── swim
    │                       └── jms
    │                           ├── JmsClient.java
    │                           ├── JmsClientConfig.java
    │                           └── JmsMessageProcessor.java
├── README.md
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
1 | /target/
2 | .settings/
3 | .classpath
4 | .project


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
 1 | <project xmlns="http://maven.apache.org/POM/4.0.0"
 2 | 	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 3 | 	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 4 | 	<modelVersion>4.0.0</modelVersion>
 5 | 	<groupId>us.dot.faa.swim.jms</groupId>
 6 | 	<artifactId>jms-client</artifactId>
 7 | 	<version>1.0</version>
 8 | 	<name>SWIM JMS Client</name>
 9 | 	<description>Basic SWIM Client to connect and consumer messages from SWIM</description>
10 | 
11 | 	<properties>
12 | 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
13 | 		<maven.compiler.source>11</maven.compiler.source>
14 | 		<maven.compiler.target>11</maven.compiler.target>
15 | 	</properties>
16 | 
17 | 	<dependencies>
18 | 		<dependency>
19 | 			<groupId>org.apache.geronimo.specs</groupId>
20 | 			<artifactId>geronimo-jms_1.1_spec</artifactId>
21 | 			<version>1.1.1</version>
22 | 		</dependency>
23 | 		<dependency>
24 | 			<groupId>io.dropwizard.metrics</groupId>
25 | 			<artifactId>metrics-core</artifactId>
26 | 			<version>3.1.2</version>
27 | 		</dependency>
28 | 	</dependencies>
29 | 
30 | 	<build>
31 | 		<pluginManagement>
32 | 			<plugins>
33 | 				<plugin>
34 | 					<groupId>org.apache.maven.plugins</groupId>
35 | 					<artifactId>maven-compiler-plugin</artifactId>
36 | 					<version>2.3.1</version>
37 | 					<configuration>
38 | 						<source>11</source>
39 | 						<target>11</target>
40 | 					</configuration>
41 | 				</plugin>
42 | 			</plugins>
43 | 		</pluginManagement>
44 | 		<plugins>
45 | 			<plugin>
46 | 				<groupId>org.apache.maven.plugins</groupId>
47 | 				<artifactId>maven-dependency-plugin</artifactId>
48 | 				<executions>
49 | 					<execution>
50 | 						<id>copy-dependencies</id>
51 | 						<phase>prepare-package</phase>
52 | 						<goals>
53 | 							<goal>copy-dependencies</goal>
54 | 						</goals>
55 | 						<configuration>
56 | 							<outputDirectory>${project.build.directory}/lib</outputDirectory>
57 | 							<overWriteReleases>false</overWriteReleases>
58 | 							<overWriteSnapshots>false</overWriteSnapshots>
59 | 							<overWriteIfNewer>true</overWriteIfNewer>
60 | 						</configuration>
61 | 					</execution>
62 | 				</executions>
63 | 			</plugin>
64 | 		</plugins>
65 | 	</build>
66 | </project>


--------------------------------------------------------------------------------
/src/main/java/us/dot/faa/swim/jms/JmsClient.java:
--------------------------------------------------------------------------------
 1 | package us.dot.faa.swim.jms;
 2 | 
 3 | import javax.jms.Connection;
 4 | import javax.jms.ConnectionFactory;
 5 | import javax.jms.Destination;
 6 | import javax.jms.ExceptionListener;
 7 | import javax.jms.JMSException;
 8 | import javax.jms.MessageConsumer;
 9 | import javax.jms.Session;
10 | import javax.naming.InitialContext;
11 | import javax.naming.NamingException;
12 | 
13 | public class JmsClient {
14 | 
15 | 	private JmsClientConfig config;
16 | 	private InitialContext initialcontext;
17 | 	private ConnectionFactory connectionFactory;
18 | 	private Connection connection;
19 | 
20 | 	public JmsClient(JmsClientConfig config) throws NamingException {
21 | 		this.config = config;
22 | 		this.initialcontext = new InitialContext(config.getJndiProperties());
23 | 	}
24 | 
25 | 	public JmsClientConfig getConfig() {
26 | 		return this.config;
27 | 	}
28 | 	
29 | 	public JmsClientConfig setConfig(JmsClientConfig config) {
30 | 		this.config = config;
31 | 		return this.config;
32 | 	}
33 | 	
34 | 	public void reInitialize() throws NamingException
35 | 	{
36 | 		this.initialcontext.close();
37 | 		this.initialcontext = new InitialContext(config.getJndiProperties());
38 | 	}
39 | 
40 | 	public void connect(final String connectionFactoryName) throws NamingException, JMSException {
41 | 		this.connectionFactory = (ConnectionFactory) this.initialcontext.lookup(connectionFactoryName);
42 | 		this.connection = this.connectionFactory.createConnection();
43 | 		this.connection.start();
44 | 	}
45 | 
46 | 	public void connect(final String connectionFactoryName, ExceptionListener exceptionListener)
47 | 			throws NamingException, JMSException {
48 | 		this.connectionFactory = (ConnectionFactory) this.initialcontext.lookup(connectionFactoryName);
49 | 		this.connection = this.connectionFactory.createConnection();
50 | 		this.connection.setExceptionListener(exceptionListener);
51 | 		this.connection.start();
52 | 	}
53 | 	
54 | 	public void close() throws NamingException {
55 | 		this.initialcontext.close();
56 | 	}
57 | 
58 | 	public MessageConsumer createConsumer(String destinationName) throws Exception {
59 | 		return createConsumer(destinationName, Session.AUTO_ACKNOWLEDGE);
60 | 	}
61 | 
62 | 	
63 | 	public MessageConsumer createConsumer(String destinationName, int ackMode) throws Exception {
64 | 
65 | 		Destination destination = (Destination) this.initialcontext.lookup(destinationName);
66 | 		Session session = this.connection.createSession(false, ackMode);
67 | 		MessageConsumer messageConsumer = session.createConsumer(destination);
68 | 		return messageConsumer;
69 | 	}	
70 | 
71 | }


--------------------------------------------------------------------------------
/src/main/java/us/dot/faa/swim/jms/JmsClientConfig.java:
--------------------------------------------------------------------------------
 1 | package us.dot.faa.swim.jms;
 2 | 
 3 | import java.util.Hashtable;
 4 | 
 5 | public class JmsClientConfig {
 6 | 
 7 | 	private Hashtable<String, Object> jndiProperties = new Hashtable<String, Object>();
 8 | 
 9 | 	public JmsClientConfig() {}
10 | 	
11 | 	public JmsClientConfig(Hashtable<String, Object> jndiProperties) {
12 | 		this.jndiProperties = jndiProperties;
13 | 	}
14 | 	
15 | 	public String getInitialContextFactory() {
16 | 		return (String)this.jndiProperties.get("java.naming.factory.initial");
17 | 	}
18 | 
19 | 	public String getProviderUrl() {
20 | 		return (String)this.jndiProperties.get("java.naming.provider.url");
21 | 	}
22 | 
23 | 	public String getUsername() {
24 | 		return (String)this.jndiProperties.get("java.naming.security.principal");
25 | 	}
26 | 
27 | 	public String getPassword() {
28 | 		return (String)this.jndiProperties.get("java.naming.security.credentials");
29 | 	}
30 | 	
31 | 	public String getSolaceMessageVpn() {
32 | 		return (String)this.jndiProperties.get("Solace_JMS_VPN");
33 | 	}
34 | 	
35 | 	public String getSolaceSslTrustStore() {
36 | 		return (String)this.jndiProperties.get("Solace_JMS_SSL_TrustStore");
37 | 	}
38 | 	
39 | 	public String getSolaceJndiConnectionRetries() {
40 | 		return (String)this.jndiProperties.get("Solace_JMS_JNDI_ConnectRetries");
41 | 	}
42 | 
43 | 	public Hashtable<String, Object> getJndiProperties() {
44 | 		return this.jndiProperties;
45 | 	}
46 | 
47 | 	public JmsClientConfig setInitialContextFactory(String initialContextFactory) {		
48 | 		this.jndiProperties.put("java.naming.factory.initial",initialContextFactory);
49 | 		return this;
50 | 	}
51 | 
52 | 	public JmsClientConfig setProviderUrl(String providerUrl) {
53 | 		this.jndiProperties.put("java.naming.provider.url",providerUrl);
54 | 		return this;
55 | 	}
56 | 
57 | 	public JmsClientConfig setUsername(String username) {
58 | 		this.jndiProperties.put("java.naming.security.principal", username);
59 | 		return this;
60 | 	}
61 | 
62 | 	public JmsClientConfig setPassword(String password) {
63 | 		this.jndiProperties.put("java.naming.security.credentials", password);
64 | 		return this;
65 | 	}
66 | 
67 | 	public JmsClientConfig setJndiProperties(Hashtable<String, Object> additionalJndiProperties) {
68 | 		this.jndiProperties.putAll(additionalJndiProperties);
69 | 		return this;
70 | 	}
71 | 	
72 | 	public JmsClientConfig setSolaceMessageVpn(String solaceMessageVpn) {
73 | 		this.jndiProperties.put("Solace_JMS_VPN",solaceMessageVpn);
74 | 		return this;
75 | 	}
76 | 	
77 | 	public JmsClientConfig setSolaceSslTrustStore(String solaceSslTrustStore) {
78 | 		this.jndiProperties.put("Solace_JMS_SSL_TrustStore",solaceSslTrustStore);
79 | 		return this;
80 | 	}
81 | 	
82 | 	public JmsClientConfig setSolaceJndiConnectionRetries(int solaceJndiConnectionRetries) {
83 | 		this.jndiProperties.put("Solace_JMS_JNDI_ConnectRetries", solaceJndiConnectionRetries);
84 | 		return this;
85 | 	}
86 | }


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # FAA SWIM JMS Client
  2 | 
  3 | Provides a very basic JMS Client that simplifies connecting and consuming from FAA SWIM.
  4 | 
  5 | 
  6 | ## Installing
  7 | 
  8 |   1. Clone this repository
  9 |   2. Run mvn clean install
 10 |   3. Add dependency to applicable project pom
 11 | 
 12 | ```xml
 13 | 	<dependency>
 14 | 		<groupId>us.dot.faa.swim.jms</groupId>
 15 | 		<artifactId>jms-client</artifactId>
 16 | 		<version>1.0</version>
 17 | 	</dependency>
 18 | ```
 19 | 
 20 | ## Usage
 21 | 
 22 | Import SWIM JMS Client 
 23 | 
 24 | ```java
 25 | 	import us.dot.faa.swim.jms.JmsClient;
 26 | 	import us.dot.faa.swim.jms.JmsClientConfig;
 27 | ```
 28 | 
 29 | Create new JMS Client Config
 30 | 
 31 | ```java
 32 | 	JmsClientConfig jmsClientConfig = new JmsClientConfig()
 33 |                 .setInitialContextFactory("Initial_Context_Factory_Class")
 34 |                 .setProviderUrl("Provider_Url")
 35 |                 .setUsername("Username")
 36 |                 .setPassword("Password")
 37 |                 // Solace applicable properties, if required
 38 |                 .setSolaceMessageVpn("Solace_Message_Vpn")
 39 |                 .setSolaceSslTrustStore("path/to/ssl/trust")
 40 |                 .setSolaceJndiConnectionRetries(-1);
 41 | ```
 42 | 
 43 | Create new JMS Client form Config
 44 | 
 45 | ```java
 46 | 	JmsClient jmsClient = new JmsClient(jmsClientConfig);
 47 | ```
 48 | 
 49 | Connect JMS Client
 50 | 
 51 | ```java
 52 | 	jmsClient.connect("Connection_Factory_Name");
 53 | ```
 54 | 
 55 | Create one or more Message Consumers
 56 | 
 57 | ```java
 58 | 	MessageConsumer consumer = jmsClient.createConsumer("JMS_DESTINATION");
 59 | 	
 60 | ```
 61 | 
 62 | Consuming using an Asynchronous Message Consumer
 63 | 	
 64 | 
 65 | ```java
 66 | 	consumer.setMessageListener(this);
 67 | ```
 68 | 
 69 | ```java
 70 | 	@Override
 71 | 	public void onMessage(Message jmsMessage) {
 72 | 		//assuming message is of type text message
 73 | 		System.out.println(((TextMessage)jmsMessage).getText());
 74 | 	}
 75 | ```
 76 | 
 77 | Consuming using an Synchronous Message Consumer
 78 | 
 79 | ```java
 80 | 	Message jmsMessage = consumer.recieve();
 81 | 	
 82 | 	//assuming message is of type text message
 83 | 	System.out.println(((TextMessage)jmsMessage).getText());
 84 | ```
 85 | 
 86 | ## JMS Message Processor
 87 | 
 88 | JMS Message Processor provides a high performance processor that takes one or more MessageConsumers, consumes messages, and queues for single threaded or parallel processing.  If consumption rate is faster than processing rate, resulting in processing queue reaching max capacity, consumption will be stopped until processing threads are available. This allows for cases of either inbound message bursts or a delay in processing (e.g. writing to a database). If consumption yielding happens often, increase the parallel processor count and/or the processing queue size accordingly. If consumption rate is insufficient, increase the concurrent consumer count accordingly. Processing logic is controlled via the MessageListener interface onMessage method.
 89 | 
 90 | ```java
 91 | 
 92 | 	String jmsDestination = "JMS_DESTINATION";
 93 | 	int concurrentConsumerCount = 4;
 94 | 	int parallelProcessorCount = 2;
 95 | 	int processingQueueSize = 10000;
 96 | 	ArrayList<MessageConsumer> consumers = new ArrayList<MessageConsumer>();
 97 | 	
 98 | 	for(int i=0; i < concurrentConsumerCount; i++) {
 99 | 	MessageConsumer consumer = jmsClient.createConsumer(jmsDestination);
100 | 		consumers.add(consumer);
101 | 	}
102 | 
103 | 	JmsMessageProcessor processor = new JmsMessageProcessor(consumers, parallelProcessorCount, processingQueueSize, this);
104 | 	
105 | 	processor.start();
106 | 	
107 | 	//do other stuff//
108 | 	
109 | 	//stop processor before exiting application
110 | 	processor.stop();
111 | 	
112 | ```
113 | 
114 | ```java
115 | 
116 | 	public void onMessage(Message jmsMessage) {
117 | 		try {					
118 | 			//assuming message is of type text message
119 | 			System.out.println(((TextMessage)jmsMessage).getText());
120 | 		} catch (Exception e) {
121 | 			e.printStackTrace();
122 | 		}
123 | 	}
124 | ```
125 | 


--------------------------------------------------------------------------------
/src/main/java/us/dot/faa/swim/jms/JmsMessageProcessor.java:
--------------------------------------------------------------------------------
  1 | package us.dot.faa.swim.jms;
  2 | 
  3 | import java.time.Instant;
  4 | import java.util.ArrayList;
  5 | import java.util.List;
  6 | 
  7 | import java.util.concurrent.CountDownLatch;
  8 | import java.util.concurrent.LinkedBlockingQueue;
  9 | import java.util.concurrent.RejectedExecutionHandler;
 10 | import java.util.concurrent.ThreadPoolExecutor;
 11 | import java.util.concurrent.TimeUnit;
 12 | import java.util.concurrent.locks.Lock;
 13 | import java.util.concurrent.locks.ReentrantLock;
 14 | 
 15 | import javax.jms.JMSException;
 16 | import javax.jms.Message;
 17 | import javax.jms.MessageConsumer;
 18 | import javax.jms.MessageListener;
 19 | 
 20 | import com.codahale.metrics.Meter;
 21 | 
 22 | public class JmsMessageProcessor implements MessageListener {
 23 | 	int processingThreadCount;
 24 | 	ThreadPoolExecutor executor;
 25 | 	int processingQueueSize = 100;
 26 | 	int consumptionYieldTimeInSeconds = 1;
 27 | 	Instant suspendConsumptionUntil = Instant.now();
 28 | 	Meter consumedMessagesMeter = new Meter();
 29 | 	Meter processedMessagesMeter = new Meter();
 30 | 	List<MessageConsumer> consumers;
 31 | 	MessageListener messageListener;
 32 | 	boolean running = false;
 33 | 
 34 | 	final CountDownLatch latch = new CountDownLatch(1);
 35 | 
 36 | 	public JmsMessageProcessor(MessageConsumer consumer, int processingThreadCount, int processingQueueSize,
 37 | 			MessageListener messageListener) throws JMSException {
 38 | 
 39 | 		final List<MessageConsumer> consumerList = new ArrayList<MessageConsumer>();
 40 | 		consumerList.add(consumer);
 41 | 		initialize(consumerList, processingThreadCount, processingQueueSize, messageListener);
 42 | 	}
 43 | 
 44 | 	public JmsMessageProcessor(List<MessageConsumer> consumers, int processingThreadCount, int processingQueueSize,
 45 | 			MessageListener messageListener) throws Exception {
 46 | 
 47 | 		initialize(consumers, processingThreadCount, processingQueueSize, messageListener);
 48 | 	}
 49 | 
 50 | 	private void initialize(List<MessageConsumer> consumers, int processingThreadCount, int processingQueueSize,
 51 | 			MessageListener messageListener) throws JMSException {
 52 | 
 53 | 		this.messageListener = messageListener;
 54 | 		this.processingQueueSize = processingQueueSize;
 55 | 		this.processingThreadCount = processingThreadCount;
 56 | 		this.consumers = consumers;
 57 | 	}
 58 | 
 59 | 	public void onMessage(Message message) {
 60 | 		if (message != null) {
 61 | 			executor.execute(new Runnable() {
 62 | 				@Override
 63 | 				public void run() {
 64 | 					messageListener.onMessage(message);
 65 | 					processedMessagesMeter.mark();
 66 | 				}
 67 | 			});
 68 | 			consumedMessagesMeter.mark();
 69 | 		}
 70 | 	}
 71 | 
 72 | 	public int getConsumptionYeildTimeInSeconds() {
 73 | 		return this.consumptionYieldTimeInSeconds;
 74 | 	}
 75 | 
 76 | 	public JmsMessageProcessor setConsumptionYeildTimeInSeconds(int yieldTimeInSeconds) {
 77 | 		this.consumptionYieldTimeInSeconds = yieldTimeInSeconds;
 78 | 		return this;
 79 | 	}
 80 | 
 81 | 	public long getTotalConsumedMessages() {
 82 | 		return this.consumedMessagesMeter.getCount();
 83 | 	}
 84 | 
 85 | 	public double getConsumedMessagePerSecond() {
 86 | 		return this.consumedMessagesMeter.getOneMinuteRate();
 87 | 	}
 88 | 
 89 | 	public long getTotalProcessedMessages() {
 90 | 		return this.processedMessagesMeter.getCount();
 91 | 	}
 92 | 
 93 | 	public double getProcessedMessagePerSecond() {
 94 | 		return this.processedMessagesMeter.getOneMinuteRate();
 95 | 	}
 96 | 
 97 | 	public int getQueuedMessageCount() {
 98 | 		return this.executor.getQueue().size();
 99 | 	}
100 | 
101 | 	public void start() throws JMSException {
102 | 
103 | 		this.running = true;
104 | 		executor = new ThreadPoolExecutor(processingThreadCount, processingThreadCount, 0L, TimeUnit.MILLISECONDS,
105 | 				new LinkedBlockingQueue<Runnable>(processingQueueSize), new RunInCallingThreadOrThrow());
106 | 
107 | 		for (MessageConsumer messageConsumer : this.consumers) {
108 | 			try {
109 | 				messageConsumer.setMessageListener(this);
110 | 			} catch (Exception e) {
111 | 				throw e;
112 | 			}
113 | 		}
114 | 	}
115 | 
116 | 	public void stop() throws Exception {
117 | 
118 | 		for (MessageConsumer messageConsumer : this.consumers) {
119 | 			try {
120 | 				messageConsumer.setMessageListener(null);
121 | 			} catch (Exception e) {
122 | 				throw e;
123 | 			}
124 | 		}
125 | 
126 | 		this.running = false;
127 | 		executor.shutdown();
128 | 		executor.awaitTermination(10, TimeUnit.SECONDS);
129 | 	}
130 | 
131 | 	class RunInCallingThreadOrThrow implements RejectedExecutionHandler {
132 | 
133 | 		private final Lock lock = new ReentrantLock();
134 | 
135 | 		@Override
136 | 		public void rejectedExecution(Runnable r, ThreadPoolExecutor executor) {
137 | 			lock.lock();
138 | 			try {
139 | 				if (!executor.isShutdown()) {
140 | 					r.run();
141 | 				} else {
142 | 					throw new RuntimeException(new Exception("Executor Shutdown"));
143 | 				}
144 | 			} finally
145 | 
146 | 			{
147 | 				lock.unlock();
148 | 			}
149 | 		}
150 | 	}
151 | 
152 | }
153 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                                  Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "[]"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright [yyyy] [name of copyright owner]
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.
202 | 


--------------------------------------------------------------------------------