├── .travis.yml
├── resources
    ├── flink_job.png
    └── streamers.png
├── .gitignore
├── dependency-reduced-pom.xml
├── src
    └── main
    │   ├── java
    │       └── com
    │       │   └── samaitra
    │       │       └── SocketWindowWordCount.java
    │   └── resources
    │       └── example-ignite.xml
├── pom.xml
├── README.md
└── LICENSE


/.travis.yml:
--------------------------------------------------------------------------------
1 | language: java
2 |   mvn install


--------------------------------------------------------------------------------
/resources/flink_job.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/samaitra/streamers/HEAD/resources/flink_job.png


--------------------------------------------------------------------------------
/resources/streamers.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/samaitra/streamers/HEAD/resources/streamers.png


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # Compiled class file
 2 | *.class
 3 | 
 4 | # Log file
 5 | *.log
 6 | 
 7 | # BlueJ files
 8 | *.ctxt
 9 | 
10 | # Mobile Tools for Java (J2ME)
11 | .mtj.tmp/
12 | 
13 | # Package Files #
14 | *.jar
15 | *.war
16 | *.nar
17 | *.ear
18 | *.zip
19 | *.tar.gz
20 | *.rar
21 | 
22 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
23 | hs_err_pid*
24 | 
25 | # idea
26 | .idea/*


--------------------------------------------------------------------------------
/dependency-reduced-pom.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <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/maven-v4_0_0.xsd">
 3 |   <modelVersion>4.0.0</modelVersion>
 4 |   <groupId>com.samaitra</groupId>
 5 |   <artifactId>streamers</artifactId>
 6 |   <name>streamers</name>
 7 |   <version>1.0-SNAPSHOT</version>
 8 |   <url>http://maven.apache.org</url>
 9 |   <build>
10 |     <plugins>
11 |       <plugin>
12 |         <artifactId>maven-compiler-plugin</artifactId>
13 |         <configuration>
14 |           <source>1.8</source>
15 |           <target>1.8</target>
16 |         </configuration>
17 |       </plugin>
18 |       <plugin>
19 |         <artifactId>maven-shade-plugin</artifactId>
20 |         <version>3.1.1</version>
21 |         <executions>
22 |           <execution>
23 |             <phase>package</phase>
24 |             <goals>
25 |               <goal>shade</goal>
26 |             </goals>
27 |             <configuration>
28 |               <transformers>
29 |                 <transformer>
30 |                   <mainClass>com.samaitra.SocketWindowWordCount</mainClass>
31 |                 </transformer>
32 |                 <transformer>
33 |                   <resource>META-INF/spring.handlers</resource>
34 |                 </transformer>
35 |                 <transformer>
36 |                   <resource>META-INF/spring.schemas</resource>
37 |                 </transformer>
38 |               </transformers>
39 |             </configuration>
40 |           </execution>
41 |         </executions>
42 |       </plugin>
43 |     </plugins>
44 |   </build>
45 |   <dependencies>
46 |     <dependency>
47 |       <groupId>junit</groupId>
48 |       <artifactId>junit</artifactId>
49 |       <version>3.8.1</version>
50 |       <scope>test</scope>
51 |     </dependency>
52 |   </dependencies>
53 | </project>
54 | 


--------------------------------------------------------------------------------
/src/main/java/com/samaitra/SocketWindowWordCount.java:
--------------------------------------------------------------------------------
 1 | package com.samaitra;
 2 | 
 3 | import java.util.HashMap;
 4 | import java.util.Map;
 5 | import java.util.Properties;
 6 | import org.apache.flink.api.common.functions.FlatMapFunction;
 7 | import org.apache.flink.api.common.functions.MapFunction;
 8 | import org.apache.flink.api.common.serialization.SimpleStringSchema;
 9 | import org.apache.flink.api.java.tuple.Tuple2;
10 | import org.apache.flink.configuration.Configuration;
11 | import org.apache.flink.streaming.api.datastream.DataStream;
12 | import org.apache.flink.streaming.api.datastream.SingleOutputStreamOperator;
13 | import org.apache.flink.streaming.api.environment.StreamExecutionEnvironment;
14 | import org.apache.flink.streaming.api.windowing.time.Time;
15 | import org.apache.flink.streaming.connectors.kafka.FlinkKafkaConsumer010;
16 | import org.apache.flink.util.Collector;
17 | import org.apache.ignite.sink.flink.IgniteSink;
18 | 
19 | public class SocketWindowWordCount {
20 |     public static void main(String[] args) throws Exception {
21 |         /** Ignite test configuration file. */
22 |         final String GRID_CONF_FILE = "PATH_TO_PROJECT/streamers/src/main/resources/example-ignite.xml";
23 | 
24 |         IgniteSink igniteSink = new IgniteSink("testCache", GRID_CONF_FILE);
25 | 
26 |         igniteSink.setAllowOverwrite(true);
27 | 
28 |         igniteSink.setAutoFlushFrequency(5L);
29 | 
30 |         Configuration p = new Configuration();
31 |         igniteSink.open(p);
32 | 
33 |         Properties properties = new Properties();
34 |         properties.setProperty("bootstrap.servers", "localhost:9092");
35 |         properties.setProperty("group.id", "test");
36 | 
37 |         // get the execution environment
38 |         final StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment();
39 | 
40 |         // get input data by connecting to kafka
41 |         DataStream<String> text = env
42 |             .addSource(new FlinkKafkaConsumer010<>("mytopic", new SimpleStringSchema(), properties));
43 | 
44 |         // parse the data, group it, window it, and aggregate the counts
45 |         SingleOutputStreamOperator<Map<String, Integer>> windowCounts = text
46 |             .flatMap(new Splitter())
47 |             .keyBy(0)
48 |             .timeWindow(Time.seconds(5))
49 |             .sum(1)
50 |             .map(new Mapper());
51 |         // print the results with a single thread, rather than in parallel
52 |         // windowCounts.print();
53 |         windowCounts.addSink(igniteSink);
54 |         env.execute("Window WordCount");
55 |     }
56 | 
57 |     public static class Splitter implements FlatMapFunction<String, Tuple2<String, Integer>> {
58 |         @Override
59 |         public void flatMap(String sentence, Collector<Tuple2<String, Integer>> out) throws Exception {
60 |             for (String word: sentence.split(" ")) {
61 |                 out.collect(new Tuple2<String, Integer>(word, 1));
62 |             }
63 |         }
64 |     }
65 | 
66 |     public static class Mapper implements MapFunction<Tuple2<String, Integer>, Map<String, Integer>> {
67 |         @Override
68 |         public Map<String, Integer> map(Tuple2<String, Integer> tuple2) throws Exception {
69 |             Map<String, Integer> myWordMap = new HashMap<>();
70 |             myWordMap.put(tuple2.f0, tuple2.f1);
71 |             return myWordMap;
72 |         }
73 |     }
74 | }


