Developer Guide

Back Next

Connection Parameters

The following table describes the parameters in the HTTP request and response content for connections:

Parameters	Description
name	Name of the connection.
type	Type of entity. For example, _VDS_UM_TRANSPORT or _VDS_WS_TRANSPORT.

The following table describes the parameters in the HTTP request content for the Ultra Messaging transport:

Parameters	Description
resolution	Type of connection. Specify unicast or multicast topic resolution type.
umMode	Mode in which the source service distributes data to the target service. For example, ULB, UMS, or, UMP.
umConnectionType	Indicates if the connection is secure or nonsecure.
certificate	Certificate file name. Provide the file name if the connection is secure.
certificateKey	Key file name. Provide the file name if the connection is secure.
certificateKeyPassword	Password to the key file. Provide the password if the connection is secure.
trustedCertificates	Truststore file name. Provide the file name if the connection is secure.
daemon	Address of the topic resolution daemon. Provide the daemon address if the topic resolution is unicast.
address	Multicast address that you want to use. Provide the address if the topic resolution is multicast.
resolverPort	The unicast or multicast UDP port.
requestTcpPort	The port on which to listen for responses from requests.
transportTcpPort	The preferred TCP port for the topic that the UM application publishes on.
umConfig	The UM configuration that the data connection uses.

The following table describes the parameters in the HTTP request and response content for the WebSocket transport:

Parameters	Description
messagingMode	Mode in which the source service distributes data to the target service. For example, ACKNOWLEDGEMENT or STREAMING
wsConnectionType	Indicates if the connection is secure or nonsecure. For example, WS (for WebSocket), or WSS (for WebSocket Secure). Default is WS.
keystorePath	Keystore file name. Provide the file name if the connection is secure.
keystorePassword	Password to the keystore file name. Provide the file name if the connection is secure.
truststorePath	Truststore file name. Provide the password if the connection is secure.
truststorePassword	Password to the truststore file name. Provide the file name if the connection is secure.
port	Port on which the target service listens for incoming connections.
healthCheckUrl	Path to which an HTTP GET request is sent to verify if the server is running.