-
Notifications
You must be signed in to change notification settings - Fork 188
/
BaseSortableDataProvider.java
381 lines (317 loc) · 13.1 KB
/
BaseSortableDataProvider.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
/*
* Copyright (c) 2010-2017 Evolveum
*
* 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 com.evolveum.midpoint.web.component.data;
import com.evolveum.midpoint.gui.api.page.PageBase;
import com.evolveum.midpoint.gui.api.util.WebComponentUtil;
import com.evolveum.midpoint.model.api.*;
import com.evolveum.midpoint.prism.PrismContext;
import com.evolveum.midpoint.prism.path.ItemPath;
import com.evolveum.midpoint.prism.query.ObjectOrdering;
import com.evolveum.midpoint.prism.query.ObjectPaging;
import com.evolveum.midpoint.prism.query.ObjectQuery;
import com.evolveum.midpoint.prism.query.OrderDirection;
import com.evolveum.midpoint.repo.api.RepositoryService;
import com.evolveum.midpoint.schema.GetOperationOptions;
import com.evolveum.midpoint.schema.SchemaConstantsGenerated;
import com.evolveum.midpoint.schema.SelectorOptions;
import com.evolveum.midpoint.schema.result.OperationResult;
import com.evolveum.midpoint.task.api.TaskManager;
import com.evolveum.midpoint.util.logging.Trace;
import com.evolveum.midpoint.util.logging.TraceManager;
import com.evolveum.midpoint.web.page.PageDialog;
import com.evolveum.midpoint.web.security.MidPointApplication;
import com.evolveum.midpoint.wf.api.WorkflowManager;
import com.evolveum.midpoint.xml.ns._public.common.common_3.AdminGuiConfigurationType;
import com.evolveum.midpoint.xml.ns._public.common.common_3.DistinctSearchOptionType;
import com.evolveum.midpoint.xml.ns._public.common.common_3.GuiObjectListType;
import org.apache.commons.lang.Validate;
import org.apache.wicket.Component;
import org.apache.wicket.extensions.markup.html.repeater.data.sort.SortOrder;
import org.apache.wicket.extensions.markup.html.repeater.util.SortParam;
import org.apache.wicket.extensions.markup.html.repeater.util.SortableDataProvider;
import org.apache.wicket.model.AbstractReadOnlyModel;
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.Model;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import javax.xml.namespace.QName;
import java.io.Serializable;
import java.util.*;
import static com.evolveum.midpoint.gui.api.util.WebComponentUtil.safeLongToInteger;
/**
* @author lazyman
*/
public abstract class BaseSortableDataProvider<T extends Serializable> extends SortableDataProvider<T, String> {
private static final Trace LOGGER = TraceManager.getTrace(BaseSortableDataProvider.class);
private static final String DOT_CLASS = BaseSortableDataProvider.class.getName() + ".";
private static final String OPERATION_GET_EXPORT_SIZE_LIMIT = DOT_CLASS + "getDefaultExportSizeLimit";
private Component component;
private List<T> availableData;
private ObjectQuery query;
// after this amount of time cached size will be removed
// from cache and replaced by new value, time in seconds
private Map<Serializable, CachedSize> cache = new HashMap<>();
private int cacheCleanupThreshold = 60;
private boolean useCache;
private boolean exportSize = false;
private long exportLimit = -1;
public BaseSortableDataProvider(Component component) {
this(component, false, true);
}
public BaseSortableDataProvider(Component component, boolean useCache) {
this(component, useCache, true);
}
public BaseSortableDataProvider(Component component, boolean useCache, boolean useDefaultSortingField) {
Validate.notNull(component, "Component must not be null.");
this.component = component;
this.useCache = useCache;
if (useDefaultSortingField) {
setSort("name", SortOrder.ASCENDING);
}
setExportLimitValue();
}
protected ModelService getModel() {
MidPointApplication application = MidPointApplication.get();
return application.getModel();
}
protected RepositoryService getRepositoryService() {
MidPointApplication application = MidPointApplication.get();
return application.getRepositoryService();
}
protected TaskManager getTaskManager() {
MidPointApplication application = MidPointApplication.get();
return application.getTaskManager();
}
protected PrismContext getPrismContext() {
MidPointApplication application = MidPointApplication.get();
return application.getPrismContext();
}
protected TaskService getTaskService() {
MidPointApplication application = MidPointApplication.get();
return application.getTaskService();
}
protected ModelInteractionService getModelInteractionService() {
MidPointApplication application = MidPointApplication.get();
return application.getModelInteractionService();
}
protected WorkflowService getWorkflowService() {
MidPointApplication application = MidPointApplication.get();
return application.getWorkflowService();
}
protected ModelAuditService getAuditService() {
MidPointApplication application = MidPointApplication.get();
return application.getAuditService();
}
protected WorkflowManager getWorkflowManager() {
MidPointApplication application = MidPointApplication.get();
return application.getWorkflowManager();
}
public List<T> getAvailableData() {
if (availableData == null) {
availableData = new ArrayList<>();
}
return availableData;
}
@Override
public IModel<T> model(T object) {
return new Model<>(object);
}
protected PageBase getPage() {
if (component instanceof PageBase) {
return (PageBase) component;
}
if (component.getPage() instanceof PageBase) {
return (PageBase) component.getPage();
}
if (component.getPage() instanceof PageDialog) {
return ((PageDialog) component.getPage()).getPageBase();
}
throw new IllegalStateException("Component is not instance of '" + PageBase.class.getName()
+ "' or is not placed on page of that instance.");
}
public ObjectQuery getQuery() {
return query;
}
public void setQuery(ObjectQuery query) {
this.query = query;
}
/**
* Flag method for {@link TablePanel}. If true navigation panel with paging "X to Y from Z results is shown",
* otherwise only "previous and next" simple paging is used.
*
* @return By defaults it returns true.
*/
public IModel<Boolean> isSizeAvailableModel() {
return new AbstractReadOnlyModel<Boolean>() {
@Override
public Boolean getObject() {
return true;
}
};
}
protected boolean checkOrderingSettings() {
return false;
}
public boolean isDistinct() {
GuiObjectListType def = WebComponentUtil.getDefaultGuiObjectListType((PageBase) component.getPage());
return def == null || def.getDistinct() != DistinctSearchOptionType.NEVER; // change after other options are added
}
protected Collection<SelectorOptions<GetOperationOptions>> createDefaultOptions() {
return getDistinctRelatedOptions(); // probably others in the future
}
@Nullable
protected Collection<SelectorOptions<GetOperationOptions>> getDistinctRelatedOptions() {
if (isDistinct()) {
return SelectorOptions.createCollection(GetOperationOptions.createDistinct());
} else {
return null;
}
}
public boolean isOrderingDisabled() {
if (!checkOrderingSettings()) {
return false;
}
GuiObjectListType def = WebComponentUtil.getDefaultGuiObjectListType((PageBase) component.getPage());
return def != null && def.isDisableSorting();
}
protected ObjectPaging createPaging(long offset, long pageSize) {
Integer o = safeLongToInteger(offset);
Integer size = safeLongToInteger(pageSize);
List<ObjectOrdering> orderings = null;
if (!isOrderingDisabled()) {
orderings = createObjectOrderings(getSort());
}
return ObjectPaging.createPaging(o, size, orderings);
}
/**
* Could be overridden in subclasses.
*/
@NotNull
protected List<ObjectOrdering> createObjectOrderings(SortParam<String> sortParam) {
if (sortParam != null && sortParam.getProperty() != null) {
OrderDirection order = sortParam.isAscending() ? OrderDirection.ASCENDING : OrderDirection.DESCENDING;
return Collections.singletonList(
ObjectOrdering.createOrdering(
new ItemPath(new QName(SchemaConstantsGenerated.NS_COMMON, sortParam.getProperty())), order));
} else {
return Collections.emptyList();
}
}
public void clearCache() {
cache.clear();
getAvailableData().clear();
}
public int getCacheCleanupThreshold() {
return cacheCleanupThreshold;
}
public void setCacheCleanupThreshold(int cacheCleanupThreshold) {
Validate.isTrue(cacheCleanupThreshold > 0, "Cache cleanup threshold must be bigger than zero.");
this.cacheCleanupThreshold = cacheCleanupThreshold;
}
@Override
public Iterator<? extends T> iterator(long first, long count) {
Iterator<? extends T> iterator = internalIterator(first, count);
saveProviderPaging(getQuery(), createPaging(first, count));
return iterator;
}
protected void saveProviderPaging(ObjectQuery query, ObjectPaging paging) {
}
public abstract Iterator<? extends T> internalIterator(long first, long count);
@Override
public long size() {
LOGGER.trace("begin::size()");
if (!useCache) {
int internalSize = internalSize();
return exportSize && exportLimit >= 0 && exportLimit < internalSize ? exportLimit : internalSize;
}
long size;
CachedSize cachedSize = getCachedSize(cache);
if (cachedSize != null) {
long timestamp = cachedSize.getTimestamp();
if (System.currentTimeMillis() - timestamp > cacheCleanupThreshold * 1000) {
//recreate
size = internalSize();
addCachedSize(cache, new CachedSize(size, System.currentTimeMillis()));
} else {
LOGGER.trace("Size returning from cache.");
size = cachedSize.getSize();
}
} else {
//recreate
size = internalSize();
addCachedSize(cache, new CachedSize(size, System.currentTimeMillis()));
}
LOGGER.trace("end::size(): {}", size);
return exportSize && exportLimit >= 0 && exportLimit < size ? exportLimit : size;
}
protected abstract int internalSize();
protected CachedSize getCachedSize(Map<Serializable, CachedSize> cache) {
return cache.get(query);
}
protected void addCachedSize(Map<Serializable, CachedSize> cache, CachedSize newSize) {
cache.put(query, newSize);
}
public static class CachedSize implements Serializable {
private long timestamp;
private long size;
private CachedSize(long size, long timestamp) {
this.size = size;
this.timestamp = timestamp;
}
public long getSize() {
return size;
}
public long getTimestamp() {
return timestamp;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
CachedSize that = (CachedSize) o;
if (size != that.size) return false;
if (timestamp != that.timestamp) return false;
return true;
}
@Override
public int hashCode() {
int result = (int) (timestamp ^ (timestamp >>> 32));
result = 31 * result + (int) (size ^ (size >>> 32));
return result;
}
@Override
public String toString() {
return "CachedSize(size=" + size + ", timestamp=" + timestamp + ")";
}
}
private void setExportLimitValue() {
OperationResult result = new OperationResult(OPERATION_GET_EXPORT_SIZE_LIMIT);
try {
AdminGuiConfigurationType adminGui = getModelInteractionService().getAdminGuiConfiguration(null, result);
if (adminGui.getDefaultExportSettings() != null && adminGui.getDefaultExportSettings().getSizeLimit() != null) {
exportLimit = adminGui.getDefaultExportSettings().getSizeLimit();
}
} catch (Exception ex) {
LOGGER.error("Unable to get default export size limit, ", ex);
}
}
public boolean isExportSize() {
return exportSize;
}
public void setExportSize(boolean exportSize) {
this.exportSize = exportSize;
}
}