/**
    * This file Copyright (c) 2008-2013 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.cache;
  
  import info.magnolia.module.cache.executor.Bypass;
  
  import java.util.HashMap;
  import java.util.Map;
  
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * Each CacheConfiguration holds a CachePolicy, a FlushPolicy and a
   * BrowserCachePolicy. Based on the outcome of the cachePolicy the defined
   * executors will be called.
   * 
   * @see CachePolicy
   * @see FlushPolicy
   * @author gjoseph
   * @version $Revision: $ ($Author: $)
   */
  public class CacheConfiguration {
  
      private static Logger log = LoggerFactory.getLogger(CacheConfiguration.class);
  
      private String name;
      private CachePolicy cachePolicy;
      private FlushPolicy flushPolicy;
      private BrowserCachePolicy browserCachePolicy;
  
      private Map<String, CachePolicyExecutor> executors = new HashMap<String, CachePolicyExecutor>();
  
      public CacheConfiguration() {
      }
  
      /**
       * This constructor is intended for tests only. For regular use, instantiate this class from its repository configuration using content2bean.
       */
      CacheConfiguration(String name, CachePolicy cachePolicy, FlushPolicy flushPolicy) {
          this.name = name;
          this.cachePolicy = cachePolicy;
          this.flushPolicy = flushPolicy;
      }
  
      public String getName() {
          return name;
      }
  
      public void setName(String name) {
          this.name = name;
      }
  
      public CachePolicy getCachePolicy() {
          if (cachePolicy != null) {
              return cachePolicy;
          }
          // someone probably deleted cachePolicy node - fallback to no cache policy
          log.error("Check your cache configuration! CachePolicy is probably not set! Falling back Never cache policy.");
          return new info.magnolia.module.cache.cachepolicy.Never();
      }
  
      public void setCachePolicy(CachePolicy cachePolicy) {
          this.cachePolicy = cachePolicy;
      }
  
      public FlushPolicy getFlushPolicy() {
          if (flushPolicy != null) {
             return flushPolicy;
         }
         // someone probably deleted flushPolicy node - fallback to FlushAllListeningPolicy
         log.error("Check your cache configuration! FlushPolicy is probably not set! Falling back to FlushAllListeningPolicy.");
         return new FlushAllListeningPolicy();
     }
 
     public void setFlushPolicy(FlushPolicy flushPolicy) {
         this.flushPolicy = flushPolicy;
     }
 
     public CachePolicyExecutor getExecutor(CachePolicyResult.CachePolicyBehaviour behaviour) {
         if (executors.containsKey(behaviour.getName())) {
             return executors.get(behaviour.getName());
         }
         // someone probably deleted executors node - fallback to bypass cache policy
         log.error("Check your cache configuration! Executor " + behaviour.getName() + " is probably not set! Bypassing cache.");
         return new Bypass();
     }
 
     public BrowserCachePolicy getBrowserCachePolicy() {
         if (browserCachePolicy != null) {
             return browserCachePolicy;
         }
         // someone probably deleted cachePolicy node - fallback to no cache policy
         log.error("Check your cache configuration! BrowserCachePolicy is probably not set! Falling back to Never cache policy.");
         return new info.magnolia.module.cache.browsercachepolicy.Never();
     }
 
     public void setBrowserCachePolicy(BrowserCachePolicy browserCachePolicy) {
         this.browserCachePolicy = browserCachePolicy;
     }
 
     public Map<String, CachePolicyExecutor> getExecutors() {
         return executors;
     }
 
     public void setExecutors(Map<String, CachePolicyExecutor> executors) {
         this.executors = executors;
     }
 
     public void addExecutor(String name, CachePolicyExecutor executor) {
         executor.setCacheConfiguration(this);
         this.executors.put(name, executor);
     }
 
 }