/**
    * This file Copyright (c) 2008-2015 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.cms.util.DeprecationUtil;
  import info.magnolia.module.ModuleLifecycleContext;
  import info.magnolia.module.ModuleManager;
  import info.magnolia.module.cache.mbean.CacheMonitor;
  
  import java.util.Collections;
  import java.util.HashMap;
  import java.util.HashSet;
  import java.util.Map;
  import java.util.Set;
  
  import javax.inject.Inject;
  
  /**
   * The CacheModule holds several named ContentCachingConfiguration instances and a CacheFactory.
   *
   * @see ContentCachingConfiguration
   * @see CacheFactory
   */
  public class CacheModule extends AbstractCacheModule {
  
      private final Set<CacheModuleLifecycleListener> listeners = Collections.synchronizedSet(new HashSet<CacheModuleLifecycleListener>());
      private CacheFactory cacheFactory;
      private Map<String, ContentCachingConfiguration> contentCaching = new HashMap<String, ContentCachingConfiguration>();
      private ContentCompression compression;
  
  
      @Inject
      public CacheModule(CacheMonitor cacheMonitor) {
          super(cacheMonitor);
      }
  
      /**
       * @deprecated since 5.4. Use {@link #CacheModule(info.magnolia.module.cache.mbean.CacheMonitor)} intead.
       */
      @Deprecated
      public CacheModule(ModuleManager moduleManager, CacheMonitor cacheMonitor) {
          this(cacheMonitor);
      }
  
      /**
       * Inject {@link info.magnolia.module.cache.inject.CacheFactoryProvider}} instead.
       */
      @Override
      public CacheFactory getCacheFactory() {
          return cacheFactory;
      }
  
      public void setCacheFactory(CacheFactory cacheFactory) {
          this.cacheFactory = cacheFactory;
      }
  
      public Map<String, ContentCachingConfiguration> getContentCaching() {
          return contentCaching;
      }
  
      /**
       * @deprecated since 5.4 use {@link #setContentCaching(java.util.Map)}}
       */
      @Deprecated
      public ContentCachingConfiguration addConfiguration(String name, CacheConfiguration cacheConfiguration) {
          DeprecationUtil.isDeprecated("Use info.magnolia.module.cache.CacheModule#setContentCaching instead.");
          return contentCaching.put(name, cacheConfiguration);
      }
 
     public void setContentCaching(Map<String, ContentCachingConfiguration> contentCaching) {
         this.contentCaching = contentCaching;
     }
 
     public void setCompression(ContentCompression compression) {
         this.compression = compression;
     }
 
     public ContentCompression getCompression() {
         return compression;
     }
 
     public void register(CacheModuleLifecycleListener listener) {
         listeners.add(listener);
     }
 
     /**
      * @deprecated since 5.4 use {@link #getContentCaching(String)}
      */
     @Deprecated
     public ContentCachingConfiguration getConfiguration(String name) {
         DeprecationUtil.isDeprecated("Use info.magnolia.module.cache.CacheModule#getContentCaching instead.");
         return this.getContentCaching(name);
     }
 
     @Override
     public ContentCachingConfiguration getContentCaching(String name) {
         return this.getContentCaching().get(name) != null ? this.getContentCaching().get(name) : this.getContentCaching().get(DEFAULT_CACHE_CONFIG);
     }
 
     // TODO : i still feel like we should separate module config bean and lifecycle
     @Override
     public void start(ModuleLifecycleContext moduleLifecycleContext) {
 
         cacheFactory.start(ModuleLifecycleContext.PHASE_MODULE_RESTART == moduleLifecycleContext.getPhase());
         this.getCacheMonitor().countStart();
 
         // Monitor and start flush policies for every configured pageCache
         for (ContentCachingConfiguration cfg : contentCaching.values()) {
             final String name = cfg.getCacheName();
             this.startCache(name);
         }
 
         for (CacheModuleLifecycleListener listener : listeners) {
             listener.onCacheModuleStart();
         }
     }
 
     @Override
     public void stop(ModuleLifecycleContext moduleLifecycleContext) {
         this.getCacheMonitor().stop();
         for (ContentCachingConfiguration cfg : contentCaching.values()) {
             final String name = cfg.getCacheName();
             this.stopCache(name);
         }
         cacheFactory.stop(ModuleLifecycleContext.PHASE_MODULE_RESTART == moduleLifecycleContext.getPhase());
     }
 }