1 /**
2 * This file Copyright (c) 2017 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
37 import info.magnolia.event.EventBus;
38
39 import java.util.Collections;
40 import java.util.Map;
41
42 import com.google.inject.Key;
43 import com.vaadin.server.VaadinSession;
44
45 /**
46 * Provides access to {@link VaadinSession} as if it was a key-value store where
47 * the key would be a {@link UiContextReference} and the value
48 * would be {@link BeanStore} (stores the scoped beans and provides access to them).
49 *
50 * @see UiScopes
51 */
52 public class SessionStore {
53
54 /**
55 * Returns {@link SessionStore} corresponding to current {@link VaadinSession}.
56 */
57 public static SessionStore access() {
58 return access(VaadinSession.getCurrent());
59 }
60
61 /**
62 * Returns {@link SessionStore} corresponding to provided {@link VaadinSession}.
63 */
64 public static SessionStore access(VaadinSession session) {
65 return session.getAttribute(SessionStore.class);
66 }
67
68 private final VaadinSession vaadinSession;
69
70 private final EventBus eventBus;
71
72 public SessionStore(VaadinSession vaadinSession, EventBus eventBus) {
73 this.vaadinSession = vaadinSession;
74 this.eventBus = eventBus;
75 }
76
77 public BeanStore createBeanStore(UiContextReference uiContextReference) {
78 return createBeanStore(uiContextReference, Collections.emptyMap());
79 }
80
81 public BeanStore createBeanStore(UiContextReference key, Map<Key, Object> initialInstances) {
82
83 final BeanStore beanStore = new BeanStore();
84 vaadinSession.setAttribute(key.asString(), beanStore);
85 initialInstances.forEach(beanStore::put);
86
87 eventBus.fireEvent(new BeanStoreLifecycleEvent.Create(key, beanStore));
88
89 return beanStore;
90 }
91
92 /**
93 * Finds a bean store which corresponds to a scope key.
94 * If such store does not exist - creates one.
95 */
96 public BeanStore getBeanStore(UiContextReference uiContextReference) {
97 return (BeanStore) vaadinSession.getAttribute(uiContextReference.asString());
98 }
99
100 /**
101 * Clears a bean store which corresponds to a ui context and removes it.
102 */
103 public void releaseBeanStore(UiContextReference uiContextReference) {
104 final BeanStore store = getBeanStore(uiContextReference);
105
106 if (store == null) {
107 throw new IllegalArgumentException(String.format("No bean store registered for provided uiContextReference [%s]...", uiContextReference));
108 }
109
110 eventBus.fireEvent(new BeanStoreLifecycleEvent.BeforeDestroy(uiContextReference, store));
111
112 store.clear();
113 vaadinSession.setAttribute(uiContextReference.asString(), null);
114
115 eventBus.fireEvent(new BeanStoreLifecycleEvent.Destroy(uiContextReference, store));
116 }
117 }