GenericElephantNotification.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2017 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package org.turro.mail.queue;
 
import java.util.Collection;
import java.util.EnumSet;
import org.turro.action.queue.IElephantNotification;
import org.turro.action.queue.NotificationCategory;
import org.turro.action.queue.NotificationRole;
import org.turro.action.queue.QueuePeriod;
import org.turro.annotation.ElephantNotification;
import org.turro.elephant.entities.db.QueueOptions;
import org.turro.plugin.contacts.IContact;
 
@ElephantNotification
public class GenericElephantNotification implements IElephantNotification {
 
  @Override
  public Collection<NotificationCategory> getCategories() {
    NotificationCategoryMap map = initCategories(this);
    return map.values();
  }
 
  @Override
  public Collection<NotificationCategory> getAllCategories() {
    NotificationCategoryMap map = new NotificationCategoryMap();
    map.putAll(initCategories(this));
    map.putAll(_private);
    return map.values();
  }
 
  @Override
  public Collection<String> getCategoryIds() {
    NotificationCategoryMap map = initCategories(this);
    return map.keySet();
  }
 
  @Override
  public Collection<String> getAllCategoryIds() {
    NotificationCategoryMap map = new NotificationCategoryMap();
    map.putAll(initCategories(this));
    map.putAll(_private);
    return map.keySet();
  }
 
  @Override
  public NotificationCategory getCategory(String id) {
    NotificationCategoryMap map = new NotificationCategoryMap();
    map.putAll(initCategories(this));
    map.putAll(_private);
    return map.get(id);
  }
 
  @Override
  public QueuePeriod period(String idCategory, IContact contact) {
    QueueManager qm = new QueueManager();
    QueueOptions qo = qm.getConfiguration(contact, idCategory);
    return qo != null ? qo.getPeriod() : null;
  }
 
  @Override
  public void subscribe(String idCategory, IContact contact, QueuePeriod period) {
    QueueManager qm = new QueueManager();
    qm.setPeriod(contact, idCategory, period, true);
  }
 
  @Override
  public void subscribeIfNot(String idCategory, IContact contact, QueuePeriod period) {
    QueueManager qm = new QueueManager();
    qm.setPeriod(contact, idCategory, period, false);
  }
 
  @Override
  public void removeAll(String idCategory) {
    QueueManager qm = new QueueManager();
    qm.removeOptions(idCategory);
  }
 
  @Override
  public void periodToAll(String idCategory, QueuePeriod period) {
    QueueManager qm = new QueueManager();
    qm.setPeriodToAll(idCategory, period);
  }
 
  @Override
  public void checkConstraints(String idCategory) {
    //
  }
 
  @Override
  public void reset() {
    // do nothing
  }
 
  /* Categories */
  
  private static NotificationCategoryMap _categories, _private;
  
  public static final String
          GENERIC_NOTIFICATION = "/elephant",
          SYSTEM_NOTIFICATION = "/system";
  
  private static NotificationCategoryMap initCategories(IElephantNotification en) {
    if(_categories == null) {
      _categories = new NotificationCategoryMap();
      _categories.addCategory(GENERIC_NOTIFICATION, 
              "Site notifications", "Includes generic notifications from de web site in contexts where you participate, such as accepted comments.", 
              EnumSet.range(QueuePeriod.DONT_SEND, QueuePeriod.MONTHLY),
              false, QueuePeriod.DAILY, en, NotificationRole.NOTIF_OBSERVER, null, true);
      _private = new NotificationCategoryMap();
      _private.addCategory(SYSTEM_NOTIFICATION, 
              "System notification", "dSystemNotification", 
              EnumSet.range(QueuePeriod.DONT_SEND, QueuePeriod.DAILY),
              false, QueuePeriod.AS_GENERATED, en, NotificationRole.NOTIF_OBSERVER, null, false);
    }
    return _categories;
  }
 
}