├── EventHubUI.png
├── src
    └── main
    │   ├── java
    │       ├── eu
    │       │   └── adrianistan
    │       │   │   ├── EventHubProperty.kt
    │       │   │   ├── Main.java
    │       │   │   ├── EventHubMessage.kt
    │       │   │   ├── App.kt
    │       │   │   ├── MainController.kt
    │       │   │   └── NullCheckpointStore.kt
    │       └── module-info.java
    │   └── resources
    │       └── main.fxml
├── .gitignore
├── README.md
├── .github
    └── workflows
    │   └── maven.yml
├── pom.xml
└── LICENSE


/EventHubUI.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/aarroyoc/eventhub-ui/main/EventHubUI.png


--------------------------------------------------------------------------------
/src/main/java/eu/adrianistan/EventHubProperty.kt:
--------------------------------------------------------------------------------
1 | package eu.adrianistan
2 | 
3 | data class EventHubProperty(val key: String, val value: String)


--------------------------------------------------------------------------------
/src/main/java/eu/adrianistan/Main.java:
--------------------------------------------------------------------------------
1 | package eu.adrianistan;
2 | 
3 | public class Main {
4 |     public static void main(String[] args) {
5 |         App.main(args);
6 |     }
7 | }
8 | 


--------------------------------------------------------------------------------
/src/main/java/eu/adrianistan/EventHubMessage.kt:
--------------------------------------------------------------------------------
 1 | package eu.adrianistan
 2 | 
 3 | import java.time.Instant
 4 | 
 5 | data class EventHubMessage(
 6 |     val partition: String,
 7 |     val sequence: Long,
 8 |     val body: String,
 9 |     val timestamp: Instant,
10 |     val properties: List<EventHubProperty>
11 | )


--------------------------------------------------------------------------------
/src/main/java/module-info.java:
--------------------------------------------------------------------------------
 1 | module app {
 2 |     requires javafx.controls;
 3 |     requires javafx.fxml;
 4 |     requires transitive kotlin.stdlib;
 5 |     requires com.azure.messaging.eventhubs;
 6 |     requires com.google.gson;
 7 | 
 8 |     opens eu.adrianistan to javafx.fxml;
 9 |     exports eu.adrianistan;
10 | }


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


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # EventHub UI
 2 | A graphical interface to watch your EventHub in real time. Useful to know what is inside your Azure EventHub with zero code.
 3 | 
 4 | ![EventHub UI Screenshot](EventHubUI.png)
 5 | 
 6 | ## Running
 7 | 
 8 | EventHub UI is a Kotlin + JavaFX app, built using Maven. To run the app, download the code and then execute:
 9 | 
10 |     $ mvn clean javafx:run
11 | 
12 | ## TODO
13 | 
14 | Some things missing:
15 | 
16 | * Store credentials for quick connections
17 | * Send messages
18 | * Search messages


--------------------------------------------------------------------------------
/.github/workflows/maven.yml:
--------------------------------------------------------------------------------
 1 | # This workflow will build a Java project with Maven
 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
 3 | 
 4 | name: Java CI with Maven
 5 | 
 6 | on:
 7 |   push:
 8 |     branches: [ main ]
 9 |   pull_request:
10 |     branches: [ main ]
11 | 
12 | jobs:
13 |   build:
14 | 
15 |     runs-on: ubuntu-latest
16 | 
17 |     steps:
18 |     - uses: actions/checkout@v2
19 |     - name: Set up JDK 11
20 |       uses: actions/setup-java@v1
21 |       with:
22 |         java-version: 11
23 |     - name: Build with Maven
24 |       run: mvn -B package --file pom.xml
25 | 


--------------------------------------------------------------------------------
/src/main/java/eu/adrianistan/App.kt:
--------------------------------------------------------------------------------
 1 | package eu.adrianistan
 2 | 
 3 | import javafx.application.Application
 4 | import javafx.fxml.FXMLLoader
 5 | import javafx.scene.Parent
 6 | import javafx.scene.Scene
 7 | import javafx.stage.Stage
 8 | import java.io.IOException
 9 | import kotlin.jvm.JvmStatic
