Package com.flowable.engage.external.system.common

Class BaseExternalMessageBuilder

java.lang.Object

com.flowable.engage.external.system.common.BaseExternalMessageBuilder

All Implemented Interfaces:

ExternalMessageBuilder

Direct Known Subclasses:

LineExternalMessageBuilder, WeChatExternalMessageBuilder, WhatsAppExternalMessageBuilder

public abstract class BaseExternalMessageBuilder
extends Object
implements ExternalMessageBuilder

Base class that can be used by different external system provider to provide an implementation for the sending of the outbound message.

Author:

Filip Hrisafov

Field Summary

Fields

Modifier and Type	Field	Description
protected String	businessAccountId
protected String	externalUserId
protected String	message
protected String	messageId

Constructor Summary

Constructors

Constructor	Description
BaseExternalMessageBuilder()

Method Summary

Modifier and Type	Method	Description
ExternalMessageBuilder	businessAccountId(String businessAccountId)	The id of the business account for the external user
protected void	checkBeforeSend(String type)	Perform certain checks before sending the message.
protected OutboundMessageDto	createOutboundMessage(String type)
ExternalMessageBuilder	externalUserId(String externalUserId)	The id of the external user to which the message should be send to
ExternalMessageBuilder	message(String message)	The contents of the message that needs to be send
ExternalMessageBuilder	messageId(String messageId)	The id of the message being send (can be used for logging purposes)
protected OutboundMessageDto	newOutboundMessageDto()
void	sendMediaMessage(String mediaId)	Perform sending of media message
void	sendMessage()	Perform sending a normal text message
protected abstract void	sendOutboundMessage(OutboundMessageDto outboundMessage)
protected String	validateAndCreateMessageContent(String type)	This method is invoked when the content for the outbound message is create.

Methods inherited from class java.lang.Object

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

Field Detail

externalUserId

protected String externalUserId

businessAccountId

protected String businessAccountId

messageId

protected String messageId

message

protected String message

Constructor Detail

BaseExternalMessageBuilder

public BaseExternalMessageBuilder()

Method Detail

externalUserId

public ExternalMessageBuilder externalUserId(String externalUserId)

Description copied from interface: ExternalMessageBuilder

The id of the external user to which the message should be send to

Specified by:

externalUserId in interface ExternalMessageBuilder

Parameters:

externalUserId - the external user id

businessAccountId

public ExternalMessageBuilder businessAccountId(String businessAccountId)

Description copied from interface: ExternalMessageBuilder

The id of the business account for the external user

Specified by:

businessAccountId in interface ExternalMessageBuilder

Parameters:

businessAccountId - the bussiness account id

messageId

public ExternalMessageBuilder messageId(String messageId)

Description copied from interface: ExternalMessageBuilder

The id of the message being send (can be used for logging purposes)

Specified by:

messageId in interface ExternalMessageBuilder

Parameters:

messageId - the message id

message

public ExternalMessageBuilder message(String message)

Description copied from interface: ExternalMessageBuilder

The contents of the message that needs to be send

Specified by:

message in interface ExternalMessageBuilder

Parameters:

message - the message content

sendMessage

public void sendMessage()

Description copied from interface: ExternalMessageBuilder

Perform sending a normal text message

Specified by:

sendMessage in interface ExternalMessageBuilder

sendMediaMessage

public void sendMediaMessage(String mediaId)

Description copied from interface: ExternalMessageBuilder

Perform sending of media message

Specified by:

sendMediaMessage in interface ExternalMessageBuilder

Parameters:

mediaId - the id of the media that is being sent

checkBeforeSend

protected void checkBeforeSend(String type)

Perform certain checks before sending the message. By default this checks that the externalUserId and messageId have been set.

Parameters:

type - the type of message that is being send

sendOutboundMessage

protected abstract void sendOutboundMessage(OutboundMessageDto outboundMessage)

createOutboundMessage

protected OutboundMessageDto createOutboundMessage(String type)

newOutboundMessageDto

protected OutboundMessageDto newOutboundMessageDto()

validateAndCreateMessageContent

protected String validateAndCreateMessageContent(String type)

This method is invoked when the content for the outbound message is create. It can be used to perform validations and to modify the content if it is required. By default this methods appends the display name to the message.

Parameters:

type - the type of the message for which the content is being created

Returns:

the content that should be used to send the message