Contact Us 1-800-596-4880

Notifications Configuration Reference

This version of Mule reached its End of Life on May 2, 2023, when Extended Support ended.

Deployments of new applications to CloudHub that use this version of Mule are no longer allowed. Only in-place updates to applications are permitted.

MuleSoft recommends that you upgrade to the latest version of Mule 4 that is in Standard Support so that your applications run with the latest fixes and security enhancements.

This topic provides details on the elements to configure for notifications. For more information on notifications, see Mule Server Notifications.

Notifications

Registers listeners for notifications, and associates interfaces with specific events.

Attributes of Notifications

Name Description

dynamic

If the notification manager is dynamic, you can set up the listeners to be registered dynamically at runtime. Otherwise, some parts of Mule will cache the notification configurations for efficiency reasons and will not generate events for newly-enabled notifications or listeners.
Type: boolean
Required: no
Default: false

Child Elements of Notifications

Use the notification and disable-notification elements to configure the relationship between interfaces and events.

Name Cardinality Description

notification

0..*

Associates an event with an interface. Listeners that implement the interface receive instances of the event.

disable-notification

0..*

Blocks the association of an event with a particular interface. This filters events after the association is made with the interface, so it takes precedence over other elements, such as notification-listener.

notification-listener

0..*

Registers a bean as a listener with the notification system. Events are dispatched by reflection, which means that the listener receives all events associated with the interfaces it implements.

Notification

Associates an event with an interface. Listeners that implement the interface will receive instances of the event.

Attributes of Notification

Name Description

event-class

The class name of the notification event to deliver to the interface. You can use this instead of the event attribute to specify a custom class.
Type: class name
Required: no
Default: none

event

The notification event to deliver.
Type: notificationTypes
Required: no
Default: none

interface-class

The class name of the interface that receives the notification event.
Type: class name
Required: no
Default: none

interface

The name of the interface that receives the notification event.
Type: notificationTypes
Required: no
Default: none

There are no child elements for notification.

Disable Notification

Blocks the association of an event with a particular interface. This filters events after the association is made with the interface, so it takes precedence over over other elements, such as notification-listener.

Attributes of disable-notification

Name Description

event-class

The class name of the event that is no longer delivered to an interface. You can use this instead of the event attribute to specify a custom class.
Type: class name
Required: no
Default: none

event

The event you no longer want to deliver.
Type: notificationTypes
Required: no
Default: none

interface-class

The class name of the interface that no longer receives the event.
Type: class name
Required: no
Default: none

interface

The name of the interface that no longer receives the event.
Type: notificationTypes
Required: no
Default: none

There are no child elements for disable-notification.

Notification Listener

Registers a bean as a listener with the notification system. Events are dispatched by reflection, which means that the listener receives all events associated with the interfaces it implements.

Notification Types

You can specify the following types of notifications using the event attribute of the notification and disable-notification elements:

  • ASYNC-MESSAGE

  • CONNECTION

  • CONNECTOR-MESSAGE

  • CONTEXT

  • CUSTOM

  • EXCEPTION

  • EXCEPTION-STRATEGY

  • EXTENSION

  • MANAGEMENT

  • MESSAGE-PROCESSOR

  • PIPELINE-MESSAGE

  • ROUTING

  • SECURITY

  • TRANSACTION