Web Input Adapter

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.

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.

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.

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:

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.

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.

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"
                                }
                            }
                        ]
                    }
                }
            }
        }

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