Just a second...

WebServer.xml

This file specifies the schema for the web server properties.

web-servers

Definitions of one or more web servers.

The following table lists the elements that an element of type web-servers can contain:
Name Type Description Min occurs Max occurs
web-server   Web server definition. 0 unbounded

web-server

Web server definition.

The following table lists the attributes that an element of type web-server can have:
Name Type Description Required
name push:string Name of the web server definition. true
The following table lists the elements that an element of type web-server can contain:
Name Type Description Min occurs Max occurs
client-service   Optional client service. 0 1
http-service   HTTP service. 0 unbounded
rest-service   REST API definition. 0 1
file-service   Optional file service. 0 1

virtual-host

Virtual host definiton.

The following table lists the attributes that an element of type virtual-host can have:
Name Type Description Required
name push:string Virtual host name. true
debug push:boolean Debug flag. Set to true for debugging. Default is false. false
The following table lists the elements that an element of type virtual-host can contain:
Name Type Description Min occurs Max occurs
host push:string Specifies the host which the virtual host is to serve, for example, download.pushtechnology.com or * for all. 1 1
document-root push:string The physical directory for this virtual host. If a relative path is configured, it is resolved relative to the Diffusion home directory. 1 1
home-page push:string The default home page. This file is used with directory browsing. 1 1
error-page push:string This is used to control the 404 response. The server looks for one of these files in the directory of the request. If the file does not exist, it looks for this file in the virtual directory. If the file is not supplied or the file does not exist, a standard 404 response HTML document is sent. 0 1
static push:boolean If this is set to true, after loading the resource once, the file system is not checked again. This improves performance for simple static usage. By default this is false. 0 1
minify push:boolean Set to true to minify the html. This happens before the file is compressed. By default this is false. 0 1
cache   The virtual host cache configuration. 1 1
compression-threshold push:bytes All HTTP responses over this size are compressed. If not specified, a default value of 512 is used. 0 1
alias-file push:string Optionally specifies an alias file. This allows for URL aliasing if required. If a relative path is configured, it is resolved relative to the Diffusion configuration directory. 0 1
realms   Virtual host realms. 0 1

realms

Virtual host realms.

The following table lists the elements that an element of type realms can contain:
Name Type Description Min occurs Max occurs
realm   A virtual host realm. 0 unbounded

realm

A virtual host realm.

The following table lists the attributes that an element of type realm can have:
Name Type Description Required
name push:string Virtual host realm name. true
path push:string Virtual host realm path. true
The following table lists the elements that an element of type realm can contain:
Name Type Description Min occurs Max occurs
users   Virtual host realm users. 0 1

users

Virtual host realm users.

The following table lists the elements that an element of type users can contain:
Name Type Description Min occurs Max occurs
user   Virtual host realm user. 1 unbounded

user

Virtual host realm user.

The following table lists the attributes that an element of type user can have:
Name Type Description Required
name push:string Virtual host realm user name. true
password push:string Virtual host realm user password. true

cache

Virtual host cache.

The following table lists the attributes that an element of type cache can have:
Name Type Description Required
debug push:boolean Set true to debug the cache. If a value is not specified, a default of false is used. false
The following table lists the elements that an element of type cache can contain:
Name Type Description Min occurs Max occurs
file-size-limit push:bytes If the file to be served is over this size, do not cache the entire contents, but map the file instead. If a size is not specified, a default value of 1m is used. 0 1
cache-size-limit push:bytes Total size of the cache for this web server definition. If a size is not specified, a default value of 10m is used. 0 1
file-life-time push:millis If the file has not been accessed within the time specified, remove the entry from the cache. If a time is not specified, a default value of 1d is used. 0 1

http-service

HTTP service.

The following table lists the attributes that an element of type http-service can have:
Name Type Description Required
name push:string HTTP service name. true
debug push:boolean Set true to debug the HTTP service. If a value is not specified, a default of false is used. false
The following table lists the elements that an element of type http-service can contain:
Name Type Description Min occurs Max occurs
class push:string The user HTTP service class name. This class must implement the HTTPServiceHandler interface in the web server API. 1 1
url-pattern push:string The pattern that the URL must match for this service to be invoked. 1 1
log push:string DEPRECATED: Since 6.8 - This setting is no longer used and will be removed in a future release. 0 1
max-inbound-request-size push:bytes The maximum number of bytes that the HTTP request can have. If this is not specified, a default of the maximum message size is used. 0 1
property   HTTP service property. 0 unbounded

rest-service

REST service definition.

The following table lists the elements that an element of type rest-service can contain:
Name Type Description Min occurs Max occurs
session-token-timeout push:millis The timeout value for a REST session token, after it is last accessed. If the session token is used after it times out, it will be invalidated and removed from the server. If this is not specified, a default of 300000 (5 minutes) is used. 0 1
rest-apis   List of REST APIs to enable 1 1

rest-apis

The following table lists the elements that an element of type rest-apis can contain:
Name Type Description Min occurs Max occurs
rest-api   List of REST APIs to enable. 1 unbounded

rest-api

REST API configuration.

The following table lists the attributes that an element of type rest-api can have:
Name Type Description Required
type restApiType REST API type to enable. false
debug push:boolean Set true to debug the REST API. If a value is not specified, a default of false is used. false
The following table lists the elements that an element of type rest-api can contain:
Name Type Description Min occurs Max occurs
max-inbound-request-size push:bytes The maximum number of bytes that the HTTP request can have. If this is not specified, a default of the maximum message size is used. 0 1

property

A property.

The following table lists the attributes that an element of type property can have:
Name Type Description Required
name push:string Property name. true
type push:string Optional property type. false

file-service

File service.

The following table lists the attributes that an element of type file-service can have:
Name Type Description Required
name push:string File service name. true
The following table lists the elements that an element of type file-service can contain:
Name Type Description Min occurs Max occurs
virtual-host   Virtual host. 1 unbounded
write-timeout push:millis Write timeout for serving files. This does not affect HTTP clients. If a value is not specified, a default value of 3s is used. 0 1

client-service

Client service.

The following table lists the attributes that an element of type client-service can have:
Name Type Description Required
name push:string Client service name. true
debug push:boolean Set true to debug the client service. If a value is not specified, a default of false is used. false
The following table lists the elements that an element of type client-service can contain:
Name Type Description Min occurs Max occurs
message-sequence-timeout push:millis This is used with HTTP clients to indicate how long to wait for a missing message in a sequence of messages before assuming it has been lost and closing the client session. If a value is not specified, a default of 4 seconds is used. If this exceeds one hour (3600000ms) a warning will be logged and the time-out will be set to one hour. 0 1
websocket-origin push:string The server will reject a WebSocket connection upgrade request that has an Origin header if the header does not match this regular expression. The default value is ".*", which allows all WebSocket upgrade requests. 0 1
cors-origin push:string This is used to control access from client web (XHR) to Diffusion. This element will enable Cross Origin Resource Sharing (CORS). This is a regular expression pattern that matches the origin of the request. A value of ".*" matches anything, so all requests are allowed. If a value is not specified, the service cannot handle CORS requests. 0 1
max-inbound-request-size push:bytes The maximum number of bytes that the HTTP request can have. If a value is not specified, a default of the maximum message size is used. 0 1
disable-cookies push:boolean Set true to disable session cookie from being in the "Set-Cookie" header. If a value is not specified, cookies are enabled. 0 1

restApiType

This value must be a push:string.

The following values are allowed:
  • GATEWAY_CONTROL

property-value

This value must be a push:string.