274 lines
14 KiB
HTML
274 lines
14 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="Add Triggered Cache Manager Rule Set (QzhtAddTCMRuleSet) API" />
|
||
|
|
<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="rzaieapi_qzhtaddtcmruleset" />
|
||
|
|
<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>Add Triggered Cache Manager Rule Set (QzhtAddTCMRuleSet) API</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzaieapi_qzhtaddtcmruleset"><a name="rzaieapi_qzhtaddtcmruleset"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<!--Java sync-link--><h1 class="topictitle1">Add Triggered Cache Manager Rule Set (QzhtAddTCMRuleSet) API</h1>
|
||
|
|
<div><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>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" class="figborder" frame="void" border="0" rules="none"><tbody><tr><td colspan="4" valign="top">Required Parameter Group:</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">1</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">request variable</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Input</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">2</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">length of request variable</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Input</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">3</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">request variable format</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Input</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Char(8)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">4</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">error code</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">I/O</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="4" valign="top">Library Name/Service Program: QTCM/QZHTINCONF</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="4" valign="top">Threadsafe: Yes</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p>The <em>QzhtAddTCMRuleSet</em> API adds new rule sets to the configurations
|
||
|
|
of triggered cache manager servers. New rule sets are referenced subsequently,
|
||
|
|
by name, from trigger handler descriptions associated with the same server.
|
||
|
|
New rule sets are utilized by all descriptions referencing them the next time
|
||
|
|
the servers are started.</p>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> Triggers are sent to trigger handlers which process them according to
|
||
|
|
publishing rules. Custom publishing rule descriptions may be provided for
|
||
|
|
the trigger handler through a rule set. If extensions of files identified
|
||
|
|
in triggers match one of the extensions listed in a custom publishing rule,
|
||
|
|
they will be processed according to that publishing rule. If extensions do
|
||
|
|
not match any of the custom publishing rules, the file will be processed according
|
||
|
|
to the default publishing rule.</div>
|
||
|
|
<p>The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for this API.</p>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="authoritylocks"><a name="authoritylocks"><!-- --></a><h2 class="topictitle2">Authorities and locks</h2>
|
||
|
|
<div><ul><li>*IOSYSCFG special authority</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="required"><a name="required"><!-- --></a><h2 class="topictitle2">Required parameter group</h2>
|
||
|
|
<div><dl><dt class="dlterm"><strong>request variable</strong></dt>
|
||
|
|
<dd>INPUT: CHAR(*) <p>The variable used to pass information to add a new rule
|
||
|
|
set.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>length of request variable</strong></dt>
|
||
|
|
<dd>INPUT: BINARY(4) <p>The number of bytes that the calling program provides
|
||
|
|
for request variable.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>request variable format</strong></dt>
|
||
|
|
<dd>INPUT: CHAR(8)<p> The format name of the request variable data. The following
|
||
|
|
values must be used:</p>
|
||
|
|
<ul><li>RSDP0100: Basic information format for a rule set.</li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>error code</strong></dt>
|
||
|
|
<dd>I/O: CHAR(*) <p>The structure in which to return error information.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="rsdp0100_format"><a name="rsdp0100_format"><!-- --></a><h2 class="topictitle2">RSDP0100 format</h2>
|
||
|
|
<div>
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th colspan="2" valign="top" id="d0e144">Offset</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e146">Type</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e148">Field</th>
|
||
|
|
</tr>
|
||
|
|
<tr><th valign="top" id="d0e151">Dec</th>
|
||
|
|
<th valign="top" id="d0e153">Hex</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e144 d0e151 ">0</td>
|
||
|
|
<td valign="top" headers="d0e144 d0e153 ">0</td>
|
||
|
|
<td valign="top" headers="d0e146 ">Char(32)</td>
|
||
|
|
<td valign="top" headers="d0e148 ">Server name</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e144 d0e151 ">32</td>
|
||
|
|
<td valign="top" headers="d0e144 d0e153 ">20</td>
|
||
|
|
<td valign="top" headers="d0e146 ">Char(32)</td>
|
||
|
|
<td valign="top" headers="d0e148 ">Rule set name</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e144 d0e151 ">64</td>
|
||
|
|
<td valign="top" headers="d0e144 d0e153 ">40</td>
|
||
|
|
<td valign="top" headers="d0e146 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e148 ">Default property</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e144 d0e151 ">68</td>
|
||
|
|
<td valign="top" headers="d0e144 d0e153 ">44</td>
|
||
|
|
<td valign="top" headers="d0e146 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e148 ">Offset to publishing rules</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e144 d0e151 ">72</td>
|
||
|
|
<td valign="top" headers="d0e144 d0e153 ">48</td>
|
||
|
|
<td valign="top" headers="d0e146 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e148 ">Length of publishing rules</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e144 d0e151 "> </td>
|
||
|
|
<td valign="top" headers="d0e144 d0e153 "> </td>
|
||
|
|
<td valign="top" headers="d0e146 ">Char(*)</td>
|
||
|
|
<td valign="top" headers="d0e148 ">Publishing rules</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="rsdp0100_field_descriptions"><a name="rsdp0100_field_descriptions"><!-- --></a><h2 class="topictitle2">RSDP0100 format field descriptions</h2>
|
||
|
|
<div><dl><dt class="dlterm"><strong>Default property</strong></dt>
|
||
|
|
<dd>Specifies if the new description is to become the default rule set for
|
||
|
|
the triggered cache manager server specified in Server name. The value must
|
||
|
|
equal one of the special values described below. If the value equals 1 (QZHT_YES),
|
||
|
|
the default property on the current default rule set, if any, is set to 0
|
||
|
|
(QZHT_NO). The default value is 0 (QZHT_NO). <p>Special values and their meanings
|
||
|
|
are as follows:</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.151515151515152%"><strong>1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The description is
|
||
|
|
to become the default rule set for this server.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The description
|
||
|
|
is not to become the default rule set.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_DEFAULT: The default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> Trigger handler descriptions, added or changed using the *DEFAULT
|
||
|
|
special value, reference the rule set designated as default at the time they
|
||
|
|
are added or changed.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Length of publishing rules</strong></dt>
|
||
|
|
<dd>The length of the information for the Publishing rules entry.<div class="note"><span class="notetitle">Note:</span> If
|
||
|
|
Offset to Publishing rules equals 0 (QZHT_NONE) or -1 (QZHT_DEFAULT), this
|
||
|
|
value must equal 0.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Offset to publishing rules</strong></dt>
|
||
|
|
<dd>The offset from the beginning of the request variable to the Publishing
|
||
|
|
rules data, in bytes. The value must be greater than 0, or equal to one of
|
||
|
|
the special values described below. <p>Special values and their meanings are
|
||
|
|
as follows:</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.151515151515152%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_NONE: Same as -1 (QZHT_DEFAULT).</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_DEFAULT: The default value is used for Publishing
|
||
|
|
rules.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Publishing rules</strong></dt>
|
||
|
|
<dd>A list of publishing rules associated with the triggered cache manager
|
||
|
|
server referenced by the new Rule Set and used by trigger handlers, at startup,
|
||
|
|
to direct how files are processed. Descriptions must be listed by name, where
|
||
|
|
each name is separated by one or more spaces, and padded with blanks if necessary.
|
||
|
|
The default value is null, indicating that an empty rule set is described.<div class="note"><span class="notetitle">Note:</span> If
|
||
|
|
the value is null, Offset to publishing rules must equal 0 (QZHT_NONE) or
|
||
|
|
-1 (QZHT_DEFAULT). See Offset to publishing rules for more details. An empty
|
||
|
|
rule set referenced by a trigger handler causes it to process all triggers
|
||
|
|
according to the default publishing rule. An escape message is sent if any
|
||
|
|
referenced description does not currently exist.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Rule set object name</strong></dt>
|
||
|
|
<dd>The name used by the new rule set (left justified and padded with blanks
|
||
|
|
if necessary).<div class="note"><span class="notetitle">Note:</span> Rule set names must be unique for each triggered cache
|
||
|
|
manager server. They are referenced, by name, from trigger handler descriptions
|
||
|
|
associated with the same server.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Server name</strong></dt>
|
||
|
|
<dd>The name used to identify the triggered cache manager server to which
|
||
|
|
the new description is associated (left justified and padded with blanks if
|
||
|
|
necessary).</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="error"><a name="error"><!-- --></a><h2 class="topictitle2">Error messages</h2>
|
||
|
|
<div><dl><dt class="dlterm"><strong>TCM7001 E</strong></dt>
|
||
|
|
<dd>User &1 is not authorized.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM7030 E</strong></dt>
|
||
|
|
<dd>Severe error occurred while addressing parameter list.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM7031 E</strong></dt>
|
||
|
|
<dd>Request variable format is not valid.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM7033 E</strong></dt>
|
||
|
|
<dd>Length of request variable is not valid for the specified format.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM703E E</strong></dt>
|
||
|
|
<dd>Error code parameter is not valid.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM70F0 E</strong></dt>
|
||
|
|
<dd>Unknown error occurred while processing request.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM7101 E</strong></dt>
|
||
|
|
<dd>User QTCM is not authorized to the configuration file for triggered cache
|
||
|
|
manager server &1.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM7190 E</strong></dt>
|
||
|
|
<dd>A configuration file for triggered cache manager server &1 was not
|
||
|
|
found.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM7293 E</strong></dt>
|
||
|
|
<dd>A &1 using the name&2 already exists for triggered cache manager
|
||
|
|
server &3.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM72C0 E</strong></dt>
|
||
|
|
<dd>Triggered cache manager &1 name is not valid.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM72C3 E</strong></dt>
|
||
|
|
<dd>Value passed to offset &1 is not valid.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM74C0 E</strong></dt>
|
||
|
|
<dd>Triggered cache manager server name is not valid.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|