Class BrevoSynchronisationServiceImpl

java.lang.Object

ch.tocco.nice2.optional.newsletterbrevo.impl.BrevoSynchronisationServiceImpl

All Implemented Interfaces:

BrevoSynchronisationService

Direct Known Subclasses:

StubBrevoSynchronisationService

@ConditionalOnExpression("'${spring.profiles.active}' == 'production' || !${nice2.brevo.disableTestSync:true}")
@Component
public class BrevoSynchronisationServiceImpl
extends Object
implements BrevoSynchronisationService

Nested Class Summary

Nested classes/interfaces inherited from interface BrevoSynchronisationService

BrevoSynchronisationService.AttributePath, BrevoSynchronisationService.AttributeType, BrevoSynchronisationService.SimpleContact

Constructor Summary

Constructors

Constructor	Description
BrevoSynchronisationServiceImpl(PersistenceService persistenceService, org.slf4j.Logger logger, QueryBuilderResultHelperService queryBuilderResultHelperService)

Method Summary

Modifier and Type	Method	Description
void	createAttribute(String name, BrevoSynchronisationService.AttributeType type, EntityList values)	creates a new attribute
void	deleteAttribute(String name, BrevoSynchronisationService.AttributeType type)	delete an attribute
void	getAllContacts(long batchSize, Consumer<Tuple2<Long, List<BrevoSynchronisationService.SimpleContact>>> contactConsumer)	This method will retrieve all contacts of the current brevo account.
List<String>	getAttributes()
brevoModel.GetExtendedContactDetails	getContactInfo(String email)	Returns the contact details for a given email address
void	importUsers(long listId, Condition synchronisationCondition, List<BrevoSynchronisationService.AttributePath> attributes)	Import users to brevo.
boolean	isEmailAddressInUse(String email)	despite ContactsApi.getContactInfoWithHttpInfo(String, String, String, String) (String, Object, Object)} existing, a 404 still throws an exception instead of just returning the code so we can handle it ourselves.
String	normalizeAttributeName(String name)	adjust a string to be a valid brevo attribute name this means the string fulfills the following conditions: - is all upper case - starts with a later (prepend X if not fulfilled) - has no spaces (replace with underscores if not fulfilled)
void	removeUsersFromList(long listId, Condition synchronisationCondition)
void	setImportLimit(int importLimit)
void	setRemoveFromListLimit(int removeFromListLimit)
long	synchroniseFolder(Entity folder)	Synchronises a tocco folder to brevo.
long	synchroniseList(long folderId, Entity newsletterCategory)	Synchronises a newsletter category with brevo.
void	updateAttribute(String name, BrevoSynchronisationService.AttributeType type, EntityList values)	update attribute, only useful for category attributes, others need to be deleted and recreated for changes
void	updateBlocklists(String email, List<String> selectedBlocklists)	update blocklist entries in brevo make sure that the email address exist in Brevo before updating it, see BrevoSynchronisationService.isEmailAddressInUse(String)
void	updateEmailAddresses(Map<String,String> changes)	update email addresses in brevo make sure that the email addresses exist in Brevo before updating them, see BrevoSynchronisationService.isEmailAddressInUse(String)

Methods inherited from class Object

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

Constructor Details

BrevoSynchronisationServiceImpl

public BrevoSynchronisationServiceImpl(PersistenceService persistenceService,
 org.slf4j.Logger logger,
 QueryBuilderResultHelperService queryBuilderResultHelperService)

Method Details

synchroniseFolder

public long synchroniseFolder(Entity folder)

Description copied from interface: BrevoSynchronisationService

Synchronises a tocco folder to brevo.

Specified by:

synchroniseFolder in interface BrevoSynchronisationService

Parameters:

folder - the brevo folder entity to be synchronised

Returns:

id of the folder in brevo

synchroniseList

public long synchroniseList(long folderId,
 Entity newsletterCategory)

Description copied from interface: BrevoSynchronisationService

Synchronises a newsletter category with brevo. Newsletter categories are mapped to lists in brevo.

Specified by:

synchroniseList in interface BrevoSynchronisationService

Parameters:

folderId - the folder id to be used to create new newsletter categories

newsletterCategory - the newsletter category to be synchronised

Returns:

id of the list in brevo

importUsers

public void importUsers(long listId,
 Condition synchronisationCondition,
 List<BrevoSynchronisationService.AttributePath> attributes)

Description copied from interface: BrevoSynchronisationService

Import users to brevo. Users are transformed to "contacts" and then imported to brevo using the import endpoint. The import endpoint handles creating / updating users and maps users using the email address.

Specified by:

importUsers in interface BrevoSynchronisationService

Parameters:

listId - the list id to which the users should be added.

synchronisationCondition - query builder condition to be used to select the users to be synchronised

removeUsersFromList

