diff --git a/README.md b/README.md index 8a70ad78..7ba2dc76 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 @@ -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 #{VALUE.name} @@ -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-/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-/adapters.xml` file. The following sections will guide you through the configuration details. @@ -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-`) 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-`) for message validation respectively of the Kafka key and the Kakfa value. Examples: @@ -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` @@ -1000,7 +1000,7 @@ The _QuickStart_ [factory configuration file](kafka-connector/src/connector/dist ##### Filtered Record Routing (`item-template.`) -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. @@ -1205,7 +1205,7 @@ For a Maven project, add the dependency to your _pom.xml_ file: ```xml - com.lighstreamer.kafka-connector + com.lightstreamer.kafka-connector kafka-connector 0.1.0 diff --git a/docs/javadoc/allclasses-index.html b/docs/javadoc/allclasses-index.html index ac39ef8c..e322158a 100644 --- a/docs/javadoc/allclasses-index.html +++ b/docs/javadoc/allclasses-index.html @@ -55,7 +55,7 @@

All Classes and Interfaces<
Description
-
Implementation of a Lighstreamer Metadata Adpater for the Lightstreamer Kafka Connector.
+
Implementation of a Lighttreamer Metadata Adpater for Lightstreamer Kafka Connector.
diff --git a/docs/javadoc/com/lightstreamer/kafka_connector/adapters/pub/KafkaConnectorMetadataAdapter.html b/docs/javadoc/com/lightstreamer/kafka_connector/adapters/pub/KafkaConnectorMetadataAdapter.html index bc6fa009..565ed772 100644 --- a/docs/javadoc/com/lightstreamer/kafka_connector/adapters/pub/KafkaConnectorMetadataAdapter.html +++ b/docs/javadoc/com/lightstreamer/kafka_connector/adapters/pub/KafkaConnectorMetadataAdapter.html @@ -84,7 +84,7 @@

Class KafkaConnect
public class KafkaConnectorMetadataAdapter extends com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Implementation of a Lighstreamer Metadata Adpater for the Lightstreamer Kafka Connector. +
Implementation of a Lighttreamer Metadata Adpater for Lightstreamer Kafka Connector.

For the sake of simplicity, this documentation shows only the hook methods.

@@ -129,14 +129,14 @@

Method Summary

String sessionID, com.lightstreamer.interfaces.metadata.TableInfo[] tables)
-
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.
void
onUnsubscription(String sessionID, com.lightstreamer.interfaces.metadata.TableInfo[] tables)
-
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.
protected void
@@ -225,7 +225,7 @@

onSubscription

com.lightstreamer.interfaces.metadata.TableInfo[] tables) throws com.lightstreamer.interfaces.metadata.CreditsException, com.lightstreamer.interfaces.metadata.NotificationException
-
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.

In this default implementation, the KafkaConnector Metadata Adapter does nothing.

@@ -258,7 +258,7 @@

onUnsubscription

@Nonnull com.lightstreamer.interfaces.metadata.TableInfo[] tables) throws com.lightstreamer.interfaces.metadata.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.

In this default implementation, the KafkaConnector Metadata Adapter does nothing.

diff --git a/docs/javadoc/com/lightstreamer/kafka_connector/adapters/pub/package-summary.html b/docs/javadoc/com/lightstreamer/kafka_connector/adapters/pub/package-summary.html index b25bef29..2567b263 100644 --- a/docs/javadoc/com/lightstreamer/kafka_connector/adapters/pub/package-summary.html +++ b/docs/javadoc/com/lightstreamer/kafka_connector/adapters/pub/package-summary.html @@ -68,7 +68,7 @@

Description

-
Implementation of a Lighstreamer Metadata Adpater for the Lightstreamer Kafka Connector.
+
Implementation of a Lighttreamer Metadata Adpater for Lightstreamer Kafka Connector.
diff --git a/docs/javadoc/index-all.html b/docs/javadoc/index-all.html index edcc127b..c2a742af 100644 --- a/docs/javadoc/index-all.html +++ b/docs/javadoc/index-all.html @@ -58,7 +58,7 @@

K

KafkaConnectorMetadataAdapter - Class in com.lightstreamer.kafka_connector.adapters.pub
-
Implementation of a Lighstreamer Metadata Adpater for the Lightstreamer Kafka Connector.
+
Implementation of a Lighttreamer Metadata Adpater for Lightstreamer Kafka Connector.
KafkaConnectorMetadataAdapter() - Constructor for class com.lightstreamer.kafka_connector.adapters.pub.KafkaConnectorMetadataAdapter
 
@@ -67,12 +67,12 @@

O

onSubscription(String, String, TableInfo[]) - Method in class com.lightstreamer.kafka_connector.adapters.pub.KafkaConnectorMetadataAdapter
-
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.
onUnsubscription(String, TableInfo[]) - Method in class com.lightstreamer.kafka_connector.adapters.pub.KafkaConnectorMetadataAdapter
-
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.
diff --git a/examples/README.md b/examples/README.md index cf6c4e98..7edda3f1 100644 --- a/examples/README.md +++ b/examples/README.md @@ -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 diff --git a/examples/docker/README.md b/examples/docker/README.md index 5b268a6c..2d7e75c0 100644 --- a/examples/docker/README.md +++ b/examples/docker/README.md @@ -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: diff --git a/kafka-connector/src/connector/dist/adapters.xml b/kafka-connector/src/connector/dist/adapters.xml index 1f01ad1a..1c5cde5d 100644 --- a/kafka-connector/src/connector/dist/adapters.xml +++ b/kafka-connector/src/connector/dist/adapters.xml @@ -283,14 +283,14 @@ + message validation respectively of the Kafka key and the Kafka value. -->