Package org.jboss.weld.events

Interface WeldNotificationOptions

All Superinterfaces:

jakarta.enterprise.event.NotificationOptions

public interface WeldNotificationOptions
extends jakarta.enterprise.event.NotificationOptions

The Event.fireAsync(Object, NotificationOptions) method allows to configure the notification of asynchronous observer methods.

Weld defines the following non-portable options:

• MODE
• TIMEOUT

Since:

3.0

Author:

Martin Kouba

See Also:

• Event.fireAsync(Object, NotificationOptions)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	WeldNotificationOptions.NotificationMode

Nested classes/interfaces inherited from interface jakarta.enterprise.event.NotificationOptions

jakarta.enterprise.event.NotificationOptions.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MODE	Makes it possible to specify that observer methods should be notified in parallel (if supported).
static final String	TIMEOUT	Makes it possible to specify a timeout (in milliseconds) after which the returned completion stage must be completed.

Method Summary

Static Methods

Modifier and Type	Method	Description
static jakarta.enterprise.event.NotificationOptions	withParallelMode()
static jakarta.enterprise.event.NotificationOptions	withTimeout(long timeout)

Methods inherited from interface jakarta.enterprise.event.NotificationOptions

get, getExecutor

Field Details

MODE

static final String MODE

Makes it possible to specify that observer methods should be notified in parallel (if supported).

See Also:

• WeldNotificationOptions.NotificationMode
• Constant Field Values

TIMEOUT

static final String TIMEOUT

Makes it possible to specify a timeout (in milliseconds) after which the returned completion stage must be completed.

If the time expires the stage is completed exceptionally with a CompletionException holding the TimeoutException as its cause. The expiration does not abort the notification of the observers.

See Also:

• Constant Field Values

Method Details

withParallelMode

static jakarta.enterprise.event.NotificationOptions withParallelMode()

Returns:

notification options with "weld.async.notification.mode" set to WeldNotificationOptions.NotificationMode.PARALLEL

withTimeout

static jakarta.enterprise.event.NotificationOptions withTimeout(long timeout)

Parameters:

timeout - The timeout in milliseconds

Returns:

notification options with "weld.async.notification.timeout" set