xml/schema/metaproxy.rnc

   1 # Metaproxy XML config file schemas
   2 #
   3 #   Copyright (c) 2005-2008 Index Data.
   4 #
   5 #   See the LICENSE file for details
   6 #
   7 #
   8 # The RelaxNG Compact Syntax file 'metaproxy.rnc' is the master copy.
   9 #
  10 # The RelaxNG XML Syntax and XML Schema are generated using 'trang':
  11 # trang metaproxy.rnc metaproxy.rng
  12 # trang metaproxy.rnc metaproxy.xsd
  13 #
  14 # Config file validation is done using 'xmllint':
  15 # xmllint -/-relaxng metaproxy.rng ../../../etc/config1.xml
  16 # xmllint -/-schema metaproxy.xsd config-bytarget.xml
  17 #
  18 # For information on RelaxNG see http://relaxng.org
  19 # see also http://books.xmlschemata.org/relaxng/
  20
  21
  22 namespace mp = "http://indexdata.com/metaproxy"
  23
  24 start |= metaproxy
  25
  26 include "retrievalinfo.rnc"
  27
  28 any = (text | element * { attribute * { text }*, any })*
  29
  30 metaproxy =
  31   element mp:metaproxy {
  32     attribute version { "1.0" },
  33     element mp:dlpath { xsd:string }?,
  34     element mp:start {
  35             attribute route { xsd:NCName }
  36     },
  37     element mp:filters { filter+ }?,
  38     element mp:routes { route+ }
  39   }
  40
  41 route =
  42   element mp:route {
  43     attribute id { xsd:NCName },
  44     filter+
  45   }
  46
  47 filter =
  48   element mp:filter {
  49     filter_refid
  50     | filter_auth_simple
  51     | filter_backend_test
  52     | filter_bounce
  53     | filter_cql_rpn
  54     | filter_frontend_net
  55     | filter_http_file
  56     | filter_load_balance
  57     | filter_log
  58     | filter_multi
  59     | filter_query_rewrite
  60     | filter_record_transform
  61     | filter_session_shared
  62     | filter_sru_z3950
  63     | filter_virt_db
  64     | filter_z3950_client
  65     | filter_limit
  66 #    | filter_zeerex_explain
  67   }
  68
  69 filter_refid = attribute refid { xsd:NCName }
  70
  71 filter_auth_simple =
  72   attribute type { "auth_simple" },
  73   attribute id { xsd:NCName }?,
  74   attribute name { xsd:NCName }?,
  75   element mp:userRegister { xsd:string }?,
  76   element mp:targetRegister { xsd:string }?,
  77   element mp:discardUnauthorisedTargets { empty }?
  78
  79 filter_backend_test =
  80   attribute type { "backend_test" },
  81   attribute id { xsd:NCName }?,
  82   attribute name { xsd:NCName }?
  83
  84 filter_bounce =
  85   attribute type { "bounce" },
  86   attribute id { xsd:NCName }?,
  87   attribute name { xsd:NCName }?
  88
  89 filter_cql_rpn =
  90   attribute type { "cql_rpn" },
  91   attribute id { xsd:NCName }?,
  92   attribute name { xsd:NCName }?,
  93   element mp:conversion {
  94     attribute  file { xsd:string }
  95   }
  96
  97 filter_frontend_net =
  98   attribute type { "frontend_net" },
  99   attribute id { xsd:NCName }?,
 100   attribute name { xsd:NCName }?,
 101   element mp:threads { xsd:integer }?,
 102   element mp:port { xsd:string }+,
 103   element mp:timeout { xsd:integer }?,
 104   element mp:connect-max { xsd:integer }?
 105
 106 filter_http_file =
 107   attribute type { "http_file" },
 108   attribute id { xsd:NCName }?,
 109   attribute name { xsd:NCName }?,
 110   element mp:mimetypes { xsd:string },
 111   element mp:area {
 112     element mp:documentroot { xsd:string },
 113     element mp:prefix { xsd:string }
 114   }
 115
 116 filter_load_balance =
 117   attribute type { "load_balance" },
 118   attribute id { xsd:NCName }?,
 119   attribute name { xsd:NCName }?
 120
 121 filter_log =
 122   attribute type { "log" },
 123   attribute id { xsd:NCName }?,
 124   attribute name { xsd:NCName }?,
 125   element mp:message { xsd:string }?,
 126   element mp:time-format { xsd:string }?,
 127   element mp:filename { xsd:string }?,
 128   element mp:category {
 129     attribute user-access { xsd:boolean }?,
 130     attribute access { xsd:boolean }?,
 131     attribute init-options { xsd:boolean }?,
 132     attribute request-session { xsd:boolean }?,
 133     attribute response-session { xsd:boolean }?,
 134     attribute apdu { xsd:boolean }?,
 135     attribute request-apdu { xsd:boolean }?,
 136     attribute response-apdu { xsd:boolean }?
 137   }?
 138
 139 filter_multi =
 140   attribute type { "multi" },
 141   attribute id { xsd:NCName }?,
 142   attribute name { xsd:NCName }?,
 143   element mp:target {
 144     attribute route { xsd:string },
 145     xsd:string
 146   }*,
 147   element mp:hideunavailable { empty }?,
 148   element mp:mergetype { xsd:string }?
 149
 150 filter_query_rewrite =
 151   attribute type { "query_rewrite" },
 152   attribute id { xsd:NCName }?,
 153   attribute name { xsd:NCName }?,
 154   element mp:xslt {
 155         attribute stylesheet { xsd:string }
 156   }
 157
 158 filter_record_transform =
 159   attribute type { "record_transform" },
 160   attribute id { xsd:NCName }?,
 161   attribute name { xsd:NCName }?,
 162   retrievalinfo
 163
 164 filter_session_shared =
 165   attribute type { "session_shared" },
 166   attribute id { xsd:NCName }?,
 167   attribute name { xsd:NCName }?,
 168   element mp:resultset {
 169     attribute max { xsd:integer },
 170     attribute ttl { xsd:integer }
 171   }?,
 172   element mp:session {
 173     attribute ttl { xsd:integer }
 174   }?
 175
 176 filter_sru_z3950 =
 177   attribute type { "sru_z3950" },
 178   attribute id { xsd:NCName }?,
 179   attribute name { xsd:NCName }?,
 180   element mp:database {
 181      attribute name { xsd:NCName },
 182      any
 183   }+
 184
 185 filter_virt_db =
 186   attribute type { "virt_db" },
 187   attribute id { xsd:NCName }?,
 188   attribute name { xsd:NCName }?,
 189   element mp:virtual {
 190     attribute route { xsd:NCName }?,
 191     element mp:database { xsd:NCName },
 192     element mp:target { xsd:string }+
 193   }+
 194
 195 filter_z3950_client =
 196   attribute type { "z3950_client" },
 197   attribute id { xsd:NCName }?,
 198   attribute name { xsd:NCName }?,
 199   element mp:timeout { xsd:integer }?,
 200   element mp:default_target { xsd:string }?,
 201   element mp:force_target { xsd:string }?
 202
 203 filter_limit =
 204   attribute type { "limit" },
 205   element mp:limit {
 206     attribute bandwidth { xsd:integer }?,
 207     attribute pdu { xsd:integer }?,
 208     attribute search { xsd:integer }?,
 209     attribute retrieve { xsd:integer }?
 210   }?
 211
 212 #filter_zeerex_explain =
 213 #  attribute type { "zeerex_explain" },
 214 #  attribute id { xsd:NCName }?,
 215 #  attribute name { xsd:NCName }?,
 216 #  element mp:database {
 217 #     attribute name { xsd:NCName },
 218 #     any
 219 #  }+
 220
 221