MarkLogic 10 Product Documentation
WebDAV Server Configuration Help
A
WebDAV Server
allows access to a database via a WebDAV client. A WebDAV server
also allows HTTP access to the server, but you cannot execute
XQuery code against it.
-
server name
specifies the name of the HTTP Server.
-
root
specifies the root directory for the web applications search path.
-
port specifes
the socket port for the HTTP server.
-
database
specifies the database to which this App Server connects for query
execution.
-
last login
specifies the name of the database in which this HTTP server stores
users' last login information.
-
display last
login specifies if the
xdmp:display-last-login
API should return true or
false in the display-last-login
element.
-
backlog
specifies the maximum number of pending connections allowed on the
HTTP server socket.
-
threads
specifies the maximum number of App Server threads on each host in the group;
the server may also additionally limit threads.
-
request
timeout specifies the maximum number of seconds before a
socket receives a timeout for the first request.
-
keep alive
timeout
specifies the maximum number of seconds before a socket receives a
timeout for subsequent requests over the same connection.
-
session
timeout specifies the maximum number of seconds before a session
times out.
-
max time limit
specifies the upper bound for any request's time limit.
No request may set its time limit (for example with
xdmp:set-request-time-limit
) higher than this number.
The time limit, in turn, is the maximum number of seconds allowed for
servicing a query request. The App Server gives up on queries which
take longer, and returns an error.
-
default
time limit
specifies the default value for any request's time limit,
when otherwise unspecified.
A request can change its time limit using
xdmp:set-request-time-limit
.
The time limit is the default number of seconds allowed for
servicing a query request.
-
max inference size
specifies the upper bound for any request's inference size.
No request may set its inference size higher than this number.
The inference size, in turn, is the maximum amount of memory in megabytes
allowed for sem:store performing inference. The App Server gives up on queries which
exceed the memory limit, and returns an error.
-
default inference size
specifies the default value for any request's inference size.
-
static expires
adds an "expires" HTTP header for static content to expire after this many seconds.
-
pre-commit trigger
limit specifies the maximum number of pre-commit triggers
a single statement against this App Server can invoke.
-
pre-commit trigger
depth specifies the maximum depth (how many triggers can
cause other triggers to fire, which in turn cause others to
fire, and so on) for pre-commit triggers that are executed
against this App Server.
-
collation
specifies the default collation for queries run in this appserver.
This will be the collation used for string comparison and sorting
if none is specified in the query.
-
coordinate-system
specifies the default coordinate system for queries run in this appserver.
This will be the coordinate system used for geospatial operations
if none is specified in the query.
-
authentication
specifies the authentication scheme to use for the server.
-
internal-security
specifies whether security database is used for authentication and authorization
if the user is found in the security database.
-
external
authentication specifies an external security config.
-
external
securities specifies an external security config.
-
default
user only
applies for application-level authentication. It specifies the default
user who is authenticated (without a password) for all users accessing
the server. Setting the default user to a user with the admin role
effectively disables security, because everyone who accesses the server
then has the admin role.
-
privilege
specifies the execute privilege required to access the server.
-
concurrent request
limit specifies the maximum number of requests any user may have
running at a specific time. 0 indicates no maximum.
-
compute-content-length
specifes whether to compute content length when using a webDAV server.
-
file log
level specifies the minimum log level for log messages
sent to the MarkLogic Server log file (
ErrorLog.txt
).
-
opsdirector log
level specifies the minimum log level of the current server
for application log messages sent to Ops Director. This item is
greyed out if the cluster is not managed by Ops Director.
-
log-errors
specifes whether to log uncaught errors for this App Server to the
ErrorLog.txt
file. This is useful to log exceptions
that might occur on an App Server for later debugging.
-
debug-allow
specifies whether to allow requests against this App Server to be
stopped for debugging, using the MarkLogic Server debugging APIs.
-
profile-allow
specifies whether to allow requests against this App Server to be
profiled, using the MarkLogic Server profiling APIs.
-
default-xquery-version
specifies the default XQuery language for this App Server
if an XQuery module does explicitly declare its language version.
-
multi version concurrency control
specifies how the latest timestamp is chosen for lock-free queries.
When set to
contemporaneous
, the server chooses the
latest timestamp for which any transaction is known to
have committed, even though there still may be other transactions
for that timestamp that have not yet fully committed. Queries will
see more timely results, but may block waiting for contemporaneous
transactions to fully commit.
When set to nonblocking
, the server chooses the latest
timestamp for which all transactions are known to have
committed, even though there may be a slightly later timestamp for
which another transaction has committed. Queries won't block
waiting for transactions, but they may see less timely results.
-
distribute timestamps
specifies how the latest timestamp is distributed after
updates. This affects performance of updates and the
timeliness of read-after-write query results from other hosts
in the group.
When set to fast
, updates return as quickly as
possible. No special timestamp notification messages are
broadcasted to other hosts. Instead, timestamps are
distributed to other hosts when any other message is sent.
The maximum amount of time that could pass before other hosts
see the timestamp is one second, because a heartbeat message
is sent to other hosts every second.
When set to strict
, updates immediately broadcast
timestamp notification messages to every other host in the
group. Updates do not return until their timestamp has been
distributed. This ensures timeliness of read-after-write query
results from other hosts in the group, so requests made to this
app server on other hosts in the group will see immediately
consistent results.
When set to cluster
, updates immediately broadcast
timestamp notification messages to every other host in the
cluster. Updates do not return until their timestamp has been
distributed. This ensures timeliness of read-after-write query
results from any host in the cluster, so requests made to any app
server on any host in the cluster will see immediately consistent
results.
-
output-sgml-character-entities
specifies whether to output SGML character entities for this
App Server, and how to resolve name conflicts. Valid values
are
normal
, none
, math
,
and pub
. By default (that is, if this option is
not specified), no SGML entities are serialized on output,
unless the App Server is configured to output SGML character
entities.
-
output-encoding
specifies the default output encoding for this App
Server. This is like the "encoding" option of both the XSLT
xsl:output
instruction and the MarkLogic XQuery xdmp:output
prolog statement.
-
output-method
Valid values are
xml
, html
,
xhtml
, text
,
sparql-results-json
,
sparql-results-csv
,
n-triples
, and n-quads
. This is like the
"method" option of both the XSLT xsl:output
instruction and the MarkLogic XQuery
xdmp:output
prolog statement.
-
output-byte-order-mark
Valid values are
yes
or no
. This
is like the "byte-order-mark" option of both the XSLT xsl:output
instruction and the MarkLogic XQuery xdmp:output
prolog statement.
-
output-cdata-section-namespace-uri
is used in conjunction with output-cdata-section-localname; it is a namespace URI in which elements whose text contents should be output as CDATA sections may be specified. You can only configure CDATA sections in one namespace at the level of server defaults.
-
output-cdata-section-localname
is an element or list of elements to be output as CDATA sections: a space-separated sequence of name strings (without namespace qualifiers) of elements defined in the "cdata section namespace uri" specified above. This corresponds to
the "cdata-section-elements" option of both the XSLT
xsl:output
instruction and the MarkLogic XQuery
xdmp:output
prolog statement. You can only configure CDATA sections in one namespace at the level of server defaults.
-
output-doctype-public
A public identifier, which is the public identifier to use on
the emitted DOCTYPE. This is like the "doctype-public"
option of both the XSLT
xsl:output
instruction and the MarkLogic XQuery xdmp:output
prolog statement.
-
output-doctype-system
A system identifier, which is the system identifier to use on
the emitted DOCTYPE. This is like the "doctype-system"
option of both the XSLT
xsl:output
instruction and the MarkLogic XQuery xdmp:output
prolog statement.
-
output-escape-uri-attributes
Valid values are
yes
or no
. This
is like the "escape-uri-attributes" option of both the XSLT
xsl:output
instruction and the MarkLogic XQuery xdmp:output
prolog statement.
-
output-include-content-type
Include the content-type declaration when serializing the
node. Valid values are
yes
or no
.
This is like the "include-content-type" option of both the
XSLT xsl:output
instruction and the MarkLogic XQuery xdmp:output
prolog statement.
-
output-indent
Specifies if typed XML (that is, XML for which there is an
in-scope schema) should be pretty-printed (indented). Valid
values are
yes
or no
. This is like
the "indent" option of both the XSLT xsl:output
instruction and the MarkLogic XQuery xdmp:output
prolog statement.
-
output-indent-untyped
Specifies if untyped XML (that is, XML for which there is no
in-scope schema) should be pretty-printed (indented). Valid
values are
yes
or no
. This is like
the "indent-untyped" option of the MarkLogic XQuery
xdmp:output
prolog statement.
-
output-indent-tabs
Specifies if a tab character should be output instead of 8
consecutive spaces when indenting. Valid
values are
yes
or no
. This is like
the "indent-tabs" option of the MarkLogic XQuery
xdmp:output
prolog statement.
-
output-media-type
A mimetype representing a media type. For example,
text/plain
or text/xml
(or other
valid mimetypes). This is like the "media-type" option of
both the XSLT xsl:output
instruction and the MarkLogic XQuery xdmp:output
prolog statement.
-
output-normalization-form
Valid values are
NFC
, NFD
, and
NFKD
. This is like the "normalization-form"
option of both the XSLT xsl:output
instruction and the MarkLogic XQuery
xdmp:output
prolog statement.
-
output-omit-xml-declaration
Valid values are
yes
or no
. This
is like the "omit-xml-declaration" option of both the XSLT xsl:output
instruction and the MarkLogic XQuery xdmp:output
prolog statement.
-
output-standalone
Valid values are
yes
, no
, or
omit
. This is like the "standalone" option of
both the XSLT xsl:output
instruction and the MarkLogic XQuery xdmp:output
prolog statement.
-
output-undeclare-prefixes
Valid values are
yes
or no
. This
is like the "undeclare-prefixes" option of both the XSLT xsl:output
instruction and the MarkLogic XQuery xdmp:output
prolog statement.
-
output-version
Valid values are
1.0
(for XML or XHTML) or
4.0
(for HTML). This is like the "version"
option of both the XSLT xsl:output
instruction and the MarkLogic XQuery xdmp:output
prolog statement.
-
output-include-default-attributes
Serialized output includes default attributes.This is like
the "include-default-attributes" option of the MarkLogic XQuery
xdmp:output
prolog statement.
-
default error handler
specifies the default format for protocol errors for this server.
-
error handler
specifies the page to internally redirect to in case of any 400
or 500 errors.
-
url rewriter
specifies the script to run to rewrite URLs.
-
rewrite resolves globally
specifies whether to allow rewritten URLs to be resolved from
the global MarkLogic Modules/ directory.
-
ssl certificate template
specifies the certificate template for the App Server. When
a certificate template is specified, the App Server uses an SSL
encrypted protocol (e.g. https, davs, xccs). The certificate
template specifies the common information for the individual SSL
certificates needed for each host in the group.
-
ssl hostname
specifies the hostname for the server's SSL certificate. This is
useful when many servers are running behind a load balancer. If not
specified, each host will use a certificate for its own hostname.
-
ssl ciphers
specifies the SSL ciphers that may be used.
-
ssl require client certificate
specifies whether a client certificate is required when connecting
to this application server.
-
ssl client certificate authorities
enables mutual authentication, where the client also holds a digital
certificate that it sends to the server. Select which certificate authority
is to be used to sign client certificates for the server.
-
enable-hsts-header
specifies whether to include HSTS header in response
if the app server is configured to use HTTPS.
-
hsts header max age specifes
the max-age field in HSTS header
Buttons and Tabs:
- The
Summary
tab displays a list of all of the currently configured App Servers,
along with the configuration information for each App Server.
- The
Configure
tab is where you change App Server settings.
- The
Status
tab displays current information on all App Servers in the
group, including query activity. You can cancel currently running
queries on the App Server status page.
- Use the
Create HTTP,
Create WebDAV, and
Create XDBC, and
Create ODBC
tabs to create new App Servers of the appropriate type.
HTTP servers service XQuery and HTTP requests over HTTP,
WebDAV servers allow access to a database via a WebDAV client,
XDBC, and ODBC servers service requests from XCC, XDBC or ODBC clients.
- The
delete button deletes the
App Server configuration.
- The
disable button leaves the
App Server configuration, but disables all requests to that
App Server (requests to a disabled App Server return a 503 error).
The port remains bound for a disabled App Server.
Copyright © 2024 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.