Operator HTTPGetStream

Primitive operator image not displayed. Problem loading file: ../../image/tk$com.teracloud.streams.inet/op$com.teracloud.streams.inet.http$HTTPGetStream.svg

This operator is deprecated. Use HTTPRequest operator instead.

Connects to an HTTP endpoint, reads "chunks" of data and sends it to the output port. Every line read from the HTTP server endpoint is sent as a single tuple. If a connection is closed by the server, a WINDOW punctuation will be sent on port 0. Supported Authentications: Basic Authentication, OAuth 1.0a. Supported Compressions: Gzip, Deflate.

Behavior in a consistent region

This operator cannot be used inside a consistent region.

Summary

Ports
This operator has 0 input ports and 2 output ports.
Windowing
This operator does not accept any windowing configurations.
Parameters
This operator supports 13 parameters.

Required: url

Optional: acceptAllCertificates, authenticationFile, authenticationProperty, authenticationType, backoff, dataAttributeName, disableCompression, extraHeaders, maxRetries, postData, retryDelay, retryOnClose

Metrics
This operator does not report any metrics.

Properties

Implementation
Java

Output Ports

Assignments
Java operators do not support output assignments.
Ports (0)

Data received from the server will be sent on this port.

Properties

Ports (1)

Error information will be sent out on this port including the response code and any message recieved from the server. Tuple structure must conform to the HTTPResponse type specified in this namespace.

Properties

Parameters

This operator supports 13 parameters.

Required: url

Optional: acceptAllCertificates, authenticationFile, authenticationProperty, authenticationType, backoff, dataAttributeName, disableCompression, extraHeaders, maxRetries, postData, retryDelay, retryOnClose

acceptAllCertificates

Accept all SSL certificates, even those that are self-signed. Setting this option will allow potentially insecure connections. Default is false.

Properties
authenticationFile

Path to the properties file containing authentication information. Authentication file is recommended to be stored in the application_dir/etc directory. Path of this file can be absolute or relative, if relative path is specified then it is relative to the application directory. See http_auth_basic.properties in the toolkits etc directory for a sample of basic authentication properties.

Properties
authenticationProperty

Properties to override those in the authentication file.

Properties
authenticationType

Valid options are "oauth", "basic" and "none". Default is "none". If the "oauth" option is selected, the requests will be singed using OAuth 1.0a.

Properties
backoff

Use a backoff function for increasing the wait time between retries. Wait times increase by a factor of 10. Default is false

Properties
dataAttributeName

Name of the attribute to populate the response data with. Default is "data"

Properties
disableCompression

By default the client will ask the server to compress its reponse data using supported compressions (gzip, deflate). Setting this option to true will disable compressions. Default is false.

Properties
extraHeaders

Extra headers to send with request, format is "Header-Name: value".

Properties
maxRetries

Maximum number of retries in case of failures/disconnects.

Properties
postData

The value for this parameter will be sent to the server as a POST request body. The value is expected to be in "key=value" format.

Properties
retryDelay

Wait time between retries in case of failures/disconnects.

Properties
retryOnClose

Retry connecting if the connection has been closed. Default is false

Properties
url

URL endpoint to connect to.

Properties

Libraries

Operator class library
Library Path: ../../impl/lib/com.teracloud.streams.inet.jar