CA API Gateway 9.1

9.4 9.1

Manage WebSocket Connections

WebSocket technology provides bi-directional, full-duplex communications channels over a single TCP connection and reduces the time spent creating sockets for each request. Use the Manage WebSocket Connections task to configure the CA API Gateway to communicate with WebSocket clients and servers for both inbound and outbound messages.
gateway91
WebSocket technology provides bi-directional, full-duplex communications channels over a single TCP connection and reduces the time spent creating sockets for each request. Use the 
Manage WebSocket Connections 
task to configure the CA API Gateway to communicate with WebSocket clients and servers for both inbound and outbound messages.
The Gateway currently does not support adding or removing headers in a WebSocket connection using Manage Transport Properties/Headers Assertion.
To configure WebSocket connections:
  1. In the Policy Manager, select
    Tasks >
    Extensions and Add-Ons > Manage WebSocket Connections
    .
  2. Double-click an existing connection to edit properties, or click 
    Create 
    to add a new connection.
WebSocket Connection Properties
The WebSocket connection properties are displayed when you create, modify, or view details of a WebSocket connection.
 
When you save changes to an existing enabled connection, the WebSocket server restarts. Any existing client connections are dropped.
To configure WebSocket connections:
  1. Enter a unique 
    Name
     for the WebSocket connection and an optional description.
  2. Select the 
    Enabled
     check box to activate the WebSocket connection. 
  3. Configure the Inbound and Outbound parameters shown in the following tables.
    An inbound WebSocket connection listens for a WebSocket client connection request.
    An outbound WebSocket connection passes a client message to a protected WebSocket server.
    If you have explicitly configured
    ip_tables
     to open a port, remove this modification. This assertion includes parameters to open the port.
Inbound Parameters
Description
Listen Port
Enter the port number to monitor.
Maximum Connections
Enter the maximum number of allowable connections.
Maximum Idle Time
Enter the maximum idle time in milliseconds.
Inbound Policy
Specify how to resolve the service. Choose the published service from the drop-down list.
Use SSL
Select this check box to use a secure connection. This enables the 
Client Authentication
 and 
Private Key
 settings. 
Clear this check box to use a standard connection.
Client Authentication
If using SSL, specify whether the client must present a certificate to authenticate:
  • None:
     The client never needs to present a certificate.
  • Optional:
     The client can optionally present a certificate.
  • Required:
     The client must always present a certificate to authenticate.
Private Key
If using SSL, choose the server private key to be used for the inbound connection from the drop-down list.
Outbound Parameters
Description
URL
Enter the URL of WebSocket server in one of the following formats: 
ws://
<hostname>
:
<port>
wss://
<hostname>
:
<port>
If this field is left blank, the connection is considered a loopback and responds to the client based solely on the inbound definition.
Maximum Idle Time
Enter the maximum idle time in milliseconds.
Outbound Policy
Specify how to resolve the service. Choose the published service from the drop-down list.
Use SSL
Select this check box to connect to a secure server. This enables the 
Client Authentication
 and 
Private Key
 settings. 
Clear this check box to use a standard connection.
Client Authentication
SSL only. Select this check box if the server requires client authentication.

Content feedback and comments