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/.

WebSocket Transport

The WebSocket transport implementation of WSO2 Enterprise Integrator(WSO2 EI) is based on the WebSocket protocol, and consists of an Axis2 sender implementation for WebSockets and secure WebSockets. This transport supports bi-directional message mediation.

Enabling the transport

The following transport sender class should be included in the WSO2 EI configuration to enable the WebSocket transport.

  • org.wso2.carbon.websocket.transport.WebsocketTransportSender

To enable the WebSocket transport sender

  • Edit the <EI_HOME>/conf/axis2/axis2.xml file and uncomment the following WebSocket sender configuration:

    <transportSender name="ws" class="org.wso2.carbon.websocket.transport.WebsocketTransportSender">
          <parameter name="ws.outflow.dispatch.sequence" locked="false">outflowDispatchSeq</parameter>
          <parameter name="ws.outflow.dispatch.fault.sequence" locked="false">outflowFaultSeq</parameter>       
    </transportSender>

To enable the secure WebSocket transport sender

  • Edit the <EI_HOME>/conf/axis2/axis2.xml file and uncomment the following secure WebSocket sender configuration:

    <transportSender name="wss" class="org.wso2.carbon.websocket.transport.WebsocketTransportSender">
          <parameter name="ws.outflow.dispatch.sequence" locked="false">outflowDispatchSeq</parameter>
          <parameter name="ws.outflow.dispatch.fault.sequence" locked="false">outflowFaultSeq</parameter>
          <parameter name="ws.trust.store" locked="false">
                <ws.trust.store.location>repository/resources/security/client-truststore.jks</ws.trust.store.location>
                <ws.trust.store.Password>wso2carbon</ws.trust.store.Password>
          </parameter>
    </transportSender>