10 | 
11 | /**
12 |  * JavaFX App
13 |  */
14 | class App : Application() {
15 |     override fun start(stage: Stage) {
16 |         try {
17 |             val root = FXMLLoader.load<Parent>(javaClass.getResource("/main.fxml"))
18 |             val scene = Scene(root)
19 |             stage.title = "EventHub UI"
20 |             stage.scene = scene
21 |             stage.show()
22 |         } catch (exp: IOException) {
23 |             exp.printStackTrace()
24 |         }
25 |     }
26 | 
27 |     companion object {
28 |         @JvmStatic
29 |         fun main(args: Array<String>) {
30 |             launch(App::class.java)
31 |         }
32 |     }
33 | }


--------------------------------------------------------------------------------
/src/main/java/eu/adrianistan/MainController.kt:
--------------------------------------------------------------------------------
  1 | package eu.adrianistan
  2 | 
  3 | import javafx.fxml.FXML
  4 | import javafx.collections.FXCollections
  5 | import com.azure.messaging.eventhubs.EventProcessorClient
  6 | import javafx.scene.control.cell.PropertyValueFactory
  7 | import javafx.beans.value.ObservableValue
  8 | import com.azure.messaging.eventhubs.EventProcessorClientBuilder
  9 | import com.azure.messaging.eventhubs.EventHubClientBuilder
 10 | import com.azure.messaging.eventhubs.models.ErrorContext
 11 | import com.azure.messaging.eventhubs.models.EventContext
 12 | import javafx.application.Platform
 13 | import javafx.event.ActionEvent
 14 | import javafx.scene.control.*
 15 | import java.time.Instant
 16 | import java.util.function.Consumer
 17 | import kotlin.system.exitProcess
 18 | import com.google.gson.GsonBuilder
 19 | 
 20 | class MainController {
 21 |     @FXML
 22 |     var table: TableView<EventHubMessage>? = null
 23 | 
 24 |     @FXML
 25 |     var partitionCol: TableColumn<*, *>? = null
 26 | 
 27 |     @FXML
 28 |     var sequenceCol: TableColumn<*, *>? = null
 29 | 
 30 |     @FXML
 31 |     var bodyCol: TableColumn<*, *>? = null
 32 | 
 33 |     @FXML
 34 |     var timestampCol: TableColumn<*, *>? = null
 35 | 
 36 |     @FXML
 37 |     var properties: TableView<EventHubProperty>? = null
 38 | 
 39 |     @FXML
 40 |     var keyCol: TableColumn<*, *>? = null
 41 | 
 42 |     @FXML
 43 |     var valueCol: TableColumn<*, *>? = null
 44 | 
 45 |     @FXML
 46 |     var connectionString: TextField? = null
 47 | 
 48 |     @FXML
 49 |     var hubName: TextField? = null
 50 | 
 51 |     @FXML
 52 |     var connect: Button? = null
 53 | 
 54 |     @FXML
 55 |     var msg: TextArea? = null
 56 | 
 57 |     private val data = FXCollections.observableArrayList<EventHubMessage>()
 58 |     private var eventProcessorClient: EventProcessorClient? = null
 59 | 
 60 |     fun initialize() {
 61 |         partitionCol!!.cellValueFactory = PropertyValueFactory<EventHubMessage, String>("partition")
 62 |         sequenceCol!!.cellValueFactory = PropertyValueFactory<EventHubMessage, Long>("sequence")
 63 |         bodyCol!!.cellValueFactory = PropertyValueFactory<EventHubMessage, String>("body")
 64 |         timestampCol!!.cellValueFactory = PropertyValueFactory<EventHubMessage, Instant>("timestamp")
 65 | 
 66 |         keyCol!!.cellValueFactory = PropertyValueFactory<EventHubProperty, String>("key")
 67 |         valueCol!!.cellValueFactory = PropertyValueFactory<EventHubProperty, String>("value")
 68 | 
 69 |         table!!.items = data
 70 |         table!!.selectionModel.selectionMode = SelectionMode.SINGLE
 71 |         table!!.selectionModel.isCellSelectionEnabled = true
 72 |         table!!.selectionModel.selectedItemProperty()
 73 |             .addListener { obs: ObservableValue<out EventHubMessage>?, oldSelection: EventHubMessage?, newSelection: EventHubMessage? ->
 74 |                 if (newSelection != null) {
 75 |                     val gson = GsonBuilder().setPrettyPrinting().create()
 76 |                     val data = gson.fromJson(newSelection.body, Object::class.java)
 77 |                     val formatJson = gson.toJson(data)
 78 |                     msg!!.text = formatJson
 79 |                     properties!!.items = FXCollections.observableList(newSelection.properties)
 80 |                 }
 81 |             }
 82 |     }
 83 | 
 84 |     @FXML
 85 |     fun handleDoConnect(event: ActionEvent?) {
 86 |         if (eventProcessorClient == null) {
 87 |             val eventProcessorClientBuilder = EventProcessorClientBuilder()
 88 |                 .connectionString(connectionString!!.text, hubName!!.text)
 89 |                 .consumerGroup(EventHubClientBuilder.DEFAULT_CONSUMER_GROUP_NAME)
 90 |                 .processEvent(processEvent)
 91 |                 .processError(processError)
 92 |                 .checkpointStore(NullCheckpointStore())
 93 |             eventProcessorClient = eventProcessorClientBuilder.buildEventProcessorClient()
 94 |             eventProcessorClient?.let {
 95 |                 it.start()
 96 |                 connect!!.text = "Close connection"
 97 |             }
 98 |         } else {
 99 |             eventProcessorClient!!.stop()
100 |             eventProcessorClient = null
101 |             connect!!.text = "Connect"
102 |         }
103 |     }
104 | 
105 |     @FXML
106 |     fun handleDoQuit(event: ActionEvent?) {
107 |         Platform.exit()
108 |         exitProcess(0)
109 |     }
110 | 
111 |     @FXML
112 |     fun handleDoHelp(event: ActionEvent?) {
113 |         val alert = Alert(Alert.AlertType.INFORMATION)
114 |         alert.title = "About EventHub UI"
115 |         alert.headerText = "EventHub UI 1.0.0"
116 |         alert.contentText = "EventHub UI was made by Adrián Arroyo Calle (https://adrianistan.eu). EventHub is a trademark of Microsoft"
117 |         alert.show()
118 |     }
119 | 
120 |     val processEvent = Consumer { eventContext: EventContext ->
121 |         System.out.printf("Message received: %s \n", eventContext.eventData.bodyAsString)
122 |         data.add(
123 |             EventHubMessage(
124 |                 eventContext.partitionContext.partitionId,
125 |                 eventContext.eventData.sequenceNumber,
126 |                 eventContext.eventData.bodyAsString,
127 |                 eventContext.eventData.enqueuedTime,
128 |                 eventContext.eventData.properties.map {
129 |                     EventHubProperty(it.key, it.value.toString())
130 |                 }
131 |             )
132 |         )
133 |     }
134 |     val processError = Consumer { errorContext: ErrorContext ->
135 |         System.out.printf(
136 |             "Error occurred in partition processor for partition %s, %s.%n",
137 |             errorContext.partitionContext.partitionId,
138 |             errorContext.throwable
139 |         )
140 |     }
141 | }


