Operator HTTPGetXMLContent

IBMStreams com.ibm.streamsx.inet Toolkit > com.ibm.streamsx.inet 3.4.0 > com.ibm.streamsx.inet.http > HTTPGetXMLContent

Periodically connects to an HTTP endpoint to GET XML content as a single tuple. The XML content is assigned to the first attribute in the output tuple which must be of type xml.The URL can have a single query parameter updated using the updateParameter parameter.When set the URL query string will be modified to set the named parameter to a new value.The default action is to set it to the number of milliseconds since the 1970 epoch.

Summary

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

Required: url

Optional: acceptAllCertificates, extraHeaders, initDelay, iterations, period, updateParameter, updateParameterFromContent

Metrics
This operator reports 1 metric.

Properties

Implementation
Java

Output Ports

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

Content of the HTTP GET request as an XML attribute. Each successful HTTP request that returns a single well-formed XML document results in a submitted tuple with an XML attribute containing the returned content.

Properties

Parameters

This operator supports 8 parameters.

Required: url

Optional: acceptAllCertificates, extraHeaders, initDelay, iterations, period, updateParameter, updateParameterFromContent

acceptAllCertificates

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

Properties
extraHeaders

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

Properties
initDelay

Delay in seconds before the operator starts producing tuples.

Properties
iterations

The number of tuples to submit. Negative value or zero means continually fetch and submit tuples.

Properties
period

Polling period in seconds. Tuples will be fetched every period seconds.

Properties
updateParameter

URL query parameter to update based upon content in a successful request.

Properties
updateParameterFromContent

Update the query parameter set in updateParameter from the value of this XPath expression against the returned content.

Properties
url

URL to HTTP GET content from.

Properties

Metrics

nFailedRequests - Counter

Number of HTTP requests that failed, did not return response 200.

Libraries

Operator class library
Library Path: ../../impl/lib/com.ibm.streamsx.inet.jar