-
Notifications
You must be signed in to change notification settings - Fork 68
/
GrailsHibernateUtil.java
453 lines (411 loc) · 18.4 KB
/
GrailsHibernateUtil.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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
/* Copyright 2004-2005 Graeme Rocher
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.grails.orm.hibernate.cfg;
import groovy.lang.GroovyObject;
import groovy.lang.GroovySystem;
import groovy.lang.MetaClass;
import org.grails.datastore.mapping.model.PersistentEntity;
import org.grails.datastore.mapping.model.PersistentProperty;
import org.grails.datastore.mapping.model.config.GormProperties;
import org.grails.datastore.mapping.model.types.Association;
import org.grails.datastore.mapping.model.types.Embedded;
import org.grails.datastore.mapping.reflect.ClassUtils;
import org.grails.orm.hibernate.AbstractHibernateDatastore;
import org.grails.orm.hibernate.datasource.MultipleDataSourceSupport;
import org.grails.orm.hibernate.proxy.HibernateProxyHandler;
import org.grails.orm.hibernate.support.HibernateRuntimeUtils;
import org.hibernate.*;
import org.hibernate.criterion.Order;
import org.hibernate.engine.spi.EntityEntry;
import org.hibernate.engine.spi.SessionImplementor;
import org.hibernate.engine.spi.Status;
import org.hibernate.internal.util.StringHelper;
import org.hibernate.proxy.HibernateProxy;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.convert.ConversionService;
import org.springframework.transaction.support.TransactionSynchronizationManager;
import java.util.*;
/**
* Utility methods for configuring Hibernate inside Grails.
*
* @author Graeme Rocher
* @since 0.4
*/
public class GrailsHibernateUtil extends HibernateRuntimeUtils {
protected static final Logger LOG = LoggerFactory.getLogger(GrailsHibernateUtil.class);
public static final String ARGUMENT_FETCH_SIZE = "fetchSize";
public static final String ARGUMENT_TIMEOUT = "timeout";
public static final String ARGUMENT_READ_ONLY = "readOnly";
public static final String ARGUMENT_FLUSH_MODE = "flushMode";
public static final String ARGUMENT_MAX = "max";
public static final String ARGUMENT_OFFSET = "offset";
public static final String ARGUMENT_ORDER = "order";
public static final String ARGUMENT_SORT = "sort";
public static final String ORDER_DESC = "desc";
public static final String ORDER_ASC = "asc";
public static final String ARGUMENT_FETCH = "fetch";
public static final String ARGUMENT_IGNORE_CASE = "ignoreCase";
public static final String ARGUMENT_CACHE = "cache";
public static final String ARGUMENT_LOCK = "lock";
public static final Class<?>[] EMPTY_CLASS_ARRAY = {};
private static HibernateProxyHandler proxyHandler = new HibernateProxyHandler();
public static void populateArgumentsForCriteria(AbstractHibernateDatastore datastore, Class<?> targetClass, Criteria c, Map argMap, ConversionService conversionService) {
populateArgumentsForCriteria(datastore, targetClass, c, argMap, conversionService, true);
}
/**
* Populates criteria arguments for the given target class and arguments map
*
* @param datastore the GrailsApplication instance
* @param targetClass The target class
* @param c The criteria instance
* @param argMap The arguments map
*/
@SuppressWarnings("rawtypes")
public static void populateArgumentsForCriteria(AbstractHibernateDatastore datastore, Class<?> targetClass, Criteria c, Map argMap, ConversionService conversionService, boolean useDefaultMapping) {
Integer maxParam = null;
Integer offsetParam = null;
if (argMap.containsKey(ARGUMENT_MAX)) {
maxParam = conversionService.convert(argMap.get(ARGUMENT_MAX),Integer.class);
}
if (argMap.containsKey(ARGUMENT_OFFSET)) {
offsetParam = conversionService.convert(argMap.get(ARGUMENT_OFFSET),Integer.class);
}
if (argMap.containsKey(ARGUMENT_FETCH_SIZE)) {
c.setFetchSize(conversionService.convert(argMap.get(ARGUMENT_FETCH_SIZE),Integer.class));
}
if (argMap.containsKey(ARGUMENT_TIMEOUT)) {
c.setTimeout(conversionService.convert(argMap.get(ARGUMENT_TIMEOUT),Integer.class));
}
if (argMap.containsKey(ARGUMENT_FLUSH_MODE)) {
c.setFlushMode(convertFlushMode(argMap.get(ARGUMENT_FLUSH_MODE)));
}
if (argMap.containsKey(ARGUMENT_READ_ONLY)) {
c.setReadOnly(ClassUtils.getBooleanFromMap(ARGUMENT_READ_ONLY, argMap));
}
String orderParam = (String)argMap.get(ARGUMENT_ORDER);
Object fetchObj = argMap.get(ARGUMENT_FETCH);
if (fetchObj instanceof Map) {
Map fetch = (Map)fetchObj;
for (Object o : fetch.keySet()) {
String associationName = (String) o;
c.setFetchMode(associationName, getFetchMode(fetch.get(associationName)));
}
}
final int max = maxParam == null ? -1 : maxParam;
final int offset = offsetParam == null ? -1 : offsetParam;
if (max > -1) {
c.setMaxResults(max);
}
if (offset > -1) {
c.setFirstResult(offset);
}
if (ClassUtils.getBooleanFromMap(ARGUMENT_LOCK, argMap)) {
c.setLockMode(LockMode.PESSIMISTIC_WRITE);
c.setCacheable(false);
}
else {
if (argMap.containsKey(ARGUMENT_CACHE)) {
c.setCacheable(ClassUtils.getBooleanFromMap(ARGUMENT_CACHE, argMap));
} else {
cacheCriteriaByMapping(targetClass, c);
}
}
final Object sortObj = argMap.get(ARGUMENT_SORT);
if (sortObj != null) {
boolean ignoreCase = true;
Object caseArg = argMap.get(ARGUMENT_IGNORE_CASE);
if (caseArg instanceof Boolean) {
ignoreCase = (Boolean) caseArg;
}
if (sortObj instanceof Map) {
Map sortMap = (Map) sortObj;
for (Object sort : sortMap.keySet()) {
final String order = ORDER_DESC.equalsIgnoreCase((String) sortMap.get(sort)) ? ORDER_DESC : ORDER_ASC;
addOrderPossiblyNested(datastore, c, targetClass, (String) sort, order, ignoreCase);
}
} else {
final String sort = (String) sortObj;
final String order = ORDER_DESC.equalsIgnoreCase(orderParam) ? ORDER_DESC : ORDER_ASC;
addOrderPossiblyNested(datastore, c, targetClass, sort, order, ignoreCase);
}
}
else if (useDefaultMapping) {
Mapping m = GrailsDomainBinder.getMapping(targetClass);
if (m != null) {
Map sortMap = m.getSort().getNamesAndDirections();
for (Object sort : sortMap.keySet()) {
final String order = ORDER_DESC.equalsIgnoreCase((String) sortMap.get(sort)) ? ORDER_DESC : ORDER_ASC;
addOrderPossiblyNested(datastore, c, targetClass, (String) sort, order, true);
}
}
}
}
/**
* @deprecated No replacement. Do not use.
*/
@Deprecated
public static void setBinder(GrailsDomainBinder binder) {
}
/**
* Populates criteria arguments for the given target class and arguments map
*
* @param targetClass The target class
* @param c The criteria instance
* @param argMap The arguments map
*
*/
@Deprecated
@SuppressWarnings("rawtypes")
public static void populateArgumentsForCriteria(Class<?> targetClass, Criteria c, Map argMap, ConversionService conversionService) {
populateArgumentsForCriteria(null, targetClass, c, argMap, conversionService);
}
@SuppressWarnings("rawtypes")
public static void populateArgumentsForCriteria(Criteria c, Map argMap, ConversionService conversionService) {
populateArgumentsForCriteria(null, null, c, argMap, conversionService);
}
private static FlushMode convertFlushMode(Object object) {
if (object == null) {
return null;
}
if (object instanceof FlushMode) {
return (FlushMode)object;
}
return FlushMode.valueOf(String.valueOf(object));
}
/**
* Add order to criteria, creating necessary subCriteria if nested sort property (ie. sort:'nested.property').
*/
private static void addOrderPossiblyNested(AbstractHibernateDatastore datastore, Criteria c, Class<?> targetClass, String sort, String order, boolean ignoreCase) {
int firstDotPos = sort.indexOf(".");
if (firstDotPos == -1) {
addOrder(c, sort, order, ignoreCase);
} else { // nested property
String sortHead = sort.substring(0,firstDotPos);
String sortTail = sort.substring(firstDotPos+1);
PersistentProperty property = getGrailsDomainClassProperty(datastore, targetClass, sortHead);
if (property instanceof Embedded) {
// embedded objects cannot reference entities (at time of writing), so no more recursion needed
addOrder(c, sort, order, ignoreCase);
} else if(property instanceof Association) {
Criteria subCriteria = c.createCriteria(sortHead);
Class<?> propertyTargetClass = ((Association)property).getAssociatedEntity().getJavaClass();
GrailsHibernateUtil.cacheCriteriaByMapping(datastore, propertyTargetClass, subCriteria);
addOrderPossiblyNested(datastore, subCriteria, propertyTargetClass, sortTail, order, ignoreCase); // Recurse on nested sort
}
}
}
/**
* Add order directly to criteria.
*/
private static void addOrder(Criteria c, String sort, String order, boolean ignoreCase) {
if (ORDER_DESC.equals(order)) {
c.addOrder(ignoreCase ? Order.desc(sort).ignoreCase() : Order.desc(sort));
}
else {
c.addOrder(ignoreCase ? Order.asc(sort).ignoreCase() : Order.asc(sort));
}
}
/**
* Get hold of the GrailsDomainClassProperty represented by the targetClass' propertyName,
* assuming targetClass corresponds to a GrailsDomainClass.
*/
private static PersistentProperty getGrailsDomainClassProperty(AbstractHibernateDatastore datastore, Class<?> targetClass, String propertyName) {
PersistentEntity grailsClass = datastore != null ? datastore.getMappingContext().getPersistentEntity( targetClass.getName()) : null;
if (grailsClass == null) {
throw new IllegalArgumentException("Unexpected: class is not a domain class:"+targetClass.getName());
}
return grailsClass.getPropertyByName(propertyName);
}
/**
* Configures the criteria instance to cache based on the configured mapping.
*
* @param targetClass The target class
* @param criteria The criteria
*/
public static void cacheCriteriaByMapping(Class<?> targetClass, Criteria criteria) {
Mapping m = GrailsDomainBinder.getMapping(targetClass);
if (m != null && m.getCache() != null && m.getCache().getEnabled()) {
criteria.setCacheable(true);
}
}
public static void cacheCriteriaByMapping(AbstractHibernateDatastore datastore, Class<?> targetClass, Criteria criteria) {
cacheCriteriaByMapping(targetClass, criteria);
}
/**
* Retrieves the fetch mode for the specified instance; otherwise returns the default FetchMode.
*
* @param object The object, converted to a string
* @return The FetchMode
*/
public static FetchMode getFetchMode(Object object) {
String name = object != null ? object.toString() : "default";
if (name.equalsIgnoreCase(FetchMode.JOIN.toString()) || name.equalsIgnoreCase("eager")) {
return FetchMode.JOIN;
}
if (name.equalsIgnoreCase(FetchMode.SELECT.toString()) || name.equalsIgnoreCase("lazy")) {
return FetchMode.SELECT;
}
return FetchMode.DEFAULT;
}
/**
* Sets the target object to read-only using the given SessionFactory instance. This
* avoids Hibernate performing any dirty checking on the object
*
* @see #setObjectToReadWrite(Object, org.hibernate.SessionFactory)
*
* @param target The target object
* @param sessionFactory The SessionFactory instance
*/
public static void setObjectToReadyOnly(Object target, SessionFactory sessionFactory) {
Object resource = TransactionSynchronizationManager.getResource(sessionFactory);
if(resource != null) {
Session session = sessionFactory.getCurrentSession();
if (canModifyReadWriteState(session, target)) {
if (target instanceof HibernateProxy) {
target = ((HibernateProxy)target).getHibernateLazyInitializer().getImplementation();
}
session.setReadOnly(target, true);
session.setHibernateFlushMode(FlushMode.MANUAL);
}
}
}
private static boolean canModifyReadWriteState(Session session, Object target) {
return session.contains(target) && Hibernate.isInitialized(target);
}
/**
* Sets the target object to read-write, allowing Hibernate to dirty check it and auto-flush changes.
*
* @see #setObjectToReadyOnly(Object, org.hibernate.SessionFactory)
*
* @param target The target object
* @param sessionFactory The SessionFactory instance
*/
public static void setObjectToReadWrite(final Object target, SessionFactory sessionFactory) {
Session session = sessionFactory.getCurrentSession();
if (!canModifyReadWriteState(session, target)) {
return;
}
SessionImplementor sessionImpl = (SessionImplementor) session;
EntityEntry ee = sessionImpl.getPersistenceContext().getEntry(target);
if (ee == null || ee.getStatus() != Status.READ_ONLY) {
return;
}
Object actualTarget = target;
if (target instanceof HibernateProxy) {
actualTarget = ((HibernateProxy)target).getHibernateLazyInitializer().getImplementation();
}
session.setReadOnly(actualTarget, false);
session.setHibernateFlushMode(FlushMode.AUTO);
incrementVersion(target);
}
/**
* Increments the entities version number in order to force an update
* @param target The target entity
*/
public static void incrementVersion(Object target) {
MetaClass metaClass = GroovySystem.getMetaClassRegistry().getMetaClass(target.getClass());
if (metaClass.hasProperty(target, GormProperties.VERSION)!=null) {
Object version = metaClass.getProperty(target, GormProperties.VERSION);
if (version instanceof Long) {
Long newVersion = (Long) version + 1;
metaClass.setProperty(target, GormProperties.VERSION, newVersion);
}
}
}
/**
* Ensures the meta class is correct for a given class
*
* @param target The GroovyObject
* @param persistentClass The persistent class
*/
@Deprecated
public static void ensureCorrectGroovyMetaClass(Object target, Class<?> persistentClass) {
if (target instanceof GroovyObject) {
GroovyObject go = ((GroovyObject)target);
if (!go.getMetaClass().getTheClass().equals(persistentClass)) {
go.setMetaClass(GroovySystem.getMetaClassRegistry().getMetaClass(persistentClass));
}
}
}
/**
* Unwraps and initializes a HibernateProxy.
* @param proxy The proxy
* @return the unproxied instance
*/
public static Object unwrapProxy(HibernateProxy proxy) {
return proxyHandler.unwrap(proxy);
}
/**
* Returns the proxy for a given association or null if it is not proxied
*
* @param obj The object
* @param associationName The named assoication
* @return A proxy
*/
public static HibernateProxy getAssociationProxy(Object obj, String associationName) {
return proxyHandler.getAssociationProxy(obj, associationName);
}
/**
* Checks whether an associated property is initialized and returns true if it is
*
* @param obj The name of the object
* @param associationName The name of the association
* @return true if is initialized
*/
public static boolean isInitialized(Object obj, String associationName) {
return proxyHandler.isInitialized(obj, associationName);
}
/**
* Unproxies a HibernateProxy. If the proxy is uninitialized, it automatically triggers an initialization.
* In case the supplied object is null or not a proxy, the object will be returned as-is.
*/
public static Object unwrapIfProxy(Object instance) {
return proxyHandler.unwrap(instance);
}
/**
* @deprecated Use {@link MultipleDataSourceSupport#getDefaultDataSource(PersistentEntity)} instead
*/
@Deprecated
public static String getDefaultDataSource(PersistentEntity domainClass) {
return MultipleDataSourceSupport.getDefaultDataSource(domainClass);
}
/**
* @deprecated Use {@link MultipleDataSourceSupport#getDatasourceNames(PersistentEntity)} instead
*/
@Deprecated
public static List<String> getDatasourceNames(PersistentEntity domainClass) {
return MultipleDataSourceSupport.getDatasourceNames(domainClass);
}
/**
* @deprecated Use {@link MultipleDataSourceSupport#getDefaultDataSource(PersistentEntity)} instead
*/
@Deprecated
public static boolean usesDatasource(PersistentEntity domainClass, String dataSourceName) {
return MultipleDataSourceSupport.usesDatasource(domainClass, dataSourceName);
}
public static boolean isMappedWithHibernate(PersistentEntity domainClass) {
return domainClass instanceof HibernatePersistentEntity;
}
public static String qualify(final String prefix, final String name) {
return StringHelper.qualify(prefix, name);
}
public static boolean isNotEmpty(final String string) {
return StringHelper.isNotEmpty(string);
}
public static String unqualify(final String qualifiedName) {
return StringHelper.unqualify(qualifiedName);
}
}