Event Dispatcher

For the most up-to-date documentation, please visit docs.brix.ch

This plugin informs external systems about changes in CELUM. Various filters allow you to restrict the scope of the events, so that only relevant events are dispatched. Both the filters and the dispatcher allow for custom implementations through the use of beans. By default we ship simple GET and POST implementations for use in Webhooks.

General properties

eventDispatcher.license

type: String, required: yes, default: -

The license key for the plugin (product: eventDispatcher), provided by brix.

eventDispatcher.filters

type: bean names (comma separated), required: no, default: -

Event filters to apply - needs to pass all of them in order to be dispatched. Providing no filters will dispatch all events. Known implementations:

  • eventFilterByName
  • eventFilterByUser
  • eventFilterByNode
eventDispatcher.dispatchers

type: bean names (comma separated), required: yes, default: eventDispatcherSimpleGet

Event dispatchers to inform about the event, all will be called in order. Known implementations:

  • eventDispatcherSimpleGet
  • eventDispatcherSimplePost
eventDispatcher.threads

type: int, required: yes, default: 4

Size of the thread pool that dispatches the events

Dispatcher properties

eventDispatcher.baseUrl

type: string, required: yes, default: http://localhost, applies to: eventDispatcherSimpleGet, eventDispatcherSimplePost

Endpoint to be informed about the event. Adds additional parameters when available:

  • eventType: Name of the event (always; since 1.0)
  • id: ID of the affected object, unique per object type (on assets, nodes, users and usergroups; since 1.0)
  • name: Name of the affected object, non-unique (on assets, nodes, users and usergroups; since 1.3)
  • fileName: Original file name of the asset (on assets; since 1.3)

Example: http://pim.brix.ch/event-handler/celum.do?eventType=AssetAddedEvent&id=1337&name=Ponies&fileName=Ponies.jpg

Filter properties

eventDispatcher.eventWhitelist

type: string (comma separated), required: no, default: -, applies to: eventFilterByName

Only pass on events with the following names, list of:

AssetEvents

  • AssetAddedEvent
  • AssetCreatedEvent
  • AssetDeletedEvent
  • AssetMetadataUpdatedEvent
  • AssetReleasedEvent
  • AssetRemovedEvent
  • AssetsDownloadStartedEvent
  • AssetStatusAvailable
  • AssetStatusUnavailable
  • AssetSyncedEvent
  • AssetTypeSetEvent
  • AssetVersionActivatedEvent
  • AssetVersionAddedEvent
  • AssetVersionDeletedEvent

NodeEvents

  • NodeCreatedEvent
  • NodeDeletedEvent
  • NodeMetadataUpdatedEvent
  • NodeMovedEvent

UserEvents

  • UserCreatedEvent
  • UserDeletedEvent
  • UserLoggedInEvent
  • UserLoginFailedEvent

UserGroupEvents

  • UserGroupAddedToUserGroupEvent
  • UserGroupCreatedEvent
  • UserGroupDeletedEvent
  • UserGroupRemovedFromUserGroupEvent
  • UserAddedToUserGroupEvent
  • UserRemovedFromUserGroupEvent

PublicUrlEvents

  • PublicUrlAddedEvent
  • PublicUrlDeletedEvent

RelationEvents

  • RelationCreatedEvent
  • RelationDeletedEvent

Other

  • PreviewConversionEvent
  • PropertyChangedEvent

You can check which events are available by setting the logger of ch.brix.eventDispatcher.EventDispatcherListener to INFO, it will print a list of known events at startup.

eventDispatcher.scopeUserId

type: long, required: no, default: -, applies to: eventFilterByUser

Only pass on events that originate from an asset/node that this user can see

eventDispatcher.scopeNodeId

type: long, required: no, default: -, applies to: eventFilterByNode

Only pass on events that originate in a certain node (recursively)

Compatibility Matrix

eventDispatcher CELUM
1.0 - 1.5 5.12.4
1.6 5.13.4

Release Notes

1.0

Released 2017-05-19

Initial version with support for eventFilterByName, eventFilterByUser, eventFilterByNode as well as eventDispatcherSimpleGet and eventDispatcherSimplePost.

1.1

Released 2017-05-23

Added synthesized events AssetStatusAvailable and AssetStatusUnavailable through a nightly task (in order to detect assets at the egde of their validity period).

1.2

Released 2017-08-16

Switched synthesized event source to SolrQueries (way faster)

1.3

Released 2018-03-19

Added additional parameters to the GET- and POST-Dispatchers (name and fileName when applicable)

1.4

Released 2018-07-07

Refactored default dispatchers to facilitate writing custom dispatchers

1.5

Released 2019-01-25

Added license.

1.6

Released 2019-03-07

Established compatibility with the new SOLR server (CELUM 5.13.4 and above)