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

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

import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

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

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

public interface IResponseDataTransformer {
    /***
     * This method will be called during typecheck time to allow 
     * a response 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 of the input data to transform
     * @throws TypecheckException
     */
    public void validateSettings(Map<String, String> settings, Schema schema) throws 
    TypecheckException;

    /***
     * This method allows the tuple to be sent to the HTTP response with any custom 
     * logic required
     * 
     * @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 httpServletRequest The HTTP request
     * @param request The base HTTP request
     * @param tuple The tuple to convert
     * @throws StreamBaseException
     */
    public void transformResponseData(Logger logger, Map<String, String> settings, 
    HttpServletRequest httpServletRequest, Request request, HttpServletResponse 
    httpServletResponse, Tuple tuple) throws StreamBaseException;
}

The JSON response data transform converts a tuple to a JSON response. If no content type is set, this will set it as application/json.

The XML response data transform converts a tuple to an XML response. If no content type is set, this will set it as application/xml.