Package com.flowable.engage.external.system.whatsapp

Class WhatsAppJmsExternalConversationSystemAdapter

java.lang.Object

com.flowable.engage.external.system.whatsapp.WhatsAppJmsExternalConversationSystemAdapter

All Implemented Interfaces:

ExternalConversationSystemAdapter, WhatsAppExternalConversationSystemAdapter

public class WhatsAppJmsExternalConversationSystemAdapter
extends Object
implements WhatsAppExternalConversationSystemAdapter

Field Summary

Fields

Modifier and Type	Field	Description
protected JmsMessageOperations	jmsMessagingOperations
protected int	maximumMessageSize
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected String	outboundMessageDestination
protected Collection<String>	supportedSendMessageTypes

Fields inherited from interface com.flowable.engage.external.system.api.ExternalConversationSystemAdapter

SEND_DOCUMENT, SEND_IMAGE, SEND_REPLY, SEND_VIDEO, SEND_VOICE

Constructor Summary

Constructors

Constructor	Description
WhatsAppJmsExternalConversationSystemAdapter(JmsMessageOperations jmsMessagingOperations, com.fasterxml.jackson.databind.ObjectMapper objectMapper, String outboundMessageDestination, int maximumMessageSize, Collection<String> supportedSendMessageTypes)

Method Summary

Modifier and Type	Method	Description
protected boolean	checkMessageSize(String content)
String	convertAndCheckMessageSize(String message)
WhatsAppContactVerificationQuery	createContactVerificationQuery()	Create the verification query for WhatsApp contacts.
WhatsAppInteractiveMessageBuilder	createInteractiveMessageBuilder()	Create a message builder for the WhatsApp interactive message.
ExternalMessageBuilder	createMessageBuilder()	Creates the ExternalMessageBuilder that is responsible for constructing the external message for the give external user id.
WhatsAppTemplateMessageBuilder	createTemplateMessageBuilder()	Create a message builder for the WhatsApp template message.
Collection<String>	fetchSupportedSendMessageTypes()
String	getExternalSystemId()	Returns the id of the external system implemented by this adapter.
void	markMessageAsRead(String whatsAppMessageId, String businessAccountId)	Mark a WhatsApp message as read with the given business account.
protected void	send(Object payload, String type)
void	sendMessageDuringCommitting(OutboundMessageDto outboundMessage)
void	sendOutboundMessage(OutboundMessageDto outboundMessage)
void	validateMessageContent(String messageContent, String messageCategory)	Validates the content of the message.
void	verifyContact(WhatsAppContactVerificationRequest payload)

Methods inherited from class java.lang.Object

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

Field Detail

jmsMessagingOperations

protected final JmsMessageOperations jmsMessagingOperations

objectMapper

protected final com.fasterxml.jackson.databind.ObjectMapper objectMapper

outboundMessageDestination

protected final String outboundMessageDestination

maximumMessageSize

protected final int maximumMessageSize

supportedSendMessageTypes

protected final Collection<String> supportedSendMessageTypes

Constructor Detail

WhatsAppJmsExternalConversationSystemAdapter

public WhatsAppJmsExternalConversationSystemAdapter(JmsMessageOperations jmsMessagingOperations,
                                                    com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                                    String outboundMessageDestination,
                                                    int maximumMessageSize,
                                                    Collection<String> supportedSendMessageTypes)

Method Detail

getExternalSystemId

public String getExternalSystemId()

Description copied from interface: ExternalConversationSystemAdapter

Returns the id of the external system implemented by this adapter.

Specified by:

getExternalSystemId in interface ExternalConversationSystemAdapter

Returns:

the external system id implemented by this adapter

createMessageBuilder

public ExternalMessageBuilder createMessageBuilder()

Description copied from interface: ExternalConversationSystemAdapter

Creates the ExternalMessageBuilder that is responsible for constructing the external message for the give external user id. This is invoked by the engage system when sending out outbound messages.

Specified by:

createMessageBuilder in interface ExternalConversationSystemAdapter

Returns:

the ExternalMessageBuilder

createInteractiveMessageBuilder

public WhatsAppInteractiveMessageBuilder createInteractiveMessageBuilder()

Description copied from interface: WhatsAppExternalConversationSystemAdapter

Create a message builder for the WhatsApp interactive message.

Specified by:

createInteractiveMessageBuilder in interface WhatsAppExternalConversationSystemAdapter

Returns:

the interactive message builder

createTemplateMessageBuilder

public WhatsAppTemplateMessageBuilder createTemplateMessageBuilder()

Description copied from interface: WhatsAppExternalConversationSystemAdapter

Create a message builder for the WhatsApp template message.

Specified by:

createTemplateMessageBuilder in interface WhatsAppExternalConversationSystemAdapter

Returns:

the template message builder

createContactVerificationQuery

public WhatsAppContactVerificationQuery createContactVerificationQuery()

Description copied from interface: WhatsAppExternalConversationSystemAdapter

Create the verification query for WhatsApp contacts.

Specified by:

createContactVerificationQuery in interface WhatsAppExternalConversationSystemAdapter

Returns:

the verification query

markMessageAsRead

public void markMessageAsRead(String whatsAppMessageId,
                              String businessAccountId)

Description copied from interface: WhatsAppExternalConversationSystemAdapter

Mark a WhatsApp message as read with the given business account.

Specified by:

markMessageAsRead in interface WhatsAppExternalConversationSystemAdapter

Parameters:

whatsAppMessageId - The id of the message in WhatsApp that should be marked as read

businessAccountId - The business account id for which the message should be marked as read

validateMessageContent

public void validateMessageContent(String messageContent,
                                   String messageCategory)

Description copied from interface: ExternalConversationSystemAdapter

Validates the content of the message. If the content is invalid an exception should be thrown.

Specified by:

validateMessageContent in interface ExternalConversationSystemAdapter

Parameters:

messageContent - the content of the message that should be validated

messageCategory - the message category

fetchSupportedSendMessageTypes

public Collection<String> fetchSupportedSendMessageTypes()

Specified by:

fetchSupportedSendMessageTypes in interface ExternalConversationSystemAdapter

Returns:

the types of messages that the adapter can send

convertAndCheckMessageSize

public String convertAndCheckMessageSize(String message)

checkMessageSize

protected boolean checkMessageSize(String content)

sendOutboundMessage

public void sendOutboundMessage(OutboundMessageDto outboundMessage)

sendMessageDuringCommitting

public void sendMessageDuringCommitting(OutboundMessageDto outboundMessage)

verifyContact

public void verifyContact(WhatsAppContactVerificationRequest payload)

send

protected void send(Object payload,
                    String type)