WebSocket Local Event Publisher
- Former user (Deleted)
WebSocket local event publisher is an internal event publisher that comes with WSO2 products by default. You can configure it with XML, text, and JSON output mapping types.
The websocket-local event publisher should be used when the DAS publishes to a websocket client. Websocket clients need to connect to the inbuilt websocket server of WSO2 DAS for the events to be published. However, when the DAS publishes to a web socket server, the DAS should connect to the websocket server in order to publish events. In such scenarios, use the WebSocket Event Publisher.
Creating a WebSocket local event publisher
For instructions on creating a WebSocket local event publisher, see Creating Alerts.
Configuring global properties
The following global properties can be set for WebSocket local event publisher type in the <DAS_HOME>/repository/conf/output-event-adapters.xml file. These properties apply to all the publishers of the web socket-local type. If a global property available by default is removed, the default value of the property is considered.
Custom properties cannot be added as global properties.
| Property Key | Description | Data Type | Default Value |
|---|---|---|---|
minThread | The minimum number of threads (including idle threads) that should be available in the thread pool at a given time. | Integer | 8 |
maxThread | The maximum number of threads (including idle threads) that should be available in the thread pool at a given time. | Integer | 100 |
keepAliveTimeInMillis | The maximum number of milliseconds that idle threads should be kept alive when the total number of threads in the pool exceeds the number of cores in the machine. | Integer | 20000 |
jobQueueSize | The maximum number of milliseconds that idle threads should be kept alive when the total number of threads in the pool exceeds the number of cores in the machine. | Integer | 10000
|
Configuring adapter properties
There are not any adapter-specific properties for the WebSocket local event publisher as shown below.
When multi-tenancy is used, the URL formats used to publish events are as follows.
| Super-tenant/Tenant | URL Formats |
|---|---|
| Super-tenant | ws://localhost:";<DAS_Server_Port>"/outputwebsocket/<publisher_name>wss://localhost:";<DAS_SSL_Server_Port>"/outputwebsocket/<publisher_name>"; |
| Tenant | ws://localhost:";<DAS_Server_Port>"/t/<tenant_domain>/outputwebsocket/<publisher_name>wss://localhost:";<DAS_SSL_Server_Port>"/t/<tenant_domain>/outputwebsocket/<publisher_name>"; |
e.g., If the publisher name is WebSocketLocalOutputEventPublisher and the tenant domain is mycompany.com, the URL would be as follows when you use the default server ports.
| Super-tenant/Tenant | URL Formats |
|---|---|
| Super-tenant | ws://localhost:";9763"/outputwebsocket/WebSocketLocalOutputEventPublisherwss://localhost:";9443"/outputwebsocket/WebSocketLocalOutputEventPublisher"; |
| Tenant | ws://localhost:";9763"/t/mycompany.com/outputwebsocket/WebSocketLocalOutputEventPublisherwss://localhost:";9443"/t/mycompany.com/outputwebsocket/WebSocketLocalOutputEventPublisher";
|
Related samples
For more information on websocket-local event publisher type, see the following sample.