-
Notifications
You must be signed in to change notification settings - Fork 101
/
UpdateImpl.java
366 lines (311 loc) · 11.9 KB
/
UpdateImpl.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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
/*
* Copyright 2006-2016 University of Dundee. All rights reserved.
* Use is subject to license terms supplied in LICENSE.txt
*/
/*------------------------------------------------------------------------------
*
* Written by: Josh Moore <josh.moore@gmx.de>
*
*------------------------------------------------------------------------------
*/
package ome.logic;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import ome.annotations.RolesAllowed;
import ome.api.IUpdate;
import ome.api.ServiceInterface;
import ome.api.local.LocalQuery;
import ome.api.local.LocalUpdate;
import ome.conditions.ApiUsageException;
import ome.conditions.ValidationException;
import ome.model.IObject;
import ome.model.meta.EventLog;
import ome.parameters.Parameters;
import ome.services.eventlogs.EventLogLoader;
import ome.services.fulltext.FullTextBridge;
import ome.services.fulltext.FullTextIndexer;
import ome.services.fulltext.FullTextThread;
import ome.services.sessions.SessionManager;
import ome.services.util.Executor;
import ome.tools.hibernate.ReloadFilter;
import ome.tools.hibernate.UpdateFilter;
import ome.util.Utils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.hibernate.Session;
import org.springframework.dao.InvalidDataAccessApiUsageException;
import org.springframework.orm.hibernate3.SessionFactoryUtils;
import org.springframework.transaction.annotation.Transactional;
/**
* implementation of the IUpdate service interface
*
* @author Josh Moore, <a href="mailto:josh.moore@gmx.de">josh.moore@gmx.de</a>
* @version 1.0 <small> (<b>Internal version:</b> $Rev$ $Date$) </small>
* @since OMERO 3.0
*/
@Transactional(readOnly = false)
public class UpdateImpl extends AbstractLevel1Service implements LocalUpdate {
private final Logger log = LoggerFactory.getLogger(UpdateImpl.class);
protected transient LocalQuery localQuery;
protected transient Executor executor;
protected transient SessionManager sessionManager;
protected transient FullTextBridge fullTextBridge;
public final void setQueryService(LocalQuery query) {
getBeanHelper().throwIfAlreadySet(this.localQuery, query);
this.localQuery = query;
}
public void setExecutor(Executor executor) {
getBeanHelper().throwIfAlreadySet(this.executor, executor);
this.executor = executor;
}
public void setSessionManager(SessionManager sessionManager) {
getBeanHelper().throwIfAlreadySet(this.sessionManager, sessionManager);
this.sessionManager = sessionManager;
}
public void setFullTextBridge(FullTextBridge fullTextBridge) {
getBeanHelper().throwIfAlreadySet(this.fullTextBridge, fullTextBridge);
this.fullTextBridge = fullTextBridge;
}
public Class<? extends ServiceInterface> getServiceInterface() {
return IUpdate.class;
};
// ~ LOCAL PUBLIC METHODS
// =========================================================================
@RolesAllowed("user")
public void flush() {
session().flush();
}
// ~ INTERFACE METHODS
// =========================================================================
@RolesAllowed("user")
public void saveObject(IObject graph) {
doAction(graph, new UpdateAction<IObject>() {
@Override
public IObject run(IObject value, UpdateFilter filter, Session s) {
return internalMerge(value, filter, s);
}
});
}
@RolesAllowed("user")
public IObject saveAndReturnObject(IObject graph) {
return doAction(graph, new UpdateAction<IObject>() {
@Override
public IObject run(IObject value, UpdateFilter filter, Session s) {
return internalMerge(value, filter, s);
}
});
}
@RolesAllowed("user")
public void saveCollection(Collection graph) {
doAction(graph, new UpdateAction<Collection>() {
@Override
public Collection run(Collection value, UpdateFilter filter,
Session s) {
for (Object o : value) {
IObject obj = (IObject) o;
obj = internalMerge(obj, filter, s);
}
return null;
}
});
}
@RolesAllowed("user")
public IObject[] saveAndReturnArray(IObject[] graph) {
return doAction(graph, new UpdateAction<IObject[]>() {
@Override
public IObject[] run(IObject[] value, UpdateFilter filter, Session s) {
IObject[] copy = new IObject[value.length];
for (int i = 0; i < value.length; i++) {
copy[i] = internalMerge(value[i], filter, s);
}
return copy;
}
});
}
@RolesAllowed("user")
public List<Long> saveAndReturnIds(IObject[] graph) {
if (graph == null || graph.length == 0) {
return Collections.emptyList(); // EARLY EXIT!
}
final List<Long> ids = new ArrayList<Long>(graph.length);
final ReloadFilter filter = new ReloadFilter(session());
doAction(graph, filter, new UpdateAction<IObject[]>() {
@Override
public IObject[] run(IObject[] value, UpdateFilter filter, Session s) {
for (int i = 0; i < value.length; i++) {
ids.add(i, internalSave(value[i], (ReloadFilter) filter, s));
}
return null;
}
});
return ids;
}
@RolesAllowed("user")
public void saveArray(IObject[] graph) {
doAction(graph, new UpdateAction<IObject[]>() {
@Override
public IObject[] run(IObject[] value, UpdateFilter filter, Session s) {
IObject[] copy = new IObject[value.length];
for (int i = 0; i < value.length; i++) {
copy[i] = internalMerge(value[i], filter, s);
}
return copy;
}
});
}
@RolesAllowed("user")
public void deleteObject(IObject row) {
if (row == null) {
return;
}
if (row.getId() == null) {
throw new ApiUsageException(
"Non-managed IObject entity cannot be deleted. Must have an id.");
}
try {
doAction(row, new UpdateAction<IObject>() {
@Override
public IObject run(IObject value, UpdateFilter filter, Session s) {
internalDelete(value, filter, s);
return null;
}
});
} catch (InvalidDataAccessApiUsageException idaaue) {
throw new ApiUsageException("Cannot delete " + row + "\n" +
"Original message: " + idaaue.getMessage() + "\n" +
"Consider using IDelete instead.");
}
}
@RolesAllowed("system")
public void indexObject(IObject row) {
if (row == null || row.getId() == null) {
throw new ValidationException(
"Non-managed object cannot be indexed.");
}
CreationLogLoader logs = new CreationLogLoader(localQuery, row);
FullTextIndexer fti = new FullTextIndexer(logs);
fti.setApplicationContext(this.executor.getContext());
final FullTextThread ftt = new FullTextThread(sessionManager, executor,
fti, this.fullTextBridge, true);
Future<Object> future = executor.submit(Executors.callable(ftt));
executor.get(future);
}
// ~ Internals
// =========================================================
private void beforeUpdate(Object argument, UpdateFilter filter) {
if (argument == null) {
throw new IllegalArgumentException(
"Argument to save cannot be null.");
}
if (getBeanHelper().getLogger().isDebugEnabled()) {
getBeanHelper().getLogger().debug(" Saving event before merge. ");
}
}
/**
* Note if we use anything other than merge here, functionality from
* {@link ome.security.basic.MergeEventListener} needs to be moved to
* {@link UpdateFilter} or to another event listener.
*/
protected Long internalSave(IObject obj, ReloadFilter filter,
Session session) {
if (getBeanHelper().getLogger().isDebugEnabled()) {
getBeanHelper().getLogger().debug(" Internal save. ");
}
IObject result = (IObject) filter.filter(null, obj);
Long id = (Long) session.save(result);
return id;
}
/**
* Note if we use anything other than merge here, functionality from
* {@link ome.security.basic.MergeEventListener} needs to be moved to
* {@link UpdateFilter} or to another event listener.
*/
protected IObject internalMerge(IObject obj, UpdateFilter filter,
Session session) {
if (getBeanHelper().getLogger().isDebugEnabled()) {
getBeanHelper().getLogger().debug(" Internal merge. ");
}
final Long previousId = obj.getId();
IObject result = (IObject) filter.filter(null, obj);
result = (IObject) session.merge(result);
final Long currentId = result.getId();
if (previousId != null && previousId != currentId) {
/* HHH-1661: merge may insert deleted entities with new ID */
if (getBeanHelper().getLogger().isDebugEnabled()) {
getBeanHelper().getLogger().debug("attempt to save deleted object: " + obj);
}
throw new ValidationException("object no longer exists in database");
}
return result;
}
protected void internalDelete(IObject obj, UpdateFilter filter,
Session session) {
if (getBeanHelper().getLogger().isDebugEnabled()) {
getBeanHelper().getLogger().debug(" Internal delete. ");
}
session.delete(session.load(Utils.trueClass(obj.getClass()), obj
.getId()));
}
private void afterUpdate(UpdateFilter filter, Session session) {
if (getBeanHelper().getLogger().isDebugEnabled()) {
getBeanHelper().getLogger().debug(" Post-save cleanup. ");
}
// Clean up
session.flush();
filter.unloadReplacedObjects();
}
private <T> T doAction(final T graph, final UpdateAction<T> action) {
final UpdateFilter filter = new UpdateFilter();
return doAction(graph, filter, action);
}
private <T> T doAction(final T graph, final UpdateFilter filter,
final UpdateAction<T> action) {
final Session session = session();
T retVal;
beforeUpdate(graph, filter);
retVal = action.run(graph, filter, session);
afterUpdate(filter, session);
return retVal;
}
private abstract class UpdateAction<T> {
public abstract T run(T value, UpdateFilter filter, Session s);
}
private Session session() {
return SessionFactoryUtils.getSession(getSessionFactory(), false);
}
}
/**
* {@link EventLogLoader} which loads a single instance.
*/
class CreationLogLoader extends EventLogLoader {
final private LocalQuery query;
private IObject obj;
public CreationLogLoader(LocalQuery query, IObject obj) {
this.obj = obj;
this.query = query;
setQueryService(query);
}
@Override
public EventLog query() {
if (obj == null) {
return null;
} else {
EventLog el = query.findByQuery("select el from EventLog el "
+ "where el.action = 'INSERT' and "
+ "el.entityType = :type and " + "el.entityId = :id",
new Parameters()
.addString("type", obj.getClass().getName()).addId(
obj.getId()));
obj = null;
return el;
}
}
@Override
public long more() {
return 0;
}
}