ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaie_5.4.0.1/rzaierefapi.htm

253 lines
19 KiB
HTML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="topic" />
<meta name="DC.Title" content="Application programming interfaces (APIs) for HTTP Server" />
<meta name="abstract" content="This topic provides information about HTTP Server APIs for CGI applications, configuration APIs, server instance APIs, group APIs, and triggered cache manager APIs." />
<meta name="description" content="This topic provides information about HTTP Server APIs for CGI applications, configuration APIs, server instance APIs, group APIs, and triggered cache manager APIs." />
<meta name="DC.Relation" scheme="URI" content="rzaieparapi.htm" />
<meta name="copyright" content="(C) Copyright IBM Corporation 2002,2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2002,2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rzaierefapi" />
<meta name="DC.Language" content="en-us" />
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>Application programming interfaces (APIs) for HTTP Server</title>
</head>
<body id="rzaierefapi"><a name="rzaierefapi"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">Application programming interfaces (APIs) for HTTP Server</h1>
<div><p>This topic provides information about HTTP Server APIs for CGI
applications, configuration APIs, server instance APIs, group APIs, and triggered
cache manager APIs.</p>
<div class="important"><span class="importanttitle">Important:</span> 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 <a href="http://www-03.ibm.com/servers/eserver/iseries/software/http/services/service.html" target="_blank">http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm</a> <img src="www.gif" alt="Link outside Information Center" /> for more information. </div>
<p>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.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaieparapi.htm" title="This topic provides information on application programming interfaces (APIs).">Application Programming Interface</a></div>
</div>
</div><div class="hr" id="cgiapi"><a name="cgiapi"><!-- --></a><h2 class="topictitle2">CGI application APIs</h2>
<div><p>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<sup>®</sup> ILE C, ILE RPG, and ILE COBOL.</p>
<ul><li><a href="rzaieapi_qtmhgetenv.htm">Get Environment Variable (QtmhGetEnv) API</a></li>
<li><a href="rzaieapi_qtmhputenv.htm">Put Environment Variable (QtmhPutEnv) API</a></li>
<li><a href="rzaieapi_qtmhrdstin.htm">Read from Stdin (QtmhRdStin) API</a></li>
<li><a href="rzaieapi_qtmhwrstout.htm">Write to Stdout (QtmhWrStout) API</a></li>
<li><a href="rzaieapi_qtmhcvtdb.htm">Convert to DB (QtmhCvtDB) API</a></li>
<li><a href="rzaieapi_qzhbcgiparse.htm">Parse QUERY_STRING Environment Variable or Post stdin data (QzhbCgiParse) API</a></li>
<li><a href="rzaieapi_qzhbcgiutils.htm">Produce Full HTTP Response (QzhbCgiUtils) API</a></li>
<li><a href="rzaieapi_qzhbcgisendstate.htm">Send or Save CGI Stateful Data (QzhbCgiSendState) API</a></li>
<li><a href="rzaieapi_qzhbcgirecvstate.htm">Receive CGI Stateful Data (QzhbCgiRecvState) API</a></li>
<li><a href="rzaieapi_qzsrputenvccsid.htm">Put environment variable with CCSID (QzsrPutEnvCCSID) API</a></li>
<li><a href="rzaieapi_qzsrgetenvccsid.htm">Get environment variable with CCSID (QzsrGetEnvCCSID) API</a></li>
</ul>
</div>
</div>
<div class="hr" id="configapi"><a name="configapi"><!-- --></a><h2 class="topictitle2">Configuration APIs</h2>
<div><p>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:</p>
<ul><li>*OBJOPR, *READ, *ADD, and *EXECUTE to the QUSRSYS library</li>
<li>*READ, *ADD, *DELETE, *EXECUTE, *OBJOPR, *OBJEXIST, and either *OBJMGT
or *OBJALTER to the QUSRSYS/QATMHTTPC file</li>
<li>*READ, *ADD, *DELETE, *EXECUTE, *OBJOPR, *OBJEXIST, and either *OBJMGT
or *OBJALTER to the QUSRSYS/QATMHTTPA file</li>
</ul>
<div class="note"><span class="notetitle">Note:</span> The QUSRSYS/QATMHTTPA file is the administration (ADMIN) server configuration
file.</div>
<ul><li><a href="rzaieapi_qzuiaddconfigobject.htm">Add Config Object (QzuiAddConfigObject) API</a></li>
<li><a href="rzaieapi_qzuichangeconfigobject.htm">Change Config Object Value (QzuiChangeConfigObject) API</a></li>
<li><a href="rzaieapi_qzuicloseconfig.htm">Close Apache Config File (QzuiCloseConfig) API</a></li>
<li><a href="rzaieapi_qzuifindconfigobject.htm">Find Config Object (QzuiFindConfigObject) API</a></li>
<li><a href="rzaieapi_qzuiopenconfig.htm">Open Apache Config File (QzuiOpenConfig) API</a></li>
<li><a href="rzaieapi_qzuiremoveconfigobject.htm">Remove Config Object (QzuiRemoveConfigObject) API</a></li>
</ul>
</div>
</div>
<div class="hr" id="serverapi"><a name="serverapi"><!-- --></a><h2 class="topictitle2">Server instance APIs</h2>
<div><p>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:</p>
<ul><li>*OBJOPR, *READ, *ADD, and *EXECUTE to the QUSRSYS library</li>
<li>*READ, *ADD, *DELETE, *EXECUTE, *OBJOPR, *OBJEXIST, and either *OBJMGT
or *OBJALTER to the QUSRSYS/QATMHINSTC file</li>
<li>*READ, *ADD, *DELETE, *EXECUTE, *OBJOPR, *OBJEXIST, and either *OBJMGT
or *OBJALTER to the QUSRSYS/QATMHINSTA file</li>
</ul>
<div class="note"><span class="notetitle">Note:</span> The QUSRSYS/QATMINSTA file is the administration (ADMIN) server instance
file.</div>
<ul><li><a href="rzaieapi_qzuichangeinstancedata.htm">Change Apache Server Instance Data (QzuiChangeInstanceData) API</a></li>
<li><a href="rzaieapi_qzuicreateinstance.htm">Create Apache Server Instance (QzuiCreateInstance) API</a></li>
<li><a href="rzaieapi_qzuigetinstancedata.htm">Get Apache Server Instance Data (QzuiGetInstanceData) API</a></li>
<li><a href="rzaieapi_qzuigetinstancenames.htm">Get Server Instance Names (QzuiGetInstanceNames) API</a></li>
<li><a href="rzaieapi_qzuigetinstancetype.htm">Get Instance Type (QzuiGetInstanceType) API</a></li>
</ul>
</div>
</div>
<div class="hr" id="groupapi"><a name="groupapi"><!-- --></a><h2 class="topictitle2">Group file APIs</h2>
<div><p>The group file APIs are in *SRVPGM QZHBCONF in library QHTTPSVR. ILE C
programs must include header file QHTTPSVR/H(QZHBCONF). </p>
<div class="note"><span class="notetitle">Note:</span> Group file APIs are independent of HTTP Server type.</div>
<ul><li><a href="rzaieapi_qzhbcreategrouplist.htm">Create a new Group File (QzhbCreateGroupList) API</a></li>
<li><a href="rzaieapi_qzhbopengrouplist.htm">Read a Group File into Memory (QzhbOpenGroupList) API</a></li>
<li><a href="rzaieapi_qzhbclosegrouplist.htm">Free Group File from Memory (QzhbCloseGroupList) API</a></li>
<li><a href="rzaieapi_qzhbgetnextgroup.htm">Retrieve the next Group in the Group List (QzhbGetNextGroup) API</a></li>
<li><a href="rzaieapi_qzhbfindgroupinlist.htm">Locate a named group in a Group List (QzhbFindGroupInList) API</a></li>
<li><a href="rzaieapi_qzhbgetgroupname.htm">Retrieve the Name of a Group (QzhbGetGroupName) API</a></li>
<li><a href="rzaieapi_qzhbaddgrouptolist.htm">Add a new Group to the end of a Group List (QzhbAddGroupToList) API</a></li>
<li><a href="rzaieapi_qzhbremovegroupfromlist.htm">Remove a Group from a Group List (QzhbRemoveGroupFromList) API</a></li>
<li><a href="rzaieapi_qzhbgetnextuser.htm">Retrieve the next User in the Group (QzhbGetNextUser) API</a></li>
<li><a href="rzaieapi_qzhbfinduserIngroup.htm">Locate a User in a Group (QzhbFindUserInGroup) API</a></li>
<li><a href="rzaieapi_qzhbgetuserstring.htm">Retrieve the Name of a User (QzhbGetUserString) API</a></li>
<li><a href="rzaieapi_qzhbaddusertogroup.htm">Add a new user to the end of a Group (QzhbAddUserToGroup) API</a></li>
<li><a href="rzaieapi_qzhbremoveuserfromgroup.htm">Remove a User or Element from a Group (QzhbRemoveUserFromGroup) API</a></li>
</ul>
</div>
</div>
<div class="hr" id="server_opertation_apis"><a name="server_opertation_apis"><!-- --></a><h2 class="topictitle2">TCM server operation APIs</h2>
<div><p>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. </p>
<ul><li><a href="rzaieapi_qzhtstrtcmserver.htm">Start Triggered Cache Manager Server (QzhtStrTCMServer) API</a></li>
<li><a href="rzaieapi_qzhtendtcmserver.htm">End Triggered Cache Manager Server (QzhtEndTCMServer) API</a></li>
</ul>
</div>
</div>
<div class="hr" id="basic_config_apis"><a name="basic_config_apis"><!-- --></a><h2 class="topictitle2">TCM basic configuration APIs</h2>
<div><p>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.</p>
<ul><li><a href="rzaieapi_qzhtcrttcmserver.htm">Create Triggered Cache Manager Server (QzhtCrtTCMServer) API</a></li>
<li><a href="rzaieapi_qzhtgettcmserverstatus.htm">Get Triggered Cache Manager Server Status (QzhtGetTCMServerStatus) API</a></li>
<li><a href="rzaieapi_qzhtdlttcmserver.htm">Delete Triggered Cache Manager Server Status (QzhtDltTCMServer) API</a></li>
<li><a href="rzaieapi_qzhtrtvtcmbasicconfig.htm">Retrieve Triggered Cache Manager Basic Configuration (QzhtRtvTCMBasicConfig) API</a></li>
<li><a href="rzaieapi_qzhtchgtcmbasicconfig.htm">Change Triggered Cache Manager Basic Configuration (QzhtChgTCMBasicConfig) API</a></li>
</ul>
</div>
</div>
<div class="hr" id="trigger_hand_config_apis"><a name="trigger_hand_config_apis"><!-- --></a><h2 class="topictitle2">TCM trigger handler configuration APIs</h2>
<div><p>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.</p>
<ul><li><a href="rzaieapi_qzhtaddtcmtriggerhandlerdesc.htm">Add Triggered Cache Manager Trigger Handler Description (QzhtAddTCMTriggerHandlerDesc) API</a></li>
<li><a href="rzaieapi_qzhtrtvtcmtriggerhandlerdesc.htm">Retrieve Triggered Cache Manager Trigger Handler Description (QzhtRtvTCMTriggerHandlerDesc) API</a></li>
<li><a href="rzaieapi_qzhtchgtcmtriggerhandlerdesc.htm">Change Triggered Cache Manager Trigger Handler Description (QzhtChgTCMTriggerHandlerDesc) API</a></li>
<li><a href="rzaieapi_qzhtrmvtcmtriggerhandlerdesc.htm">Remove Triggered Cache Manager Trigger Handler Description (QzhtRmvTCMTriggerHandlerDesc) API</a></li>
</ul>
</div>
</div>
<div class="hr" id="data_source_config_apis"><a name="data_source_config_apis"><!-- --></a><h2 class="topictitle2">TCM data source configuration APIs</h2>
<div><p>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.</p>
<ul><li><a href="rzaieapi_qzhtaddtcmdatasourcedesc.htm">Add Triggered Cache Manager Data Source Description (QzhtAddTCMDataSourceDesc) API</a></li>
<li><a href="rzaieapi_qzhtrtvtcmdatasourcedesc.htm">Retrieve Triggered Cache Manager Data Source Description (QzhtRtvTCMDataSourceDesc) API</a></li>
<li><a href="rzaieapi_qzhtchgtcmdatasourcedesc.htm">Change Triggered Cache Manager Data Source Description (QzhtChgTCMDataSourceDesc) API</a></li>
<li><a href="rzaieapi_qzhtrmvtcmdatasourcedesc.htm">Remove Triggered Cache Manager Data Source Description (QzhtRmvTCMDataSourceDesc) API</a></li>
</ul>
</div>
</div>
<div class="hr" id="cache_target_config_apis"><a name="cache_target_config_apis"><!-- --></a><h2 class="topictitle2">TCM cache target configuration APIs</h2>
<div><p>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. </p>
<ul><li><a href="rzaieapi_qzhtaddtcmcachetargetdesc.htm">Add Triggered Cache Manager Cache Target Description (QzhtAddTCMCacheTargetDesc) API</a></li>
<li><a href="rzaieapi_qzhtrtvtcmcachetargetdesc.htm">Retrieve Triggered Cache Manager Cache Target Description (QzhtRtvTCMCacheTargetDesc) API</a></li>
<li><a href="rzaieapi_qzhtchgtcmcachetargetdesc.htm">Change Triggered Cache Manager Cache Target Description (QzhtChgTCMCacheTargetDesc) API</a></li>
<li><a href="rzaieapi_qzhtrmvtcmcachetargetdesc.htm">Remove Triggered Cache Manager Cache Target Description (QzhtRmvTCMCacheTargetDesc) API</a></li>
</ul>
</div>
</div>
<div class="hr" id="ack_target_config_apis"><a name="ack_target_config_apis"><!-- --></a><h2 class="topictitle2">TCM acknowledgement target configuration APIs</h2>
<div><p>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.</p>
<ul><li><a href="rzaieapi_qzhtaddtcmacktargetdesc.htm">Add Triggered Cache Manager Acknowledgment Target Description (QzhtAddTCMAckTargetDesc) API</a></li>
<li><a href="rzaieapi_qzhtrtvtcmacktargetdesc.htm">Retrieve Triggered Cache Manager Acknowledgment Target Description (QzhtRtvTCMAckTargetDesc) API</a></li>
<li><a href="rzaieapi_qzhtchgtcmacktargetdesc.htm">Change Triggered Cache Manager Acknowledgment Target Description (QzhtChgTCMAckTargetDesc) API</a></li>
<li><a href="rzaieapi_qzhtrmvtcmacktargetdesc.htm">Remove Triggered Cache Manager Acknowledgment Target Description (QzhtRmvTCMAckTargetDesc) API</a></li>
</ul>
</div>
</div>
<div class="hr" id="host_config_apis"><a name="host_config_apis"><!-- --></a><h2 class="topictitle2">TCM host configuration APIs</h2>
<div><p>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.</p>
<ul><li><a href="rzaieapi_qzhtaddtcmhostdesc.htm">Add Triggered Cache Manager Host Description (QzhtAddTCMHostDesc) API</a></li>
<li><a href="rzaieapi_qzhtrtvtcmhostdesc.htm">Retrieve Triggered Cache Manager Host Description (QzhtRtvTCMHostDesc) API</a></li>
<li><a href="rzaieapi_qzhtchgtcmhostdesc.htm">Change Triggered Cache Manager Host Description (QzhtChgTCMHostDesc) API</a></li>
<li><a href="rzaieapi_qzhtrmvtcmhostdesc.htm">Remove Triggered Cache Manager Host Description (QzhtRmvTCMHostDesc) API</a></li>
</ul>
</div>
</div>
<div class="hr" id="odg_config_apis"><a name="odg_config_apis"><!-- --></a><h2 class="topictitle2">TCM object dependency graph configuration APIs</h2>
<div><p>The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for these
API.</p>
<ul><li><a href="rzaieapi_qzhtaddtcmodgdesc.htm">Add Triggered Cache Manager Object Dependency Graph Description (QzhtAddTCMODGDesc) API</a></li>
<li><a href="rzaieapi_qzhtrtvtcmodgdesc.htm">Retrieve Triggered Cache Manager Object Dependency Graph Description (QzhtRtvTCMODGDesc) API</a></li>
<li><a href="rzaieapi_qzhtchgtcmodgdesc.htm">Change Triggered Cache Manager Object Dependency Graph Description (QzhtChgTCMODGDesc) API</a></li>
<li><a href="rzaieapi_qzhtrmvtcmodgdesc.htm">Remove Triggered Cache Manager Object Dependency Graph Description (QzhtRmvTCMODGDesc) API</a></li>
</ul>
</div>
</div>
<div class="hr" id="ruleset_config_apis"><a name="ruleset_config_apis"><!-- --></a><h2 class="topictitle2">TCM rule set configuration APIs</h2>
<div><p>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.</p>
<ul><li><a href="rzaieapi_qzhtaddtcmruleset.htm">Add Triggered Cache Manager Rule Set (QzhtAddTCMRuleSet) API</a></li>
<li><a href="rzaieapi_qzhtrtvtcmruleset.htm">Retrieve Triggered Cache Manager Rule Set (QzhtRtvTCMRuleSet) API</a></li>
<li><a href="rzaieapi_qzhtchgtcmruleset.htm">Change Triggered Cache Manager Rule Set (QzhtChgTCMRuleSet) API</a></li>
<li><a href="rzaieapi_qzhtrmvtcmruleset.htm">Remove Triggered Cache Manager Rule Set (QzhtRmvTCMRuleSet) API</a></li>
</ul>
</div>
</div>
<div class="hr" id="pubrule_config_apis"><a name="pubrule_config_apis"><!-- --></a><h2 class="topictitle2">TCM publishing rule configuration APIs</h2>
<div><p> 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.</p>
<ul><li><a href="rzaieapi_qzhtaddtcmpublishingrule.htm">Add Triggered Cache Manager Publishing Rule (QzhtAddTCMPublishingRule) API</a></li>
<li><a href="rzaieapi_qzhtrtvtcmpublishingrule.htm">Retrieve Triggered Cache Manager Publishing Rule (QzhtRtvTCMPublishingRule) API</a></li>
<li><a href="rzaieapi_qzhtchgtcmpublishingrule.htm">Change Triggered Cache Manager Publishing Rule (QzhtChgTCMPublishingRule) API</a></li>
<li><a href="rzaieapi_qzhtrmvtcmpublishingrule.htm">Remove Triggered Cache Manager Publishing Rule (QzhtRmvTCMPublishingRule) API</a></li>
</ul>
</div>
</div>
</body>
</html>