View Javadoc
1   /**
2    * This file Copyright (c) 2014-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.ui.contentapp.imageprovider;
35  
36  import info.magnolia.objectfactory.ComponentProvider;
37  import info.magnolia.ui.api.app.SubAppContext;
38  import info.magnolia.ui.api.app.SubAppDescriptor;
39  import info.magnolia.ui.api.ioc.SubAppScoped;
40  import info.magnolia.ui.contentapp.definition.ContentSubAppDescriptor;
41  import info.magnolia.ui.imageprovider.ImageProvider;
42  import info.magnolia.ui.imageprovider.definition.ImageProviderDefinition;
43  
44  import javax.inject.Inject;
45  
46  import com.google.inject.Provider;
47  
48  /**
49   * Provides the {@link ImageProvider} as configured under current sub-app descriptor.
50   *
51   * @deprecated since 6.0. Use new framework and inject {@link info.magnolia.ui.contentapp.browser.preview.PreviewProvider} annotated with {@link info.magnolia.ui.framework.datasource.DatasourceComponent}.
52   */
53  @Deprecated
54  @SubAppScoped
55  public class ImageProviderProvider implements Provider<ImageProvider> {
56  
57      private ComponentProvider componentProvider;
58  
59      private SubAppContext subAppContext;
60  
61      private ImageProvider imageProvider;
62  
63      @Inject
64      public ImageProviderProvider(ComponentProvider componentProvider, SubAppContext subAppContext) {
65          this.componentProvider = componentProvider;
66          this.subAppContext = subAppContext;
67      }
68  
69      @Override
70      public ImageProvider get() {
71          if (imageProvider == null) {
72              ImageProviderDefinition definition = resolveImageProviderDefinition();
73              if (definition != null) {
74                  imageProvider = componentProvider.newInstance(definition.getImageProviderClass(), definition);
75              }
76          }
77          if (imageProvider == null) {
78              imageProvider = new NullImageProvider();
79          }
80          return imageProvider;
81      }
82  
83      protected ImageProviderDefinition resolveImageProviderDefinition() {
84          SubAppDescriptor subAppDescriptor = subAppContext.getSubAppDescriptor();
85          if (subAppDescriptor instanceof ContentSubAppDescriptor) {
86              return ((ContentSubAppDescriptor) subAppDescriptor).getImageProvider();
87          }
88          return null;
89      }
90  
91      /**
92       * A void implementation of ImageProvider for those cases where imageProvider is not configured and cannot be injected otherwise.
93       */
94      private static class NullImageProvider implements ImageProvider {
95  
96          @Override
97          public String getPortraitPath(Object itemId) {
98              return null;
99          }
100 
101         @Override
102         public String getThumbnailPath(Object itemId) {
103             return null;
104         }
105 
106         @Override
107         public String resolveIconClassName(String mimeType) {
108             return null;
109         }
110 
111         @Override
112         public Object getThumbnailResource(Object itemId, String generator) {
113             return null;
114         }
115     }
116 
117 }