From 9960226abe1700d3dc87e68529755e5cff09f0d9 Mon Sep 17 00:00:00 2001 From: Marc Cromme Date: Thu, 18 Jan 2007 11:32:42 +0000 Subject: [PATCH] added cql_rpn module docs added section on XInclude updated all module headers to be more conformant in apprearence included common XML entities in all XMl files --- doc/Makefile.am | 4 ++- doc/auth_simple.xml | 6 ++-- doc/backend_test.xml | 6 ++-- doc/book.xml | 53 ++++++++++++++++++++++------ doc/bounce.xml | 6 ++-- doc/cql_rpn.xml | 88 ++++++++++++++++++++++++++++++++++++++++++++++ doc/frontend_net.xml | 7 ++-- doc/http_file.xml | 6 ++-- doc/load_balance.xml | 7 ++-- doc/log.xml | 6 ++-- doc/metaproxy.xml | 4 ++- doc/multi.xml | 6 ++-- doc/query_rewrite.xml | 6 ++-- doc/record_transform.xml | 6 ++-- doc/session_shared.xml | 18 +++++++--- doc/sru_z3950.xml | 4 +-- doc/template.xml | 6 ++-- doc/virt_db.xml | 6 ++-- doc/z3950_client.xml | 6 ++-- doc/zeerex_explain.xml | 9 +++-- 20 files changed, 213 insertions(+), 47 deletions(-) create mode 100644 doc/cql_rpn.xml diff --git a/doc/Makefile.am b/doc/Makefile.am index 10419dc..668aec3 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -## $Id: Makefile.am,v 1.35 2007-01-18 09:20:52 adam Exp $ +## $Id: Makefile.am,v 1.36 2007-01-18 11:32:42 marc Exp $ docdir=$(datadir)/doc/@PACKAGE@ SUBDIRS = common @@ -13,6 +13,7 @@ XMLMAN = metaproxy.xml \ auth_simple.xml \ backend_test.xml \ bounce.xml \ + cql_rpn.xml \ frontend_net.xml \ http_file.xml \ load_balance.xml \ @@ -31,6 +32,7 @@ MANFILES = metaproxy.1 \ auth_simple.3mp \ backend_test.3mp \ bounce.3mp \ + cql_rpn.3mp \ frontend_net.3mp \ http_file.3mp \ load_balance.3mp \ diff --git a/doc/auth_simple.xml b/doc/auth_simple.xml index b9aecef..6e1b4d5 100644 --- a/doc/auth_simple.xml +++ b/doc/auth_simple.xml @@ -1,8 +1,10 @@ + + %common; ]> - + auth_simple @@ -12,7 +14,7 @@ auth_simple - simple authentication and authorization. + Metaproxy Simple Authentication And Authorization Module DESCRIPTION diff --git a/doc/backend_test.xml b/doc/backend_test.xml index 496b74f..55ba3e3 100644 --- a/doc/backend_test.xml +++ b/doc/backend_test.xml @@ -1,8 +1,10 @@ + + %common; ]> - + backend_test @@ -12,7 +14,7 @@ backend_test - backend Z39.50 server for testing. + Metaproxy Backend Test Z39.50 Server Module DESCRIPTION diff --git a/doc/book.xml b/doc/book.xml index d7e7383..9b8f118 100644 --- a/doc/book.xml +++ b/doc/book.xml @@ -18,7 +18,7 @@ --> ]> - + Metaproxy - User's Guide and Reference @@ -741,8 +741,8 @@ Figure out what additional information we need in: sets Z39.50 packages to Z_Close, and HTTP_Request packages to HTTP_Response err code 400 packages, and adds a suitable bounce message. - The bounce filter is usually added at end of each filter chain - config.xml to prevent infinite hanging of for example HTTP + The bounce filter is usually added at end of each filter chain route + to prevent infinite hanging of for example HTTP requests packages when only the Z39.50 client partial sink filter is found in the route. @@ -750,6 +750,19 @@ Figure out what additional information we need in:
+ <literal>cql_rpn</literal> + (mp::filter::CQLtoRPN) + + A query language transforming filter which catches Z39.50 + searchRequest + packages containing CQL queries, transforms + those to RPN queries, + and sends the searchRequests on to the next + filters. It is among other things useful in a SRU context. + +
+ +
<literal>frontend_net</literal> (mp::filter::FrontendNet) @@ -764,7 +777,8 @@ Figure out what additional information we need in: <literal>http_file</literal> (mp::filter::HttpFile) - A partial sink which swallows only HTTP_Request packages, and + A partial sink which swallows only + HTTP_Request packages, and returns the contents of files from the local filesystem in response to HTTP requests. It lets Z39.50 packages and all other forthcoming package types @@ -821,7 +835,9 @@ Figure out what additional information we need in: <literal>query_rewrite</literal> (mp::filter::QueryRewrite) - Rewrites Z39.50 Type-1 and Type-101 (``RPN'') queries by a + Rewrites Z39.50 Type-1 + and Type-101 (``RPN'') + queries by a three-step process: the query is transliterated from Z39.50 packet structures into an XML representation; that XML representation is transformed by an XSLT stylesheet; and the @@ -851,10 +867,8 @@ Figure out what additional information we need in: This filter implements global sharing of result sets (i.e. between threads and therefore between - clients), yielding performance improvements especially when - incoming requests are from a stateless environment such as a - web-server, in which the client process representing a session - might be any one of many. + clients), yielding performance improvements by clever resource + pooling.
@@ -1123,7 +1137,26 @@ Figure out what additional information we need in: which returns the response to the client. -
+ +
+ Config file modularity + + Metaproxy XML configuration snippets can be reused by other + filters using the XInclude standard, as seen in + the /etc/config-sru-to-z3950.xml example SRU + configuration. + + + + + +]]> + +
+ +
Config file syntax checking The distribution contains RelaxNG Compact and XML syntax checking diff --git a/doc/bounce.xml b/doc/bounce.xml index bdeeab1..a23a3dd 100644 --- a/doc/bounce.xml +++ b/doc/bounce.xml @@ -1,8 +1,10 @@ + + %common; ]> - + bounce @@ -12,7 +14,7 @@ bounce - bouncing package sink for all kind of metaproxy packages + Metaproxy Bouncing Package Sink Module for all kind of metaproxy packages DESCRIPTION diff --git a/doc/cql_rpn.xml b/doc/cql_rpn.xml new file mode 100644 index 0000000..24f2f5f --- /dev/null +++ b/doc/cql_rpn.xml @@ -0,0 +1,88 @@ + + + %common; +]> + + + + query_rewrite + 3mp + Metaproxy Module + + + + cql_rpn + Metaproxy CQL to RPN Query Language Transforming Module + + + DESCRIPTION + + A query language transforming filter which catches Z39.50 + searchRequest + packages containing CQL queries, transforms + those to RPN queries, + and sends the searchRequests on to the next + filters. + + + The filter takes only one configuration parameter, namely the path + of the standard YAZ + CQL-to-CQL configuration + file. See the YAZ manual for + configuration file syntax and details. + + + A common and wellknown challenge is that the ZeeRex SRU + Explain config file used in the sru_z3950 + filter and the CQL translation configuration + file used in this filter must be kept in syncronization. + Syncronization can be eased by using the provided XSLT stylesheet, + xml/xslt/explain2cqlpqftxt.xsl, which transforms + from ZeeReX Explain to the later. The example configurations have + been created by running: + + xsltproc xml/xslt/explain2cqlpqftxt.xsl etc/explain.xml > etc/cql2pqf.txt + + + + + EXAMPLES + + A typical configuration looks like this: + + + + ]]> + + + + + SEE ALSO + + + metaproxy + 1 + + + + + ©right; + + + diff --git a/doc/frontend_net.xml b/doc/frontend_net.xml index 206367f..40c6d4a 100644 --- a/doc/frontend_net.xml +++ b/doc/frontend_net.xml @@ -1,8 +1,10 @@ + + %common; ]> - + frontend_net @@ -12,7 +14,8 @@ frontend_net - network server + Metaproxy Network Server module that accepts Z39.50 and + HTTP requests DESCRIPTION diff --git a/doc/http_file.xml b/doc/http_file.xml index 11047d8..ae066de 100644 --- a/doc/http_file.xml +++ b/doc/http_file.xml @@ -1,8 +1,10 @@ + + %common; ]> - + http_file @@ -12,7 +14,7 @@ http_file - network server + Metaproxy HTTP File Server Module DESCRIPTION diff --git a/doc/load_balance.xml b/doc/load_balance.xml index fb5b25a..d5a7984 100644 --- a/doc/load_balance.xml +++ b/doc/load_balance.xml @@ -1,8 +1,10 @@ + + %common; ]> - + load_balance @@ -12,7 +14,8 @@ load_balance - balances load among Z39.50 targets + Metaproxy Module balancing load among multiple identical + Z39.50 targets DESCRIPTION diff --git a/doc/log.xml b/doc/log.xml index c6e9907..69a8c8c 100644 --- a/doc/log.xml +++ b/doc/log.xml @@ -1,8 +1,10 @@ + + %common; ]> - + log @@ -12,7 +14,7 @@ log - logs packages + Metaproxy Package Logging Module DESCRIPTION diff --git a/doc/metaproxy.xml b/doc/metaproxy.xml index 22268ab..c205ac7 100644 --- a/doc/metaproxy.xml +++ b/doc/metaproxy.xml @@ -1,8 +1,10 @@ + + %common; ]> - + metaproxy diff --git a/doc/multi.xml b/doc/multi.xml index dab3f27..3d83e0e 100644 --- a/doc/multi.xml +++ b/doc/multi.xml @@ -1,8 +1,10 @@ + + %common; ]> - + multi @@ -12,7 +14,7 @@ multi - package multiplexer + Metaproxy Package Multiplexer Module DESCRIPTION diff --git a/doc/query_rewrite.xml b/doc/query_rewrite.xml index be45870..e1694fd 100644 --- a/doc/query_rewrite.xml +++ b/doc/query_rewrite.xml @@ -1,8 +1,10 @@ + + %common; ]> - + query_rewrite @@ -12,7 +14,7 @@ query_rewrite - network server + Metaproxy RPN Query Rewrite Module DESCRIPTION diff --git a/doc/record_transform.xml b/doc/record_transform.xml index fec01f4..c414ef4 100644 --- a/doc/record_transform.xml +++ b/doc/record_transform.xml @@ -1,8 +1,10 @@ + + %common; ]> - + record_transform @@ -12,7 +14,7 @@ record_transform - Z3950 present package record transformation + Metaproxy Module that performs Z39.50 presentResponse record transformations DESCRIPTION diff --git a/doc/session_shared.xml b/doc/session_shared.xml index 480ad35..2c66fd4 100644 --- a/doc/session_shared.xml +++ b/doc/session_shared.xml @@ -1,8 +1,10 @@ + + %common; ]> - + session_shared @@ -12,13 +14,19 @@ session_shared - Module for sharing result-sets etc. between threads + Metaproxy Module for sharing system ressorces between + threads DESCRIPTION - This module allows many Z39.50 frontend sessions to share - a number of backend sessions. The purpose is this filter is to: + This filter implements global sharing of + result sets (i.e. between threads and therefore between + clients), yielding performance improvements especially when + incoming requests are from a stateless environment such as a + web-server, in which the client process representing a session + might be any one of many. + It performs the following actions: @@ -27,7 +35,7 @@ - Reduce number of Initializations with backend servers. + Reduce the number of initializations with backend servers. diff --git a/doc/sru_z3950.xml b/doc/sru_z3950.xml index 37d7e60..2e7787b 100644 --- a/doc/sru_z3950.xml +++ b/doc/sru_z3950.xml @@ -4,7 +4,7 @@ %common; ]> - + sru_z3950 @@ -14,7 +14,7 @@ sru_z3950 - transforming SRU web service requests to Z3950 Metaproxy packages + Metaproxy Module transforming SRU web service requests to Z3950 Metaproxy packages DESCRIPTION diff --git a/doc/template.xml b/doc/template.xml index e301500..81f87cb 100644 --- a/doc/template.xml +++ b/doc/template.xml @@ -1,8 +1,10 @@ + + %common; ]> - + template @@ -12,7 +14,7 @@ template - Template module that does nothing + Metaproxy Template Module That Does Nothing DESCRIPTION diff --git a/doc/virt_db.xml b/doc/virt_db.xml index 26ea673..120b7b1 100644 --- a/doc/virt_db.xml +++ b/doc/virt_db.xml @@ -1,8 +1,10 @@ + + %common; ]> - + virt_db @@ -12,7 +14,7 @@ virt_db - virtual database(s) + Metaproxy Virtual Databases Module DESCRIPTION diff --git a/doc/z3950_client.xml b/doc/z3950_client.xml index a33e5fc..79d8bd0 100644 --- a/doc/z3950_client.xml +++ b/doc/z3950_client.xml @@ -1,8 +1,10 @@ + + %common; ]> - + z3950_client @@ -12,7 +14,7 @@ z3950_client - backend module Z39.50 client + Metaproxy Z39.50 Backend Client Module DESCRIPTION diff --git a/doc/zeerex_explain.xml b/doc/zeerex_explain.xml index b4b3552..4170d6c 100644 --- a/doc/zeerex_explain.xml +++ b/doc/zeerex_explain.xml @@ -4,7 +4,7 @@ %common; ]> - + zeerex_explain @@ -14,7 +14,7 @@ zeerex_explain - answering Z39.50 ZeeReX explain requests + Metaproxy Z39.50 ZeeReX Explain Module DESCRIPTION @@ -35,6 +35,11 @@ SRU Explain pages for more information. + + + This filter is not yet completed. + + EXAMPLES -- 1.7.10.4