Skip to content

Commit

Permalink
Update project layoyt
Browse files Browse the repository at this point in the history
  • Loading branch information
gfinocchiaro committed Mar 13, 2024
1 parent 97c4efa commit 2535bdc
Show file tree
Hide file tree
Showing 47 changed files with 647 additions and 215 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ where you have to replace `API.key` and `secret` with the _API Key_ and _secret_

2. Attach a Lightstreamer Consumer.

The [`kafka-connector-samples`](kafka-connector-samples/) submodule hosts a simple
The [`kafka-connector-utils`](kafka-connector-utils) submodule hosts a simple
Lightstreamer Java client that can be used to test the consumption of Kafka events from any Kafka topics.

Before launching the consumer, you first need to build it with the command:
Expand All @@ -250,12 +250,12 @@ where you have to replace `API.key` and `secret` with the _API Key_ and _secret_
./gradlew distribuiteConsumer
```

which generates the `lightstreamer-kafka-connector-samples-consumer-all-<version>.jar` under the `deploy` folder.
which generates the `lightstreamer-kafka-connector-utils-consumer-all-<version>.jar` under the `deploy` folder.

Then, launch it with:

```sh
java -jar deploy/lightstreamer-kafka-connector-samples-consumer-all-<version>.jar --address http://localhost:8080 --adapter-set KafkaConnector --data-adapter QuickStart --items stock-[index=1] --fields ask,bid,min,max
java -jar deploy/lightstreamer-kafka-connector-utils-consumer-all-<version>.jar --address http://localhost:8080 --adapter-set KafkaConnector --data-adapter QuickStart --items stock-[index=1] --fields ask,bid,min,max
```

As you can see, you have to specify a few parameters:
Expand All @@ -271,20 +271,21 @@ where you have to replace `API.key` and `secret` with the _API Key_ and _secret_
3. Publish Events.

The [`kafka-connector-samples`](kafka-connector-samples/) submodule hosts a simple Kafka producer to publish simulated market events for the _QuickStart_ app.
The [`examples/quickstart-producer`](examples/quickstart-producer/) folder hosts a simple Kafka producer to publish simulated market events for the _QuickStart_ app.

Before launching the producer, you first need to build it. Open a new shell and execute the command:
Before launching the producer, you first need to build it. Open a new shell from the folder and execute the command:

```sh
./gradlew distribuiteProducer
cd examples/quickstart-producer
./gradlew distribuite
```

which generates the `lightstreamer-kafka-connector-samples-producer-all-<version>.jar` under the `deploy` folder.
which generates the `quickstart-producer-all` under the `deploy` folder.

Then, launch it with:

```sh
java -jar deploy/lightstreamer-kafka-connector-samples-producer-all-<version>.jar --bootstrap-servers <kafka.connection.string> --topic stocks
java -jar deploy/quickstart-producer-all.jar --bootstrap-servers <kafka.connection.string> --topic stocks
```

![producer_video](pictures/producer.gif)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ repositories {
maven {
url "https://packages.confluent.io/maven"
}

}

dependencies {
Expand Down
3 changes: 3 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Docs

This folder contains the [API Specification](https://lightstreamer.github.io/Lightstreamer-kafka-connector/javadoc) for _Lightstreamer Kafka Connector_.
3 changes: 2 additions & 1 deletion docs/javadoc/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li><a href="com/lightstreamer/kafka_connector/adapters/pub/package-summary.html">Package</a></li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
Expand Down Expand Up @@ -55,7 +56,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/lightstreamer/kafka_connector/adapters/pub/KafkaConnectorMetadataAdapter.html" title="class in com.lightstreamer.kafka_connector.adapters.pub">KafkaConnectorMetadataAdapter</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Implementation of a Lighttreamer Metadata Adpater for Lightstreamer Kafka Connector.</div>
<div class="block">Implementation of a Lightstreamer Metadata Adapter for Lightstreamer Kafka Connector.</div>
</div>
</div>
</div>
Expand Down
1 change: 1 addition & 0 deletions docs/javadoc/allpackages-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li><a href="com/lightstreamer/kafka_connector/adapters/pub/package-summary.html">Package</a></li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li class="nav-bar-cell1-rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
Expand Down Expand Up @@ -68,7 +69,7 @@ <h1 title="Package com.lightstreamer.kafka_connector.adapters.pub" class="title"
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="KafkaConnectorMetadataAdapter.html" title="class in com.lightstreamer.kafka_connector.adapters.pub">KafkaConnectorMetadataAdapter</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Implementation of a Lighttreamer Metadata Adpater for Lightstreamer Kafka Connector.</div>
<div class="block">Implementation of a Lightstreamer Metadata Adapter for Lightstreamer Kafka Connector.</div>
</div>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="nav-bar-cell1-rev">Tree</li>
Expand All @@ -53,9 +54,9 @@ <h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
<ul>
<li class="circle">com.lightstreamer.interfaces.metadata.MetadataProviderAdapter (implements com.lightstreamer.interfaces.metadata.MetadataProvider)
<li class="circle">com.lightstreamer.interfaces.metadata.<a href="https://sdk.lightstreamer.com/ls-adapter-inprocess/8.0.0/api/com/lightstreamer/interfaces/metadata/MetadataProviderAdapter.html" class="type-name-link external-link" title="class or interface in com.lightstreamer.interfaces.metadata">MetadataProviderAdapter</a> (implements com.lightstreamer.interfaces.metadata.<a href="https://sdk.lightstreamer.com/ls-adapter-inprocess/8.0.0/api/com/lightstreamer/interfaces/metadata/MetadataProvider.html" title="class or interface in com.lightstreamer.interfaces.metadata" class="external-link">MetadataProvider</a>)
<ul>
<li class="circle">com.lightstreamer.adapters.metadata.LiteralBasedProvider
<li class="circle">com.lightstreamer.adapters.metadata.<a href="https://sdk.lightstreamer.com/ls-adapter-inprocess/8.0.0/api/com/lightstreamer/adapters/metadata/LiteralBasedProvider.html" class="type-name-link external-link" title="class or interface in com.lightstreamer.adapters.metadata">LiteralBasedProvider</a>
<ul>
<li class="circle">com.lightstreamer.kafka_connector.adapters.pub.<a href="KafkaConnectorMetadataAdapter.html" class="type-name-link" title="class in com.lightstreamer.kafka_connector.adapters.pub">KafkaConnectorMetadataAdapter</a></li>
</ul>
Expand Down
6 changes: 6 additions & 0 deletions docs/javadoc/help-doc.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li><a href="com/lightstreamer/kafka_connector/adapters/pub/package-summary.html">Package</a></li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
Expand Down Expand Up @@ -61,6 +62,7 @@ <h1 class="title">JavaDoc Help</h1>
</li>
<li><a href="#help-pages">Kinds of Pages</a>:
<ul class="help-subtoc">
<li><a href="#overview">Overview</a></li>
<li><a href="#package">Package</a></li>
<li><a href="#class">Class or Interface</a></li>
<li><a href="#doc-file">Other Files</a></li>
Expand Down Expand Up @@ -90,6 +92,10 @@ <h3>Search</h3>
<div class="sub-title">
<h2 id="help-pages">Kinds of Pages</h2>
The following sections describe the different kinds of pages in this collection.
<section class="help-section" id="overview">
<h3>Overview</h3>
<p>The <a href="index.html">Overview</a> page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.</p>
</section>
<section class="help-section" id="package">
<h3>Package</h3>
<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:</p>
Expand Down
3 changes: 2 additions & 1 deletion docs/javadoc/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li><a href="com/lightstreamer/kafka_connector/adapters/pub/package-summary.html">Package</a></li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
Expand Down Expand Up @@ -58,7 +59,7 @@ <h2 class="title" id="I:K">K</h2>
<dl class="index">
<dt><a href="com/lightstreamer/kafka_connector/adapters/pub/KafkaConnectorMetadataAdapter.html" class="type-name-link" title="class in com.lightstreamer.kafka_connector.adapters.pub">KafkaConnectorMetadataAdapter</a> - Class in <a href="com/lightstreamer/kafka_connector/adapters/pub/package-summary.html">com.lightstreamer.kafka_connector.adapters.pub</a></dt>
<dd>
<div class="block">Implementation of a Lighttreamer Metadata Adpater for Lightstreamer Kafka Connector.</div>
<div class="block">Implementation of a Lightstreamer Metadata Adapter for Lightstreamer Kafka Connector.</div>
</dd>
<dt><a href="com/lightstreamer/kafka_connector/adapters/pub/KafkaConnectorMetadataAdapter.html#%3Cinit%3E()" class="member-name-link">KafkaConnectorMetadataAdapter()</a> - Constructor for class com.lightstreamer.kafka_connector.adapters.pub.<a href="com/lightstreamer/kafka_connector/adapters/pub/KafkaConnectorMetadataAdapter.html" title="class in com.lightstreamer.kafka_connector.adapters.pub">KafkaConnectorMetadataAdapter</a></dt>
<dd>&nbsp;</dd>
Expand Down
65 changes: 53 additions & 12 deletions docs/javadoc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,65 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>kafka-connector 0.1.0 API</title>
<title>Overview (kafka-connector 0.1.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="index redirect">
<meta name="generator" content="javadoc/IndexRedirectWriter">
<link rel="canonical" href="com/lightstreamer/kafka_connector/adapters/pub/package-summary.html">
<meta name="description" content="package index">
<meta name="generator" content="javadoc/PackageIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript">window.location.replace('com/lightstreamer/kafka_connector/adapters/pub/package-summary.html')</script>
<noscript>
<meta http-equiv="Refresh" content="0;com/lightstreamer/kafka_connector/adapters/pub/package-summary.html">
</noscript>
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-redirect-page">
<main role="main">
<body class="package-index-page">
<script type="text/javascript">var pathtoroot = "./";
loadScripts(document, 'script');</script>
<noscript>
<p>JavaScript is disabled on your browser.</p>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<p><a href="com/lightstreamer/kafka_connector/adapters/pub/package-summary.html">com/lightstreamer/kafka_connector/adapters/pub/package-summary.html</a></p>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li class="nav-bar-cell1-rev">Overview</li>
<li><a href="com/lightstreamer/kafka_connector/adapters/pub/package-summary.html">Package</a></li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html#overview">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 class="title"><h1>Lighstreamer Kafka Connector <br>API Specification</h1></h1>
</div>
<div class="block"><p>API Specification for the Lightstreamer Kafka Connector.</p></div>
<div id="all-packages-table">
<div class="caption"><span>Packages</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="com/lightstreamer/kafka_connector/adapters/pub/package-summary.html">com.lightstreamer.kafka_connector.adapters.pub</a></div>
<div class="col-last even-row-color all-packages-table all-packages-table-tab1">&nbsp;</div>
</div>
</div>
</main>
</div>
</div>
</body>
</html>
25 changes: 25 additions & 0 deletions docs/javadoc/overview-summary.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>kafka-connector 0.1.0 API</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="index redirect">
<meta name="generator" content="javadoc/IndexRedirectWriter">
<link rel="canonical" href="index.html">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript">window.location.replace('index.html')</script>
<noscript>
<meta http-equiv="Refresh" content="0;index.html">
</noscript>
</head>
<body class="index-redirect-page">
<main role="main">
<noscript>
<p>JavaScript is disabled on your browser.</p>
</noscript>
<p><a href="index.html">index.html</a></p>
</main>
</body>
</html>
5 changes: 3 additions & 2 deletions docs/javadoc/overview-tree.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li class="nav-bar-cell1-rev">Tree</li>
Expand Down Expand Up @@ -57,9 +58,9 @@ <h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
<ul>
<li class="circle">com.lightstreamer.interfaces.metadata.MetadataProviderAdapter (implements com.lightstreamer.interfaces.metadata.MetadataProvider)
<li class="circle">com.lightstreamer.interfaces.metadata.<a href="https://sdk.lightstreamer.com/ls-adapter-inprocess/8.0.0/api/com/lightstreamer/interfaces/metadata/MetadataProviderAdapter.html" class="type-name-link external-link" title="class or interface in com.lightstreamer.interfaces.metadata">MetadataProviderAdapter</a> (implements com.lightstreamer.interfaces.metadata.<a href="https://sdk.lightstreamer.com/ls-adapter-inprocess/8.0.0/api/com/lightstreamer/interfaces/metadata/MetadataProvider.html" title="class or interface in com.lightstreamer.interfaces.metadata" class="external-link">MetadataProvider</a>)
<ul>
<li class="circle">com.lightstreamer.adapters.metadata.LiteralBasedProvider
<li class="circle">com.lightstreamer.adapters.metadata.<a href="https://sdk.lightstreamer.com/ls-adapter-inprocess/8.0.0/api/com/lightstreamer/adapters/metadata/LiteralBasedProvider.html" class="type-name-link external-link" title="class or interface in com.lightstreamer.adapters.metadata">LiteralBasedProvider</a>
<ul>
<li class="circle">com.lightstreamer.kafka_connector.adapters.pub.<a href="com/lightstreamer/kafka_connector/adapters/pub/KafkaConnectorMetadataAdapter.html" class="type-name-link" title="class in com.lightstreamer.kafka_connector.adapters.pub">KafkaConnectorMetadataAdapter</a></li>
</ul>
Expand Down
3 changes: 2 additions & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# Examples

This folder contains several examples showing you how to use Lightstreamer Kafka Connector.
This folder contains several examples showing you how to use Lightstreamer Kafka Connector:

- [docker](./docker/): a minimal Docker image
- [quickstart](quickstart/): the _Quick Start_ app
- [quickstart-producer](quickstart-producer//): the producer used for the the _Quick Start_ app
- [quickstart-ssl](quickstart-ssl/): the _Quick Start_ app with encryption settings
- [quickstart-confluent-cloud](quickstart-confluent-cloud/): the _Quick Start_ app with Confluent Cloud as the target Kafka Cluster
- [custom-kafka-connector-adapter](custom-kafka-connector-adapter/): a sample Gradle project for building and deploying a custom _Kafka Connector Metadata Adapter_
9 changes: 0 additions & 9 deletions examples/compose-templates/Dockerfile.producer

This file was deleted.

5 changes: 0 additions & 5 deletions examples/compose-templates/start.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,6 @@ source ../utils/helpers.sh
../docker/build.sh

if [ $? == 0 ]; then
# Generate the producer jar
$_gradle distribuiteProducer
rm -fr ../compose-templates/producer; mkdir -p ../compose-templates/producer
cp ../../deploy/lightstreamer-kafka-connector-samples-producer-all-${version}.jar ../compose-templates/producer
# Export the version env variable to be used by Compose
export version
docker compose -f $(pwd)/docker-compose.yml up --build -d &&
sleep 10 &&
Expand Down
1 change: 0 additions & 1 deletion examples/compose-templates/stop.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ source ../utils/helpers.sh
# Export the version env variable to be used by Compose
export version
docker compose down
rm -fr ../compose-templates/producer
$_gradle clean
3 changes: 1 addition & 2 deletions examples/quickstart-confluent-cloud/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@ services:
producer:
container_name: producer
build:
context: ../compose-templates
dockerfile: Dockerfile.producer
context: ../quickstart-producer
args:
VERSION: ${version}
configs:
Expand Down
3 changes: 3 additions & 0 deletions examples/quickstart-producer/.vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"java.configuration.updateBuildConfiguration": "automatic"
}
Loading

0 comments on commit 2535bdc

Please sign in to comment.