1 /**
2 * This file Copyright (c) 2015 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.module.site.provider;
35
36 import info.magnolia.cms.core.AggregationState;
37 import info.magnolia.module.site.ExtendedAggregationState;
38 import info.magnolia.module.site.Site;
39 import info.magnolia.module.site.SiteManager;
40 import info.magnolia.objectfactory.Components;
41
42 import javax.inject.Inject;
43 import javax.inject.Provider;
44
45 /**
46 * {@link javax.inject.Provider} for {@link info.magnolia.module.site.Site}s that will try to acquire an instance of
47 * the current {@link Site} from the {@link info.magnolia.module.site.ExtendedAggregationState}.
48 *
49 * @see info.magnolia.module.site.ExtendedAggregationState#getSite()
50 */
51 public class SiteProvider implements Provider<Site> {
52
53 private final Provider<AggregationState> aggregationStateProvider;
54 private final Provider<SiteManager> siteManagerProvider;
55
56 /**
57 * @deprecated since 1.0.3. Use {@link SiteProvider#SiteProvider(javax.inject.Provider, javax.inject.Provider)} instead.
58 */
59 @Deprecated
60 public SiteProvider(Provider<AggregationState> aggregationStateProvider) {
61 this(aggregationStateProvider, new Provider<SiteManager>() {
62 @Override
63 public SiteManager get() {
64 return Components.getComponent(SiteManager.class);
65 }
66 });
67 }
68
69 @Inject
70 public SiteProvider(Provider<AggregationState> aggregationStateProvider, Provider<SiteManager> siteManagerProvider) {
71 this.aggregationStateProvider = aggregationStateProvider;
72 this.siteManagerProvider = siteManagerProvider;
73 }
74
75 /**
76 * Tries to return the current {@link Site} from the {@link ExtendedAggregationState}.
77 * If {@link AggregationState} is null or not a type of {@link ExtendedAggregationState} then
78 * return the default {@link Site} from the {@link SiteManager}.
79 */
80 @Override
81 public Site get() {
82 final AggregationState aggregationState = aggregationStateProvider.get();
83
84 if (aggregationState instanceof ExtendedAggregationState) {
85 return ((ExtendedAggregationState) aggregationState).getSite();
86 }
87
88 SiteManager siteManager = siteManagerProvider.get();
89 if (siteManager != null) {
90 return siteManager.getDefaultSite();
91 }
92
93 return null;
94 }
95 }