Web Output Adapter

Introduction

The Spotfire Streaming Web Output Adapter allows the system to stream tuple data in JSON format to one or more connected WebSockets. When this adapter is placed on the canvas, it will take the schema of the input port and create a WebSocket endpoint based on the fully qualified path of the adapter, unless specified by the context path property. For example, if the adapter's path including the container name is default.module1.weboutput then a WebSocket endpoint is created at http://localhost:10090/default/module1/weboutput using the default 10090 port. A default web page is created at the root which lists all available endpoints and their schemas. The root endpoint also provides a test page for each endpoint. To view the default page, visit http://localhost:10090 when your application is running.

Properties

This section describes the properties you can set for this adapter, using the various tabs of the Properties view in StreamBase Studio.

General Tab

Name: Use this required field to specify or change the name of this instance of this component. The name must be unique within the current EventFlow module. The name can contain alphanumeric characters, underscores, and escaped special characters. Special characters can be escaped as described in Identifier Naming Rules. The first character must be alphabetic or an underscore.

Adapter: A read-only field that shows the formal name of the adapter.

Class name: Shows the fully qualified class name that implements the functionality of this adapter. If you need to reference this class name elsewhere in your application, you can right-click this field and select Copy from the context menu to place the full class name in the system clipboard.

Start with application: If this field is set to Yes (default) or to a module parameter that evaluates to true, this instance of this adapter starts as part of the JVM engine that runs this EventFlow fragment. If this field is set to No or to a module parameter that evaluates to false, the adapter instance is loaded with the engine, but does not start until you send an epadmin container resume command (or its sbadmin equivalent), or until you start the component with StreamBase Manager.

Enable Error Output Port: Select this checkbox to add an Error Port to this component. In the EventFlow canvas, the Error Port shows as a red output port, always the last port for the component. See Using Error Ports to learn about Error Ports.

Description: Optionally, enter text to briefly describe the purpose and function of the component. In the EventFlow Editor canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.

Operator Properties Tab

Property Type Description
WebStream Configuration Edit Button Shortcut to the StreamBase Configuration File Editor, used for adapter configuration or converting an existing application's adapter-configurations.xml file to HOCON format.
Id Field string The field in the incoming tuple which represents the ID of the WebSocket to send this tuple. If this field is not set or is null or empty, then the tuple is sent to all connections.
Context Path string The context path for this WebSocket endpoint, if empty the fully qualified container path of this operator will be used.
Timestamp Format string The timestamp format used to convert timestamp fields to JSON.

Cluster Aware Tab

Use the settings in this tab to enable this operator or adapter for runtime start and stop conditions in a multi-node cluster. During initial development of the fragment that contains this operator or adapter, and for maximum compatibility with releases before 10.5.0, leave the Cluster start policy control in its default setting, Start with module.

Cluster awareness is an advanced topic that requires an understanding of StreamBase Runtime architecture features, including clusters, quorums, availability zones, and partitions. See Cluster Awareness Tab Settings on the Using Cluster Awareness page for instructions on configuring this tab.

WebSocket Protocol

This section describes how the WebSocket protocol works.

Input

Once connected, the only message the WebSocket accepts is a JSON-formatted string to set the WebSocket's ID.

The ID field is used when input tuples also contain an ID field, and if they match the tuple is sent to this WebSocket. If no ID is set for this WebSocket, then only tuples with no ID field set or a null or empty ID field is sent to this WebSocket.

Example message: {"id":"7080AA07-5C01-4F8D-BB40-5B9C47F757BB"}

Output

Once connected, the adapter starts sending tuples received on its input port to connected WebSockets. Tuples are converted from a tuple to a JSON-formatted string before sending. To preserver bandwidth, the JSON will not include any null fields.

Configuration

Description

Only exactly one webstream configuration is allowed per application, which all adapters will use if found.

This example configuration shows a web server that contains all available values.

Example

