IBM InfoSphere Streams Version 4.1.0

Operator `HTTPPost`

SPL standard and specialized toolkits > com.ibm.streamsx.inet 2.0.1 > com.ibm.streamsx.inet.http > HTTPPost

This operator sends incoming tuples to the specified HTTP server as part of a POST request. A single tuple will be sent as a body of one HTTP POST request. All attributes of the tuple will be serialized and sent to the server. Certain authentication modes are supported. Tuples are sent to the server one at a time in order of receipt. If the HTTP server cannot be accessed, the operation will be retried on the current thread and may temporarily block any additional tuples that arrive on the input port. By default, the data is sent in application/x-www-form-urlencoded UTF-8 encoded format.

Behavior in a consistent region

This operator cannot be placed at the start of a consistent region.

Summary

Ports: This operator has 1 input port and 1 output port.
Windowing: This operator does not accept any windowing configurations.
Parameters: This operator supports 7 parameters. (authenticationFile, authenticationProperty, authenticationType, headerContentType, maxRetries, retryDelay, url)
Metrics: This operator does not report any metrics.

Properties

Implementation: Java™

Input Ports

Ports (0)

All attributes of the input stream are sent as POST data to the specified HTTP server

Properties

Optional: false

ControlPort: false
WindowingMode: NonWindowed
WindowPunctuationInputMode: Oblivious

Output Ports

Assignments: Java operators do not support output assignments.

Ports (0)

Emits a tuple containing the reponse received from the server. Tuple structure must conform to the HTTPResponse type specified in this namespace.

Properties

Optional: true

WindowPunctuationOutputMode: Free

Parameters

This operator supports 7 parameters.

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

Type: rstring
Cardinality: 1
Optional: true

authenticationProperty

Properties to override those in the authentication file.

Properties

Type: rstring
Optional: true

authenticationType

Valid options are "basic" and "none". Default is "none".

Properties

Type: rstring
Cardinality: 1
Optional: true

headerContentType

Set the content type of the HTTP request. If the value is set to "application/json" then the entire tuple is sent in JSON format. Default is "application/x-www-form-urlencoded". Note that if a value other than the above mentioned ones is specified, the input stream can only have a single attribute.

Properties