This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.
Input MQTT Event Adapter
MQTT event adapter is an internal event adapter that comes with WSO2 products.
Prerequisites
Follow the steps below before starting the input MQTT event adapter configuration.
- Download MQTT client library (
mqtt-client-0.4.0.jar
). - Add the file to
<PRODUCT_HOME>/repository/components/lib/
directory.
Configuring input MQTT event adapter
You can configure the input MQTT adapter using the management console or using a configuration file.
Configure using the management console
Follow the instructions below to configure input MQTT event adapter using the management console. This deploys the event adapter in the <PRODUCT_HOME>
/
repository/
deployment/
server/
inputeventadaptors/
directory.
- Log in to product's management console, and click Configure.
- Click Input Event Adaptors in the Event Processor Configs menu, and then click Add Input Event Adaptor.
- Enter details as shown in the below example.
Click Add Event Adaptor.
Configure using a configuration file
Follow the instructions below to configure input MQTT event adapter using a configuration file.
Create an XML file with the following MQTT input event adapter configurations. Input event adapter implementation must start with
<inputEventAdaptor>
as the root element.<inputEventAdaptor name="mqttInputEventAdaptor" statistics="disable" trace="disable" type="mqtt" xmlns="http://wso2.org/carbon/eventadaptormanager"> <property name="cleanSession">true</property> <property name="url">tcp://localhost:1883</property> <property name="keepAlive">70000</property> </inputEventAdaptor>
Add the XML file to the
<PRODUCT_HOME>/repository/deployment/server/inputeventadaptors/
directory. Since hot deployment is enabled, you can simply add/remove files to deploy/undeploy to/from the server.
After an adapter is successfully added, it gets added to the list of adapters displayed under Event Processor Configs in the Configure menu of the product's management console. Click Edit to change its configuration and redeploy it. This opens an XML-based editor allowing you to edit the event adapter configurations from the UI. Do your modifications and click Update. You can also delete it, enable/disable statistics or enable/disable tracing on it using the provided options in the UI.
Configuring input MQTT event adaptor message properties
The configured input event adapters are used in event builders. With input event adaptor message properties, event builders are able to extract data from the incoming events to build the event streams. Following are the specific message properties of input MQTT event adapter.
The message properties of the input MQTT event adapter are described below.
Property | Description |
---|---|
Topic | The topic that will be used to receive messages on the MQTT input adapter |
Client Id | Unique client ID used for communication. You cannot have duplicated client IDs for the same MQTT broker. |
Input Mapping Type | The incoming event type to be mapped. |