ka.oxygen.tei-authorizer.1.2.0.source-code.config.xsd Maven / Gradle / Ivy
The newest version!
XML Schema for configuration of the TEI-Authorizer.
Configuration details for the TEI-Authorizer.
Optional default server configuration to be used. Can be overriden on a per-autoComplete basis.
Optional default namespace bindings to use globally when XPaths used in the configuration are evaluated.
An autoComplete defines the configuration for suggesting auto-complete values for a particular XPath context and optional dependency.
Optional namespace bindings to use when XPaths used in this autoComplete are evaluated. Overrides any default global namespace bindings with the same prefix.
An optional dependency for the context.
Optional configuration of steps to perform on the response.
Optional configuration for uploading a new suggestion to the server.
An XPath which indicates the element for which auto-complete is to be performed.
The name of an attribute on the context element which triggers auto-complete.
Optional. An attribute which we have a dependency on being non-empty
An optional default value to be used for the dependency if the attribute value is empty
A human-readable label for the dependent, this is used in the GUI.
The XPath (relative to the context) to use for the selection. e.g. text()
A human-readable label for the selection, this is used in the GUI.
Configuration for making a HTTP/HTTPS request to a server
Optional server configuration, overrides the default server configuration.
The URL to use for the request to the server. The following templates can be used in the URL:
$username The username from the server config (if present).
$baseUrl The baseUrl from the server config.
$selection The effective string value indicated by the evaluationg the selection XPath.
$dependent The effective string value of the dependent attribute.
The path to an XSLT transformation to execute. Relative file paths are assumed to be relative to the configuration file.
Configuration for making a HTTP/HTTPS upload to a server
Optional server configuration, overrides the default server configuration.
Optional fields that the user must complete. These will be sent as part of the upload request
Optional body to send as part of the upload request
The HTTP method to use for the upload, if unspecified, defaults to POST.
A field that the user will be prompted to complete
The name of the field which will be sent in the upload
A label to show in the GUI beside the input box, if not specifed then a capitalised form of name will be used.
Controls whether the input field is displayed as a multi-line input box in the GUI.
Whether the user is required to enter a value for the field.
An initial value or template to display in the field in the GUI before it receives focus.
A default value to use if the user does not complete the field.
A regular expression compatible with java.util.regex.Pattern which must match against the value entered by the user.
A transformation to apply to the body of the request before it is sent to the server
The type of the HTTP body to send in the upload, if unspecified, defaults to XML.
The type of encoding to apply to the HTTP body sent in the upload
Indicates whether the selection should also be sent as part of the body
Indicates whether the the dependent (if configured) should also be sent as part of the body
The URL to use for uploading the suggestion to the server. The following templates can be used in the URL:
$username The username from the server config (if present).
$baseUrl The baseUrl from the server config.
$suggestion The new suggestion entered by the user.
$description The description of the new suggestion entered by the user.
$selection The effective string value indicated by the evaluationg the selection XPath.
$dependent The effective string value of the dependent attribute (if present).
HTTP Methods that may be used for uploads.
Send an XML body in the upload
Send a JSON body in the upload
Send a Form data body in the upload
Apply GZip encoding to the upload body
Base configuration for making a HTTP/HTTPS request to a server.
The credentials for authenticating with a server.
The type of authentication to use when communicating with the server.
The TEI Authorizer will pre-emptively send credentials details using the HTTP Basic authentication scheme.
The TEI Authorizer will not pre-emptively send authentication credentials, instead it will send a request without credentials, the server should reply HTTP 401 asking for authentication using the Basic authentication scheme.
The TEI Authorizer will not pre-emptively send authentication credentials, instead it will send a request without credentials, the server should reply HTTP 401 asking for authentication using the Digest authentication scheme.
The TEI Authorizer will not pre-emptively send authentication credentials, instead it will send a request without credentials, the server should reply HTTP 401 asking for authentication and indicating that the TEI Authorizer use either the Basic or Digest authentication scheme.
A username used for authentication
A password used for authentication
The base URL of a URL understood by the server. Is combined with autoComplete 's url to form a complete URL. e.g. http://localhost:8080/srv/my-service
Namespace bindings to use when evaluating an XPath
The prefix used in the XPath
The namespace to refer to by the prefix
An absolute XPath that must start with a '/'
A relative XPath that must not start with a '/' or '//'
The QName of an attribute prefixed by '@'