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_zeerex_explain
  66   }
  67
  68 filter_refid = attribute refid { xsd:NCName }
  69
  70 filter_auth_simple =
  71   attribute type { "auth_simple" },
  72   attribute id { xsd:NCName }?,
  73   attribute name { xsd:NCName }?,
  74   element mp:userRegister { xsd:string }?,
  75   element mp:targetRegister { xsd:string }?,
  76   element mp:discardUnauthorisedTargets { empty }?
  77
  78 filter_backend_test =
  79   attribute type { "backend_test" },
  80   attribute id { xsd:NCName }?,
  81   attribute name { xsd:NCName }?
  82
  83 filter_bounce =
  84   attribute type { "bounce" },
  85   attribute id { xsd:NCName }?,
  86   attribute name { xsd:NCName }?
  87
  88 filter_cql_rpn =
  89   attribute type { "cql_rpn" },
  90   attribute id { xsd:NCName }?,
  91   attribute name { xsd:NCName }?,
  92   element mp:conversion {
  93     attribute  file { xsd:string }
  94   }
  95
  96 filter_frontend_net =
  97   attribute type { "frontend_net" },
  98   attribute id { xsd:NCName }?,
  99   attribute name { xsd:NCName }?,
 100   element mp:threads { xsd:integer }?,
 101   element mp:port { xsd:string }+,
 102   element mp:timeout { xsd:integer }?
 103
 104 filter_http_file =
 105   attribute type { "http_file" },
 106   attribute id { xsd:NCName }?,
 107   attribute name { xsd:NCName }?,
 108   element mp:mimetypes { xsd:string },
 109   element mp:area {
 110     element mp:documentroot { xsd:string },
 111     element mp:prefix { xsd:string }
 112   }
 113
 114 filter_load_balance =
 115   attribute type { "load_balance" },
 116   attribute id { xsd:NCName }?,
 117   attribute name { xsd:NCName }?
 118
 119 filter_log =
 120   attribute type { "log" },
 121   attribute id { xsd:NCName }?,
 122   attribute name { xsd:NCName }?,
 123   element mp:message { xsd:string }?,
 124   element mp:time-format { xsd:string }?,
 125   element mp:filename { xsd:string }?,
 126   element mp:category {
 127     attribute user-access { xsd:boolean }?,
 128     attribute access { xsd:boolean }?,
 129     attribute init-options { xsd:boolean }?,
 130     attribute request-session { xsd:boolean }?,
 131     attribute response-session { xsd:boolean }?,
 132     attribute apdu { xsd:boolean }?,
 133     attribute request-apdu { xsd:boolean }?,
 134     attribute response-apdu { xsd:boolean }?
 135   }?
 136
 137 filter_multi =
 138   attribute type { "multi" },
 139   attribute id { xsd:NCName }?,
 140   attribute name { xsd:NCName }?,
 141   element mp:target {
 142     attribute route { xsd:string },
 143     xsd:string
 144   }*,
 145   element mp:hideunavailable { empty }?,
 146   element mp:mergetype { xsd:string }?
 147
 148 filter_query_rewrite =
 149   attribute type { "query_rewrite" },
 150   attribute id { xsd:NCName }?,
 151   attribute name { xsd:NCName }?,
 152   element mp:xslt {
 153         attribute stylesheet { xsd:string }
 154   }
 155
 156 filter_record_transform =
 157   attribute type { "record_transform" },
 158   attribute id { xsd:NCName }?,
 159   attribute name { xsd:NCName }?,
 160   retrievalinfo
 161
 162 filter_session_shared =
 163   attribute type { "session_shared" },
 164   attribute id { xsd:NCName }?,
 165   attribute name { xsd:NCName }?,
 166   element mp:resultset {
 167     attribute max { xsd:integer },
 168     attribute ttl { xsd:integer }
 169   }?,
 170   element mp:session {
 171     attribute ttl { xsd:integer }
 172   }?
 173
 174 filter_sru_z3950 =
 175   attribute type { "sru_z3950" },
 176   attribute id { xsd:NCName }?,
 177   attribute name { xsd:NCName }?,
 178   element mp:database {
 179      attribute name { xsd:NCName },
 180      any
 181   }+
 182
 183 filter_virt_db =
 184   attribute type { "virt_db" },
 185   attribute id { xsd:NCName }?,
 186   attribute name { xsd:NCName }?,
 187   element mp:virtual {
 188     attribute route { xsd:NCName }?,
 189     element mp:database { xsd:NCName },
 190     element mp:target { xsd:string }+
 191   }+
 192
 193 filter_z3950_client =
 194   attribute type { "z3950_client" },
 195   attribute id { xsd:NCName }?,
 196   attribute name { xsd:NCName }?,
 197   element mp:timeout { xsd:integer }?,
 198   element mp:default_target { xsd:string }?,
 199   element mp:force_target { xsd:string }?
 200
 201 #filter_zeerex_explain =
 202 #  attribute type { "zeerex_explain" },
 203 #  attribute id { xsd:NCName }?,
 204 #  attribute name { xsd:NCName }?,
 205 #  element mp:database {
 206 #     attribute name { xsd:NCName },
 207 #     any
 208 #  }+
 209
 210