"resumeStreamingConnection" (JSON Action)
Activate paused streaming connections
The "resumeStreamingConnection" action resumes a paused data change stream. If the connection is already resumed, this action does nothing new. To pause a streaming connection, call the "pauseStreamingConnection" action.
Request examples
Minimal
This example resumed the data change stream named "db1".
{
"api": "admin",
"action": "resumeStreamingConnection",
"params": {
"streamingConnectionName": "db1"
},
"authToken": "replaceWithAuthTokenFromCreateSession"
}
The example returns all information about the specified streaming connection.
{
"authToken": "authToken",
"result": {
"streamingConnectionName": "db1",
"metadata": {},
"streamParallelism": 4,
"sourceServers": [
{
"purpose": "Primary Server",
"sourceServerName": "FAIRCOMS",
"sourceHostname": "10.70.13.112",
"sourcePort": 5597,
"sourceUsername": "ADMIN",
"sourcePassword": "ADMIN",
"tls": {
"enabled": true,
"caCertificateFilename": "ca.crt",
"allowedCipherSuites": "",
"clientCertificateEnabled": true,
"clientCertificateFilename": "admin_client.crt",
"clientPrivateKeyFilename": "admin_client.key"
}
},
{
"purpose": "Secondary Server",
"sourceServerName": "FAIRCOMS2",
"sourceHostname": "10.70.13.113",
"sourcePort": 5597,
"sourceUsername": "ADMIN",
"sourcePassword": "ADMIN",
"tls": {
"enabled": true,
"caCertificateFilename": "ca.crt",
"allowedCipherSuites": "",
"clientCertificateEnabled": true,
"clientCertificateFilename": "admin_client.crt",
"clientPrivateKeyFilename": "admin_client.key"
}
}
]
},
"errorCode": 0,
"errorMessage": ""
}
"params" property summariesProperty | Description | Default | Type | Limits (inclusive) |
|---|---|---|---|---|
specifies a unique, user-defined name for a streaming connection. This API uses it to identify streaming connections and to connect a data change stream to a FairCom DB or RTG server. | Required - No default value | string | 1 to 64 bytes |
The "streamingConnectionName" property is a required string that specifies a unique, user-defined name for a streaming connection. The API uses it to identify streaming connections and to connect a data change stream to a FairCom DB or RTG server.
"params": {
"streamingConnectionName": "db1",
"metadata": {},
"maxSecondsBeforeConnectingToNextServer": 15,
"streamParallelism": 4,
"sourceServers": []
},"result" property summariesProperty | Description | Type | Contents | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
lists the streaming connections that match the filters in the request as separate objects. | array of objects | 0 or more objects | ||||||||||
| reports the approximate time, in seconds, needed by the FairCom MQ server to apply data changes from the source server. | integer |
| |||||||||
| specifies metadata about the streaming connection. It must be a JSON object and you may add your own properties to it. | object | No limits | |||||||||
| specifies a list of FairCom DB or RTG servers. FairCom MQ attempts to connect to the first server in the list. If that fails, it attempts to connect to the next one. If it reaches the last server in the list, it attempts to connect to the first. | array of server connection objects | {
"purpose": "Primary Server",
"sourceServerName": "FAIRCOMS",
"sourceHostname": "10.70.13.112",
"sourcePort": 5597,
"sourceUsername": "ADMIN",
"sourcePassword": "ADMIN",
"tls": {
"enabled": true,
"caCertificateFilename": "ca.crt",
"allowedCipherSuites": "",
"clientCertificateEnabled": true,
"clientCertificateFilename": "admin_client.crt",
"clientPrivateKeyFilename": "admin_client.key"
}
}
| |||||||||
| defines a short description of the server's purpose. | string | 1 to 64 bytes | |||||||||
| specifies a unique host name or TCP/IP address of a FairCom DB or RTG server. | string | 1 to 255 bytes | |||||||||
| specifies the login password of a FairCom DB or RTG server. | string | 1 to 128 bytes | |||||||||
| specifies the ISAM TCP/IP port of a FairCom DB or RTG server. | int16 |
| |||||||||
| specifies the server name of a FairCom DB or RTG server. It is the name specified by the | string | 1 to 255 bytes | |||||||||
| specifies the login name of a FairCom DB or RTG server. | string | 1 to 64 bytes | |||||||||
| specifies Transport Layer Security settings for connecting to a FairCom DB or RTG server. | object |
| |||||||||
| limits the ciphers that FairCom MQ is willing to use when communicating with a FairCom DB or RTG server. | string | No limits | |||||||||
| specifies the name and optional path of the CA certificate file (such as | string | No limits | |||||||||
| enables client certificate authentication if true. The target FairCom DB or RTG server must be configured to accept client certificates. | Boolean |
| |||||||||
| specifies the file name, such as | string | No limits | |||||||||
| specifies the file name, such as | string | No limits | |||||||||
| enables or disables tls. | Boolean |
| |||||||||
| specifies a unique, user-defined name for a streaming connection. This API uses it to identify streaming connections and to connect a data change stream to a FairCom DB or RTG server. | string | 1 to 64 bytes | |||||||||
| specifies the number of parallel streams the server uses to deliver data changes to the FairCom MQ server. You typically use a number that does not exceed the number of cores on the FairCom MQ server. | integer |
|
The "streamingConnections" property is an array of objects that list the streaming connections that match the filters in the request as separate objects.
The "estimatedBacklogSeconds" property is an integer that reports the approximate time, in seconds, needed by the FairCom MQ server to apply data changes from the source server.
The "metadata" property is an optional JSON object. It exists primarily for the user interface to find integration information. By default, it is an empty JSON object.
It contains a flexible set of properties.
It typically contains tags and description properties.
Example
{
"description": "",
"tags": [""],
"yourOwnProperties": "usage, purpose, notes, location, etc.",
}
The "sourceServers" property is a required array containing a list of FairCom DB or RTG server connection objects. FairCom MQ attempts to connect to the first server in the list. If that fails, it attempts to connect to the next one. If it reaches the last server in the list, it attempts to connect to the first.
"sourceServers": [
{
"purpose": "Primary Server",
"sourceServerName": "FAIRCOMS",
"sourceHostname": "10.70.13.112",
"sourcePort": 5597,
"sourceUsername": "ADMIN",
"sourcePassword": "ADMIN",
"tls": {
"enabled": true,
"caCertificateFilename": "ca.crt",
"allowedCipherSuites": "",
"clientCertificateEnabled": true,
"clientCertificateFilename": "admin_client.crt",
"clientPrivateKeyFilename": "admin_client.key"
}
}
]The "purpose" property is an optional string that provides a short description of the specified server's purpose.
"sourceServers": [
{
"purpose": "Primary Server",
"sourceServerName": "FAIRCOMS",
"sourceHostname": "10.70.13.112",
"sourcePort": 5597,
"sourceUsername": "ADMIN",
"sourcePassword": "ADMIN",
"tls": {
"enabled": true,
"caCertificateFilename": "ca.crt",
"allowedCipherSuites": "",
"clientCertificateEnabled": true,
"clientCertificateFilename": "admin_client.crt",
"clientPrivateKeyFilename": "admin_client.key"
}
}
]The "sourceHostname" property is a required string that specifies a unique host name or TCP/IP address of a FairCom DB or RTG server.
"sourceServers": [
{
"purpose": "Primary Server",
"sourceServerName": "FAIRCOMS",
"sourceHostname": "10.70.13.112",
"sourcePort": 5597,
"sourceUsername": "ADMIN",
"sourcePassword": "ADMIN",
"tls": {
"enabled": true,
"caCertificateFilename": "ca.crt",
"allowedCipherSuites": "",
"clientCertificateEnabled": true,
"clientCertificateFilename": "admin_client.crt",
"clientPrivateKeyFilename": "admin_client.key"
}
}
]The "sourcePassword" property is an optional string that specifies the login password of a FairCom DB or RTG server.
"sourceServers": [
{
"purpose": "Primary Server",
"sourceServerName": "FAIRCOMS",
"sourceHostname": "10.70.13.112",
"sourcePort": 5597,
"sourceUsername": "ADMIN",
"sourcePassword": "ADMIN",
"tls": {
"enabled": true,
"caCertificateFilename": "ca.crt",
"allowedCipherSuites": "",
"clientCertificateEnabled": true,
"clientCertificateFilename": "admin_client.crt",
"clientPrivateKeyFilename": "admin_client.key"
}
}
]The "sourcePort" property is an optional integer that specifies the ISAM TCP/IP port of a FairCom DB or RTG server.
"sourceServers": [
{
"purpose": "Primary Server",
"sourceServerName": "FAIRCOMS",
"sourceHostname": "10.70.13.112",
"sourcePort": 5597,
"sourceUsername": "ADMIN",
"sourcePassword": "ADMIN",
"tls": {
"enabled": true,
"caCertificateFilename": "ca.crt",
"allowedCipherSuites": "",
"clientCertificateEnabled": true,
"clientCertificateFilename": "admin_client.crt",
"clientPrivateKeyFilename": "admin_client.key"
}
}
]The "sourceServerName" property is a conditional string that specifies the server name of a FairCom DB or RTG server. It is the name specified by the SERVER_NAME keyword defined in the target server's configuration file, ctsrvr.cfg. The server name used by most FairCom DB and RTG servers is "FAIRCOMS". This property is required if the "sourceHostname" is not defined.
"sourceServers": [
{
"purpose": "Primary Server",
"sourceServerName": "FAIRCOMS",
"sourceHostname": "10.70.13.112",
"sourcePort": 5597,
"sourceUsername": "ADMIN",
"sourcePassword": "ADMIN",
"tls": {
"enabled": true,
"caCertificateFilename": "ca.crt",
"allowedCipherSuites": "",
"clientCertificateEnabled": true,
"clientCertificateFilename": "admin_client.crt",
"clientPrivateKeyFilename": "admin_client.key"
}
}
]The "sourceUsername" property is an optional string that specifies the name of a FairCom DB or RTG server.
"sourceServers": [
{
"purpose": "Primary Server",
"sourceServerName": "FAIRCOMS",
"sourceHostname": "10.70.13.112",
"sourcePort": 5597,
"sourceUsername": "ADMIN",
"sourcePassword": "ADMIN",
"tls": {
"enabled": true,
"caCertificateFilename": "ca.crt",
"allowedCipherSuites": "",
"clientCertificateEnabled": true,
"clientCertificateFilename": "admin_client.crt",
"clientPrivateKeyFilename": "admin_client.key"
}
}
]The "tls" property is a JSON object that defines the public server certificate filename, the private key filename, the certificate authority filename, the cipher suites that are allowed, and whether the client certificate is required. This property is optional. It defaults to an empty object.
Example
"tls": {
"serverCertificateFilename": "server.crt",
"privateKeyFilename": "server.key",
"caCertificateFilename": "ca.crt",
"allowedCipherSuites": "AES256-SHA256"
"requireClientCertificate": "true"
}"allowedCipherSuites"
"caCertificateFilename"
"requireClientCertificate"
"tls": {
"enabled": true,
"caCertificateFilename": "ca.crt",
"allowedCipherSuites": "",
"clientCertificateEnabled": true,
"clientCertificateFilename": "admin_client.crt",
"clientPrivateKeyFilename": "admin_client.key"
}The "clientCertificateEnabled" property is an optional boolean that enables client certificate authentication if true. The target FairCom DB or RTG server must be configured to accept client certificates.
"tls": {
"enabled": true,
"caCertificateFilename": "ca.crt",
"allowedCipherSuites": "",
"clientCertificateEnabled": true,
"clientCertificateFilename": "admin_client.crt",
"clientPrivateKeyFilename": "admin_client.key"
} "tls": {
"enabled": true,
"caCertificateFilename": "ca.crt",
"allowedCipherSuites": "",
"clientCertificateEnabled": true,
"clientCertificateFilename": "admin_client.crt",
"clientPrivateKeyFilename": "admin_client.key"
} "tls": {
"enabled": true,
"caCertificateFilename": "ca.crt",
"allowedCipherSuites": "",
"clientCertificateEnabled": true,
"clientCertificateFilename": "admin_client.crt",
"clientPrivateKeyFilename": "admin_client.key"
}The "enabled" property is an optional Boolean that specifies whether or not the feature is enabled. The example below enables the TLS feature.
"tls": {
"enabled": true,
"caCertificateFilename": "ca.crt",
"allowedCipherSuites": "",
"clientCertificateEnabled": true,
"clientCertificateFilename": "admin_client.crt",
"clientPrivateKeyFilename": "admin_client.key"
}The "streamingConnectionName" property is a required string that specifies a unique, user-defined name for a streaming connection. The API uses it to identify streaming connections and to connect a data change stream to a FairCom DB or RTG server.
"params": {
"streamingConnectionName": "db1",
"metadata": {},
"maxSecondsBeforeConnectingToNextServer": 15,
"streamParallelism": 4,
"sourceServers": []
},The "streamParallelism" property is an optional integer that specifies the number of parallel streams the server uses to deliver data changes to the FairCom MQ server. You typically use a number that does not exceed the number of cores on the FairCom MQ server.
"params": {
"streamingConnectionName": "db1",
"metadata": {},
"maxSecondsBeforeConnectingToNextServer": 15,
"streamParallelism": 4,
"sourceServers": []
},