This documentation is for WSO2 API Manager 2.1.0 View documentation for the latest release.
Page Comparison - Changing the Default Ports with Offset (v.4 vs v.5) - API Manager 2.1.0 - WSO2 Documentation

All docs This doc

Versions Compared

Key

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

...

Code Block
languagehtml/xml
<address uri="https://localhost:9445/store/site/blocks/workflow/workflow-listener/ajax/workflow-listener.jag" format="rest"/>

Changing the Inbound websocket port

Warning

If you are changing the port offset, it is necessary to change the websocket port as well, regardless of whether or not you use websocket APIs.

From API Manager 2.1.0 onwards, you can create and publish websocket APIs. The default port used for websocket APIs is port 9099. 

If you are using port offsets with multiple API Manager nodes in a distributed mode, you need to change the inbound.ws.port in the <APIM_HOME>/repository/deployment/server/synapse-configs/default/inbound-endpoints/WebSocketInboundEndpoint.xml file by incrementing it with the same offset that you used in the <APIM_HOME>/repository/conf/carbon.xml file above.

For example, if your carbon.xml file has an offset value of 2, the WebSocketInboundEndpoint.xml file should have an inbound.ws.port value of 9101, as shown below.

Code Block
languagexml
<inboundEndpoint xmlns="http://ws.apache.org/ns/synapse"
                 name="WebSocketInboundEndpoint"
                 sequence="dispatchSeq"
                 onError="fault"
                 protocol="ws"
                 suspend="false">
   <parameters>
      <parameter name="inbound.ws.port">9101</parameter>
      <parameter name="ws.outflow.dispatch.sequence">outDispatchSeq</parameter>
      <parameter name="ws.pipeline.handler.class">org.wso2.carbon.apimgt.gateway.handlers.WebsocketHandler</parameter>
      <parameter name="ws.subprotocol.handler.class">org.wso2.carbon.inbound.endpoint.protocol.websocket.subprotocols.EchoSubprotocolHandler</parameter>
      <parameter name="dispatch.custom.sequence">true</parameter>
      <parameter name="ws.outflow.dispatch.fault.sequence">fault</parameter>
      <parameter name="ws.client.side.broadcast.level">0</parameter>
   </parameters>
</inboundEndpoint>

For a list of all default ports opened in WSO2 API Manager, see Default Product Ports.