org.turro.mail.queue.QueueManager Class Reference

Public Member Functions
MailItem	addToQueue (NotificationCategory category, IContact contact, MailMessage mmt, String reason, String poolName)
MailItem	addToQueue (NotificationCategory category, IContact contact, String subject, String message, String reason, String poolName)
void	checkConfiguration (IContact contact, String idCategory, QueuePeriod queuePeriod)
void	setPeriod (IContact contact, String idCategory, QueuePeriod queuePeriod, boolean override)
void	subscribeDefaults (ConstraintKeys keys)
QueueOptions	getConfiguration (IContact contact, String idCategory)
QueueOptions	configQueue (QueueOptions qo)
boolean	contactWants (IContact contact, String idCategory)
boolean	contactMayWant (IContact contact, String idCategory)
List< MailItem >	getPending (QueuePeriod period)
ContactMap	getContactMap (List< MailItem > list)
void	removeUniquesFor (String idCategory, String idContact)
void	removeMails (QueuePeriod period, String idContact, String idCategory)
void	removeContactMails (String idContact)
void	removeWithoutOptions ()
void	removeOldsByPeriod ()
void	removeOptions (String idCategory)
void	setPeriodToAll (String idCategory, QueuePeriod period)
void	checkConstraints (String idCategory)
Collection< QueueOptions >	getSubcribers (String idCategory)
Collection< Long >	getSubcribersId (String idCategory)
void	createBulk ()
void	removeMail (MailItem mi)
void	removeOptions (QueueOptions qo)
Collection< QueueOptions >	getSubcribersByRoot (String root)

Static Public Member Functions
static void	send (IConstructor constructor, QueuePeriod period)

Detailed Description

Author

Lluis Turró Cutiller lluis.nosp@m.@tur.nosp@m.ro.or.nosp@m.g

Definition at line 48 of file QueueManager.java.

Member Function Documentation

addToQueue() [1/2]

MailItem org.turro.mail.queue.QueueManager.addToQueue	(	NotificationCategory	category,
		IContact	contact,
		MailMessage	mmt,
		String	reason,
		String	poolName
	)

