Web Input Adapter

Introduction

The Spotfire Streaming Web Input Adapter allows the StreamBase application to receive JSON-formatted tuples via a HTTP POST request. When this adapter is placed on the canvas, it takes the input port's schema and creates a REST 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.webinput then a REST endpoint is created at http://localhost:10090/default/module1/webinput using the default 10090 port. A default web page is created at the root that 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.

Adapter 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.

Operator: A read-only field that shows the formal name of the operator.

Class name: Shows the fully qualified class name that implements the functionality of this operator. 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 options: This field provides a link to the Cluster Aware tab, where you configure the conditions under which this operator starts.

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.
Context Path string The context path for this REST endpoint, if empty the fully qualified path of this operator is used.
Linked Web Input Response string The linked web input response adapter to use to complete a REST response via event flow. If this value is not set, a default REST response is sent for each REST call.
Output Request Metadata check box If enabled, a field is output with each tuple that contains the http request metadata. This metadata field will contain extra details about the request such as headers and method. The output field is named SB_RequestData.
Timestamp Format string The timestamp format used to convert timestamp fields.

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.

Input Port

The input port is used to determine the schema of the inbound REST request. Any tuples entering this port are sent directly out on the output port untouched.

Output Port

The output port will emit tuples that either entered this adapter via the input port or were received by the REST endpoint automatically created for this adapter on startup. If the Linked Web Input Response adapter is set, then a SB_ResponseId field is set as a unique Id for each REST called received by this adapter.

REST Endpoint Protocol

This section describes how the REST endpoint protocol works.

Input

The Web Input adapter allows POST, PUT, GET, and DELETE requests with a JSON formatted body. The body must match the schema of the input port of the adapter. For example, if the input schema is (ID string, Field1 string, Field2 string) then the resulting JSON request must be {"ID":null,"Field1":null,"Field2":null}. Fields are optional depending on your application.

Note for GET requests, the path parameters are converted into tuple fields (for example, http://localhost:10090/test?ID=123&Field1=test would create a tuple with the ID and Field1 fields set).

List path parameters are also valid by specifying the path parameter more than once. For example, http://localhost:10090/test?MyList=test1&MyList=test2 would be converted to a (MyList list(string)) in StreamBase.

Output

If the Linked Web Input Response is not set then the response from a REST POST request will be a simple JSON encode response, and is one of:

  • {"Status":"OK"}

  • {"Type":"[exception type here]", "Error":"Reading", "Message":"[error message here]"}

  • {"Type":"[exception type here]", "Error":"Parsing", "Message":"[error message here]"}

If the Linked Web Input Response is set, then the response is sent when the tuple produced by this adapter enters the corresponding Web Input Response adapter and the REST response will be based on that adapter's input schema.

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.