The HTTP/2 functions are used to exchange data over HTTP/2 as a client. The functions can also be used for HTTP/1.

The client functions are used to exchange data with a HTTP server. There are specific functions for GET and POST as well as functions for general HTTP requests. Either plain text or encrypted communication can be used. Basic authentication is supported, as well as the use of a keystore, and if required a truststore, for the functions with an encrypted communication channel.

The HTTP client functions also support the use of proxy, see HTTP Proxy Setup (3.3) for information on how to setup HTTP proxy support.

Note!

In all parameter descriptions below, "HTTP" may refer to both HTTP and HTTPS, and both HTTP/1 and HTTP/2.

httpGet

This function uses the GET method to retrieve content from an HTTP server.

string httpGet
    ( string host,
      string path,
      string protocol,			    //Optional
      int port,                     //Optional
      boolean secure,               //Optional
      int requestTimeout,           //Optional
      int connectionTimeout,        //Optional
      string username,              //Optional
      string password,              //Optional
      map<string, string> headers ) //Optional

Parameter	Description

Parameter	Description
`host`	The name or IP address of the HTTP server.
`path`	The path. Example - path `/api/v2/doc`
`protocol`	The protocol used: HTTP/1 or HTTP/2. The default value is HTTP/1. To use HTTP/2, you must set this value to "h2".
`port`	The port number to contact the HTTP server on. Port 80 is used for HTTP connection and 443 is used for HTTPS connection by default.
`secure`	Indicates whether the data should be sent in secure mode or not.
`requestTimeout`	The number of milliseconds to wait for a response. If the value is not specifically specified, the default timeout is used. The default value is 15000 milliseconds.
`connectionTimeout`	The number of milliseconds to wait for a connection to be established. If the value is not specifically specified, the default timeout is used. The default value is 3000 milliseconds.
`username`	A username for an account on the HTTP server.
`password`	Password associated with the username.
`headers`	Custom HTTP request headers.
Returns	Content from the HTTP server. It will be `null` if any part of the communication fails.

httpPost

This function uses the POST method to send content to an HTTP/2 server and receives the response.

string httpPost
    ( string host, 
      string path,		
      bytearray content, 
      string contentType,
      string protocol,			    //Optional
      int port,                     //Optional 
 	  boolean secure,               //Optional 
      int requestTimeout,           //Optional
      int connectionTimeout,        //Optional 
      string username,              //Optional
      string password,              //Optional
      map<string, string> headers ) //Optional

Parameter	Description

Parameter	Description
`host`	The name or IP address of the HTTP server.
`path`	The path Example - path
`bytearraycontent`	The body of the request in bytearray format.
`contentType`	The MIME type of the content.
`protocol`	The protocol used: HTTP/1 or HTTP/2. The default value is HTTP/1. To use HTTP/2, you must set this value to "h2".
`port`	The port number to contact the HTTP server on. Port 80 is used for HTTP connection and 443 is used for HTTPS connection by default.
`secure`	Indicates whether the data should be sent in secure mode or not.
`requestTimeout`	The number of milliseconds to wait for a response. If the value is not specifically specified, the default timeout is used. The default value is 15000 milliseconds.
`connectionTimeout`	The number of milliseconds to wait for a connection to be established. If the value is not specifically specified, the default timeout is used. The default value is 3000 milliseconds.
`username`	A username for an account on the HTTP server.
`password`	Password associated with the username.
`headers`	Custom HTTP request headers.
Returns	Content from the HTTP server. It will be `null` if any part of the communication fails.

httpReq

This function makes an HTTP request and uses the specified method, e g GET, POST, PUT etc.

Parameter	Description

Parameter	Description
`method`	The HTTP method.
`url`	The host and port of the HTTP server, e g http://host:port
`header`	Key-value pairs containing request header fields
`path`	The path
`content`	The body of the request in bytearray format.
`contentType`	The MIME type of the content.
`protocol`	The protocol used: HTTP/1 or HTTP/2. The default value is HTTP/1. To use HTTP/2, you must set this value to "h2".
`port`	The port number to contact the HTTP server on. Port 80 is used for HTTP connection and 443 is used for HTTPS connection by default.
`secure`	Indicates whether the data should be sent in secure mode or not.
`requestTimeout`	The number of milliseconds to wait for a response. If the value is not specifically specified, the default timeout is used. The default value is 15000 milliseconds.
`connectionTimeout`	The number of milliseconds to wait for a connection to be established. If the value is not specifically specified, the default timeout is used. The default value is 3000 milliseconds.
`username`	A username for an account on the HTTP server.
`password`	Password associated with the username.
`headers`	Custom HTTP request headers.
Returns	A response from the HTTP server. It will be `null` if any part of the communication fails.

httpMultipartPost

This function uses the POST method to send multipart binary contents to an HTTP server and receives the response.

Parameter	Description

Parameter	Description
`host`	The name or IP address of the HTTP server.
`path`	The path on the server to which we should do the POST.
content	The body of the the request.
protocol	The protocol used: HTTP/1 or HTTP/2. The default value is HTTP/1. To use HTTP/2, you must set this value to "h2".
`port`	The port to be used for the HTTP server. Port 80 is used for HTTP connection and 443 is used for HTTPS connection by default.
`secure`	Indicates whether the data should be sent in secure mode or not.
`requestTimeout`	The number of milliseconds to wait for a response. If the value is not specifically specified, the default timeout is used. The default value is 15000 milliseconds.
`connectionTimeout`	The number of milliseconds to wait for a connection to be established. If the value is not specifically specified, the default timeout is used. The default value is 3000 milliseconds.
`username`	Username for the account to be used on the HTTP server.
`password`	Password associated with the username.
`headers`	Custom HTTP request headers.
Returns	A bytearray from the HTTP server. It will be null if any part of the communication fails.

TLS/SSL Encryption

When selecting secure, a keystore is required. In this case, the use of a truststore is supported.

Configure Java Keystore for Secure URL Functions

Keystore is used to store HTTP Client’s credential. This certificate is sent to a server for authentication if required.

To specify a Keystore file that you want to use, set the properties https.apl.keystore_location and https.apl.keystore_passphrase in the relevant ECs.

If the two properties above are not set in the relevant Execution Context <pico>.conf, MZ Default Keystore is used.

The property https.apl.keystore_location represents the location of the keystore and the property https.apl.keystore_passphrase represents the passphrase for that keystore.

The following command can be used to create a keystore with the Java keytool program.

See the JVM product documentation for more information about how to use the keytool.

Configure Java Truststore for Secure URL Functions

A truststore is a keystore that is used when deciding what to trust - truststore stores certificates from third parties. If you receive data from an entity that you already trust, and if you can verify that the entity is what it claims to be, you can assume that the data does in fact come from that entity.

By Default, uses its own truststore, which always trusts any server connection.

If you want to use a specific truststore, add the property https.apl.userdefined.truststore to the required ECs and set the value to true.

The default value of this property is false.

After setting the property https.apl.userdefined.truststore to true, if you want to use a specific truststore, set the following properties in the relevant ECs:

https.apl.truststore_location
https.apl.truststore_passphrase

If you do not set these two properties, the Java Default Truststore is used.

Usage Engine Private Edition 4 Documentation

HTTP/2 Functions(4.1)