Listeners
Listeners are configured by the listeners global configuration property
in the PDL Client configuration file. All
listeners support the following configuration properties:
- cleanupInterval
- How long to wait (in milliseconds) between cleaning up the listener
- Default:
3600000 - concurrentProducts
- How many products to process at a time.
- Default:
1 - excludePaths
- A comma-separated list of content paths a product must not include in order for the listener to process the product.
- excludeSources
- A comma-separated list of product sources to be excluded.
- excludeTypes
- A comma-separated list of product types to be excluded.
- includeActuals
- Boolean flag indicating if actual product types are included.
- Default:
true - includeDevelopments
- Boolean flag indicating if development product sub-types are included.
- Default:
false - includeInternals
- Boolean flag indicating if internal product sub-types are included.
- Default:
false - includePaths
- A comma-separated list of content paths a product must include in order for the listener to process the product.
- includeScenarios
- Boolean flag indicating if scenario product sub-types are included.
- Default:
false - includeSources
- A comma-separated list of product sources to be included.
- includeTests
- Boolean flag indicating if test product sub-types are included.
- Default:
false - includeTypes
- A comma-separated list of product types to be included.
- listenerIndex
- Property referencing a listener index config sub-section.
- An index must be configured on the listener using either the
listenerIndexorlistenerIndexFileconfiguration property. - listenerIndexFile
- Shortcut to create a SQLite JDBCNotificationIndex
- An index must be configured on the listener using either the
listenerIndexorlistenerIndexFileconfiguration property. - maxTries
- The maximum number of attempts to process a product
- Default:
1 - processDuplicates
- Whether or not to process products more than once.
- Default:
false - retryDelay
- The duration (in milliseconds) to wait before retrying to process a product.
- Default:
300000 - timeout
- The duration (in milliseconds) to allow for a product to be processed.
- Default:
0(wait forever)
Many of the configuration properties above create filtering conditions for
when a product shall be processed by a listener. There are the
includeX and excludeX configuration options. If both
these properties are configured for a specific filter type (i.e.,
X), then the exclude is evaluated first, and if
the product is excluded, the corresponding include will have no effect.
If neither includeX nor excludeX are
specified, then products pass the filter and are included by default.
Additionally, a product must pass all configured filter types for the product to be included for processing by the listener. Failure to pass any filter type will exclude the product from processing by the listener.
Specific Listener Types
Last modified: Fri Jul 26 00:49:49 UTC 2024