Skip to content

Commit

Permalink
Fix names
Browse files Browse the repository at this point in the history
  • Loading branch information
gfinocchiaro committed Mar 13, 2024
1 parent 67a9a14 commit 7160b3b
Show file tree
Hide file tree
Showing 9 changed files with 26 additions and 26 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@

## Introduction

The _Lightstreamer Kafka Connector_ is a ready-made pluggable Lightstreamer Adapter that enables event streaming from a Kafka broker to the internet.
_Lightstreamer Kafka Connector_ is a ready-made pluggable Lightstreamer Adapter that enables event streaming from a Kafka broker to the internet.

With Kafka Connector, any internet client connected to Lightstreamer Server can consume events from Kafka topics like any other Kafka client. The Connector takes care of processing records received from Kafka to adapt and route them as real-time updates for the clients.

Expand Down Expand Up @@ -113,7 +113,7 @@ To provide a complete stack, the app is based on _Docker Compose_. The [Docker C

## Installation

This section will guide you through the installation of Lightstreamer Kafka Connector to get it up and running in a very short time.
This section will guide you through the installation of Kafka Connector to get it up and running in a very short time.

### Requirements

Expand Down Expand Up @@ -190,7 +190,7 @@ To quickly complete the installation and verify the successful integration with

Kafka Connector will then route the event to all matched items.

In addition, the following section defines how to map the record to the tabular form of Lightstreamer fields, by using the aforementioned _Extraction Keys_. In this case, the `VALUE` predefined constant extracts the value part of Kakfa records.
In addition, the following section defines how to map the record to the tabular form of Lightstreamer fields, by using the aforementioned _Extraction Keys_. In this case, the `VALUE` predefined constant extracts the value part of Kafka records.

```xml
<param name="field.stock_name">#{VALUE.name}</param>
Expand Down Expand Up @@ -315,7 +315,7 @@ where you have to replace `API.key` and `secret` with the _API Key_ and _secret_

## Configuration

As already anticipated, Lightstreamer Kafka Connector is a Lightstreamer Adapter Set, which means it is made up of a Metadata Adapter and one or more Data Adapters, whose settings are defined in the `LS_HOME/adapters/lightstreamer-kafka-connector-<version>/adapters.xml` file.
As already anticipated, Kafka Connector is a Lightstreamer Adapter Set, which means it is made up of a Metadata Adapter and one or more Data Adapters, whose settings are defined in the `LS_HOME/adapters/lightstreamer-kafka-connector-<version>/adapters.xml` file.

The following sections will guide you through the configuration details.

Expand Down Expand Up @@ -814,7 +814,7 @@ Examples:

##### `record.key.evaluator.schema.path` and `record.value.evaluator.schema.path`

_Mandatory if [evaluator type](#recordkeyevaluatortype-and-recordvalueevaluatortype) is `AVRO`_ and the [Confluent Schema Registry](#recordkeyevaluatorschemaregistryenable-and-recordvalueevaluatorschemaregistryenable) is disabled. The path of the local schema file relative to the deployment folder (`LS_HOME/adapters/lightstreamer-kafka-connector-<version>`) for message validation respectively of the Kafka key and the Kafa value.
_Mandatory if [evaluator type](#recordkeyevaluatortype-and-recordvalueevaluatortype) is `AVRO`_ and the [Confluent Schema Registry](#recordkeyevaluatorschemaregistryenable-and-recordvalueevaluatorschemaregistryenable) is disabled. The path of the local schema file relative to the deployment folder (`LS_HOME/adapters/lightstreamer-kafka-connector-<version>`) for message validation respectively of the Kafka key and the Kakfa value.

Examples:

Expand All @@ -825,7 +825,7 @@ Examples:

##### `record.key.evaluator.schema.registry.enable` and `record.value.evaluator.schema.registry.enable`

_Mandatory if [evaluator type](#recordkeyevaluatortype-and-recordvalueevaluatortype) is `AVRO` and no [local schema paths](#recordkeyevaluatorschemaregistryenable-and-recordvalueevaluatorschemaregistryenable) are specified_. Enable the use of the [Confluent Schema Registry](#schema-registry) for validation respectively of the Kafka key and the Kafa value. Can be one of the following:
_Mandatory if [evaluator type](#recordkeyevaluatortype-and-recordvalueevaluatortype) is `AVRO` and no [local schema paths](#recordkeyevaluatorschemaregistryenable-and-recordvalueevaluatorschemaregistryenable) are specified_. Enable the use of the [Confluent Schema Registry](#schema-registry) for validation respectively of the Kafka key and the Kafka value. Can be one of the following:
- `true`
- `false`

Expand Down Expand Up @@ -1000,7 +1000,7 @@ The _QuickStart_ [factory configuration file](kafka-connector/src/connector/dist

##### Filtered Record Routing (`item-template.<template-name>`)

Besides mapping topics to statically predefined items, Kakfa Connector allows you to configure the _item templates_,
Besides mapping topics to statically predefined items, Kafka Connector allows you to configure the _item templates_,
which specify the rule needed to decide if a message can be forwarded to the clients, thus enabling a _filtered routing_.
The item template leverages the _Data Extraction Language_ to extract data from Kafka records and match them against the _parameterized_ subscribed items.

Expand Down Expand Up @@ -1205,7 +1205,7 @@ For a Maven project, add the dependency to your _pom.xml_ file:

```xml
<dependency>
<groupId>com.lighstreamer.kafka-connector</groupId>
<groupId>com.lightstreamer.kafka-connector</groupId>
<artifactId>kafka-connector</artifactId>
<version>0.1.0</version>
</dependency>
Expand Down
2 changes: 1 addition & 1 deletion docs/javadoc/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,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 Lighstreamer Metadata Adpater for the Lightstreamer Kafka Connector.</div>
<div class="block">Implementation of a Lighttreamer Metadata Adpater for Lightstreamer Kafka Connector.</div>
</div>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ <h1 title="Class KafkaConnectorMetadataAdapter" class="title">Class KafkaConnect
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">KafkaConnectorMetadataAdapter</span>
<span class="extends-implements">extends com.lightstreamer.adapters.metadata.LiteralBasedProvider</span></div>
<div class="block">Implementation of a Lighstreamer Metadata Adpater for the Lightstreamer Kafka Connector.
<div class="block">Implementation of a Lighttreamer Metadata Adpater for Lightstreamer Kafka Connector.

<p>For the sake of simplicity, this documentation shows only the hook methods.</div>
<dl class="notes">
Expand Down Expand Up @@ -129,14 +129,14 @@ <h2>Method Summary</h2>
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;sessionID,
com.lightstreamer.interfaces.metadata.TableInfo[]&nbsp;tables)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Hook method invoked by Lighstreamer Kernel to notify that a user has submitted a
<div class="block">Hook method invoked by Lightstreamer Kernel to notify that a user has submitted a
Subscription.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onUnsubscription(java.lang.String,com.lightstreamer.interfaces.metadata.TableInfo%5B%5D)" class="member-name-link">onUnsubscription</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;sessionID,
com.lightstreamer.interfaces.metadata.TableInfo[]&nbsp;tables)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Hook method invoked by Lighstreamer Kernel to notify that a Subscription has been removed
<div class="block">Hook method invoked by Lightstreamer Kernel to notify that a Subscription has been removed
from a push session.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
Expand Down Expand Up @@ -225,7 +225,7 @@ <h3>onSubscription</h3>
com.lightstreamer.interfaces.metadata.TableInfo[]&nbsp;tables)</span>
throws <span class="exceptions">com.lightstreamer.interfaces.metadata.CreditsException,
com.lightstreamer.interfaces.metadata.NotificationException</span></div>
<div class="block">Hook method invoked by Lighstreamer Kernel to notify that a user has submitted a
<div class="block">Hook method invoked by Lightstreamer Kernel to notify that a user has submitted a
Subscription.

