diff --git a/README.md b/README.md index b18b2e96..d0999990 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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-.jar` under the `deploy` folder. + which generates the `lightstreamer-kafka-connector-utils-consumer-all-.jar` under the `deploy` folder. Then, launch it with: ```sh - java -jar deploy/lightstreamer-kafka-connector-samples-consumer-all-.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-.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: @@ -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-.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-.jar --bootstrap-servers --topic stocks + java -jar deploy/quickstart-producer-all.jar --bootstrap-servers --topic stocks ``` ![producer_video](pictures/producer.gif) diff --git a/buildSrc/src/main/groovy/lightstreamer-kafka-connector.gradle b/buildSrc/src/main/groovy/lightstreamer-kafka-connector.gradle index a965e52e..a4a1f748 100644 --- a/buildSrc/src/main/groovy/lightstreamer-kafka-connector.gradle +++ b/buildSrc/src/main/groovy/lightstreamer-kafka-connector.gradle @@ -49,7 +49,6 @@ repositories { maven { url "https://packages.confluent.io/maven" } - } dependencies { diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..cf751fe7 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,3 @@ +# Docs + +This folder contains the [API Specification](https://lightstreamer.github.io/Lightstreamer-kafka-connector/javadoc) for _Lightstreamer Kafka Connector_. diff --git a/docs/javadoc/allclasses-index.html b/docs/javadoc/allclasses-index.html index e322158a..cd5a1a0a 100644 --- a/docs/javadoc/allclasses-index.html +++ b/docs/javadoc/allclasses-index.html @@ -27,6 +27,7 @@ diff --git a/docs/javadoc/allpackages-index.html b/docs/javadoc/allpackages-index.html index d06b2286..8db36b13 100644 --- a/docs/javadoc/allpackages-index.html +++ b/docs/javadoc/allpackages-index.html @@ -27,6 +27,7 @@
-

Methods inherited from class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter

-customizeUpdate, customizeUpdate, enableUpdateCustomization, enableUpdateCustomization, isModeAllowed, isModeAllowed, isSelected, isSelected, isSelectorAllowed, isSelectorAllowed, notifyMpnDeviceAccess, notifyMpnDeviceTokenChange, notifyMpnSubscriptionActivation, notifyNewSession, notifyNewSession, notifySessionClose, notifyUserMessage
+

Methods inherited from class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter

+customizeUpdate, customizeUpdate, enableUpdateCustomization, enableUpdateCustomization, isModeAllowed, isModeAllowed, isSelected, isSelected, isSelectorAllowed, isSelectorAllowed, notifyMpnDeviceAccess, notifyMpnDeviceTokenChange, notifyMpnSubscriptionActivation, notifyNewSession, notifyNewSession, notifySessionClose, notifyUserMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-

Methods inherited from interface com.lightstreamer.interfaces.metadata.MetadataProvider

-getSessionTimeToLive, setListener
+

Methods inherited from interface com.lightstreamer.interfaces.metadata.MetadataProvider

+getSessionTimeToLive, setListener @@ -191,7 +182,7 @@

Method Details

postInit

protected void postInit(Map params, File configDir) - throws com.lightstreamer.interfaces.metadata.MetadataProviderException
+ throws MetadataProviderException
Hook method invoked by Lightstreamer Kernel after the initialization phase of the Kafka Connector Metadata Adapter has been completed.
@@ -202,7 +193,7 @@

postInit

configDir - the path of the directory on the local disk where the KafkaConnector configuration file resides
Throws:
-
com.lightstreamer.interfaces.metadata.MetadataProviderException - if an error occurs that prevents the correct behavior of +
MetadataProviderException - if an error occurs that prevents the correct behavior of the Metadata Adapter. This causes the Server not to complete the startup and to exit.
See Also:
@@ -222,9 +213,9 @@

onSubscription

@Nonnull String sessionID, @Nonnull - com.lightstreamer.interfaces.metadata.TableInfo[] tables) - throws com.lightstreamer.interfaces.metadata.CreditsException, -com.lightstreamer.interfaces.metadata.NotificationException + TableInfo[] tables) + throws CreditsException, +NotificationException
Hook method invoked by Lightstreamer Kernel to notify that a user has submitted a Subscription. @@ -236,8 +227,8 @@

onSubscription

tables - an array of TableInfo instances, each of them containing the details of a Subscription to be added to the session
Throws:
-
com.lightstreamer.interfaces.metadata.CreditsException - if the user is not allowed to submit the Subscription
-
com.lightstreamer.interfaces.metadata.NotificationException - if something is wrong in the parameters, such as the +
CreditsException - if the user is not allowed to submit the Subscription
+
NotificationException - if something is wrong in the parameters, such as the sessionID of a session that is not currently open or inconsistent information about the Subscription
See Also:
@@ -256,8 +247,8 @@

onUnsubscription

public void onUnsubscription(@Nonnull String sessionID, @Nonnull - com.lightstreamer.interfaces.metadata.TableInfo[] tables) - throws com.lightstreamer.interfaces.metadata.NotificationException
+ TableInfo[] tables) + throws NotificationException
Hook method invoked by Lightstreamer Kernel to notify that a Subscription has been removed from a push session. @@ -268,7 +259,7 @@

onUnsubscription

tables - an array of TableInfo instances, each of them containing the details of a Subscription that has been removed from the session
Throws:
-
com.lightstreamer.interfaces.metadata.NotificationException - if something is wrong in the parameters, such as the +
NotificationException - if something is wrong in the parameters, such as the sessionID of a session that is not currently open or inconsistent information about the Subscription
See Also:
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 2567b263..b589f59a 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 @@ -27,6 +27,7 @@
KafkaConnectorMetadataAdapter
-
Implementation of a Lighttreamer Metadata Adpater for Lightstreamer Kafka Connector.
+
Implementation of a Lightstreamer Metadata Adapter for Lightstreamer Kafka Connector.
diff --git a/docs/javadoc/com/lightstreamer/kafka_connector/adapters/pub/package-tree.html b/docs/javadoc/com/lightstreamer/kafka_connector/adapters/pub/package-tree.html index 5921154d..0c36e88f 100644 --- a/docs/javadoc/com/lightstreamer/kafka_connector/adapters/pub/package-tree.html +++ b/docs/javadoc/com/lightstreamer/kafka_connector/adapters/pub/package-tree.html @@ -27,6 +27,7 @@