/**
    * This file Copyright (c) 2008-2011 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.module.observation;
  
  import javax.jcr.observation.Event;
  import javax.jcr.observation.EventListener;
  
  import org.apache.jackrabbit.core.observation.SynchronousEventListener;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * Bean for the observation module, loaded automatically by Content2Bean.
   * 
   * @author tmiyar
   * 
   */
  public class ObservationConfiguration {
      private final static Logger log = LoggerFactory
              .getLogger(ObservationConfiguration.class);
  
      // name with which you will identify your event listener
      private String name;
  
      // text with some description
      private String description;
  
      // allows to activate/deactivate the event listener
      private boolean active = false;
  
      // the types for which the event listener will be triggered, if more than
      // one separate them by ","
      // possible values
      // NODE_ADDED,NODE_REMOVED,PROPERTY_ADDED,PROPERTY_CHANGED,PROPERTY_REMOVED
      private String eventTypes = "NODE_ADDED,NODE_REMOVED,PROPERTY_ADDED,PROPERTY_CHANGED,PROPERTY_REMOVED";
  
      // path where the event listener will be active
      private String path;
  
      // the repository where the event listener will be activated
      private String repository;
  
      // to restrict for which nodes would the event listener be active, if empty,
      // it will be active for all node types
      private String nodeType = null;
  
      // the event listener will be executed for the subnodes as well
      private boolean includeSubNodes = false;
  
      // time you want to wait to activate an event listener
      private long delay;
  
      // max time to wait before activating the event listener
      private long maxDelay;
  
      // the listener instance of the eventlistener when the delay and maxdelay
      // are specified,
      // not for the configuration
      public EventListener deferredListener;
  
      // user listener instance
      private EventListener listener;
  
      public SynchronousEventListener synchListener;
  
      private boolean synchronous = false;
  
      public boolean isSynchronous() {
         return synchronous;
     }
 
     public void setSynchronous(boolean synchronous) {
         this.synchronous = synchronous;
     }
 
     public ObservationConfiguration() {
     }
 
     public ObservationConfiguration(String name, String description,
             boolean active, EventListener listener, String repository,
             String path, String eventTypes, boolean includeSubNodes,
             String nodeType, long delay, long maxDelay) {
 
         this.name = name;
         this.description = description;
         this.active = active;
         this.listener = listener;
         this.repository = repository;
         this.path = path;
         this.eventTypes = eventTypes;
         this.includeSubNodes = includeSubNodes;
         this.nodeType = nodeType;
         this.delay = delay;
         this.maxDelay = maxDelay;
     }
 
     public long getDelay() {
         return delay;
     }
 
     public void setDelay(long delay) {
         this.delay = delay;
     }
 
     public long getMaxDelay() {
         return maxDelay;
     }
 
     public void setMaxDelay(long maxDelay) {
         this.maxDelay = maxDelay;
     }
 
     public String getNodeType() {
         return nodeType;
     }
 
     public void setNodeType(String nodeType) {
         this.nodeType = nodeType;
     }
 
     public boolean getIncludeSubNodes() {
         return includeSubNodes;
     }
 
     public void setIncludeSubNodes(boolean includeSubNodes) {
         this.includeSubNodes = includeSubNodes;
     }
 
     public boolean isActive() {
         return active;
     }
 
     public void setActive(boolean active) {
         this.active = active;
     }
 
     public String getDescription() {
         return description;
     }
 
     public void setDescription(String description) {
         this.description = description;
     }
 
     public EventListener getListener() {
         return this.listener;
     }
 
     public void setListener(EventListener listener) {
         this.listener = listener;
     }
 
     /**
      * Gets custom user name (node name) for the eventlistener configuration.
      */
     public String getName() {
         return name;
     }
 
     /**
      * Sets custom user name (node name) for the eventlistener configuration.
      */
     public void setName(String name) {
         this.name = name;
     }
 
     public String getEventTypes() {
         return eventTypes;
     }
 
     public void setEventTypes(String eventTypes) {
         if (eventTypes != null && eventTypes.length() > 0) {
             this.eventTypes = eventTypes;
         }
         getConvertedEventTypes();
     }
 
     public String getPath() {
         return path;
     }
 
     public void setPath(String path) {
         this.path = path;
     }
 
     public String getRepository() {
         return repository;
     }
 
     public void setRepository(String repository) {
         this.repository = repository;
     }
 
     /**
      * Translates the eventTypes String into int value.
      */
     public int getConvertedEventTypes() {
 
         String[] eTypes = eventTypes.split(",");
         int eConvertedTypes = 0;
         String item;
         for (int i = 0; i < eTypes.length; i++) {
             item = (eTypes[i]).trim();
             if (item.equals("NODE_ADDED")) {
                 eConvertedTypes |= Event.NODE_ADDED;
             } else if (item.equals("NODE_REMOVED")) {
                 eConvertedTypes |= Event.NODE_REMOVED;
             } else if (item.equals("PROPERTY_ADDED")) {
                 eConvertedTypes |= Event.PROPERTY_ADDED;
             } else if (item.equals("PROPERTY_CHANGED")) {
                 eConvertedTypes |= Event.PROPERTY_CHANGED;
             } else if (item.equals("PROPERTY_REMOVED")) {
                 eConvertedTypes |= Event.PROPERTY_REMOVED;
             } else {
                 log.error("Event Type not recognized " + item);
             }
         }
         return eConvertedTypes;
     }
 
     /**
      * If all mandatory fields are present and valid we can instantiate the event listener.
      */
     public boolean isPopulated() {
         boolean isPopulated = false;
         if (this.repository != null && this.repository.length() > 0
                 && this.path != null && this.path.length() > 0
                 && this.getConvertedEventTypes() > 0
                 && this.getListener() != null) {
             isPopulated = true;
         }
         return isPopulated;
     }
 
 }