View Javadoc
1   /**
2    * This file Copyright (c) 2015-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.templating.imaging;
35  
36  import info.magnolia.imaging.DefaultImagingSupport;
37  import info.magnolia.imaging.ImagingSupport;
38  import info.magnolia.imaging.variation.Variation;
39  
40  import java.util.LinkedHashMap;
41  import java.util.Map;
42  
43  import javax.jcr.Property;
44  
45  import org.slf4j.Logger;
46  import org.slf4j.LoggerFactory;
47  
48  /**
49   * {@link info.magnolia.imaging.ImagingSupport} that provides support for
50   * {@link info.magnolia.imaging.variation.Variation}s.
51   */
52  public class VariationAwareImagingSupport extends DefaultImagingSupport {
53  
54      private static final Logger log = LoggerFactory.getLogger(VariationAwareImagingSupport.class);
55  
56      private Map<String, Variation> variations = new LinkedHashMap<String, Variation>();
57      private boolean enabled = true;
58  
59      public Map<String, Variation> getVariations() {
60          return variations;
61      }
62  
63      @Override
64      public String createLink(Property binaryProperty, String variationName) {
65          if (isEnabled() && !ImagingSupport.VARIATION_ORIGINAL.equals(variationName)) {
66              if (variations.containsKey(variationName)) {
67                  return variations.get(variationName).createLink(binaryProperty);
68              } else {
69                  log.warn("Supplied variation [{}] could not be found. Please update your configuration.", variationName);
70              }
71          }
72  
73          return createLink(binaryProperty);
74      }
75  
76      public void setVariations(Map<String, Variation> variations) {
77          this.variations = variations;
78      }
79  
80      public void addVariation(String name, Variation variation) {
81          this.variations.put(name, variation);
82      }
83  
84      public boolean isEnabled() {
85          return enabled;
86      }
87  
88      public void setEnabled(boolean enabled) {
89          this.enabled = enabled;
90      }
91  
92  }