--------------------------------------------------------------------------------
/src/main/resources/example-ignite.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | 
 3 | <!--
 4 |   Licensed to the Apache Software Foundation (ASF) under one or more
 5 |   contributor license agreements.  See the NOTICE file distributed with
 6 |   this work for additional information regarding copyright ownership.
 7 |   The ASF licenses this file to You under the Apache License, Version 2.0
 8 |   (the "License"); you may not use this file except in compliance with
 9 |   the License.  You may obtain a copy of the License at
10 | 
11 |        http://www.apache.org/licenses/LICENSE-2.0
12 | 
13 |   Unless required by applicable law or agreed to in writing, software
14 |   distributed under the License is distributed on an "AS IS" BASIS,
15 |   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 |   See the License for the specific language governing permissions and
17 |   limitations under the License.
18 | -->
19 | 
20 | <!--
21 |     Ignite configuration with all defaults and enabled events.
22 |     Used for testing IgniteSink running Ignite in a client mode.
23 | -->
24 | <beans xmlns="http://www.springframework.org/schema/beans"
25 |        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
26 |        xmlns:util="http://www.springframework.org/schema/util"
27 |        xsi:schemaLocation="
28 |         http://www.springframework.org/schema/beans
29 |         http://www.springframework.org/schema/beans/spring-beans.xsd
30 |         http://www.springframework.org/schema/util
31 |         http://www.springframework.org/schema/util/spring-util.xsd">
32 |     <bean id="ignite.cfg" class="org.apache.ignite.configuration.IgniteConfiguration">
33 |         <!-- Enable client mode. -->
34 |         <property name="clientMode" value="false"/>
35 | 
36 |         <!-- Cache accessed from IgniteSink. -->
37 |         <property name="cacheConfiguration">
38 |             <list>
39 |                 <!-- Partitioned cache example configuration with configurations adjusted to server nodes'. -->
40 |                 <bean class="org.apache.ignite.configuration.CacheConfiguration">
41 |                     <property name="atomicityMode" value="ATOMIC"/>
42 |                     <property name="name" value="testCache"/>
43 |                 </bean>
44 |             </list>
45 |         </property>
46 | 
47 |         <!-- Enable cache events. -->
48 |         <property name="includeEventTypes">
49 |             <list>
50 |                 <!-- Cache events (only EVT_CACHE_OBJECT_PUT for tests). -->
51 |                 <util:constant static-field="org.apache.ignite.events.EventType.EVT_CACHE_OBJECT_PUT"/>
52 |                 <util:constant static-field="org.apache.ignite.events.EventType.EVT_CACHE_OBJECT_READ"/>
53 |                 <util:constant static-field="org.apache.ignite.events.EventType.EVT_CACHE_OBJECT_REMOVED"/>
54 | 
55 |             </list>
56 |         </property>
57 | 
58 |         <!-- Explicitly configure TCP discovery SPI to provide list of initial nodes. -->
59 |         <property name="discoverySpi">
60 |             <bean class="org.apache.ignite.spi.discovery.tcp.TcpDiscoverySpi">
61 |                 <property name="ipFinder">
62 |                     <bean class="org.apache.ignite.spi.discovery.tcp.ipfinder.vm.TcpDiscoveryVmIpFinder">
63 |                         <property name="addresses">
64 |                             <list>
65 |                                 <value>127.0.0.1:47500..47509</value>
66 |                             </list>
67 |                         </property>
68 |                     </bean>
69 |                 </property>
70 |             </bean>
71 |         </property>
72 |     </bean>
73 | </beans>
74 | 


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
  1 | <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2 |   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  3 |   <modelVersion>4.0.0</modelVersion>
  4 |   <groupId>com.samaitra</groupId>
  5 |   <artifactId>streamers</artifactId>
  6 |   <packaging>jar</packaging>
  7 |   <version>1.0-SNAPSHOT</version>
  8 |   <name>streamers</name>
  9 |   <url>http://maven.apache.org</url>
 10 |   <dependencies>
 11 | 
 12 |     <dependency>
 13 |       <groupId>org.apache.flink</groupId>
 14 |       <artifactId>flink-java</artifactId>
 15 |       <version>1.6.0</version>
 16 |     </dependency>
 17 |     <dependency>
 18 |       <groupId>org.apache.flink</groupId>
 19 |       <artifactId>flink-streaming-java_2.11</artifactId>
 20 |       <version>1.6.0</version>
 21 |     </dependency>
 22 |     <dependency>
 23 |       <groupId>org.apache.flink</groupId>
 24 |       <artifactId>flink-connector-kafka-0.10_2.11</artifactId>
 25 |       <version>1.6.0</version>
 26 |     </dependency>
 27 |     <dependency>
 28 |       <groupId>org.apache.ignite</groupId>
 29 |       <artifactId>ignite-core</artifactId>
 30 |       <version>2.8.1</version>
 31 |     </dependency>
 32 |     <dependency>
 33 |       <groupId>org.apache.ignite</groupId>
 34 |       <artifactId>ignite-spring</artifactId>
 35 |       <version>2.8.1</version>
 36 |     </dependency>
 37 |     <dependency>
 38 |       <groupId>org.apache.ignite</groupId>
 39 |       <artifactId>ignite-indexing</artifactId>
 40 |       <version>2.8.1</version>
 41 |     </dependency>
 42 |     <dependency>
 43 |       <groupId>org.apache.ignite</groupId>
 44 |       <artifactId>ignite-flink</artifactId>
 45 |       <version>2.8.1</version>
 46 |     </dependency>
 47 |     <dependency>
 48 |       <groupId>org.apache.ignite</groupId>
 49 |       <artifactId>ignite-log4j</artifactId>
 50 |       <version>2.8.1</version>
 51 |     </dependency>
 52 |     <dependency>
 53 |       <groupId>org.apache.ignite</groupId>
 54 |       <artifactId>ignite-rest-http</artifactId>
 55 |       <version>2.8.1</version>
 56 |     </dependency>
 57 |     <dependency>
 58 |       <groupId>org.springframework</groupId>
 59 |       <artifactId>spring-beans</artifactId>
 60 |       <version>5.3.18</version>
 61 |     </dependency>
 62 | 
 63 |     <dependency>
 64 |       <groupId>junit</groupId>
 65 |       <artifactId>junit</artifactId>
 66 |       <version>4.13.1</version>
 67 |       <scope>test</scope>
 68 |     </dependency>
 69 |   </dependencies>
 70 |   <build>
 71 |     <plugins>
 72 |       <plugin>
 73 |         <groupId>org.apache.maven.plugins</groupId>
 74 |         <artifactId>maven-compiler-plugin</artifactId>
 75 |         <configuration>
 76 |           <source>1.8</source>
 77 |           <target>1.8</target>
 78 |         </configuration>
 79 |       </plugin>
 80 |       <plugin>
 81 |         <groupId>org.apache.maven.plugins</groupId>
 82 |         <artifactId>maven-shade-plugin</artifactId>
 83 |         <version>3.1.1</version>
 84 |         <executions>
 85 |           <execution>
 86 |             <phase>package</phase>
 87 |             <goals>
 88 |               <goal>shade</goal>
 89 |             </goals>
 90 |             <configuration>
 91 |               <transformers>
 92 |                 <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
 93 |                   <mainClass>com.samaitra.SocketWindowWordCount</mainClass>
 94 |                 </transformer>
 95 |                 <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
 96 |                   <resource>META-INF/spring.handlers</resource>
 97 |                 </transformer>
 98 |                 <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
 99 |                   <resource>META-INF/spring.schemas</resource>