<p>In this default implementation, the KafkaConnector Metadata Adapter does nothing.</div>
Expand Down Expand Up @@ -258,7 +258,7 @@ <h3>onUnsubscription</h3>
@Nonnull
com.lightstreamer.interfaces.metadata.TableInfo[]&nbsp;tables)</span>
throws <span class="exceptions">com.lightstreamer.interfaces.metadata.NotificationException</span></div>
<div class="block">Hook method invoked by Lighstreamer Kernel to notify that a Subscription has been removed
<div class="block">Hook method invoked by Lightstreamer Kernel to notify that a Subscription has been removed
from a push session.

<p>In this default implementation, the KafkaConnector Metadata Adapter does nothing.</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,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 Lighstreamer Metadata Adpater for the Lightstreamer Kafka Connector.</div>
<div class="block">Implementation of a Lighttreamer Metadata Adpater for Lightstreamer Kafka Connector.</div>
</div>
</div>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/javadoc/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,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 Lighstreamer Metadata Adpater for the Lightstreamer Kafka Connector.</div>
<div class="block">Implementation of a Lighttreamer Metadata Adpater 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 All @@ -67,12 +67,12 @@ <h2 class="title" id="I:O">O</h2>
<dl class="index">
<dt><a href="com/lightstreamer/kafka_connector/adapters/pub/KafkaConnectorMetadataAdapter.html#onSubscription(java.lang.String,java.lang.String,com.lightstreamer.interfaces.metadata.TableInfo%5B%5D)" class="member-name-link">onSubscription(String, String, TableInfo[])</a> - Method in 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>
<div class="block">Hook method invoked by Lighstreamer Kernel to notify that a user has submitted a
<div class="block">Hook method invoked by Lightstreamer Kernel to notify that a user has submitted a
Subscription.</div>
</dd>
<dt><a href="com/lightstreamer/kafka_connector/adapters/pub/KafkaConnectorMetadataAdapter.html#onUnsubscription(java.lang.String,com.lightstreamer.interfaces.metadata.TableInfo%5B%5D)" class="member-name-link">onUnsubscription(String, TableInfo[])</a> - Method in 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>
<div class="block">Hook method invoked by Lighstreamer Kernel to notify that a Subscription has been removed
<div class="block">Hook method invoked by Lightstreamer Kernel to notify that a Subscription has been removed
from a push session.</div>
</dd>
</dl>
Expand Down
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Examples

