Setting the Streaming Providers Options

Option

Description

Provider Name

Specify a unique name for this streaming service provider. This is a required field and is used by the Subscriber configuration to refer to it.

Client Type

The type of client that will be used by CloudStreams to provide the streaming functionality. There are two types of clients:

Comet: This is a client implementation that uses the Bayeux HTTP protocol (using the CometD library) to communicate with the streaming service. This client should be used if the streaming provider explicitly indicates that they support the Bayeux protocol for their streaming functionality. For example, Salesforce uses this mechanism for their streaming functionality and hence Salesforce integrations must use this client type.

Note:

Underlying protocols that provide streaming capability are public protocols which run over HTTP like Bayeux. These protocols are not guaranteed protocols. They do not ensure delivery of messages in a guaranteed way. If there are network, proxy, or firewall connectivity related issues or delays, you may not receive the messages. In such cases, investigate the network and connectivity.

Before using streaming capabilities, it is important to understand this underlying limitation of the protocol and the SaaS backend.

HTTP: An HTTP client type is used for HTTP-based streaming service providers that use a long-lived HTTP connection to send data periodically to the client connected to them. For example, Twitter uses this mechanism to send updates made to their streaming API endpoints (Public, User and Site streams).

API Version

Optional. The version of the streaming API supported by the provider service.

Streaming API Endpoint

Points to the endpoint of the streaming provider. For example, when configuring a Salesforce streaming endpoint, you must specify the URL that corresponds to the streaming API, such as:

https://na9-api.salesforce.com/cometd/25.0

Do not specify the actual subscription channel/topic name here as part of the URL because that is subscriber configuration-specific.

Notify Meta Channel Events

Optional. Indicates whether any meta-channel (connect, disconnect, handshake, etc.) events must be notified to the subscriber. If you choose this option, then the events are delivered to the destination configured in the subscriber (see Setting the Streaming Subscribers Options).

Enable Debug

Optional. Indicates whether any connection-related debugging messages must be logged to the server log.

Connection Timeout (ms)

Specify the streaming connection timeout value, in milliseconds. If unspecified, this value defaults to a system default.

Note:

It is observed that due to network, proxy, or firewall connectivity related issues, the default timeout values may not be enough in your environment. In that case you should check what are the right timeout settings based on your network conditions and set those values here. Due to latency and other issues, some networks may take a long time to exchange messages. In such cases you may see timeout errors. To avoid that, increase the timeout values and see what values fit your organization. This is applicable for all outbound and inbound timeout configurations.

Read Timeout (ms)

Specify the read timeout value after a connection has been established with the provider. This indicates the maximum time before which a data packet must be read from the endpoint before a timeout occurs.

Truststore Alias

Specify the IS truststore alias to use if the endpoint is SSL-based and the provider certificate must be validated as part of the SSL handshake. By default, if no alias is configured, then all server certificates are trusted during SSL handshake. The alias must be configured in Integration Server Administrator. To configure Integration Server truststores, see the section Securing Communications with the Server in the document webMethods Integration Server Administrator’s Guide.

Keystore Alias

Specify the IS keystore alias to use if the endpoint is SSL-based and the CloudStreams certificate must be provided to the server endpoint as part of the SSL handshake. By default, if no alias is configured, then no client certificate is sent during SSL handshake. The alias must be configured in Integration Server Administrator. To configure Integration Server keystores, see the section Securing Communications with the Server in the document webMethods Integration Server Administrator’s Guide.

Validate Certificate

If set to true, the client will validate the provider's certificate for the SSL handshake. Default: False.

Authentication Type

Specifies the authentication information that must be sent to the streaming provider when a subscription to a topic or channel is defined. Choose one of the following ways to provide the authentication information:

Basic: Basic refers to HTTP Basic Authentication. This option can be used if the provider requires or supports HTTP Basic authentication using a username and password.

OAuth 1.0a and OAuth 2.0: Select an OAuth alias that was defined on the OAuth Access Tokens page (see Setting the OAuth Tokens Options). At run time, CloudStreams will use the OAuth configuration information to retrieve the access token to be sent to the provider in the HTTP request.

ESB Callback: This option can be used when the above two means of authentication are not sufficient. For example, if the provider does not support Basic authentication or OAuth tokens, but instead requires another form of authentication information as part of the Authorization header, then you can provide another form of authentication in a user-defined ESB service. Specify the service name in this field in the following form: folder1.folder2:serviceName. The only requirement for this ESB service is that it should specify the value for the Authorization header in the authorization.header pipeline variable. CloudStreams will use the value present in this pipeline variable to send it as part of the Authorization header value. You should not include the header name (Authorization) in the value set in this variable.