The HTTP/2 functions are used to exchange data over HTTP/2 as a client. However, 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 following functions for HTTP/2 described here are:

httpGet

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

Response 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

/api/v2/doc

httpPost

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

Response 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

/api/v2/doc

application/json

httpReq

This function makes an HTTP request and uses the specified method, for example GET, POST, and PUT.

Response httpReq
    ( string method,	
	  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

/api/v2/doc

application/json

httpMultipartPost

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

Response httpMultipartPost
    ( string host,
	  string path,
	  list<MultipartSegmentUDR> content,
	  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

httpMultipartPostURL( "mypath", mybody, "myhost", 0, null, "myusername");

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 credentials. 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. See the example below for how to set these properties using the mzsh topo command.

$ mzsh topo set topo://container:<container>/pico:<pico>/val:config.properties.https.apl.keystore_location <location of the Keystore file>
$ mzsh topo set topo://container:<container>/pico:<pico>/val:config.properties.https.apl.keystore_passphrase <DR encrypted password>

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.

keytool -keystore /var/opt/mz/HttpdExec.keystore -genkey -keyalg RSA

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, use the mzsh topo command to add the property https.apl.userdefined.truststore to the required ECs and set the value to true:

$ mzsh topo set topo://container:<container>/pico:<pico>/val:config.properties.https.apl.userdefined.truststore 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, use the mzsh topo command to set the following properties in the relevant ECs:

• https.apl.truststore_location

• https.apl.truststore_passphrase

  
  

$ mzsh topo set topo://container:<container>/pico:<pico>/val:config.properties.https.apl.truststore_location <location of the truststore file>
$ mzsh topo set topo://container:<container>/pico:<pico>/val:config.properties.https.apl.truststore_passphrase <DR encrypted password>

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