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 |
|---|---|---|---|---|
| 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 |
| 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 |
| 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 |
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 |
propertyValue
This value must be a push:string.