--------------------------------------------------------------------------------
/src/main/java/eu/adrianistan/NullCheckpointStore.kt:
--------------------------------------------------------------------------------
  1 | package eu.adrianistan
  2 | 
  3 | import com.azure.messaging.eventhubs.CheckpointStore
  4 | import com.azure.messaging.eventhubs.models.PartitionOwnership
  5 | import java.util.concurrent.ConcurrentHashMap
  6 | import com.azure.messaging.eventhubs.models.Checkpoint
  7 | import com.azure.core.util.logging.ClientLogger
  8 | import eu.adrianistan.NullCheckpointStore
  9 | import reactor.core.publisher.Flux
 10 | import java.lang.StringBuilder
 11 | import java.util.Locale
 12 | import com.azure.core.util.CoreUtils
 13 | import java.util.UUID
 14 | import reactor.core.publisher.Mono
 15 | import java.lang.Void
 16 | import java.lang.NullPointerException
 17 | 
 18 | /* Taken from https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/eventhubs/azure-messaging-eventhubs/src/samples/java/com/azure/messaging/eventhubs/SampleCheckpointStore.java */ /* Code under the MIT License */
 19 | /**
 20 |  * A simple in-memory implementation of a [CheckpointStore]. This implementation keeps track of partition
 21 |  * ownership details including checkpointing information in-memory. Using this implementation will only facilitate
 22 |  * checkpointing and load balancing of Event Processors running within this process.
 23 |  */
 24 | class NullCheckpointStore : CheckpointStore {
 25 |     private val partitionOwnershipMap: MutableMap<String, PartitionOwnership> = ConcurrentHashMap()
 26 |     private val checkpointsMap: MutableMap<String, Checkpoint> = ConcurrentHashMap()
 27 |     private val logger = ClientLogger(NullCheckpointStore::class.java)
 28 | 
 29 |     /**
 30 |      * {@inheritDoc}
 31 |      */
 32 |     override fun listOwnership(
 33 |         fullyQualifiedNamespace: String, eventHubName: String,
 34 |         consumerGroup: String
 35 |     ): Flux<PartitionOwnership> {
 36 |         logger.info("Listing partition ownership")
 37 |         val prefix = prefixBuilder(fullyQualifiedNamespace, eventHubName, consumerGroup, OWNERSHIP)
 38 |         return Flux.fromIterable(partitionOwnershipMap.keys)
 39 |             .filter { key: String -> key.startsWith(prefix) }
 40 |             .map { key: String -> partitionOwnershipMap[key] }
 41 |     }
 42 | 
 43 |     private fun prefixBuilder(
 44 |         fullyQualifiedNamespace: String, eventHubName: String, consumerGroup: String,
 45 |         type: String
 46 |     ): String {
 47 |         return StringBuilder()
 48 |             .append(fullyQualifiedNamespace)
 49 |             .append(SEPARATOR)
 50 |             .append(eventHubName)
 51 |             .append(SEPARATOR)
 52 |             .append(consumerGroup)
 53 |             .append(SEPARATOR)
 54 |             .append(type)
 55 |             .toString()
 56 |             .toLowerCase(Locale.ROOT)
 57 |     }
 58 | 
 59 |     /**
 60 |      * Returns a [Flux] of partition ownership details for successfully claimed partitions. If a partition is
 61 |      * already claimed by an instance or if the ETag in the request doesn't match the previously stored ETag, then
 62 |      * ownership claim is denied.
 63 |      *
 64 |      * @param requestedPartitionOwnerships List of partition ownerships this instance is requesting to own.
 65 |      * @return Successfully claimed partition ownerships.
 66 |      */
 67 |     override fun claimOwnership(requestedPartitionOwnerships: List<PartitionOwnership>): Flux<PartitionOwnership> {
 68 |         if (CoreUtils.isNullOrEmpty(requestedPartitionOwnerships)) {
 69 |             return Flux.empty()
 70 |         }
 71 |         val firstEntry = requestedPartitionOwnerships[0]
 72 |         val prefix = prefixBuilder(
 73 |             firstEntry.fullyQualifiedNamespace, firstEntry.eventHubName,
 74 |             firstEntry.consumerGroup, OWNERSHIP
 75 |         )
 76 |         return Flux.fromIterable(requestedPartitionOwnerships)
 77 |             .filter { partitionOwnership: PartitionOwnership ->
 78 |                 (!partitionOwnershipMap.containsKey(partitionOwnership.partitionId)
 79 |                         || (partitionOwnershipMap[partitionOwnership.partitionId]!!.eTag
 80 |                         == partitionOwnership.eTag))
 81 |             }
 82 |             .doOnNext { partitionOwnership: PartitionOwnership ->
 83 |                 logger
 84 |                     .info(
 85 |                         "Ownership of partition {} claimed by {}", partitionOwnership.partitionId,
 86 |                         partitionOwnership.ownerId
 87 |                     )
 88 |             }
 89 |             .map { partitionOwnership: PartitionOwnership ->
 90 |                 partitionOwnership.setETag(UUID.randomUUID().toString()).lastModifiedTime = System.currentTimeMillis()
 91 |                 partitionOwnershipMap[prefix + SEPARATOR + partitionOwnership.partitionId] = partitionOwnership
 92 |                 partitionOwnership
 93 |             }
 94 |     }
 95 | 
 96 |     /**
 97 |      * {@inheritDoc}
 98 |      */
 99 |     override fun listCheckpoints(
100 |         fullyQualifiedNamespace: String, eventHubName: String,
101 |         consumerGroup: String
102 |     ): Flux<Checkpoint> {
103 |         val prefix = prefixBuilder(fullyQualifiedNamespace, eventHubName, consumerGroup, CHECKPOINT)
104 |         return Flux.fromIterable(checkpointsMap.keys)
105 |             .filter { key: String -> key.startsWith(prefix) }
106 |             .map { key: String -> checkpointsMap[key] }
107 |     }
108 | 
109 |     /**
110 |      * Updates the in-memory storage with the provided checkpoint information.
111 |      *
112 |      * @param checkpoint The checkpoint containing the information to be stored in-memory.
113 |      * @return A [Mono] that completes when the checkpoint is updated.
114 |      */
115 |     override fun updateCheckpoint(checkpoint: Checkpoint): Mono<Void> {
116 |         if (checkpoint == null) {
117 |             return Mono.error(logger.logExceptionAsError(NullPointerException("checkpoint cannot be null")))
118 |         }
119 |         val prefix = prefixBuilder(
120 |             checkpoint.fullyQualifiedNamespace, checkpoint.eventHubName,
121 |             checkpoint.consumerGroup, CHECKPOINT
122 |         )
123 |         checkpointsMap[prefix + SEPARATOR + checkpoint.partitionId] = checkpoint
124 |         logger.info(
125 |             "Updated checkpoint for partition {} with sequence number {}", checkpoint.partitionId,
126 |             checkpoint.sequenceNumber
127 |         )
128 |         return Mono.empty()
129 |     }
130 | 
131 |     companion object {
132 |         private const val OWNERSHIP = "ownership"
133 |         private const val SEPARATOR = "/"
134 |         private const val CHECKPOINT = "checkpoint"
135 |     }
136 | }


