webMethods CloudStreams 10.3 | webMethods CloudStreams Documentation 10.3 | Cloud Connections, Services, and Connector Listeners | Connector Listener
 
Connector Listener
Most of the modern SaaS providers provide streaming APIs, which send data to clients using push technologies like Comet, HTTP streaming, and so on. Prior to the CloudStreams version 10.3 release, CloudStreams supported connectivity with streaming API providers as a native configuration, that is, details for user created streaming subscriptions were persisted within the WmCloudStreams package. In this release, streaming API access is available as a connector capability and you can integrate with a streaming API using a CloudStreams connector.
CloudStreams connectors now support connectivity with streaming APIs and processing of streaming API events in addition to supporting connectivity and execution of SOAP and REST APIs, so in addition to connecting to SOAP and REST APIs, you can now use CloudStreams connections for connecting to streaming APIs. You can create a CloudStreams connector listener, select a subscription channel from a list of available channels for an endpoint, and configure the action(s) to be applied on the incoming events. Additionally, you can configure transport or communication related parameters for a CloudStreams connector listener as well as enable and disable a CloudStreams connector listener. A CloudStreams listener receives the streaming API events and processes the received events.
Note: CloudStreams connector listeners do not have any exclusive support in a clustered setup. The listener behaves in the same way as it behaves in a stand-alone Integration Server setup.
You create connector listeners using the Software AG Designer. Before you create a connector listener, ensure that the CloudStreams connector associated with your cloud application provider is installed. Also ensure that a cloud connection pool is created for that connector.
The following high-level steps describe the user interactions:
1. Install the CloudStreams provider package that has streaming API capability.
2. Go to Integration Server Administrator and create a connection for the connector. You can also use an existing connection for the selected provider and connector. The streaming functionality will leverage the existing authentication, timeouts (Connection TimeOut and Socket Read Timeout), truststore (Trust store Alias), keystore (Keystore Alias), host name verification (Hostname verifier), and proxy (Proxy Server Alias) configurations from the referenced CloudStreams connection.
3. Go to Integration Server Administrator and enable the connection.
4. Go to the Service Development perspective in Software AG Designer and create a connector listener.
5. In the Service Development perspective, on the Listener page for the newly created connector listener, configure the subscription request, that is, select a subscription from the list of available subscription channels. Configure the required headers and parameters to complete the subscription request configuration. Optionally you can select a different connection pool for the subscription request or choose a different document to represent the subscribed event. Configure the processing of the subscribed events by adding an action to be applied on the incoming events. You can log or invoke a service based on your configurations.
6. To manage the listener, go to Integration Server Administrator and in the Listeners tab for the connector, click Configure to edit the listener communication or transport specific parameters for accessing the streaming API.
7. Enable the listener in Integration Server Administrator. Once the listener is enabled, connection with the streaming API is established, and incoming events will be processed whenever the streaming Provider triggers the events.
Note: For more information about connector listeners, see the webMethods Service Development Help, webMethods Deployer User’s Guide regarding the deployable assets, and also the documentation specific to your CloudStreams provider, for example, the webMethods CloudStreams Provider for Salesforce.com Installation and User's Guide.

Copyright © 2013-2018 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.