1 /**
2 * This file Copyright (c) 2016-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.framework.ioc;
35
36 import info.magnolia.ui.api.ioc.App;
37 import info.magnolia.ui.api.ioc.SubApp;
38 import info.magnolia.ui.api.ioc.View;
39
40 import java.io.Serializable;
41 import java.util.List;
42 import java.util.Optional;
43
44 import com.google.common.collect.ImmutableList;
45
46 /**
47 * When injecting the Ui-related components, {@link CurrentUiContextReference} provides information
48 * about the context in which the dependency injection has been initiated (i.e. what is
49 * currently trying to inject instances, the app, it sub-app, a view or admincentral itself?).
50 * <p>
51 * Besides of a concretely specified {@link UiContextReference current UI context reference} it provides
52 * convenience look-up for the closest app, sub-app and view contexts.
53 * </p>
54 * @see UiContextReference
55 * @see UiContextBoundComponentProvider
56 */
57 public final class CurrentUiContextReference implements Serializable {
58
59 public static CurrentUiContextReference get() {
60 return SessionStore.access().getBeanStore(UiContextReference.ofCurrentUi()).get(CurrentUiContextReference.class);
61 }
62
63 void executeInContext(Runnable execute, UiContextReference contextKey) {
64 final UiContextReference currentContextReference = this.uiContextReference;
65 this.uiContextReference = contextKey;
66 try {
67 execute.run();
68 } finally {
69 this.uiContextReference = currentContextReference;
70 }
71 }
72
73 private UiContextReference uiContextReference;
74
75 public UiContextReference getUiContextReference() {
76 return Optional.ofNullable(uiContextReference).orElse(UiContextReference.ofCurrentUi());
77 }
78
79 public void setUiContextReference(UiContextReference uiContextReference) {
80 this.uiContextReference = uiContextReference;
81 }
82
83 Optional<UiContextReference> getViewReference() {
84 return getAvailableContextReferences().stream().filter(scopeKey -> scopeKey.getAnnotation() instanceof View).findFirst();
85 }
86
87 Optional<UiContextReference> getAppReference() {
88 return getAvailableContextReferences().stream().filter(scopeKey -> scopeKey.getAnnotation() instanceof App).findFirst();
89 }
90
91 Optional<UiContextReference> getSubAppReference() {
92 return getAvailableContextReferences().stream().filter(scopeKey -> scopeKey.getAnnotation() instanceof SubApp).findFirst();
93 }
94
95 List<UiContextReference> getAvailableContextReferences() {
96 return ImmutableList.<UiContextReference>builder().add(getUiContextReference()).addAll(getUiContextReference().getParentReferences()).build();
97 }
98 }