Web Server Request 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.

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 options: This field provides a link to the Cluster Aware tab, where you configure the conditions under which this adapter 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.

Use the Concurrency tab to specify parallel regions for this instance of this component, or multiplicity options, or both. The Concurrency tab settings are described in Concurrency Options, and dispatch styles are described in Dispatch Styles.

Use the control port to send action commands to the adapter. Tuples enqueued on this port cause the adapter to start or stop a server.

The status port is used to send status information tuples downstream to inform the user of changes.

The web server adapter configuration section starts with an <WebServer.conf> element containing one <WebServer.conf name="webservers"> element that contains one or more <section name="webserver"> elements.

Each <section name="webserver"> configuration must contain a "id" and "Port" settings fields. All other setting elements are optional.

This example configuration shows two different web servers. The first contains all values available and the second shows the required values. You can have as many configurations as your application requires, but each must have a unique port number and a unique ID.

name = "WebServer.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.
                    webservers = {
          
          // 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 = "webserver"
          
          // Section property bag. All values must be strings. This key is optional and has no default value.
                                settings = {
                                  GZipMimeTypes = "text/html,text/plain,text/xml,application/xhtml+xml,text/css,application/javascript,text/javascript,image/svg+xml"
                                  IdleTimeoutMS = "30000"
                                  OutputBufferSize = "32768"
                                  Port = "8080"
                                  RequestHeaderSize = "8192"
                                  ResponseHeaderSize = "8192"
                                  SendDateHeader = "false"
                                  SendServerVersion = "true"
                                  StartOnStartup = "true"
                                  WebSocketAsyncWriteTimeoutMS = "5000"
                                  WebSocketIdleTimeoutMS = "30000"
                                  id = "Web Server Port 8080"
                                }
                            }
          
          // 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 = "webserver"
          
          // Section property bag. All values must be strings. This key is optional and has no default value.
                                settings = {
                                  Port = "9090"
                                  id = "Web Server Port 9090"
                                }
                            }
                        ]
                    }
                }
            }
          }

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

package com.streambase.sb.adapter.webserver.data;

import java.util.Map;

import javax.servlet.http.HttpServletRequest;

import org.eclipse.jetty.server.Request;
import org.slf4j.Logger;

import com.streambase.sb.Schema;
import com.streambase.sb.StreamBaseException;
import com.streambase.sb.operator.TypecheckException;

public interface IRequestDataTransformer {
    /***
     * This method will be called during typecheck time to allow a request data transformer 
     * to validate a key value map of settings against the transformer 
     * @param settings A key value map of settings the end user specified for this adapters 
     * custom data transformation
     * @param schema The schema provided by the end user for which the data should be converted to. 
     * @throws TypecheckException
     */
    public void validateSettings(Map<String, String> settings, Schema schema) throws TypecheckException;
    
    /***
     * This method allows the HTTP request data to be transformed into a tuple with any custom logic required
     * 
     * NOTE: only one of the two readers can be used (httpServletRequest or request) once one is read the 
     * other will become invalid
     * 
     * @param sender The senders methods are used to send completed tuples downstream.  It is expected 
     * that for each call to this method at least 1 tuple is create and a sendTuple or sendTupleAsync is called.
     * @param logger A logger than can be used to log any extra information which may be required
     * @param settings A key value map of settings the end user specified for this adapters custom data 
     * transformation 
     * @param schema The schema provided by the end user for which the data should be converted to.
     * @param httpServletRequest The HTTP request to use for transform into a tuple
     * @param request The base HTTP request to use for transforming into a tuple
     * @throws StreamBaseException
     */
    public void transformRequestData(IRequestDataTupleSender sender, Logger logger, Map<String, String> settings, 
    Schema schema, HttpServletRequest httpServletRequest, Request request) throws StreamBaseException;
}         

package com.streambase.sb.adapter.webserver.data;

import com.streambase.sb.Tuple;

/***
 * The request data tuple sender is used to send a tuple downstream after parsing the HTTP request into a tuple.
 * 
 * It is recommended that if you expect to send more than one tuple per http request that you mark a single tuple 
 * to send as the response.  
 * Sending more than one tuple for the same request into the response web server adapter will fail.
 */
public interface IRequestDataTupleSender {
    /***
     * Send a tuple downstream and wait for its execution to fully complete 
     * @param tuple The tuple to set as the request data tuple
     */
    public void sendTuple(Tuple tuple);
    
    /***
     * Send a tuple downstream asynchronously 
     * @param tuple The tuple to set as the request data tuple
     */
    public void sendTupleAsync(Tuple tuple);
}          

The JSON request data transform converts a JSON request to a tuple.

The XML request data transform converts an XML request to a tuple.

The Binary request data transform converts a request to a series of tuples containing the request POST data.

This transformer requires the request schema and contains three fields: Data of type Blob, Name of type String, and Value of type String.

The data field contains any data from the body. The Value field will contain any values from form fields.

This adapter will output 1-N number of tuples containing the request body data. After reading all the body data, a tuple with all null fields is emitted to represent the completion.