--------------------------------------------------------------------------------
/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>eu.adrianistan</groupId>
  5 |     <artifactId>eventhub-ui</artifactId>
  6 |     <version>1.0.1</version>
  7 |     <properties>
  8 |         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  9 |         <maven.compiler.source>11</maven.compiler.source>
 10 |         <maven.compiler.target>11</maven.compiler.target>
 11 |         <kotlin.version>1.5.30</kotlin.version>
 12 |         <javafx.version>16</javafx.version>
 13 |     </properties>
 14 |     <dependencies>
 15 |         <dependency>
 16 |             <groupId>org.openjfx</groupId>
 17 |             <artifactId>javafx-controls</artifactId>
 18 |             <version>${javafx.version}</version>
 19 |             <classifier>win</classifier>
 20 |         </dependency>
 21 |         <dependency>
 22 |             <groupId>org.openjfx</groupId>
 23 |             <artifactId>javafx-fxml</artifactId>
 24 |             <version>${javafx.version}</version>
 25 |             <classifier>win</classifier>
 26 |         </dependency>
 27 |         <dependency>
 28 |             <groupId>org.openjfx</groupId>
 29 |             <artifactId>javafx-controls</artifactId>
 30 |             <version>${javafx.version}</version>
 31 |             <classifier>mac</classifier>
 32 |         </dependency>
 33 |         <dependency>
 34 |             <groupId>org.openjfx</groupId>
 35 |             <artifactId>javafx-fxml</artifactId>
 36 |             <version>${javafx.version}</version>
 37 |             <classifier>mac</classifier>
 38 |         </dependency>
 39 |         <dependency>
 40 |             <groupId>org.openjfx</groupId>
 41 |             <artifactId>javafx-controls</artifactId>
 42 |             <version>${javafx.version}</version>
 43 |             <classifier>linux</classifier>
 44 |         </dependency>
 45 |         <dependency>
 46 |             <groupId>org.openjfx</groupId>
 47 |             <artifactId>javafx-fxml</artifactId>
 48 |             <version>${javafx.version}</version>
 49 |             <classifier>linux</classifier>
 50 |         </dependency>
 51 |         <dependency>
 52 |             <groupId>com.azure</groupId>
 53 |             <artifactId>azure-messaging-eventhubs</artifactId>
 54 |             <version>5.10.0</version>
 55 |         </dependency>
 56 |         <dependency>
 57 |             <groupId>org.jetbrains.kotlin</groupId>
 58 |             <artifactId>kotlin-stdlib-jdk8</artifactId>
 59 |             <version>${kotlin.version}</version>
 60 |         </dependency>
 61 |         <dependency>
 62 |             <groupId>com.google.code.gson</groupId>
 63 |             <artifactId>gson</artifactId>
 64 |             <version>2.8.8</version>
 65 |         </dependency>
 66 |         <dependency>
 67 |             <groupId>org.jetbrains.kotlin</groupId>
 68 |             <artifactId>kotlin-test</artifactId>
 69 |             <version>${kotlin.version}</version>
 70 |             <scope>test</scope>
 71 |         </dependency>
 72 |     </dependencies>
 73 |     <build>
 74 |         <plugins>
 75 |             <plugin>
 76 |                 <groupId>org.openjfx</groupId>
 77 |                 <artifactId>javafx-maven-plugin</artifactId>
 78 |                 <version>0.0.5</version>
 79 |                 <configuration>
 80 |                     <release>1.0.0</release>
 81 |                     <jlinkImageName>app</jlinkImageName>
 82 |                     <launcher>launcher</launcher>
 83 |                     <mainClass>app/eu.adrianistan.Main</mainClass>
 84 |                 </configuration>
 85 |             </plugin>
 86 |             <plugin>
 87 |                 <groupId>org.jetbrains.kotlin</groupId>
 88 |                 <artifactId>kotlin-maven-plugin</artifactId>
 89 |                 <version>${kotlin.version}</version>
 90 |                 <executions>
 91 |                     <execution>
 92 |                         <id>compile</id>
 93 |                         <phase>process-sources</phase>
 94 |                         <goals>
 95 |                             <goal>compile</goal>
 96 |                         </goals>
 97 |                         <configuration>
 98 |                             <sourceDirs>
 99 |                                 <sourceDir>src/main/java</sourceDir>