100 |                 </transformer>
101 |               </transformers>
102 |             </configuration>
103 |           </execution>
104 |         </executions>
105 |       </plugin>
106 |     </plugins>
107 |   </build>
108 | </project>
109 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | [![Build Status](https://travis-ci.org/samaitra/streamers.svg?branch=master)](https://travis-ci.org/samaitra/streamers)
  2 | 
  3 | Apache IgniteSink offers a streaming connector to inject Flink data into the Ignite cache. The sink emits its input data to the Ignite cache. The key feature to note is the performance and scale both Apache Flink and Apache Ignite offer. Apache Flink can process unbounded and bounded data sets and has been designed to run stateful streaming applications at scale. Application computation is distributed and concurrently executed in clusters. Apache Flink is also optimized for local state access for tasks and does checkpointing of local state for durability. Apache Ignite provides streaming capabilities that allow data ingestion at high scale in its in-memory data grid.
  4 | 
  5 | In this post, we will discuss how we can build a data streaming application using Apache Flink and Apache Ignite. Building a data streaming application offers the benefit of ingesting large finite and infinite volumes of data in an optimized and fault tolerant way into the Ignite cluster. The data ingestion rate is very high and can scale up to millions of events per seconds.
  6 | 
  7 | # streamers
  8 | A collection of streaming application
  9 | 
 10 | ### Stream processing topology
 11 | 
 12 | ![Stream processing topology](https://github.com/samaitra/streamers/raw/master/resources/streamers.png) 
 13 | 
 14 | ### Setup: Download and Start Flink
 15 | 
 16 | Download a binary from the downloads page. You can pick any Hadoop/Scala combination you like. If you plan to just use the local file system, any Hadoop version will work fine.
 17 | Go to the download directory.
 18 | 
 19 | ### Unpack the downloaded archive.
 20 | ```
 21 | $ cd ~/Downloads        # Go to download directory
 22 | $ tar xzf flink-*.tgz   # Unpack the downloaded archive
 23 | $ cd flink-1.5.0
 24 | ```
 25 | 
 26 | ### Start a Local Flink Cluster
 27 | ```
 28 | $ ./bin/start-cluster.sh  # Start Flink
 29 | ```
 30 | Check the Dispatcher’s web frontend at http://localhost:8081 and make sure everything is up and running. The web frontend should report a single available TaskManager instance.
 31 | 
 32 | ### Dispatcher: Overview
 33 | 
 34 | ![Flink Dispatcher Overview](https://github.com/samaitra/streamers/raw/master/resources/flink_job.png) 
 35 | 
 36 | You can also verify that the system is running by checking the log files in the logs directory:
 37 | ```
 38 | $ tail log/flink-*-standalonesession-*.log
 39 | ```
 40 | 
 41 | ### Download kafka 
 42 | 
 43 | Download a binary from the downloads page (https://kafka.apache.org/downloads). You can pick Apache Kafka `0.10.2.2` version with `scala 2.11`.
 44 | 
 45 | ### Start zookeeper server
 46 | ```
 47 | $./bin/zookeeper-server-start.sh ./config/zookeeper.properties
 48 | ```
 49 | 
 50 | ### Start broker
 51 | ```
 52 | ./bin/kafka-server-start.sh ./config/server.properties 
 53 | ```
 54 | 
 55 | ### Create topic “mytopic”
 56 | ```
 57 | $ ./bin/kafka-topics.sh --create --topic mytopic --zookeeper localhost:2181 --partitions 1 --replication-factor 1
 58 | ```
 59 | 
 60 | ### Describe topic "mytopic"
 61 | 
 62 | ```
 63 | $ ./bin/kafka-topics.sh --describe --zookeeper localhost:2181 --topic mytopic
 64 | ```
 65 | 
 66 | ### Produce something into the topic (write something and hit enter)
 67 | ```
 68 | $ ./bin/kafka-console-producer.sh --topic mytopic --broker-list localhost:9092
 69 | ```
 70 | 
 71 | ### Consume from the topic using the console producer
 72 | ```
 73 | $ ./bin/kafka-console-consumer.sh --topic mytopic --zookeeper localhost:2181
 74 | ```
 75 | 
 76 | ### Clone Apache Ignite 
 77 | 
 78 | ```
 79 | $ git clone https://github.com/apache/ignite
 80 | ```
 81 | 
 82 | ### Build Apache Ignite 
 83 | 
 84 | ```
 85 | $ mvn clean package install -DskipTests
 86 | ```
 87 | 
 88 | 
 89 | ### Build the Flink program :
 90 | ```
 91 | $ mvn clean package
 92 | ```
 93 | 
 94 | ### Submit the Flink program :
 95 | ```
 96 | $ ./bin/flink run streamers-1.0-SNAPSHOT.jar
 97 | ```
 98 | 
 99 | ### Produce something into the topic (write something and hit enter)
100 | ```
101 | $ ./bin/kafka-console-producer.sh --topic mytopic --broker-list localhost:9092
102 | ```
103 | 
104 | The .out file will print the counts at the end of each time window as long as words are floating in, e.g.:
105 | ```
106 | $ tail -f log/flink-*-taskexecutor-*.out
107 | lorem : 1
108 | bye : 1
109 | ipsum : 4
110 | ```
111 | 
112 | ### Ignite rest service
113 | To check the cache key values you can use the Ignite rest service 
114 | 
115 | ```
116 | $ curl -X GET http://localhost:8080/ignite\?cmd\=getall\&k1\=jam\&cacheName\=testCache
117 | ```
118 | 
119 | ### Scan cache 
120 | To check all the keys from an Ignite cache the following rest service can be used
121 | ```
122 | $ curl -X GET http://localhost:8080/ignite?cmd=qryscanexe&pageSize=10&cacheName=testCache
123 | ```
124 | 
125 | ### Ignite Web Console
126 | 
127 | #### Ignite Web Console Build Instructions
128 | 
129 | 1. Install MongoDB (version >=3.2.0 <=3.4.15) using instructions from http://docs.mongodb.org/manual/installation.
130 | 2. Install Node.js (version >=8.0.0) using installer from https://nodejs.org/en/download/current for your OS.
131 | 3. Change directory to 'modules/web-console/backend' and
132 |  run "npm install --no-optional" for download backend dependencies.
133 | 4. Change directory to 'modules/web-console/frontend' and
134 |  run "npm install --no-optional" for download frontend dependencies.
135 | 5. Build ignite-web-agent module follow instructions from 'modules/web-console/web-agent/README.txt'.
136 | 6. Copy ignite-web-agent-<version>.zip from 'modules/web-console/web-agent/target'
137 |  to 'modules/web-console/backend/agent_dists' folder.
138 | 7. Unzip ignite-web-agent-<version>.zip in 'modules/web-console/backend/agent_dists'
139 | 8. run './ignite-web-agent.sh' inside ignite-web-agent-<version> folder 
140 | 
141 | Steps 1 - 4 should be executed once.
142 | 
143 | #### Ignite Web Console Run In Development Mode
144 | 
145 | 1. Configure MongoDB to run as service or in terminal change dir to $MONGO_INSTALL_DIR/server/3.2/bin
146 |   and start MongoDB by executing "mongod".
147 | 
148 | 2. In new terminal change directory to 'modules/web-console/backend'.
149 |    If needed run "npm install --no-optional" (if dependencies changed) and run "npm start" to start backend.
150 | 
151 | 3. In new terminal change directory to 'modules/web-console/frontend'.
152 |   If needed run "npm install --no-optional" (if dependencies changed) and start webpack in development mode "npm run dev".
153 | 
154 | 4. In browser open: http://localhost:9000
155 | 
156 | Web console can be used to scan cache and view all the cache contents. 
157 | 
158 | ### To stop Flink when you’re done type:
159 | ```
160 | $ ./bin/stop-cluster.sh
161 | ```
162 | 


--------------------------------------------------------------------------------
/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 | 


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