Application programming interfaces (APIs) for HTTP Server

This topic provides information about HTTP Server APIs for CGI applications, configuration APIs, server instance APIs, group APIs, and triggered cache manager APIs.

Important: Information for this topic supports the latest PTF levels for HTTP Server for i5/OS . It is recommended that you install the latest PTFs to upgrade to the latest level of the HTTP Server for i5/OS. Some of the topics documented here are not available prior to this update. See http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm Link outside Information Center

for more information.

HTTP Server supports the APIs listed below in C++, REXX, ILE C, ILE COBOL, and ILE RPG programming languages. Although all APIs are supported in all of these languages, most ILE C CGI applications will only need to use QtmhCvtDB, QzhbCgiParse, or QzhbCgiUtils. This is because ANSI C can work with stdin, stdout, and environment variables directly. ILE C CGI applications use ANSI C function calls to work with stdin, stdout, environment variables, and string functions for parsing stdin and environment variable data.

Parent topic: Application Programming Interface

CGI application APIs

To use these APIs in a CGI application, you must bind the CGI program to *SRVPGM QZHBCGI in library QHTTPSVR. ILE C programs must include header file QSYSINC/H(QZHBCGI). CGI application programs must be written and compiled in Integrated Language Environment^® ILE C, ILE RPG, and ILE COBOL.

Configuration APIs

The configuration APIs are in *SRVPGM QZHBCONF in library QHTTPSVR. ILE C programs must include header file QHTTPSVR/H(QZHBCONF). While each individual API lists its own authorities, the following authorities are needed to run all configuration APIs:

*OBJOPR, *READ, *ADD, and *EXECUTE to the QUSRSYS library
*READ, *ADD, *DELETE, *EXECUTE, *OBJOPR, *OBJEXIST, and either *OBJMGT or *OBJALTER to the QUSRSYS/QATMHTTPC file
*READ, *ADD, *DELETE, *EXECUTE, *OBJOPR, *OBJEXIST, and either *OBJMGT or *OBJALTER to the QUSRSYS/QATMHTTPA file

Note: The QUSRSYS/QATMHTTPA file is the administration (ADMIN) server configuration file.

Server instance APIs

The server instance APIs are in *SRVPGM QZHBCONF in library QHTTPSVR. ILE C programs must include header file QHTTPSVR/H(QZHBCONF). While each individual API lists its own authorities, the following authorities are needed to run all server instance APIs:

*OBJOPR, *READ, *ADD, and *EXECUTE to the QUSRSYS library
*READ, *ADD, *DELETE, *EXECUTE, *OBJOPR, *OBJEXIST, and either *OBJMGT or *OBJALTER to the QUSRSYS/QATMHINSTC file
*READ, *ADD, *DELETE, *EXECUTE, *OBJOPR, *OBJEXIST, and either *OBJMGT or *OBJALTER to the QUSRSYS/QATMHINSTA file

Note: The QUSRSYS/QATMINSTA file is the administration (ADMIN) server instance file.

Group file APIs

The group file APIs are in *SRVPGM QZHBCONF in library QHTTPSVR. ILE C programs must include header file QHTTPSVR/H(QZHBCONF).

Note: Group file APIs are independent of HTTP Server type.

TCM server operation APIs

The trigger cache manager server operation APIs may be used to start and stop trigger cache manager servers. The APIs are callable service implemented as an ILE entry point within the QZHTINOPS *SVRPGM in the QTCM *LIB. The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for these APIs.

TCM basic configuration APIs

The trigger cache manager basic configuration APIs are a callable service implemented as an ILE entry point within the QZHTINCONF *SRVPGM in the QTCM *LIB. The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for these APIs.

TCM trigger handler configuration APIs

The trigger cache manager trigger handler configuration APIs are a callable service implemented as an ILE entry point within the QZHTINCONF *SRVPGM in the QTCM *LIB. The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for these APIs.

TCM data source configuration APIs

The trigger cache manger data source configuration APIs are a callable service implemented as an ILE entry point within the QZHTINCONF *SRVPGM in the QTCM *LIB. The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for these APIs.

TCM cache target configuration APIs

The trigger cache manager cache target configuration APIs are a callable service implemented as an ILE entry point within the QZHTINCONF *SRVPGM in the QTCM *LIB. The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for these APIs.

TCM acknowledgement target configuration APIs

The triggered cache manager acknowledgement target configuration APIs are a callable service implemented as an ILE entry point within the QZHTINCONF *SRVPGM in the QTCM *LIB. The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for these APIs.

TCM host configuration APIs

The triggered cache manager host configuration APIs are a callable service implemented as an ILE entry point within the QZHTINCONF *SRVPGM in the QTCM *LIB. The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for these APIs.

TCM object dependency graph configuration APIs

The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for these API.

TCM rule set configuration APIs

The triggered cache manager rule set configuration APIs are a callable service implemented as an ILE entry point within the QZHTINCONF *SRVPGM in the QTCM *LIB. The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for these APIs.

TCM publishing rule configuration APIs

The triggered cache manger publishing rule configuration APIs are a callable service implemented as an ILE entry point within QZHTINCONF *SRVPGM in QTCM *LIB. The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for these APIs.