Update wiki Home page for pubnub

Home.md

@@ -1,21 +1,41 @@
-# Deploy the Project on CamelX Platform
+# PubNub
 
-Deploy on CamelX Platform in three steps
+Send and receive messages to/from PubNub data stream network for connected devices.
 
-## Step 1: Create a release
+## Metadata
-From the project space, click on **"Create a release"**
 
-The new version is automatically available in the list
+| Property | Value |
+|----------|-------|
+| Scheme | `pubnub` |
+| Support Level | Stable |
+| Labels | cloud,iot,messaging |
+| Version | 4.10.2 |
 
-## Step 2: Deploy
+## Maven Dependency
-Click on **"Deploy"**
 
-- **Version:** Select the desired release
+```xml
-- **Environment:** Choose `Development`, `Staging`, or `Production` 
+<dependency>
-- **Configuration:** Select the configuration source
+    <groupId>org.apache.camel</groupId>
-- **Resources:** Set CPU and Memory
+    <artifactId>camel-pubnub</artifactId>
+    <version>4.10.2</version>
+</dependency>
+```
 
-## Step 3: Expose
+## Endpoint Properties
-Enable **"Expose"**
 
-Choose an **API Gateway** (Internal, Public, etc.)
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `channel` | string | ✓ |  | The channel used for subscribing/publishing events |
+| `uuid` | string | ✓ |  | UUID to be used as a device identifier, a default UUID is generated if not passed. |
+| `withPresence` | boolean |  | `false` | Also subscribe to related presence information |
+| `bridgeErrorHandler` | boolean |  | `false` | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
+| `exceptionHandler` | object |  |  | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
+| `exchangePattern` | object |  |  | Sets the exchange pattern when the consumer creates an exchange. |
+| `operation` | string |  |  | The operation to perform. PUBLISH: Default. Send a message to all subscribers of a channel. FIRE: allows the client to send a message to BLOCKS Event Handlers. These messages will go directly to any Event Handlers registered on the channel. HERENOW: Obtain information about the current state of a channel including a list of unique user-ids currently subscribed to the channel and the total occupancy count. GETSTATE: Used to get key/value pairs specific to a subscriber uuid. State information is supplied as a JSON object of key/value pairs SETSTATE: Used to set key/value pairs specific to a subscriber uuid GETHISTORY: Fetches historical messages of a channel. |
+| `lazyStartProducer` | boolean |  | `false` | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
+| `pubnub` | object |  |  | Reference to a Pubnub client in the registry. |
+| `authKey` | string |  |  | If Access Manager is utilized, client will use this authKey in all restricted requests. Default value notice: This setting is deprecated because it relates to deprecated Access Manager (PAM V2) and will be removed in the future. Please, migrate to new Access Manager (PAM V3) https://www.pubnub.com/docs/general/resources/migration-guides/pam-v3-migration |
+| `publishKey` | string |  |  | The publish key obtained from your PubNub account. Required when publishing messages. |
+| `secretKey` | string |  |  | The secret key used for message signing. |
+| `secure` | boolean |  | `true` | Use SSL for secure transmission. |
+| `subscribeKey` | string |  |  | The subscribe key obtained from your PubNub account. Required when subscribing to channels or listening for presence events |