Publishers.xml
This file specifies the schema for the publisher properties.
publishers
The set of publishers that the Diffusion server is aware of at startup.
The following table lists the elements that an element of type publishers can contain:
Name | Type | Description | Min occurs | Max occurs |
---|---|---|---|---|
publisher | publisher | A publisher definition. | 0 | unbounded |
publisher
A publisher definition.
The following table lists the attributes that an element of type publisher can have:
Name | Type | Description | Required |
---|---|---|---|
name | push:string | The publisher name. | true |
The following table lists the elements that an element of type publisher can contain:
Name | Type | Description | Min occurs | Max occurs |
---|---|---|---|---|
topics | push:string | An optional, comma-separated list of topic names specifying topics to be automatically created for the publisher as it is started. This technique does not allow for topics to be set up with data and so it is more usual to define the topics you require in the initialLoad method of the Publisher. This property remains mostly for backwards compatibility. | 0 | 1 |
class | push:string | The full class name of a Java class that implements the publisher. This class must extend the Java API Publisher class and provide implementations of methods as required. The class file must be available on the classpath of the Diffusion server (or in the configured usr-lib or ext folder). | 1 | 1 |
enabled | push:boolean | By default, the publisher is loaded as the server starts. By setting this to false, the publisher is not loaded. | 0 | 1 |
start | push:boolean | By default, the publisher is started after it is loaded. By specifying this as false, the publisher can be loaded but not started and then can be started later using JMX. | 0 | 1 |
topic-aliasing | push:boolean | Specifies whether topic aliasing is turned on for all topics created by the publisher. If the value is true, a short topic alias is transmitted in delta messages instead of the full topic name. By default, this is true, but because there are certain limitations when using topic aliasing there might be situations where you might want to turn it off. | 0 | 1 |
ack-timeout | push:millis | This specifies the default ACK (message acknowledgment) timeout value (in milliseconds) to use for messages sent from the publisher that require acknowledgment and do not have a timeout explicitly specified. If a value is not specified, a default of 1s is used. | 0 | 1 |
auto-ack | push:boolean | Indicates whether to automatically acknowledge messages sent from clients to the publisher requiring acknowledgment. By default, this is false so messages requiring acknowledgment must be manually acknowledged by the publisher. | 0 | 1 |
subscription-policy-file | push:string | Path of a subscription validation policy file. If this value is specified, the file is used to validate client subscriptions to topics owned by the publisher. | 0 | 1 |
stop-server-if-not-loaded | push:boolean | If this is set to true and the publisher fails to load, the Diffusion server stops. By default, this is false. | 0 | 1 |
log-level | push:log-level | Specifies the log level for the publisher. If this value is not specified, the publisher logs at the default log level. | 0 | 1 |
server | server | A specification of a server that is automatically connected to by the publisher when it starts. DEPRECATED : Since 5.9 - will be removed at a future release. | 0 | unbounded |
web-server | web-server | If the publisher has associated web content, it can be deployed with the publisher by specifying this property. | 0 | 1 |
launch | launch | Launch detail describes how the publisher might be accessed externally, if it has an associated webpage. | 0 | unbounded |
property | property | A property available to the publisher. This can be used to configure publisher-specific variables or parameters. | 0 | unbounded |
launch
Launch detail.
The following table lists the attributes that an element of type launch can have:
Name | Type | Description | Required |
---|---|---|---|
name | push:string | The launcher name. | true |
category | push:string | An optional category to which this launcher belongs. For example, "demo" for the Diffusion demo landing page. | false |
The following table lists the elements that an element of type launch can contain:
Name | Type | Description | Min occurs | Max occurs |
---|---|---|---|---|
description | push:string | A short description of this launcher. | 0 | 1 |
url | push:string | The URL at which a webpage associated with this publisher can be found. | 1 | 1 |
icon | push:string | A URL or path at which an icon representing this launcher can be reached. | 0 | 1 |
property
A publisher property.
The following table lists the attributes that an element of type property can have:
Name | Type | Description | Required |
---|---|---|---|
name | push:string | The property value | true |
type | push:string | An optional property type. Usage of this is implementation specific. | false |
credentials
Credentials for server connection.
The following table lists the elements that an element of type credentials can contain:
Name | Type | Description | Min occurs | Max occurs |
---|---|---|---|---|
username | push:string | User name. | 0 | 1 |
password | push:string | Password. | 0 | 1 |
server
The following table lists the attributes that an element of type server can have:
Name | Type | Description | Required |
---|---|---|---|
name | push:string | Server definition name. | true |
The following table lists the elements that an element of type server can contain:
Name | Type | Description | Min occurs | Max occurs |
---|---|---|---|---|
host | push:string | The host name or IP address of the server. | 1 | 1 |
port | push:port | The port number that the server is listening on for publisher client connections from other publishers. | 1 | 1 |
ssl | push:boolean | If this value is true, the connection to the server is a secure connection over SSL. In this case the specified port must represent an SSL client connector at the server. The keystore properties must also be supplied for secure connections. By default, this is false. | 0 | 1 |
keystore-file-location | push:string | The path of the keystore file defining the SSL context. This is ignored if ssl=false, but mandatory if it is true. | 0 | 1 |
keystore-password | push:string | The keystore password. This is ignored if ssl=false, but mandatory if it is true. | 0 | 1 |
input-buffer-size | push:bytes | Specifies the size of the input buffer to use for the connection with the server. This is used to receive messages from the server. Set this to the same size as the output buffer used at the server. | 1 | 1 |
output-buffer-size | push:bytes | The size of the output buffer to use for the connection with the server. This is used to send messages to the server. Set this to the same size as the input buffer used by the server. | 1 | 1 |
fail-policy | push:string | This specifies what happens if the publisher fails to connect to the server. 'default' means that if unable to connect, no action is taken and it is the publisher's responsibility to handle this. 'close' means that if unable to connect to the server, the publisher closes. 'retry' means that if unable to connect, the connection is automatically retried at intervals as specified by the retry-interval property. | 1 | 1 |
retry-interval | push:millis | If the fail-policy for a server is 'retry', this is the interval at which the connection to the server is retried. If this value is not specified, a default of 5s is used. | 0 | 1 |
credentials | credentials | Credentials to use for the server connection. If this value is not specified, no credentials are passed on connection. | 0 | 1 |
queue-definition | push:string | Optional outbound queue definition for this server connection. The definition must exist in Server.xml. This defines the queue to use for outbound messages from the publisher to the server. If this value is not specified, the default queue definition in Server.xml is used. | 0 | 1 |
web-server
A web server definition.
The following table lists the elements that an element of type web-server can contain:
Name | Type | Description | Min occurs | Max occurs |
---|---|---|---|---|
virtual-host | push:string | The name of the virtual host to deploy to. If this value is not supplied, default-files-default is used. | 0 | 1 |
alias-file | push:string | The alias file to use for this publisher | 1 | 1 |