1 /**
2 * This file Copyright (c) 2003-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.cms.beans.config;
35
36 import info.magnolia.cms.core.Content;
37 import info.magnolia.cms.core.DefaultContent;
38 import info.magnolia.cms.util.ObservationUtil;
39 import info.magnolia.cms.util.SystemContentWrapper;
40 import info.magnolia.context.MgnlContext;
41 import info.magnolia.repository.RepositoryConstants;
42
43 import java.util.ArrayList;
44 import java.util.HashMap;
45 import java.util.HashSet;
46 import java.util.Iterator;
47 import java.util.List;
48 import java.util.Map;
49 import java.util.Set;
50
51 import javax.jcr.ItemNotFoundException;
52 import javax.jcr.Node;
53 import javax.jcr.RepositoryException;
54 import javax.jcr.Session;
55 import javax.jcr.observation.EventIterator;
56 import javax.jcr.observation.EventListener;
57
58 import org.slf4j.Logger;
59 import org.slf4j.LoggerFactory;
60
61 /**
62 * A lot of "manager" objects are observed. Will mean that they reload the registered content after the content was changed. To
63 * centralize this code we use this abstract manager. A subclass will implement onRegister and onClear.
64 *
65 * @deprecated since 5.5. Use {@link info.magnolia.cms.util.ModuleConfigurationObservingManager} instead.
66 */
67 @Deprecated
68 public abstract class ObservedManager {
69 protected final Logger log = LoggerFactory.getLogger(getClass());
70
71 /**
72 * UUIDs and paths of the registered main nodes. They will get registered again after a change.
73 */
74 protected Set<String> registeredUUIDs = new HashSet<String>();
75 private Map<String, String> UUIDToPathMap = new HashMap<String, String>();
76
77 /**
78 * Register a node. The uuid and path are cached and then onRegister() called.
79 *
80 * @param node the node to register
81 */
82 public synchronized void register(Content node) {
83 if (node == null) {
84 log.warn("Tried to register a non-existing node!");
85 return;
86 }
87
88 ObservationUtil.registerDeferredChangeListener(RepositoryConstants.CONFIG, node.getHandle(), new EventListener() {
89
90 @Override
91 public void onEvent(EventIterator events) {
92 reload();
93 }
94 }, 1000, 5000);
95
96 try {
97 registeredUUIDs.add(node.getUUID());
98 UUIDToPathMap.put(node.getUUID(), node.getHandle());
99 onRegister(new SystemContentWrapper(node));
100 } catch (Exception e) {
101 log.warn("Was not able to register [{}]", node.getHandle(), e);
102 }
103 }
104
105 /**
106 * Calls onClear and reregister the nodes by calling onRegister.
107 */
108 public synchronized void reload() {
109 // Call onClear and reregister the nodes by calling onRegister
110 onClear();
111
112 Session session = null;
113 try {
114 session = MgnlContext.getSystemContext().getJCRSession(RepositoryConstants.CONFIG);
115 } catch (RepositoryException e) {
116 throw new RuntimeException(e);
117 }
118
119 // copy to avoid ConcurrentModificationException since the list get changed during iteration
120 List<String> uuidsAndPaths = new ArrayList<String>(registeredUUIDs);
121
122 for (Iterator<String> iter = uuidsAndPaths.iterator(); iter.hasNext(); ) {
123 String uuid = iter.next();
124 try {
125 Node node = getNodeByIdentifierOrPath(session, uuid, UUIDToPathMap.get(uuid));
126 reload(new DefaultContent(node));
127 } catch (Exception e) {
128 registeredUUIDs.remove(uuid);
129 UUIDToPathMap.remove(uuid);
130 log.warn("Can't reload the node with uuid [{}] and path [{}]", uuid, UUIDToPathMap.get(uuid));
131 }
132 }
133 return;
134 }
135
136 /**
137 * Get a node by uuid, or failing that, by its path.
138 *
139 * @return The node with the specified UUID, or failing that, the specified path.
140 * @throws RepositoryException if node cannot be located by either UUID or path.
141 */
142 protected static Node getNodeByIdentifierOrPath(Session session, String uuid, String path) throws RepositoryException {
143 Node node = null;
144
145 try {
146 node = session.getNodeByIdentifier(uuid);
147 } catch (ItemNotFoundException e) {
148 node = session.getNode(path);
149 }
150
151 return node;
152 }
153
154 /**
155 * Reload a specific node.
156 */
157 protected void reload(Content node) {
158 onRegister(node);
159 }
160
161 /**
162 * Clears the registered UUIDs and calls onClear().
163 */
164 public void clear() {
165 this.registeredUUIDs.clear();
166 this.UUIDToPathMap.clear();
167 onClear();
168 }
169
170 /**
171 * Registers a node.
172 */
173 protected abstract void onRegister(Content node);
174
175 /**
176 * The implementor should clear everything. If needed the nodes will get registered.
177 */
178 protected abstract void onClear();
179
180 }