1 |
|
|
2 |
|
|
3 |
|
|
4 |
|
|
5 |
|
|
6 |
|
|
7 |
|
|
8 |
|
|
9 |
|
|
10 |
|
|
11 |
|
|
12 |
|
|
13 |
|
|
14 |
|
|
15 |
|
|
16 |
|
|
17 |
|
package org.apache.jetspeed.container.window.impl; |
18 |
|
|
19 |
|
import java.util.ArrayList; |
20 |
|
import java.util.Collections; |
21 |
|
import java.util.HashMap; |
22 |
|
import java.util.List; |
23 |
|
import java.util.Map; |
24 |
|
import java.util.Set; |
25 |
|
|
26 |
|
import org.apache.commons.logging.Log; |
27 |
|
import org.apache.commons.logging.LogFactory; |
28 |
|
import org.apache.jetspeed.components.portletentity.PortletEntityAccessComponent; |
29 |
|
import org.apache.jetspeed.components.portletentity.PortletEntityNotGeneratedException; |
30 |
|
import org.apache.jetspeed.components.portletentity.PortletEntityNotStoredException; |
31 |
|
import org.apache.jetspeed.components.portletregistry.PortletRegistry; |
32 |
|
import org.apache.jetspeed.components.portletregistry.RegistryEventListener; |
33 |
|
import org.apache.jetspeed.container.window.FailedToCreateWindowException; |
34 |
|
import org.apache.jetspeed.container.window.FailedToRetrievePortletWindow; |
35 |
|
import org.apache.jetspeed.container.window.PortletWindowAccessor; |
36 |
|
import org.apache.jetspeed.factory.PortletFactory; |
37 |
|
import org.apache.jetspeed.om.common.portlet.MutablePortletApplication; |
38 |
|
import org.apache.jetspeed.om.common.portlet.MutablePortletEntity; |
39 |
|
import org.apache.jetspeed.om.common.portlet.PortletApplication; |
40 |
|
import org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite; |
41 |
|
import org.apache.jetspeed.om.page.ContentFragment; |
42 |
|
import org.apache.jetspeed.om.window.impl.PortletWindowImpl; |
43 |
|
import org.apache.jetspeed.util.ArgUtil; |
44 |
|
import org.apache.pluto.om.entity.PortletEntity; |
45 |
|
import org.apache.pluto.om.window.PortletWindow; |
46 |
|
import org.apache.pluto.om.window.PortletWindowCtrl; |
47 |
|
|
48 |
|
|
49 |
|
|
50 |
|
|
51 |
|
|
52 |
|
|
53 |
|
|
54 |
|
public class PortletWindowAccessorImpl implements PortletWindowAccessor, RegistryEventListener |
55 |
|
{ |
56 |
0 |
protected final static Log log = LogFactory.getLog(PortletWindowAccessorImpl.class); |
57 |
|
|
58 |
0 |
private Map windows = Collections.synchronizedMap(new HashMap()); |
59 |
|
private PortletEntityAccessComponent entityAccessor; |
60 |
|
private PortletFactory portletFactory; |
61 |
0 |
private boolean validateWindows = false; |
62 |
|
|
63 |
|
|
64 |
|
public PortletWindowAccessorImpl(PortletEntityAccessComponent entityAccessor, PortletFactory portletFactory, boolean validateWindows) |
65 |
0 |
{ |
66 |
0 |
this.entityAccessor = entityAccessor; |
67 |
0 |
this.portletFactory = portletFactory; |
68 |
0 |
this.validateWindows = validateWindows; |
69 |
0 |
} |
70 |
|
|
71 |
|
public PortletWindowAccessorImpl(PortletEntityAccessComponent entityAccessor, |
72 |
|
PortletFactory portletFactory, |
73 |
|
PortletRegistry registry, |
74 |
|
boolean validateWindows) |
75 |
0 |
{ |
76 |
0 |
this.entityAccessor = entityAccessor; |
77 |
0 |
this.portletFactory = portletFactory; |
78 |
0 |
this.validateWindows = validateWindows; |
79 |
0 |
registry.addRegistryListener(this); |
80 |
0 |
} |
81 |
|
|
82 |
|
public PortletWindow createPortletWindow(PortletEntity entity, String windowId) |
83 |
|
{ |
84 |
0 |
if(entity == null) |
85 |
|
{ |
86 |
0 |
throw new IllegalArgumentException("cratePortletWindow requires a non-null PortletEntity"); |
87 |
|
} |
88 |
|
|
89 |
0 |
PortletWindow found = getWindowFromCache(windowId); |
90 |
0 |
if (found != null) |
91 |
|
{ |
92 |
|
|
93 |
0 |
checkPortletWindowEntity(found); |
94 |
0 |
((PortletWindowCtrl)found).setPortletEntity(entity); |
95 |
0 |
return found; |
96 |
|
} |
97 |
|
|
98 |
0 |
PortletWindowImpl window = new PortletWindowImpl(windowId); |
99 |
0 |
window.setPortletEntity(entity); |
100 |
0 |
if ( isValidPortletEntity(entity)) |
101 |
|
{ |
102 |
0 |
windows.put(windowId, window); |
103 |
|
} |
104 |
0 |
return window; |
105 |
|
} |
106 |
|
|
107 |
|
public PortletWindow createPortletWindow(String windowId) |
108 |
|
{ |
109 |
0 |
PortletWindow found = getWindowFromCache(windowId); |
110 |
0 |
if (found != null) |
111 |
|
{ |
112 |
|
|
113 |
0 |
checkPortletWindowEntity(found); |
114 |
0 |
return found; |
115 |
|
} |
116 |
0 |
PortletWindowImpl window = new PortletWindowImpl(windowId); |
117 |
0 |
return window; |
118 |
|
} |
119 |
|
|
120 |
|
public PortletWindow getPortletWindow(String windowId) |
121 |
|
{ |
122 |
0 |
PortletWindow window = getWindowFromCache(windowId); |
123 |
0 |
if (window != null) |
124 |
|
{ |
125 |
|
|
126 |
0 |
checkPortletWindowEntity(window); |
127 |
|
} |
128 |
0 |
return window; |
129 |
|
} |
130 |
|
|
131 |
|
public PortletWindow getPortletWindow(ContentFragment fragment) throws FailedToRetrievePortletWindow, PortletEntityNotStoredException |
132 |
|
{ |
133 |
0 |
ArgUtil.assertNotNull(ContentFragment.class, fragment, this, "getPortletWindow(Fragment fragment)"); |
134 |
0 |
PortletWindow portletWindow = getWindowFromCache(fragment); |
135 |
0 |
if (portletWindow == null || !checkPortletWindowEntity(portletWindow)) |
136 |
|
{ |
137 |
|
try |
138 |
|
{ |
139 |
0 |
return createPortletWindow(fragment); |
140 |
|
} |
141 |
0 |
catch (FailedToCreateWindowException e) |
142 |
|
{ |
143 |
0 |
throw new FailedToRetrievePortletWindow(e.toString(), e); |
144 |
|
} |
145 |
|
} |
146 |
|
else |
147 |
|
{ |
148 |
0 |
if (validateWindows) |
149 |
|
{ |
150 |
0 |
validateWindow(fragment, portletWindow); |
151 |
|
} |
152 |
|
} |
153 |
|
|
154 |
0 |
return portletWindow; |
155 |
|
} |
156 |
|
|
157 |
|
|
158 |
|
|
159 |
|
|
160 |
|
|
161 |
|
|
162 |
|
|
163 |
|
|
164 |
|
|
165 |
|
|
166 |
|
|
167 |
|
protected void validateWindow( ContentFragment fragment, PortletWindow portletWindow ) throws FailedToRetrievePortletWindow, PortletEntityNotStoredException |
168 |
|
{ |
169 |
|
|
170 |
0 |
PortletEntity portletEntity = entityAccessor.getPortletEntityForFragment(fragment); |
171 |
0 |
if(portletEntity != null) |
172 |
|
{ |
173 |
0 |
((PortletWindowCtrl) portletWindow).setPortletEntity(portletEntity); |
174 |
|
|
175 |
0 |
checkPortletWindowEntity(portletWindow); |
176 |
|
} |
177 |
|
else |
178 |
|
{ |
179 |
0 |
removeWindow(portletWindow); |
180 |
0 |
throw new FailedToRetrievePortletWindow("No PortletEntity exists for for id "+fragment.getId()+" removing window from cache."); |
181 |
|
} |
182 |
0 |
} |
183 |
|
|
184 |
|
public PortletWindow getPortletWindow(ContentFragment fragment, String principal) throws FailedToRetrievePortletWindow, FailedToCreateWindowException, PortletEntityNotStoredException |
185 |
|
{ |
186 |
0 |
ArgUtil.assertNotNull(ContentFragment.class, fragment, this, "getPortletWindow(Fragment fragment, String principal)"); |
187 |
0 |
ArgUtil.assertNotNull(String.class, principal, this, "getPortletWindow(Fragment fragment, String principal)"); |
188 |
0 |
PortletWindow portletWindow = getWindowFromCache(fragment); |
189 |
0 |
if (portletWindow == null) |
190 |
|
{ |
191 |
0 |
return createPortletWindow(fragment, principal); |
192 |
|
} |
193 |
|
else |
194 |
|
{ |
195 |
|
|
196 |
0 |
validateWindow(fragment, portletWindow); |
197 |
|
} |
198 |
0 |
return portletWindow; |
199 |
|
} |
200 |
|
|
201 |
|
private PortletWindow createPortletWindow(ContentFragment fragment) throws FailedToCreateWindowException, PortletEntityNotStoredException |
202 |
|
{ |
203 |
0 |
return createPortletWindow(fragment, null); |
204 |
|
} |
205 |
|
|
206 |
|
private PortletWindow createPortletWindow(ContentFragment fragment, String principal) throws FailedToCreateWindowException, PortletEntityNotStoredException |
207 |
|
{ |
208 |
0 |
PortletWindow portletWindow = new PortletWindowImpl(fragment.getId()); |
209 |
0 |
boolean temporaryWindow = false; |
210 |
|
|
211 |
0 |
MutablePortletEntity portletEntity = entityAccessor.getPortletEntityForFragment(fragment, principal); |
212 |
0 |
if (portletEntity == null) |
213 |
|
{ |
214 |
0 |
log.info("No portlet entity defined for fragment ID "+fragment.getId()+" attempting to auto-generate..."); |
215 |
|
try |
216 |
|
{ |
217 |
0 |
portletEntity = entityAccessor.generateEntityFromFragment(fragment, principal); |
218 |
|
|
219 |
0 |
if(isValidPortletEntity(portletEntity)) |
220 |
|
{ |
221 |
0 |
entityAccessor.storePortletEntity(portletEntity); |
222 |
|
} |
223 |
|
else |
224 |
|
{ |
225 |
|
|
226 |
0 |
temporaryWindow = true; |
227 |
|
} |
228 |
|
} |
229 |
0 |
catch (PortletEntityNotGeneratedException e) |
230 |
|
{ |
231 |
0 |
throw new FailedToCreateWindowException("Error generating new PortletEntity: "+e.toString(), e); |
232 |
|
} |
233 |
0 |
catch (PortletEntityNotStoredException e) |
234 |
|
{ |
235 |
0 |
throw new FailedToCreateWindowException("Error storing new PortletEntity: "+e.toString(), e); |
236 |
0 |
} |
237 |
|
|
238 |
0 |
if(portletEntity == null) |
239 |
|
{ |
240 |
0 |
throw new FailedToCreateWindowException("Unable to generate portlet entity."); |
241 |
|
} |
242 |
|
|
243 |
|
} |
244 |
0 |
((PortletWindowCtrl) portletWindow).setPortletEntity(portletEntity); |
245 |
|
|
246 |
0 |
if ( !temporaryWindow ) |
247 |
|
{ |
248 |
0 |
windows.put(fragment.getId(), portletWindow); |
249 |
|
} |
250 |
|
|
251 |
0 |
return portletWindow; |
252 |
|
} |
253 |
|
|
254 |
|
|
255 |
|
public void removeWindows(PortletEntity portletEntity) |
256 |
|
{ |
257 |
0 |
List tmpWindows = new ArrayList(windows.entrySet()); |
258 |
0 |
for(int i = 0; i < tmpWindows.size(); i++) |
259 |
|
{ |
260 |
0 |
PortletWindow window = (PortletWindow)((Map.Entry)tmpWindows.get(i)).getValue(); |
261 |
0 |
if (portletEntity.getId().equals(window.getPortletEntity().getId())) |
262 |
|
{ |
263 |
0 |
removeWindow(window); |
264 |
|
} |
265 |
|
} |
266 |
0 |
tmpWindows.clear(); |
267 |
|
|
268 |
0 |
} |
269 |
|
|
270 |
|
public void removeWindow(PortletWindow window) |
271 |
|
{ |
272 |
0 |
windows.remove(window.getId().toString()); |
273 |
0 |
} |
274 |
|
|
275 |
|
private PortletWindow getWindowFromCache(ContentFragment fragment) |
276 |
|
{ |
277 |
0 |
return (PortletWindow)windows.get(fragment.getId()); |
278 |
|
} |
279 |
|
|
280 |
|
private PortletWindow getWindowFromCache(String id) |
281 |
|
{ |
282 |
0 |
return (PortletWindow)windows.get(id); |
283 |
|
} |
284 |
|
|
285 |
|
private boolean checkPortletWindowEntity(PortletWindow window) |
286 |
|
{ |
287 |
0 |
if (!isValidPortletEntity(window.getPortletEntity())) |
288 |
|
{ |
289 |
0 |
removeWindow(window); |
290 |
0 |
return false; |
291 |
|
} |
292 |
0 |
return true; |
293 |
|
} |
294 |
|
|
295 |
|
private boolean isValidPortletEntity(PortletEntity pe) |
296 |
|
{ |
297 |
0 |
return pe != null |
298 |
|
&& pe.getPortletDefinition() != null |
299 |
|
&& pe.getPortletDefinition().getPortletApplicationDefinition() != null |
300 |
|
&& portletFactory.isPortletApplicationRegistered((PortletApplication) pe.getPortletDefinition() |
301 |
|
.getPortletApplicationDefinition()); |
302 |
|
} |
303 |
|
|
304 |
|
public Set getPortletWindows() |
305 |
|
{ |
306 |
0 |
return this.windows.entrySet(); |
307 |
|
} |
308 |
|
|
309 |
|
protected void removeForPortletDefinition(PortletDefinitionComposite def) |
310 |
|
{ |
311 |
0 |
List tmpWindows = new ArrayList(windows.entrySet()); |
312 |
0 |
for (int i = 0; i < tmpWindows.size(); i++) |
313 |
|
{ |
314 |
0 |
PortletWindow window = (PortletWindow)((Map.Entry)tmpWindows.get(i)).getValue(); |
315 |
0 |
PortletDefinitionComposite windowDef = (PortletDefinitionComposite)window.getPortletEntity().getPortletDefinition(); |
316 |
0 |
if(def != null && windowDef != class="keyword">null && def.getUniqueName() != class="keyword">null && def.getUniqueName().equals(windowDef.getUniqueName())) |
317 |
|
{ |
318 |
0 |
removeWindow(window); |
319 |
|
} |
320 |
|
} |
321 |
0 |
tmpWindows.clear(); |
322 |
0 |
if (def != null) |
323 |
0 |
portletFactory.updatePortletConfig(def); |
324 |
0 |
} |
325 |
|
|
326 |
|
protected void removeForPortletApplication(MutablePortletApplication app) |
327 |
|
{ |
328 |
0 |
List tmpWindows = new ArrayList(windows.entrySet()); |
329 |
0 |
for (int i = 0; i < tmpWindows.size(); i++) |
330 |
|
{ |
331 |
0 |
PortletWindow window = (PortletWindow)((Map.Entry)tmpWindows.get(i)).getValue(); |
332 |
0 |
PortletDefinitionComposite pd = (PortletDefinitionComposite)window.getPortletEntity().getPortletDefinition(); |
333 |
0 |
if (pd != null) |
334 |
|
{ |
335 |
0 |
MutablePortletApplication windowApp = (MutablePortletApplication)pd.getPortletApplicationDefinition(); |
336 |
0 |
if (app.getName().equals(windowApp.getName())) |
337 |
|
{ |
338 |
0 |
removeWindow(window); |
339 |
|
} |
340 |
|
} |
341 |
|
} |
342 |
0 |
tmpWindows.clear(); |
343 |
0 |
} |
344 |
|
|
345 |
|
public void applicationRemoved(MutablePortletApplication app) |
346 |
|
{ |
347 |
0 |
if (app == null) |
348 |
|
{ |
349 |
|
|
350 |
0 |
return; |
351 |
|
} |
352 |
|
|
353 |
0 |
removeForPortletApplication(app); |
354 |
0 |
} |
355 |
|
|
356 |
|
|
357 |
|
public void applicationUpdated(MutablePortletApplication app) |
358 |
|
{ |
359 |
0 |
if (app == null) |
360 |
|
{ |
361 |
|
|
362 |
0 |
return; |
363 |
|
} |
364 |
|
|
365 |
0 |
removeForPortletApplication(app); |
366 |
0 |
} |
367 |
|
|
368 |
|
public void portletRemoved(PortletDefinitionComposite def) |
369 |
|
{ |
370 |
0 |
if (def == null) |
371 |
|
{ |
372 |
|
|
373 |
0 |
return; |
374 |
|
} |
375 |
|
|
376 |
0 |
removeForPortletDefinition(def); |
377 |
0 |
} |
378 |
|
|
379 |
|
public void portletUpdated(PortletDefinitionComposite def) |
380 |
|
{ |
381 |
0 |
if (def == null) |
382 |
|
{ |
383 |
|
|
384 |
0 |
return; |
385 |
|
} |
386 |
|
|
387 |
0 |
removeForPortletDefinition(def); |
388 |
0 |
} |
389 |
|
} |