vendor/zasync/1.1

changeset 44:584f189d4f82 1.1-nux

Added schema file for Zope2.8.x from https://svn.nuxeo.org/pub/vendor/zasync/branches/z29-nux/client/zasync
author rspivak
date Thu, 14 Feb 2008 21:48:49 +0000
parents 91843245a3c1
children 9faf38e6b4c9
files client/zasync/schema28.xml
diffstat 1 files changed, 324 insertions(+), 0 deletions(-) [+]
line diff
     1.1 new file mode 100644
     1.2 --- /dev/null
     1.3 +++ b/client/zasync/schema28.xml
     1.4 @@ -0,0 +1,324 @@
     1.5 +<schema handler="root_handler" prefix="Zope2.Startup.datatypes" 
     1.6 +        datatype="zasync.config.root_section">
     1.7 +  <description>
     1.8 +    ZAsync configuration schema.
     1.9 +    
    1.10 +    This schema describes the configuration options available to a site 
    1.11 +    administrator via the zasync.conf configuration file.
    1.12 +  </description>
    1.13 +  <!-- for Zope 2.8 -->
    1.14 +  <import package="ZConfig.components.logger" file="handlers.xml"/>
    1.15 +  <import package="ZConfig.components.logger" file="eventlog.xml"/>
    1.16 +  <!-- end for Zope 2.8 -->
    1.17 +  <import package="ZODB"/>
    1.18 +  <import package="tempstorage" />
    1.19 +
    1.20 +  <sectiontype name="plugin" datatype="zasync.config.plugin">
    1.21 +    <description>
    1.22 +    Register zasync plugins.
    1.23 +    </description>
    1.24 +    
    1.25 +    <key name="handler" required="yes" 
    1.26 +         datatype="zasync.config.DottedNameFunctionConversion">
    1.27 +      <description>
    1.28 +      The handler for the plugin.  The arguments to this callable
    1.29 +      are the signature that Zope calls should match.  If a description
    1.30 +      is not provided as a key to this configuration, the handler's
    1.31 +      docstring will be used, if any, as the description.
    1.32 +      </description>
    1.33 +    </key>
    1.34 +    
    1.35 +    <key name="timeout" datatype="time-interval">
    1.36 +      <description>
    1.37 +      The maximum timeout that this plugin allows/
    1.38 +      </description>
    1.39 +    </key>
    1.40 +    
    1.41 +    <key name="description" datatype="string">
    1.42 +      <description>
    1.43 +      The description of this plugin.  If not provided, handler's docstring
    1.44 +      is used, if any.
    1.45 +      </description>
    1.46 +    </key>
    1.47 +  
    1.48 +    <key name="retry" datatype="boolean" default="yes">
    1.49 +      <description>
    1.50 +      Whether the async call should be retried if zasync restarts while the
    1.51 +      call is accepted (in process).
    1.52 +      </description>
    1.53 +    </key>
    1.54 +  
    1.55 +    <key name="zope-aware" datatype="boolean" default="no">
    1.56 +      <description>
    1.57 +      Whether the async call needs to know about the path to the tool and the 
    1.58 +      zope deferred identifier.  If it does, any arguments from manager calls
    1.59 +      are prepended with a tuple (a single argument) of 
    1.60 +      (tool path, zope deferred id).
    1.61 +      </description>
    1.62 +    </key>
    1.63 +  </sectiontype>
    1.64 +
    1.65 +  <!-- for Zope 2.8 -->
    1.66 +  <sectiontype name="logger" datatype="zasync.config.LoggerFactory">
    1.67 +    <description>
    1.68 +      This "logger" type only applies to access and request ("trace")
    1.69 +      logging; event logging is handled by the "logging" package in
    1.70 +      the Python standard library.  The loghandler type used here is
    1.71 +      provided by the "ZConfig.components.logger" package.
    1.72 +    </description>
    1.73 +    <key name="level"
    1.74 +         datatype="ZConfig.components.logger.datatypes.logging_level"
    1.75 +         default="info"/>
    1.76 +    <key name="propagate" datatype="boolean" default="no"/>
    1.77 +    <multisection name="*"
    1.78 +                  type="ZConfig.logger.handler"
    1.79 +                  attribute="handlers"/>
    1.80 +  </sectiontype>
    1.81 +  <!-- end for Zope 2.8 -->
    1.82 +
    1.83 +  <sectiontype name="environment"
    1.84 +               datatype=".cgi_environment"
    1.85 +               keytype="identifier">
    1.86 +    <description>
    1.87 +     A section which allows you to define simple key-value pairs which
    1.88 +     will be used as environment variable settings during startup.  
    1.89 +    </description>
    1.90 +    <key name="+" attribute="environ">
    1.91 +      <description>
    1.92 +        Use any key/value pair, e.g. 'MY_PRODUCT_ENVVAR foo_bar'
    1.93 +      </description>
    1.94 +    </key>
    1.95 +  </sectiontype>
    1.96 +
    1.97 +  <sectiontype name="zodb_db" datatype=".ZopeDatabase"
    1.98 +               implements="ZODB.database" extends="zodb">
    1.99 +
   1.100 +    <description>
   1.101 +      We need to specialize the database configuration section for Zope
   1.102 +      only by including a (required) mount-point argument, which
   1.103 +      is a string.  A Zope ZODB database can have multiple mount points,
   1.104 +      so this is a multikey.
   1.105 +    </description>
   1.106 +    <multikey name="mount-point" required="yes" attribute="mount_points"
   1.107 +              datatype=".mount_point">
   1.108 +      <description>
   1.109 +       The mount point is the slash-separated path to which this database
   1.110 +       will be mounted within the Zope application server.
   1.111 +      </description>
   1.112 +    </multikey>
   1.113 +
   1.114 +    <key name="connection-class" datatype=".importable_name">
   1.115 +      <description>
   1.116 +       Change the connection class a database uses on a per-database basis to
   1.117 +       support different connection policies.  Use a Python dotted-path
   1.118 +       name to specify the connection class.
   1.119 +      </description>
   1.120 +    </key>
   1.121 +
   1.122 +   <key name="class-factory" datatype=".importable_name"
   1.123 +        default="DBTab.ClassFactories.autoClassFactory">
   1.124 +      <description>
   1.125 +       Change the class factory function a database uses on a
   1.126 +       per-database basis to support different class factory policy.
   1.127 +       Use a Python dotted-path name to specify the class factory function.
   1.128 +      </description>
   1.129 +    </key>
   1.130 +
   1.131 +    <key name="container-class" datatype=".python_dotted_path">
   1.132 +      <description>
   1.133 +       Change the contiainer class a (mounted) database uses on a
   1.134 +       per-database basis to support a different container than a plain
   1.135 +       Folder. Use a Python dotted-path name to specify the container class.
   1.136 +      </description>
   1.137 +    </key>
   1.138 +
   1.139 +  </sectiontype>
   1.140 +
   1.141 +  <!-- end sectiontype defs, begin section and key defs -->
   1.142 +
   1.143 +  <section type="environment" attribute="environment" name="*">
   1.144 +    <description>
   1.145 +     A section which allows a user to define arbitrary key-value pairs for
   1.146 +     use as environment variables during Zope's run cycle.  It
   1.147 +     is not recommended to set system-related environment variables such as
   1.148 +     PYTHONPATH within this section.
   1.149 +    </description>
   1.150 +  </section>
   1.151 +
   1.152 +  <key name="instancehome" datatype="existing-directory" required="yes">
   1.153 +    <description>
   1.154 +    The path to the data files, local product files, import directory,
   1.155 +    and Extensions directory used by Zope.
   1.156 +    </description>
   1.157 +  </key>
   1.158 +
   1.159 +  <key name="clienthome" datatype="existing-directory">
   1.160 +    <description>
   1.161 +      The directory used to store the default filestorage file used to
   1.162 +      back the ZODB database, as well as other files used by the
   1.163 +      Zope applications server during runtime.
   1.164 +    </description>
   1.165 +    <metadefault>$instancehome/var</metadefault>
   1.166 +  </key>
   1.167 +  
   1.168 +  <multikey name="products" datatype="existing-directory">
   1.169 +    <description>
   1.170 +    Name of a directory that contains additional Product packages.  This
   1.171 +    directive may be used as many times as needed to add additional
   1.172 +    collections of products.  Each directory identified will be
   1.173 +    added to the __path__ of the Products package.  All Products are
   1.174 +    initialized in ascending alphabetical order by product name.  If
   1.175 +    two products with the same name exist in two Products directories,
   1.176 +    the order in which the packages appear here defines the load
   1.177 +    order.  The master Products directory exists in Zope's software home,
   1.178 +    and cannot be removed from the products path (and should not be added
   1.179 +    to it here).
   1.180 +    </description>
   1.181 +  </multikey>
   1.182 +  
   1.183 +  <multikey name="path" datatype="existing-directory">
   1.184 +    <description>
   1.185 +    Name of a directory which should be inserted into the
   1.186 +    the beginning of Python's module search path.  This directive
   1.187 +    may be specified as many times as needed to insert additional
   1.188 +    directories.  The set of directories specified is inserted into the
   1.189 +    beginning of the module search path in the order which they are specified
   1.190 +    here.  Note that the processing of this directive may happen too late
   1.191 +    under some circumstances; it is recommended that you use the PYTHONPATH
   1.192 +    environment variable if using this directive doesn't work for you.
   1.193 +    </description>
   1.194 +  </multikey>
   1.195 +
   1.196 +  <key name="security-policy-implementation"
   1.197 +       datatype=".security_policy_implementation"
   1.198 +       default="C">
   1.199 +     <description>
   1.200 +     The default Zope "security policy" implementation is written in C.
   1.201 +     Set this key to "PYTHON" to use the Python implementation
   1.202 +     (useful for debugging purposes); set it to "C" to use the C
   1.203 +     implementation.
   1.204 +     </description>
   1.205 +     <metadefault>C</metadefault>
   1.206 +  </key>
   1.207 +
   1.208 +  <key name="skip-authentication-checking" datatype="boolean"
   1.209 +       default="off">
   1.210 +     <description>
   1.211 +     Set this directive to 'on' to cause Zope to prevent Zope from
   1.212 +     attempting to authenticate users during normal operation.
   1.213 +     Potentially dangerous from a security perspective.  Only works if
   1.214 +     security-policy-implementation is set to 'C'.
   1.215 +     </description>
   1.216 +     <metadefault>off</metadefault>
   1.217 +  </key>
   1.218 +
   1.219 +  <key name="skip-ownership-checking" datatype="boolean"
   1.220 +       default="off">
   1.221 +     <description>
   1.222 +     Set this directive to 'on' to cause Zope to ignore ownership checking
   1.223 +     when attempting to execute "through the web" code. By default, this
   1.224 +     directive is off in order to prevent 'trojan horse' security problems
   1.225 +     whereby a user with less privilege can cause a user with more
   1.226 +     privilege to execute code which the less privileged user has written.
   1.227 +     </description>
   1.228 +     <metadefault>off</metadefault>
   1.229 +  </key>
   1.230 +
   1.231 +  <!-- for 2.8 -->
   1.232 +  <key name="verbose-security" datatype="boolean"
   1.233 +       default="off">
   1.234 +     <description>
   1.235 +     Set this directive to 'on' to enable verbose security exceptions.
   1.236 +     This can help you track down the reason for Unauthorized exceptions,
   1.237 +     but it is not suitable for public sites because it may reveal
   1.238 +     unnecessary information about the structure of your site.  Only
   1.239 +     works if security-policy-implementation is set to 'PYTHON'.
   1.240 +     </description>
   1.241 +     <metadefault>off</metadefault>
   1.242 +  </key>
   1.243 +  <!-- end for 2.8 -->
   1.244 +
   1.245 +  <key name="verbose-traceback" datatype="boolean" default="off">
   1.246 +     <description>
   1.247 +     Set this directive to 'on' to cause zasync to produce very verbose
   1.248 +     tracebacks, including the locals and globals for every frame.
   1.249 +     </description>
   1.250 +     <metadefault>off</metadefault>
   1.251 +  </key>
   1.252 +
   1.253 +  <multisection type="ZODB.Database" name="+" attribute="databases">
   1.254 +    <description>
   1.255 +       Zope ZODB databases must have a name, and they are required to be
   1.256 +       referenced via the "zodb_db" database type because it is
   1.257 +       the only kind of database definition that implements
   1.258 +       the required mount-point argument.  There is another
   1.259 +       database sectiontype named "zodb", but it cannot be used
   1.260 +       in the context of a proper Zope configuration (due to
   1.261 +       lack of a mount-point).
   1.262 +    </description>
   1.263 +  </multisection>
   1.264 +
   1.265 +  <key name="target" datatype="string" default="/asynchronous_call_manager">
   1.266 +    <description>
   1.267 +    identify the path to the object that implements the asynchronous call 
   1.268 +    manager interface
   1.269 +    </description>
   1.270 +  </key>
   1.271 +  
   1.272 +  <key name="max-conflict-resolution-attempts" datatype="integer" default="5">
   1.273 +    <description>
   1.274 +    The number of times a transaction with a ConflictError should be retried
   1.275 +    </description>
   1.276 +  </key>
   1.277 +  
   1.278 +  <key name="initial-retry-delay" datatype="time-interval" default="5">
   1.279 +    <description>
   1.280 +    The initial delay in seconds between attempts to resolve an error in 
   1.281 +    finding the ZEO server or the target
   1.282 +    </description>
   1.283 +  </key>
   1.284 +  
   1.285 +  <key name="retry-exponential-backoff" datatype="float" default="1.1">
   1.286 +    <description>
   1.287 +    An exponential backoff of the retry delay.  Set to 1 for no exponential
   1.288 +    increase.  Values less than one are not allowed.
   1.289 +    </description>
   1.290 +  </key>
   1.291 +  
   1.292 +  <key name="max-total-retry" datatype="time-interval" default="1h">
   1.293 +    <description>
   1.294 +    The maximum total retry time since a failure in reaching the ZEO server
   1.295 +    or the target before zasync gives a up.  A value of 0 indicates that 
   1.296 +    zasync should never give up.  Value is in seconds.
   1.297 +    </description>
   1.298 +  </key>
   1.299 +  
   1.300 +  <multisection type="plugin" name="*" attribute="plugins">
   1.301 +    <description>
   1.302 +    Register zasync plugins.
   1.303 +    </description>
   1.304 +  </multisection>
   1.305 +
   1.306 +  <section type="eventlog" name="*" attribute="eventlog">
   1.307 +    <description>
   1.308 +      Describes the logging performed by Zope in the course of zasync
   1.309 +      calls.
   1.310 +    </description>
   1.311 +  </section>
   1.312 +
   1.313 +  <section type="logger" name="zasync">
   1.314 +     <description>
   1.315 +      Describes the logging performed to capture the zasync log messages
   1.316 +    </description>
   1.317 +  </section>
   1.318 +
   1.319 +  <section type="logger" name="plugins" attribute="zasync_plugins">
   1.320 +     <description>
   1.321 +      Describes the logging performed to capture the zasync plugins log,
   1.322 +      which collects log messages from the plugins, if they are log to the
   1.323 +      'plugin' log.  If messages are propagated, they are propagated
   1.324 +      to the zasync log.
   1.325 +    </description>
   1.326 +  </section>
   1.327 +
   1.328 +</schema>