cat.albirar.communications.core.services

Interface IReportRegister

All Known Implementing Classes:

ReportRegister

@Validated
public interface IReportRegister

The report register, that hold any report message. The register hold a collection with Map for each report type (see IPropertiesComm.QUEUE_REPORT_EMAIL and IPropertiesComm.QUEUE_REPORT_SMS). When a new message is reported, a collection should to be indicated. When users ask for get report or check if a report exists, all collection are checked for the indicated id. Warning about this, if AlbirarCommunicationsConfiguration.namingStrategy() is no unique over all collections, a collision can be produced if two reports with same id is put on this register.

Since:

1.0.0

Author:

Octavi Fornés <ofornes@albirar.cat>

Method Summary

Modifier and Type	Method and Description
Optional<MessageStatusBean>	getAndDeleteReport(@NotBlank String messageId) Get and delete the report associated with the indicated messageId
Optional<MessageStatusBean>	getReport(@NotBlank String messageId) Get the report about the message with id messageId.
boolean	isReport(@NotBlank String messageId) Check if report for messageId exists.
void	putReport(@NotBlank String collectionId, @NotBlank String messageId, @NotNull @Valid MessageStatusBean report) Put a new report for the messageId onto collection with collectionId id.
Optional<MessageStatusBean>	removeReport(@NotBlank String collectionId, @NotBlank String messageId) Remove, if exists, the report associated with the messageId from the collection with collectionId id.

Method Detail

getReport

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

Get the report about the message with id messageId.

Parameters:

messageId - The key

Returns:

The message or Optional.empty() if no report for that messageId exists.

getAndDeleteReport

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

Get and delete the report associated with the indicated messageId

Parameters:

messageId - The message id

Returns:

The associated report or Optional.empty() if no report exists associated with the indicated messageId

isReport

boolean isReport(@NotBlank
                 @NotBlank String messageId)

Check if report for messageId exists.

Parameters:

messageId -

Returns:

true if exists and false if not

putReport

void putReport(@NotBlank
               @NotBlank String collectionId,
               @NotBlank
               @NotBlank String messageId,
               @NotNull @Valid
               @NotNull @Valid MessageStatusBean report)

Put a new report for the messageId onto collection with collectionId id.

Parameters:

collectionId - The collection id

messageId - The message id

report - The report

removeReport

Optional<MessageStatusBean> removeReport(@NotBlank
                                         @NotBlank String collectionId,
                                         @NotBlank
                                         @NotBlank String messageId)

Remove, if exists, the report associated with the messageId from the collection with collectionId id.

Parameters:

collectionId - The collection id

messageId - The message id

Returns:

The report or Optional.empty() if report was not found