public void removeUsersFromList(long listId,
 Condition synchronisationCondition)

Specified by:

removeUsersFromList in interface BrevoSynchronisationService

getAttributes

public List<String> getAttributes()

Specified by:

getAttributes in interface BrevoSynchronisationService

Returns:

names of all attributes configured in brevo

createAttribute

public void createAttribute(String name,
 BrevoSynchronisationService.AttributeType type,
 EntityList values)

Description copied from interface: BrevoSynchronisationService

creates a new attribute

Specified by:

createAttribute in interface BrevoSynchronisationService

Parameters:

name - the name of the attribute, make sure it is normalized with BrevoSynchronisationService.normalizeAttributeName(String)

type - the type of the attribute

values - the Brevo_attribute_value entities the attribute can take, only relevant for category attributes

updateAttribute

public void updateAttribute(String name,
 BrevoSynchronisationService.AttributeType type,
 EntityList values)

Description copied from interface: BrevoSynchronisationService

update attribute, only useful for category attributes, others need to be deleted and recreated for changes

Specified by:

updateAttribute in interface BrevoSynchronisationService

Parameters:

name - the name of the attribute, make sure it is normalized with BrevoSynchronisationService.normalizeAttributeName(String)

type - the type of the attribute

values - the Brevo_attribute_value entities the attribute can take, only relevant for category attributes

deleteAttribute

public void deleteAttribute(String name,
 BrevoSynchronisationService.AttributeType type)

Description copied from interface: BrevoSynchronisationService

delete an attribute

Specified by:

deleteAttribute in interface BrevoSynchronisationService

Parameters:

name - the name of the attribute, make sure it is normalized with BrevoSynchronisationService.normalizeAttributeName(String)

type - the type of the attribute

normalizeAttributeName

public String normalizeAttributeName(String name)

Description copied from interface: BrevoSynchronisationService

adjust a string to be a valid brevo attribute name this means the string fulfills the following conditions: - is all upper case - starts with a later (prepend X if not fulfilled) - has no spaces (replace with underscores if not fulfilled)

Specified by:

normalizeAttributeName in interface BrevoSynchronisationService

Parameters:

name - any string

Returns:

a valid attribute name

updateEmailAddresses

public void updateEmailAddresses(Map<String,String> changes)

Description copied from interface: BrevoSynchronisationService

update email addresses in brevo make sure that the email addresses exist in Brevo before updating them, see BrevoSynchronisationService.isEmailAddressInUse(String)

Specified by:

updateEmailAddresses in interface BrevoSynchronisationService

Parameters:

changes - a map containing the current email addresses as keys, and the new email addresses as values

updateBlocklists

public void updateBlocklists(String email,
 List<String> selectedBlocklists)

Description copied from interface: BrevoSynchronisationService

update blocklist entries in brevo make sure that the email address exist in Brevo before updating it, see BrevoSynchronisationService.isEmailAddressInUse(String)

Specified by:

updateBlocklists in interface BrevoSynchronisationService

Parameters:

email - the email for which the blocklist entries should be updated

selectedBlocklists - a list of strings of the selected blocklist unique_ids (possible values: "email", "sms")

getContactInfo

public brevoModel.GetExtendedContactDetails getContactInfo(String email)
                                                    throws brevo.ApiException

Description copied from interface: BrevoSynchronisationService

Returns the contact details for a given email address

Specified by:

getContactInfo in interface BrevoSynchronisationService

Throws:

brevo.ApiException

isEmailAddressInUse

public boolean isEmailAddressInUse(String email)

despite ContactsApi.getContactInfoWithHttpInfo(String, String, String, String) (String, Object, Object)} existing, a 404 still throws an exception instead of just returning the code so we can handle it ourselves. this means, we have to catch the exception and read the status code from there

Specified by:

isEmailAddressInUse in interface BrevoSynchronisationService

Parameters:

email - the email address to check

Returns:

true if a contact exists, false other

getAllContacts

public void getAllContacts(long batchSize,
 Consumer<Tuple2<Long, List<BrevoSynchronisationService.SimpleContact>>> contactConsumer)
                    throws brevo.ApiException

Description copied from interface: BrevoSynchronisationService

This method will retrieve all contacts of the current brevo account. It uses paging and will call the consumer with each "page".

Specified by:

getAllContacts in interface BrevoSynchronisationService

Parameters:

batchSize - the batch size to use when retrieving all contacts.

contactConsumer - the consumer that processes the batches. It consumes a tuple containing the count (all contacts) and the current page of contacts.

Throws:

brevo.ApiException

setRemoveFromListLimit

@Value("${nice2.brevo.removeFromListLimit}")
public void setRemoveFromListLimit(int removeFromListLimit)

setImportLimit

@Value("${nice2.brevo.importLimit}")
public void setImportLimit(int importLimit)