Input WebSocket Local Event Adapter

Input WebSocket local event adapters are used to receive events via a WebSocket, similar to input WebSocket event adapters. The difference between input WebSocket event adapter and input WebSocket local event adapter is that the latter provides a WebSocket to the user, for convenience. WSO2 products provide this WebSocket on the same host on which, they run.

Configuring input WebSocket local event adapter

You can configure the input WebSocket local event adapter either using the management console or a configuration file.

Configure using the management console

Follow the instructions below to configure input WebSocket local event adapter using the management console. This deploys the event adapter in the <PRODUCT_HOME>/

repository/deployment/server/inputeventadaptors/ directory.

Log in to the 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 WebSocket local event adapter configuration using a configuration file.

Create an XML file with the following WebSocket event adapter configurations. Input event adapter implementation must start with <inputEventAdaptor> as the root element.
```
<inputEventAdaptor name="websocketLocalInputAdaptor" statistics="disable" trace="disable" type="websocket-local" xmlns="http://wso2.org/carbon/eventadaptormanager"/>
```
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 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 WebSocket local event adapter message properties

The configured input WebSocket local event adapters are used in event builders. With input event adapter 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 the input WebSocket local event adapter.

input WebSocket local event adapter message properties

The message properties of the input WebSocket local event adapter are described below.

Property	Specification
Topic	The topic that will be used to receive messages on the input WebSocket local event adapter. This is optional.
Input Mapping Type	The incoming event type to be mapped. The input WebSocket local event adapter supports XML, JSON, and text type mappings.

After filling the required message properties, click Add Event Builder to enable the adapter to receive events via the specified WebSocket. Thereby, an endpoint to receive incoming events will be available in the following URLs:

For super tenant: ws://<host>:9763/inputwebsocket/<INPUT_ADAPTER_NAME>/<TOPIC>
According to the above example, the generated URL would be:
ws://localhost:9763/inputwebsocket/websocketLocalInputAdaptor/abc
For other tenants: ws://<host>:9763/inputwebsocket/t/<tenant_domain>/<INPUT_ADAPTER_NAME>/<TOPIC>
According to the above example, (considering mycompany.com as the tenant domain), the generated URL would be:
ws://localhost:9763/inputwebsocket/t/mycompany.com/websocketLocalInputAdaptor/abc