Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The input WebSocket event adapter is used to receive events via a WebSocket. You can specify the URL of a WebSocket, so that WSO2 products can receive events from it. The input WebSocket event adapter supports XML, JSON, and text type mappingsTo use it you need to do the following configurations.

Excerpt
hiddentrue

NOTE TO WRITERS: Add the TOC here.

Table of Contents
maxLevel3

...

  1. Log in to the product's management console and click Configure.
  2. Click Input Event Adaptors in the Event Processor Configs menu, and then click Add Input Event Adaptor.
  3. Enter details as shown in the below example. 

    create input WebSocket event adapterImage Modified

  4. Click Add Event Adaptor.

...

  1. Create an XML file with the following WebSocket Event Adapter event adapter configurations. Input event adapter implementation must start with <inputEventAdaptor> as the root element.

    Code Block
    languagexml
    <inputEventAdaptor name="websocketInputAdaptor" statistics="disable" trace="disable" type="websocket" xmlns="http://wso2.org/carbon/eventadaptormanager">
    <property name="websocket.server.url">ws://localhost:9099</property>
    </inputEventAdaptor>
  2. 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. 

...

The configured input WebSocket 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 event adapter.

Image Removedinput WebSocket event adapter message propertiesImage Added

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

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