Definition at line 67 of file QueueManager.java.

                                                           {
    if(contact.isWebUser()) {
      MailItem mi = new MailItem();
      mi.setIdCategory(category.getIdCategory());
      mi.setCategory(category.getCategory());
      mi.setDescription(category.getDescription());
      mi.setIContact(contact);
      mi.setItemDate(mmt.getSentDate());
      mi.setSubject(mmt.getSubject());
      mi.setMessage(mmt.getMessage());
      mi.setReason(cleanSubject(reason));
      mi.setPoolName(poolName);
      if(category.isUnique()) {
        removeUniquesFor(category.getIdCategory(), contact.getId());
      }
      checkConfiguration(contact, category.getIdCategory(), category.getDefaultPeriod());
      return getDao().saveObject(mi);
    }
    return null;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

addToQueue() [2/2]

MailItem org.turro.mail.queue.QueueManager.addToQueue	(	NotificationCategory	category,
		IContact	contact,
		String	subject,
		String	message,
		String	reason,
		String	poolName
	)

Definition at line 89 of file QueueManager.java.

                                                                          {
    if(contact.isWebUser()) {
      MailItem mi = new MailItem();
      mi.setIdCategory(category.getIdCategory());
      mi.setCategory(category.getCategory());
      mi.setDescription(category.getDescription());
      mi.setIContact(contact);
      mi.setItemDate(new Date());
      mi.setSubject(subject);
      mi.setMessage(message);
      mi.setReason(cleanSubject(reason));
      mi.setPoolName(poolName);
      if(category.isUnique()) {
        removeUniquesFor(category.getIdCategory(), contact.getId());
      }
      checkConfiguration(contact, category.getIdCategory(), category.getDefaultPeriod());
      return getDao().saveObject(mi);
    }
    return null;
  }

checkConfiguration()

void org.turro.mail.queue.QueueManager.checkConfiguration	(	IContact	contact,
		String	idCategory,
		QueuePeriod	queuePeriod
	)

Definition at line 111 of file QueueManager.java.

                                                                                               {
    QueueOptions qo = getConfiguration(contact, idCategory);
    if(qo == null) {
      qo = new QueueOptions();
      qo.setIdCategory(idCategory);
      qo.setIdContact(contact.getId());
      qo.setPeriod(queuePeriod);
      qo.setSingleMail(true);
      configQueue(qo);
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

checkConstraints()

void org.turro.mail.queue.QueueManager.checkConstraints

(

String

idCategory

)

Definition at line 290 of file QueueManager.java.

                                                  {
    NotificationCategory nc = Notifications.getCategory(idCategory);
    if(nc.getConstraints().isRestricted()) {
      List<QueueOptions> toDelete = new ArrayList<>();
      SqlClause.select("o").from("QueueOptions o")
              .where().equal("o.idCategory", idCategory)
              .dao(getDao())
              .resultList(QueueOptions.class)
              .forEach(o -> {
                IContact contact = Contacts.getContactById(o.getIdContact());
                if(contact.isValid()) {
                  ConstraintKeys keys = ConstraintKeys.from(contact);
                  if(!nc.strongBond(keys)) {
                    toDelete.add(o);
                    //removeOptions(getConfiguration(keys.contact(), nc.getIdCategory()));
                  }
                } else {
                  toDelete.add(o);
                }
              });
      getDao().deleteCollection(toDelete);
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

configQueue()

QueueOptions org.turro.mail.queue.QueueManager.configQueue

(

QueueOptions

qo

)

Definition at line 156 of file QueueManager.java.

                                                   {
    return getDao().saveObject(qo);
  }

Here is the caller graph for this function:

contactMayWant()

boolean org.turro.mail.queue.QueueManager.contactMayWant	(	IContact	contact,
		String	idCategory
	)

Definition at line 165 of file QueueManager.java.

                                                                     {
    QueueOptions qo = getConfiguration(contact, idCategory);
    return qo == null || !QueuePeriod.DONT_SEND.equals(qo.getPeriod());
  }

Here is the call graph for this function:

Here is the caller graph for this function:

contactWants()

boolean org.turro.mail.queue.QueueManager.contactWants	(	IContact	contact,
		String	idCategory
	)

Definition at line 160 of file QueueManager.java.

                                                                   {
    QueueOptions qo = getConfiguration(contact, idCategory);
    return qo != null && !QueuePeriod.DONT_SEND.equals(qo.getPeriod());
  }

Here is the call graph for this function:

Here is the caller graph for this function:

createBulk()

void org.turro.mail.queue.QueueManager.createBulk

(

)

Definition at line 330 of file QueueManager.java.

                           {
//    IContact contact = Contacts.getContactByEmail("lluis@turro.org");
//    if(contact != null && contact.isWebUser()) {
//      QueueOptions qo = new QueueOptions();
//      qo.setIdCategory("/myissues");
//      qo.setIdContact(contact.getId());
//      qo.setPeriod(QueuePeriod.AS_GENERATED);
//      qo.setSingleMail(true);
//      configQueue(qo);
//      MailItem mi = new MailItem();
//      mi.setIdCategory("/myissues");
//      mi.setIContact(contact);
//      mi.setDescription("cosa");
//      mi.setCategory("My issues");
//      mi.setItemDate(new Date());
//      mi.setMessage("Message");
//      mi.setSubject("Subject");
//      mi.setPoolName("Dossier");
//      addToQueue(mi);
//    }
  }

getConfiguration()

QueueOptions org.turro.mail.queue.QueueManager.getConfiguration	(	IContact	contact,
		String	idCategory
	)

Definition at line 146 of file QueueManager.java.

                                                                            {
    WhereClause wc = new WhereClause();
    wc.addClause("select o from QueueOptions o");
    wc.addClause("where o.idContact = :idContact");
    wc.addClause("and o.idCategory = :idCategory");
    wc.addNamedValue("idContact", contact.getId());
    wc.addNamedValue("idCategory", idCategory);
    return (QueueOptions) getDao().getSingleResultOrNull(wc);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getContactMap()

ContactMap org.turro.mail.queue.QueueManager.getContactMap

(

List< MailItem >

list

)

Definition at line 181 of file QueueManager.java.

                                                       {
    ContactMap cm = new ContactMap();
    for(MailItem mi : list) {
      cm.addMailItem(mi);
    }
    return cm;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getPending()

List<MailItem> org.turro.mail.queue.QueueManager.getPending

(

QueuePeriod

period

)

Definition at line 170 of file QueueManager.java.

                                                       {
    WhereClause wc = new WhereClause();
    wc.addClause("select m from MailItem m, QueueOptions o");
    wc.addClause("where o.period = :period");
    wc.addClause("and m.idContact = o.idContact");
    wc.addClause("and m.idCategory = o.idCategory");
    wc.addClause("order by m.idContact, m.idCategory");
    wc.addNamedValue("period", period);
    return getDao().getResultList(wc);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getSubcribers()

Collection<QueueOptions> org.turro.mail.queue.QueueManager.getSubcribers

(

String

idCategory

)

Definition at line 314 of file QueueManager.java.

                                                                   {
    WhereClause wc = new WhereClause();
    wc.addClause("select o from QueueOptions o");
    wc.addClause("where o.idCategory = :category");
    wc.addNamedValue("category", idCategory);
    return getDao().getResultList(wc);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getSubcribersByRoot()

Collection<QueueOptions> org.turro.mail.queue.QueueManager.getSubcribersByRoot

(

String

root

)

Definition at line 371 of file QueueManager.java.

                                                                   {
    WhereClause wc = new WhereClause();
    wc.addClause("select o from QueueOptions o");
    wc.addClause("where o.idCategory like :category");
    wc.addNamedValue("category", root + "/%");
    return getDao().getResultList(wc);
  }

Here is the call graph for this function:

getSubcribersId()

Collection<Long> org.turro.mail.queue.QueueManager.getSubcribersId

(

String

idCategory

)

Definition at line 322 of file QueueManager.java.

                                                             {
    WhereClause wc = new WhereClause();
    wc.addClause("select o.id from QueueOptions o");
    wc.addClause("where o.idCategory = :category");
    wc.addNamedValue("category", idCategory);
    return getDao().getResultList(wc);
  }

Here is the call graph for this function:

removeContactMails()

void org.turro.mail.queue.QueueManager.removeContactMails

(

String

idContact

)

Definition at line 216 of file QueueManager.java.

                                                   {
    WhereClause wc = new WhereClause();
    wc.addClause("delete from MailItem m");
    wc.addClause("where m.idContact = :contact");
    wc.addNamedValue("contact", idContact);
    getDao().executeUpdate(wc);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

removeMail()

void org.turro.mail.queue.QueueManager.removeMail

(

MailItem

mi

)

Definition at line 352 of file QueueManager.java.

                                      {
    getDao().deleteObject(mi);
  }

removeMails()

void org.turro.mail.queue.QueueManager.removeMails	(	QueuePeriod	period,
		String	idContact,
		String	idCategory
	)

Definition at line 199 of file QueueManager.java.

                                                                                   {
    WhereClause wc = new WhereClause();
    wc.addClause("delete from MailItem m");
    wc.addClause("where m.idContact = :contact");
    wc.addClause("and m.idCategory = :category");
    wc.addClause("and exists (");
    wc.addClause("select o from QueueOptions o");
    wc.addClause("where o.period = :period");
    wc.addClause("and m.idContact = o.idContact");
    wc.addClause("and m.idCategory = o.idCategory");
    wc.addClause(")");
    wc.addNamedValue("contact", idContact);
    wc.addNamedValue("category", idCategory);
    wc.addNamedValue("period", period);
    getDao().executeUpdate(wc);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

removeOldsByPeriod()

void org.turro.mail.queue.QueueManager.removeOldsByPeriod

(

)

Definition at line 235 of file QueueManager.java.

                                   {
    WhereClause wc = new WhereClause();
    wc.addClause("delete from MailItem m");
    wc.addClause("where exists (");
    wc.addClause("select o from QueueOptions o");
    wc.addClause("where m.idContact = o.idContact");
    wc.addClause("and m.idCategory = o.idCategory");
    wc.addClause("and (");
    wc.addClause("o.period = :dontSend");
    wc.addClause("or (o.period = :asGenerated and m.itemDate < :oneDay)");
    wc.addClause("or (o.period = :daily and m.itemDate < :oneDay)");
    wc.addClause("or (o.period = :weekly and m.itemDate < :oneWeek)");
    wc.addClause("or (o.period = :fortnightly and m.itemDate < :twoWeeks)");
    wc.addClause("or (o.period = :monthly and m.itemDate < :oneMonth)");
    wc.addClause("or (o.period = :quarterly and m.itemDate < :threeMonths)");
    wc.addClause("or (o.period = :everySix and m.itemDate < :sixMonths)");
    wc.addClause("or (o.period = :yearly and m.itemDate < :oneYear)");
    wc.addClause("))");
    wc.addNamedValue("dontSend", QueuePeriod.DONT_SEND);
    wc.addNamedValue("asGenerated", QueuePeriod.AS_GENERATED);
    wc.addNamedValue("daily", QueuePeriod.DAILY);
    wc.addNamedValue("oneDay", new CheckDate().addDays(-2).getDate());
    wc.addNamedValue("weekly", QueuePeriod.WEEKLY);
    wc.addNamedValue("oneWeek", new CheckDate().addWeeks(-1).addDays(-2).getDate());
    wc.addNamedValue("fortnightly", QueuePeriod.FORTNIGHTLY);
    wc.addNamedValue("twoWeeks", new CheckDate().addWeeks(-2).addDays(-2).getDate());
    wc.addNamedValue("monthly", QueuePeriod.MONTHLY);
    wc.addNamedValue("oneMonth", new CheckDate().addMonths(-1).addDays(-2).getDate());
    wc.addNamedValue("quarterly", QueuePeriod.QUARTERLY);
    wc.addNamedValue("threeMonths", new CheckDate().addMonths(-3).addDays(-2).getDate());
    wc.addNamedValue("everySix", QueuePeriod.EVERY_SIX_MONTHS);
    wc.addNamedValue("sixMonths", new CheckDate().addMonths(-6).addDays(-2).getDate());
    wc.addNamedValue("yearly", QueuePeriod.YEARLY);
    wc.addNamedValue("oneYear", new CheckDate().addYears(-1).addDays(-2).getDate());
    getDao().executeUpdate(wc);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

removeOptions() [1/2]

void org.turro.mail.queue.QueueManager.removeOptions

(

QueueOptions

qo

)

Definition at line 356 of file QueueManager.java.

                                             {
    if(qo != null) getDao().deleteObject(qo);
  }

removeOptions() [2/2]

void org.turro.mail.queue.QueueManager.removeOptions

(

String

idCategory

)

Definition at line 272 of file QueueManager.java.

                                               {
    WhereClause wc = new WhereClause();
    wc.addClause("delete from QueueOptions o");
    wc.addClause("where o.idCategory = :category");
    wc.addNamedValue("category", idCategory);
    getDao().executeUpdate(wc);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

removeUniquesFor()

void org.turro.mail.queue.QueueManager.removeUniquesFor	(	String	idCategory,
		String	idContact
	)

Definition at line 189 of file QueueManager.java.

                                                                    {
    WhereClause wc = new WhereClause();
    wc.addClause("delete from MailItem m");
    wc.addClause("where m.idContact = :contact");
    wc.addClause("and m.idCategory = :category");
    wc.addNamedValue("contact", idContact);
    wc.addNamedValue("category", idCategory);
    getDao().executeUpdate(wc);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

removeWithoutOptions()

void org.turro.mail.queue.QueueManager.removeWithoutOptions

(

)

Definition at line 224 of file QueueManager.java.

                                     {
    WhereClause wc = new WhereClause();
    wc.addClause("delete from MailItem m");
    wc.addClause("where not exists (");
    wc.addClause("select o from QueueOptions o");
    wc.addClause("where m.idContact = o.idContact");
    wc.addClause("and m.idCategory = o.idCategory");
    wc.addClause(")");
    getDao().executeUpdate(wc);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

send()

static void org.turro.mail.queue.QueueManager.send ( IConstructor  constructor, QueuePeriod  period  )

static

Definition at line 50 of file QueueManager.java.

                                                                        {
    boolean lockAcquired = QUEUEMANAGER_LOCK.tryLock();
    if(lockAcquired) {
      try {
        QueueManager qm = new QueueManager();
        qm.removeWithoutOptions();
        qm.removeOldsByPeriod();
        ContactMap cm = qm.getContactMap(qm.getPending(period));
        for(String idContact : cm.keySet()) {
          new ContactQueueSender(constructor, qm, period, cm.get(idContact)).send();
        }
      } finally {
        QUEUEMANAGER_LOCK.unlock();
      }
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

setPeriod()

void org.turro.mail.queue.QueueManager.setPeriod	(	IContact	contact,
		String	idCategory,
		QueuePeriod	queuePeriod,
		boolean	override
	)

Definition at line 123 of file QueueManager.java.

                                                                                                        {
    QueueOptions qo = getConfiguration(contact, idCategory);
    if(qo != null && !override) return;
    if(qo == null) {
      qo = new QueueOptions();
      qo.setIdCategory(idCategory);
      qo.setIdContact(contact.getId());
      qo.setSingleMail(true);
    }
    qo.setPeriod(queuePeriod);
    configQueue(qo);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

setPeriodToAll()

void org.turro.mail.queue.QueueManager.setPeriodToAll	(	String	idCategory,
		QueuePeriod	period
	)

Definition at line 280 of file QueueManager.java.

                                                                    {
    WhereClause wc = new WhereClause();
    wc.addClause("update QueueOptions o");
    wc.addClause("set o.period = :period");
    wc.addClause("where o.idCategory = :category");
    wc.addNamedValue("period", period);
    wc.addNamedValue("category", idCategory);
    getDao().executeUpdate(wc);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

subscribeDefaults()

void org.turro.mail.queue.QueueManager.subscribeDefaults

(

ConstraintKeys

keys

)

Definition at line 136 of file QueueManager.java.

                                                     {
    for(NotificationCategory nc : Notifications.getCategories()) {
      if(nc.wideBond(keys)) {
        checkConfiguration(keys.contact(), nc.getIdCategory(), nc.getDefaultPeriod());
      } else if(!nc.strongBond(keys)) {
        removeOptions(getConfiguration(keys.contact(), nc.getIdCategory()));
      }
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• QueueManager.java