100 |                             </sourceDirs>
101 |                         </configuration>
102 |                     </execution>
103 |                     <execution>
104 |                         <id>test-compile</id>
105 |                         <phase>test-compile</phase>
106 |                         <goals>
107 |                             <goal>test-compile</goal>
108 |                         </goals>
109 |                     </execution>
110 |                 </executions>
111 |                 <configuration>
112 |                     <jvmTarget>11</jvmTarget>
113 |                 </configuration>
114 |             </plugin>
115 |             <plugin>
116 |                 <groupId>org.apache.maven.plugins</groupId>
117 |                 <artifactId>maven-compiler-plugin</artifactId>
118 |                 <version>3.8.0</version>
119 |                 <configuration>
120 |                     <release>11</release>
121 |                 </configuration>
122 |                 <executions>
123 |                     <execution>
124 |                         <id>compile</id>
125 |                         <phase>compile</phase>
126 |                         <goals>
127 |                             <goal>compile</goal>
128 |                         </goals>
129 |                     </execution>
130 |                     <execution>
131 |                         <id>testCompile</id>
132 |                         <phase>test-compile</phase>
133 |                         <goals>
134 |                             <goal>testCompile</goal>
135 |                         </goals>
136 |                     </execution>
137 |                 </executions>
138 |             </plugin>
139 |             <plugin>
140 |                 <groupId>org.apache.maven.plugins</groupId>
141 |                 <artifactId>maven-shade-plugin</artifactId>
142 |                 <version>3.2.0</version>
143 |                 <executions>
144 |                     <execution>
145 |                         <phase>package</phase>
146 |                         <goals>
147 |                             <goal>shade</goal>
148 |                         </goals>
149 |                         <configuration>
150 |                             <shadedArtifactAttached>true</shadedArtifactAttached>
151 |                             <shadedClassifierName>project-classifier</shadedClassifierName>
152 |                             <outputFile>shade\${project.artifactId}.jar</outputFile>
153 |                             <transformers>
154 |                                 <transformer implementation=
155 |                                                      "org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
156 |                                     <mainClass>eu.adrianistan.Main</mainClass>
157 |                                 </transformer>
158 |                             </transformers>
159 |                             <filters>
160 |                                 <filter>
161 |                                     <artifact>*:*</artifact>
162 |                                     <excludes>
163 |                                         <exclude>META-INF/*.SF</exclude>
164 |                                         <exclude>META-INF/*.DSA</exclude>
165 |                                         <exclude>META-INF/*.RSA</exclude>
166 |                                     </excludes>
167 |                                 </filter>
168 |                             </filters>
169 |                         </configuration>
170 |                     </execution>
171 |                 </executions>
172 |             </plugin>
173 |         </plugins>
174 |     </build>
175 | </project>
176 | 


--------------------------------------------------------------------------------
/src/main/resources/main.fxml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | 
  3 | <!--
  4 |   Copyright (c) 2015, 2019, Gluon and/or its affiliates.
  5 |   All rights reserved. Use is subject to license terms.
  6 | 
  7 |   This file is available and licensed under the following license:
  8 | 
  9 |   Redistribution and use in source and binary forms, with or without
 10 |   modification, are permitted provided that the following conditions
 11 |   are met:
 12 | 
 13 |   - Redistributions of source code must retain the above copyright
 14 |     notice, this list of conditions and the following disclaimer.
 15 |   - Redistributions in binary form must reproduce the above copyright
 16 |     notice, this list of conditions and the following disclaimer in
 17 |     the documentation and/or other materials provided with the distribution.
 18 |   - Neither the name of Oracle Corporation nor the names of its
 19 |     contributors may be used to endorse or promote products derived
 20 |     from this software without specific prior written permission.
 21 | 
 22 |   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 23 |   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 24 |   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 25 |   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 26 |   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 27 |   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 28 |   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 29 |   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 30 |   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 31 |   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 32 |   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 33 | -->
 34 | 
 35 | <?import javafx.geometry.Insets?>
 36 | <?import javafx.scene.control.Button?>
 37 | <?import javafx.scene.control.Label?>
 38 | <?import javafx.scene.control.Menu?>
 39 | <?import javafx.scene.control.MenuBar?>
 40 | <?import javafx.scene.control.MenuItem?>
 41 | <?import javafx.scene.control.ScrollPane?>
 42 | <?import javafx.scene.control.Separator?>
 43 | <?import javafx.scene.control.SplitPane?>
 44 | <?import javafx.scene.control.TableColumn?>
 45 | <?import javafx.scene.control.TableView?>
 46 | <?import javafx.scene.control.TextArea?>
 47 | <?import javafx.scene.control.TextField?>
 48 | <?import javafx.scene.layout.AnchorPane?>
 49 | <?import javafx.scene.layout.VBox?>
 50 | <?import javafx.scene.text.Font?>
 51 | 
 52 | <VBox prefHeight="600.0" prefWidth="900.0" xmlns="http://javafx.com/javafx/15.0.1" xmlns:fx="http://javafx.com/fxml/1" fx:controller="eu.adrianistan.MainController">
 53 |   <children>
 54 |     <MenuBar VBox.vgrow="NEVER">
 55 |       <menus>
 56 |         <Menu mnemonicParsing="false" text="File">
 57 |           <items>
 58 |             <MenuItem fx:id="quit" mnemonicParsing="false" onAction="#handleDoQuit" text="Quit" />
 59 |           </items>
 60 |         </Menu>
 61 |         <Menu mnemonicParsing="false" text="Help">
 62 |           <items>
 63 |             <MenuItem fx:id="help" mnemonicParsing="false" onAction="#handleDoHelp" text="About EventHub UI" />
 64 |           </items>
 65 |         </Menu>
 66 |       </menus>
 67 |     </MenuBar>
 68 |     <SplitPane dividerPositions="0.2505567928730512, 0.7505567928730512" focusTraversable="true" prefHeight="-1.0" prefWidth="-1.0" VBox.vgrow="ALWAYS">
 69 |       <items>
 70 |         <AnchorPane>
 71 |           <children>
 72 |                   <VBox layoutX="46.0" layoutY="63.0" prefHeight="569.0" prefWidth="221.0" AnchorPane.bottomAnchor="0.0" AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="0.0" AnchorPane.topAnchor="0.0">
 73 |                      <children>
 74 |                   <Label alignment="CENTER" maxWidth="1.7976931348623157E308" minWidth="60.0" prefHeight="21.0" prefWidth="232.0" style="&#10;" text="Connection" textAlignment="CENTER" textFill="#9f9f9f" wrapText="false">
 75 |                     <font>
 76 |                       <Font size="24.0" fx:id="x1" />
 77 |                     </font>
 78 |                   </Label>
 79 |                         <Label maxWidth="1.7976931348623157E308" text="EventHub connection string">
 80 |                            <VBox.margin>
 81 |                               <Insets left="10.0" />
 82 |                            </VBox.margin></Label>
 83 |                         <TextField fx:id="connectionString" maxWidth="500.0">
 84 |                            <VBox.margin>
 85 |                               <Insets left="10.0" right="10.0" />
 86 |                            </VBox.margin></TextField>
 87 |                         <Label text="EventHub name">
 88 |                            <VBox.margin>
 89 |                               <Insets left="10.0" />
 90 |                            </VBox.margin></Label>
 91 |                         <TextField fx:id="hubName">
 92 |                            <VBox.margin>
 93 |                               <Insets left="10.0" right="10.0" />
 94 |                            </VBox.margin></TextField>
 95 |                         <Button fx:id="connect" maxWidth="1.7976931348623157E308" mnemonicParsing="false" onAction="#handleDoConnect" text="Connect">
 96 |                            <VBox.margin>
 97 |                               <Insets left="20.0" right="20.0" />
 98 |                            </VBox.margin></Button>
 99 |                      </children>
100 |                   </VBox>
101 |           </children>
102 |         </AnchorPane>
103 |         <ScrollPane fitToHeight="true" fitToWidth="true" prefHeight="-1.0" prefWidth="-1.0">
104 |                <content>
105 |                   <TableView fx:id="table" maxHeight="1.7976931348623157E308" maxWidth="1.7976931348623157E308" prefHeight="400.0" prefWidth="417.0">
106 |                     <columns>
107 |                       <TableColumn fx:id="partitionCol" prefWidth="58.0" text="Partition" />
108 |                       <TableColumn fx:id="sequenceCol" prefWidth="67.0" text="Sequence" />
109 |                         <TableColumn fx:id="bodyCol" prefWidth="226.0" text="Body" />
110 |                         <TableColumn fx:id="timestampCol" prefWidth="139.0" text="Timestamp" />
111 |                     </columns>
112 |                   </TableView>
113 |                </content>
114 |         </ScrollPane>
115 |         <AnchorPane>
116 |                <children>
117 |                   <VBox prefHeight="569.0" prefWidth="220.0" AnchorPane.bottomAnchor="0.0" AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="0.0" AnchorPane.topAnchor="0.0">
118 |                      <children>
119 |                         <Label maxWidth="1.7976931348623157E308" text="Message" textFill="#9f9f9f">
120 |                            <VBox.margin>
121 |                               <Insets left="10.0" />
122 |                            </VBox.margin>
123 |                            <font>
124 |                               <Font size="24.0" />
125 |                            </font>
126 |                         </Label>
127 |                         <TextArea fx:id="msg" editable="false" maxWidth="1.7976931348623157E308" prefHeight="200.0" prefWidth="200.0" wrapText="true" />
128 |                         <Separator prefHeight="21.0" prefWidth="220.0" />
129 |                         <Label text="Properties">
130 |                            <VBox.margin>
131 |                               <Insets left="10.0" />
132 |                            </VBox.margin>
133 |                         </Label>
134 |                         <TableView fx:id="properties" prefHeight="301.0" prefWidth="220.0">
135 |                           <columns>
136 |                             <TableColumn fx:id="keyCol" prefWidth="81.0" text="Key" />
137 |                             <TableColumn fx:id="valueCol" prefWidth="125.0" text="Value" />
138 |                           </columns>
139 |                         </TableView>
140 |                      </children>
141 |                   </VBox>
142 |                </children>
143 |         </AnchorPane>
144 |       </items>
145 |     </SplitPane>
146 |   </children>
147 | </VBox>
148 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <https://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <https://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <https://www.gnu.org/licenses/why-not-lgpl.html>.
675 | 


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