This folder contains several examples showing you how to use the 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
Expand Down
4 changes: 2 additions & 2 deletions examples/docker/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Lightstreamer Kafka Connector Docker Image

This folder contains the resources required to build a minimal Docker image of the Lighstreamer Kafka Connector.
This folder contains the resources required to build a minimal Docker image of Lightstreamer Kafka Connector.

The image is built by deriving the official [Lighstreamer Docker image](https://hub.docker.com/_/lightstreamer) with the current version of the Kafka Connector. Check out the [`Dockerfile`](./Dockerfile) for more details.
The image is built by deriving the official [Lightstreamer Docker image](https://hub.docker.com/_/lightstreamer) with the current version of the Kafka Connector. Check out the [`Dockerfile`](./Dockerfile) for more details.

## Requirements:

Expand Down
4 changes: 2 additions & 2 deletions kafka-connector/src/connector/dist/adapters.xml
Original file line number Diff line number Diff line change
Expand Up @@ -283,14 +283,14 @@

<!-- Mandatory if evaluator type is AVRO and the Confluent Schema Registry is disabled. The path of the local schema
file relative to the deployment folder (LS_HOME/adapters/lightstreamer-kafka-connector-<version>) for
message validation respectively of the Kafka key and the Kafa value. -->
message validation respectively of the Kafka key and the Kafka value. -->
<!--
<param name="record.key.evaluator.schema.path">schema/record_key.avsc</param>
<param name="record.value.evaluator.schema.path">schemas/record_value.avsc</param>
-->

<!-- Mandatory if evaluator type is AVRO and no local schema paths are specified. Enable the use of the Confluent Schema Registry for validation respectively of the Kafka key and
the Kafa value. Can be one of the following:
the Kafka value. Can be one of the following:
- true
- false
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
import javax.annotation.Nullable;

/**
* Implementation of a Lighstreamer Metadata Adpater for the Lightstreamer Kafka Connector.
* Implementation of a Lighttreamer Metadata Adpater for Lightstreamer Kafka Connector.
*
* <p>For the sake of simplicity, this documentation shows only the hook methods.
*
Expand Down Expand Up @@ -237,7 +237,7 @@ protected final Optional<ConnectionInfo> lookUp(String connectionName) {
}

/**
* Hook method invoked by Lighstreamer Kernel to notify that a user has submitted a
* Hook method invoked by Lightstreamer Kernel to notify that a user has submitted a
* Subscription.
*
* <p>In this default implementation, the KafkaConnector Metadata Adapter does nothing.
Expand All @@ -259,7 +259,7 @@ public void onSubscription(
throws CreditsException, NotificationException {}

/**
* Hook method invoked by Lighstreamer Kernel to notify that a Subscription has been removed
* Hook method invoked by Lightstreamer Kernel to notify that a Subscription has been removed
* from a push session.
*
* <p>In this default implementation, the KafkaConnector Metadata Adapter does nothing.
Expand Down

0 comments on commit 7160b3b

Please sign in to comment.