/
EventListenersFactoryBean.java
286 lines (247 loc) · 9.48 KB
/
EventListenersFactoryBean.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
/*
* ome.security.basic.EventListenersFactoryBean
*
* Copyright 2006 University of Dundee. All rights reserved.
* Use is subject to license terms supplied in LICENSE.txt
*/
package ome.security.basic;
// Java imports
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.Map;
import java.util.Set;
import ome.security.ACLEventListener;
import ome.security.ACLVoter;
import ome.tools.hibernate.EventMethodInterceptor;
import ome.tools.hibernate.ReloadingRefreshEventListener;
import org.aopalliance.aop.Advice;
import org.aopalliance.intercept.MethodInvocation;
import org.hibernate.event.EventListeners;
import org.springframework.aop.framework.ProxyFactory;
import org.springframework.beans.factory.FactoryBean;
import org.springframework.beans.factory.config.AbstractFactoryBean;
import org.springframework.orm.hibernate3.LocalSessionFactoryBean;
/**
* configuring all the possible {@link EventListeners event listeners} within
* XML can be cumbersome.
*/
public class EventListenersFactoryBean extends AbstractFactoryBean {
private final EventListeners eventListeners = new EventListeners();
private final Map<String, LinkedList<Object>> map = new HashMap<String, LinkedList<Object>>();
private final CurrentDetails cd;
private final TokenHolder th;
private final ACLVoter voter;
private final OmeroInterceptor interceptor;
// ~ FactoryBean
// =========================================================================
public EventListenersFactoryBean(CurrentDetails cd, TokenHolder th,
ACLVoter voter, OmeroInterceptor interceptor) {
this.cd = cd;
this.th = th;
this.voter = voter;
this.interceptor = interceptor;
}
/**
* this {@link FactoryBean} produces a {@link Map} instance for use in
* {@link LocalSessionFactoryBean#setEventListeners(Map)}
*/
@Override
public Class getObjectType() {
return Map.class;
}
/**
* being a singleton implies that this {@link FactoryBean} will only ever
* create one instance.
*/
@Override
public boolean isSingleton() {
return true;
}
/**
* First, adds all default listeners. These are then overwritten.
*/
@Override
protected Object createInstance() throws Exception {
put("auto-flush", eventListeners.getAutoFlushEventListeners());
put("merge", eventListeners.getMergeEventListeners());
put("create", eventListeners.getPersistEventListeners());
put("create-onflush", eventListeners.getPersistOnFlushEventListeners());
put("delete", eventListeners.getDeleteEventListeners());
put("dirty-check", eventListeners.getDirtyCheckEventListeners());
put("evict", eventListeners.getEvictEventListeners());
put("flush", eventListeners.getFlushEventListeners());
put("flush-entity", eventListeners.getFlushEntityEventListeners());
put("load", eventListeners.getLoadEventListeners());
put("load-collection", eventListeners
.getInitializeCollectionEventListeners());
put("lock", eventListeners.getLockEventListeners());
put("refresh", eventListeners.getRefreshEventListeners());
put("replicate", eventListeners.getReplicateEventListeners());
put("save-update", eventListeners.getSaveOrUpdateEventListeners());
put("save", eventListeners.getSaveEventListeners());
put("update", eventListeners.getUpdateEventListeners());
put("pre-load", eventListeners.getPreLoadEventListeners());
put("pre-update", eventListeners.getPreUpdateEventListeners());
put("pre-delete", eventListeners.getPreDeleteEventListeners());
put("pre-insert", eventListeners.getPreInsertEventListeners());
put("post-load", eventListeners.getPostLoadEventListeners());
put("post-update", eventListeners.getPostUpdateEventListeners());
put("post-delete", eventListeners.getPostDeleteEventListeners());
put("post-insert", eventListeners.getPostInsertEventListeners());
put("post-commit-update", eventListeners
.getPostCommitUpdateEventListeners());
put("post-commit-delete", eventListeners
.getPostCommitDeleteEventListeners());
put("post-commit-insert", eventListeners
.getPostCommitInsertEventListeners());
assertHasAllKeys();
overrides();
additions();
return map;
}
// ~ Configuration
// =========================================================================
protected boolean debugAll = false;
/** for setter injection */
public void setDebugAll(boolean debug) {
this.debugAll = debug;
}
protected void overrides() {
override("merge", new MergeEventListener(cd, th));
override("save", new SaveEventListener(cd, th));
override(new String[] { "replicate", "update" }, getDisablingProxy());
}
protected void additions() {
// This must be prepended because it updates the alreadyRefreshed
// cache before passing the event on the default listener.
prepend("refresh", new ReloadingRefreshEventListener());
for (String key : map.keySet()) {
final String k = key;
EventMethodInterceptor emi = new EventMethodInterceptor(
new EventMethodInterceptor.DisableAction() {
@Override
protected boolean disabled(MethodInvocation mi) {
return cd.isDisabled(k);// getType(mi));
}
});
append(key, getProxy(emi));
}
if (voter != null) {
ACLEventListener acl = new ACLEventListener(voter);
append("post-load", acl);
append("pre-insert", acl);
append("pre-update", acl);
append("pre-delete", acl);
}
EventLogListener ell = new ome.security.basic.EventLogListener(cd);
append("post-insert", ell);
append("post-update", ell);
append("post-delete", ell);
UpdateEventListener uel = new UpdateEventListener(cd);
append("pre-update", uel);
if (debugAll) {
Object debug = getDebuggingProxy();
for (String key : map.keySet()) {
map.get(key).add(debug);
}
}
}
// ~ Helpers
// =========================================================================
private void assertHasAllKeys() {
// eventListeners has only private state. :(
}
private Class[] allInterfaces() {
Set<Class> set = new HashSet<Class>();
for (String str : map.keySet()) {
Class iface = eventListeners.getListenerClassFor(str);
if (iface == null) {
logger.warn("No interface found for " + str);
}
else {
set.add(iface);
}
}
return set.toArray(new Class[set.size()]);
}
private Object getDisablingProxy() {
EventMethodInterceptor disable = new EventMethodInterceptor(
new EventMethodInterceptor.DisableAction());
return getProxy(disable);
}
private Object getDebuggingProxy() {
EventMethodInterceptor debug = new EventMethodInterceptor();
debug.setDebug(true);
return getProxy(debug);
}
private Object getProxy(Advice... adviceArray) {
ProxyFactory factory = new ProxyFactory();
factory.setInterfaces(allInterfaces());
for (Advice advice : adviceArray) {
factory.addAdvice(advice);
}
return factory.getProxy();
}
// ~ Collection methods
// =========================================================================
/** calls override for each key */
protected void override(String[] keys, Object object) {
for (String key : keys) {
override(key, object);
}
}
/** first re-initializes the list for key, and then adds object */
protected void override(String key, Object object) {
put(key, null);
append(key, object);
}
/**
* appends the objects to the existing list identified by key. If no list is
* found, initializes. If there are no objects, just initializes if
* necessary.
*/
protected void append(String key, Object... objs) {
LinkedList<Object> l = map.get(key);
if (l == null) {
put(key, null);
l = map.get(key);
}
if (objs == null) {
return;
}
for (Object object : objs) {
l.addLast(object);
}
}
/**
* adds the objects to the existing list identified by key. If no list is
* found, initializes. If there are no objects, just initializes if
* necessary.
*/
protected void prepend(String key, Object... objs) {
LinkedList<Object> l = map.get(key);
if (l == null) {
put(key, null);
l = map.get(key);
}
if (objs == null) {
return;
}
for (Object object : objs) {
l.addFirst(object);
}
}
/**
* replaces the key with the provided objects or an empty list if none
* provided
*/
protected void put(String key, Object[] objs) {
LinkedList<Object> list = new LinkedList<Object>();
if (objs != null) {
Collections.addAll(list, objs);
}
map.put(key, list);
}
}