name = "WebStream.conf"
        type = "com.tibco.ep.streambase.configuration.adapter"
        version = "1.0.0"
        configuration = {
        
        // An adapter group type defines a collection of EventFlow adapter configurations, indexed by adapter type.
            AdapterGroup = {
        
        // A collection of EventFlow adapter configurations, indexed by adapter type. This key is required and must contain at
        // least one configuration.
                adapters = {
        
        // The root section for an EventFlow adapter configuration.
                    webstreams = {
        
        // Section list. This key is optional and has no default value.
                        sections = [
        
        // A configuration for an EventFlow adapter named section.
                            {
        
        // Section name. The value does not have to be unique; that is, you can have multiple sections with the same name
        // in the same array of sections. This key is required.
                                name = "webstreams"
        
        // Section property bag. All values must be strings. This key is optional and has no default value.
                                settings = {
                                    Enabled = "true"
                                    IdleTimeoutMS = "0"
                                    OutputBufferSize = "32768"
                                    Port = "10090"
                                    RequestHeaderSize = "8192"
                                    ResponseHeaderSize = "8192"
                                    SendDateHeader = "false"
                                    SendServerVersion = "true"
                                    StartOnStartup = "true"
                                    WebSocketAsyncWriteTimeoutMS = "0"
                                    WebSocketIdleTimeoutMS = "0"
                                    SelectorThreads = "-1"
                                    AcceptorThreads = "-1"
                                    ReuseAddress = "true"
                                    LingerTime = "-1"
                                    GZipMimeTypes = "text/html,text/plain,text/xml,application/xhtml+xml,text/css,application/javascript,text/javascript,image/svg+xml"
                                    SecurePort = "10443"
                                    SSLKeyStorePath = "keystore"
                                    SSLKeyStorePassword = "tester"
                                    SSLKeyStoreManagerPassword = "tester"
                                    SSLTrustStorePath = "keystore"
                                    SSLTrustStorePassword = "tester"
                                }
                            }
                        ]
                    }
                }
            }
        }

Settings

Setting Type Description
Enabled true/false If true the web server and all ports are started. If false no web server is started and all operators become no-ops.
Port integer The port the web server will listen on for connections.
IdleTimeoutMS integer The amount of time in milliseconds to wait for connections to send data.
OutputBufferSize integer Set the size of the buffer into which response content is aggregated before being sent to the client.
RequestHeaderSize integer Set the maximum size of a request header.
ResponseHeaderSize integer Set the maximum size of a response header.
SendServerVersion true/false If true, send the Server header in responses.
SendDateHeader true/false If true, include the date in HTTP headers.
SelectorThreads int The number of selector threads, or less than or equal to 0 for a default value. Selectors notice and schedule established connection that can make IO progress.
AcceptorThreads int The number of acceptor threads to use, or -1 for a default value. Acceptors accept new TCP/IP connections. If 0, then the selector threads are used to accept connections.
ReuseAddress true/false Whether the server socket reuses addresses.
LingerTime integer The linger time. Use -1 to disable.
GZipMimeTypes string Set the mime types associated with GZip requests. Blank or missing means do not use GZip.
WebSocketAsyncWriteTimeoutMS integer The time in milliseconds before a write command times out.
WebSocketIdleTimeoutMS integer The time in milliseconds before a web socket times out from idle behavior.
SecurePort integer Set the TCP/IP port used for CONFIDENTIAL and INTEGRAL redirections.
* SSLKeyStorePath string The file or URL of the SSL keystore.
* SSLKeyStorePassword string The password for the keystore.
* SSLKeyStoreManagerPassword string The password (if any) for the specific key within the keystore.
* SSLTrustStorePath string The file name or URL of the trust store location.
* SSLTrustStorePassword string The password for the trust store.

* NOTE: Please refer to http://wiki.eclipse.org/Jetty/Howto/Configure_SSL when setting up SSL.