Operator HTTPXMLView

IBMStreams streamsx.inetserver Toolkit > com.ibm.streamsx.inetserver 4.3.4 > com.ibm.streamsx.inet.rest > HTTPXMLView

REST API to view tuples from input ports. Embeds a Jetty web server to provide HTTP or HTTPS REST access to the first XML attribute of the last tuple received by the input port. The URLs defined by this operator are:
  • prefix/ports/input/port index/attribute - Returns the value of the XML attribute (content type application/xml).
  • prefix/ports/input/port index/info - Output port meta-data including all the stream attribute names and types (content type application/json).
The prefix for the URLs is:
  • context path/base operator name - When the context parameter is set.
  • full operator name - When the context parameter is not set.

The input port schema must contain an XML attribute whose value will be made available through the /tuple URL. If there was no input tuple received or there was a default value received, response code 204 (SC_NO_CONTENT) is returned.

Limitations:
  • By default no security access is provided to the data, HTTPS must be explicitly configured.

HTTPS Support and Sharing the Jetty Server

see also namespace:com.ibm.streamsx.inet

Summary

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

Optional: certificateAlias, context, contextResourceBase, host, keyPassword, keyStore, keyStorePassword, port, sslAppConfigName, trustStore, trustStorePassword

Metrics
This operator reports 2 metrics.

Properties

Implementation
Java

Input Ports

Ports (0)

Input port whose first XML attribute will be available using a HTTP GET request with a URL using port index 0.

Properties

Parameters

This operator supports 11 parameters.

Optional: certificateAlias, context, contextResourceBase, host, keyPassword, keyStore, keyStorePassword, port, sslAppConfigName, trustStore, trustStorePassword

certificateAlias

Alias of the certificate to use in the key store. When this parameter is set all connections use HTTPS and parameters keyStore and keyPassword are required.

Properties
context

Define a URL context path that maps to the resources defined by contextResourceBase. This allows a composite that invokes this operator in a toolkit to provide resources regardless of the value of the application's data directory. For example setting it to maps would result in the URL /maps/index.html mapping to the file index.html in the directory defined by contextResourceBase. Requires the parameter contextResourceBase to be set. If when the operator is initialized the context already exists then no action is taken. This allows multiple independent composites in the same toolkit to have common context and contextResourceBase settings, typically to point to a single set of HTML and Javascript resources for the toolkit.

If the operator provides URLs for its input or output ports then they are placed in the this context when this parameter is set. This then provides fixed locations for the URLs regardless of the depth of the operator invocation in the main composite.

Only a single context per invocation is supported.

Properties
contextResourceBase

Directory location of resources that will be available through the the URL context defined by the parameter context. Typically used to allow a toolkit to provide a set of resources in a fixed location. The set of resources is recommended to be stored in the application_dir/opt directory, which is automatically included in the bundle by default. Path of this directory can be absolute or relative, if relative path is specified then it is relative to the application directory. A set of default resources is included in the toolkit directory under ToolkitDir/opt/resources and will be loaded by the operator. This default resources can be viewed at http://hostname:8080/streamsx.inet.resources. A path within the application is obtained using the SPL function getThisToolkitDir(). Thus a composite in the file maps.spl in the namespace directory com.acme.streams.apps.map might have the following setting to map http://127.0.0.1:8080/maps to opt/resources/mapinfo in the application.

param
  context: “maps”
  contextResourceBase: getThisToolkitDir() + “/opt/resources/mapinfo”

If this parameter is applied parameter contextResourceBase is required too.

Properties
host

You can configure a host either as a host name or IP address to identify a specific network interface on which to listen. If not set, or set to the value of 0.0.0.0, the integrated jetty server listens on all local interfaces.

Properties
keyPassword

Password to the private key.

Properties
keyStore

URL to the key store containing the certificate. If a relative file path then it is taken as relative to the application directory.

Properties
keyStorePassword

Password to the key store.

Properties
port

Port number for the embedded Jetty HTTP server, default: "8080". If the port is set to 0, the jetty server uses a free tcp port, and the metric serverPort delivers the actual value.

Properties
sslAppConfigName
The operator can get the SSL server key/certificate and the client trust material from Streams application configuration with this name. If this parameter is present, certificateAlias, keyStore, keyPassword, trustStore and trustStorePassword are not allowed. The application configuration must contain the folowing properties:
  • server.jks - Base 64 encoded representation of the Java key store with one key-certificate pair to be used as server key and certitficate.
  • server.pass -Password for server.jks (and its key) and cacerts.jks.
The app configuration may contain property:
  • cacerts.jks - Base 64 encoded representation of the Java trust store with the client trust material.
If the property cacerts.jks is present, the operator requests client certificates. To create the Streams application configuration you may use a comand like:
streamtool mkappconfig --description 'server cert and trust store' --property "server.jks=$(base64 --wrap=0 etc/keystore.jks)" --property "server.pass=password" --property "cacerts.jks=$(base64 --wrap=0 etc/cacerts.jks)" streams-certs
Properties
trustStore

URL to the trust store containing client certificates. If a relative file path then it is taken as relative to the application directory. When this parameter is set, client authentication is required.

Properties
trustStorePassword

Password to the trust store.

Properties

Metrics

https - Gauge

Jetty SSL/TLS status: 0=HTTP, 1=HTTPS.

serverPort - Gauge

Jetty (HTTP/HTTPS) server port if the operator hosts the server, 0 otherwise

Libraries

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