cat.albirar.communications.core.services

Interface ICommunicationService

All Known Implementing Classes:

CommunicationServiceImpl

@Validated
public interface ICommunicationService

The contract for communications services.

Since:

1.0.0

Author:

Octavi Fornés <ofornes@albirar.cat>

Method Summary

Modifier and Type	Method and Description
boolean	isStatusMessage(@NotBlank String messageId) Check for existence of status message for a message with messageId.
Optional<MessageStatusBean>	popStatusMessage(@NotBlank String messageId) Get information about status of message with messageId and delete it.
String	pushMessage(@NotNull @Valid MessageBean message) Push a message to dispatch asynchronously.

Method Detail

popStatusMessage

Optional<MessageStatusBean> popStatusMessage(@NotBlank
                                             @NotBlank String messageId)

Get information about status of message with messageId and delete it.

Parameters:

messageId - The message id returned by pushMessage(MessageBean) or by #sendMessage(MessageBean)

Returns:

The message status or Optional.empty() if no message record exists with the indicated messageId

Throws:

ServiceException - On service exceptions errors

isStatusMessage

boolean isStatusMessage(@NotBlank
                        @NotBlank String messageId)

Check for existence of status message for a message with messageId.

Parameters:

messageId - The message id of the associated message

Returns:

true if status message exists for associated message with messageId and false if not

pushMessage

String pushMessage(@NotNull @Valid
                   @NotNull @Valid MessageBean message)

Push a message to dispatch asynchronously.

Parameters:

message - The message to send

Returns:

The identification of pushed message

Throws:

ServiceException - On service exceptions errors