Package com.flowable.notification.engine.impl

Class DeliveryContextImpl<T>

java.lang.Object

com.flowable.notification.engine.impl.DeliveryContextImpl<T>

All Implemented Interfaces:

DeliveryContext<T>

public class DeliveryContextImpl<T>
extends java.lang.Object
implements DeliveryContext<T>

Author:

Filip Hrisafov

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	messageDelivered
protected NotificationMessageProvider<T>	messageProvider
protected Notification	notification
protected java.lang.String	recipientId

Constructor Summary

Constructors

Constructor	Description
DeliveryContextImpl(NotificationMessageProvider<T> messageProvider, Notification notification, java.lang.String recipientId)

Method Summary

Modifier and Type	Method	Description
java.util.Optional<NotificationMessage<T>>	getMessage(java.lang.String deliverer)	The message that needs to be sent with it's payload for the provided deliverer.
Notification	getNotification()	The information for sending the information.
java.lang.String	getRecipientId()	The id of the user that needs to receive the message
boolean	isMessageDelivered()	Whether a message has already been delivered.
void	setMessageDelivered(boolean messageDelivered)	Set whether the message has been delivered

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

messageProvider

protected final NotificationMessageProvider<T> messageProvider

notification

protected final Notification notification

recipientId

protected final java.lang.String recipientId

messageDelivered

protected boolean messageDelivered

Constructor Details

DeliveryContextImpl

public DeliveryContextImpl(NotificationMessageProvider<T> messageProvider, Notification notification, java.lang.String recipientId)

Method Details

getMessage

public java.util.Optional<NotificationMessage<T>> getMessage(java.lang.String deliverer)

Description copied from interface: DeliveryContext

The message that needs to be sent with it's payload for the provided deliverer.

Specified by:

getMessage in interface DeliveryContext<T>

Returns:

the message that needs to be sent

getNotification

public Notification getNotification()

Description copied from interface: DeliveryContext

The information for sending the information. Such as whether a push is needed, or something similar

Specified by:

getNotification in interface DeliveryContext<T>

Returns:

the notification information

getRecipientId

public java.lang.String getRecipientId()

Description copied from interface: DeliveryContext

The id of the user that needs to receive the message

Specified by:

getRecipientId in interface DeliveryContext<T>

Returns:

the id of the user that needs to received the message

isMessageDelivered

public boolean isMessageDelivered()

Description copied from interface: DeliveryContext

Whether a message has already been delivered. This is used for communication between different MessageDeliverer(s) in order to decide whether a message needs to be sent.

Specified by:

isMessageDelivered in interface DeliveryContext<T>

Returns:

whether the message has been delivered

setMessageDelivered

public void setMessageDelivered(boolean messageDelivered)

Description copied from interface: DeliveryContext

Set whether the message has been delivered

Specified by:

setMessageDelivered in interface DeliveryContext<T>

Parameters:

messageDelivered - flag marking that the message has been delivered