/
ObjectListPanel.java
435 lines (354 loc) · 13.8 KB
/
ObjectListPanel.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
/*
* Copyright (c) 2010-2016 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.gui.api.component;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.commons.lang3.StringUtils;
import org.apache.wicket.Component;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.markup.html.form.Form;
import org.apache.wicket.model.StringResourceModel;
import com.evolveum.midpoint.gui.api.model.LoadableModel;
import com.evolveum.midpoint.gui.api.page.PageBase;
import com.evolveum.midpoint.prism.query.ObjectPaging;
import com.evolveum.midpoint.prism.query.ObjectQuery;
import com.evolveum.midpoint.schema.GetOperationOptions;
import com.evolveum.midpoint.schema.SelectorOptions;
import com.evolveum.midpoint.util.logging.Trace;
import com.evolveum.midpoint.util.logging.TraceManager;
import com.evolveum.midpoint.web.component.data.BaseSortableDataProvider;
import com.evolveum.midpoint.web.component.data.BoxedTablePanel;
import com.evolveum.midpoint.web.component.data.SelectableBeanObjectDataProvider;
import com.evolveum.midpoint.web.component.data.Table;
import com.evolveum.midpoint.web.component.data.column.CheckBoxHeaderColumn;
import com.evolveum.midpoint.web.component.data.column.ColumnUtils;
import com.evolveum.midpoint.web.component.menu.cog.InlineMenuItem;
import com.evolveum.midpoint.web.component.search.Search;
import com.evolveum.midpoint.web.component.search.SearchFactory;
import com.evolveum.midpoint.web.component.search.SearchFormPanel;
import com.evolveum.midpoint.web.component.util.ListDataProvider2;
import com.evolveum.midpoint.web.component.util.SelectableBean;
import com.evolveum.midpoint.web.page.admin.reports.PageReports;
import com.evolveum.midpoint.web.page.admin.resources.PageResources;
import com.evolveum.midpoint.web.page.admin.roles.PageRoles;
import com.evolveum.midpoint.web.page.admin.services.PageServices;
import com.evolveum.midpoint.web.page.admin.users.PageUsers;
import com.evolveum.midpoint.web.session.PageStorage;
import com.evolveum.midpoint.web.session.SessionStorage;
import com.evolveum.midpoint.web.session.UserProfileStorage.TableId;
import com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType;
import com.evolveum.midpoint.xml.ns._public.common.common_3.ResourceType;
/**
* @author katkav
*/
public abstract class ObjectListPanel<O extends ObjectType> extends BasePanel<O> {
private static final long serialVersionUID = 1L;
private static final String ID_MAIN_FORM = "mainForm";
private static final String ID_TABLE = "table";
private static final Trace LOGGER = TraceManager.getTrace(ObjectListPanel.class);
private Class<O> type;
private PageBase parentPage;
private LoadableModel<Search> searchModel;
private BaseSortableDataProvider<SelectableBean<O>> provider;
private Collection<SelectorOptions<GetOperationOptions>> options;
private boolean multiselect;
private TableId tableId;
private String addutionalBoxCssClasses;
public Class<O> getType() {
return type;
}
private static Map<Class, String> storageMap;
static {
storageMap = new HashMap<Class, String>();
storageMap.put(PageUsers.class, SessionStorage.KEY_USERS);
storageMap.put(PageResources.class, SessionStorage.KEY_RESOURCES);
storageMap.put(PageReports.class, SessionStorage.KEY_REPORTS);
storageMap.put(PageRoles.class, SessionStorage.KEY_ROLES);
storageMap.put(PageServices.class, SessionStorage.KEY_SERVICES);
}
// private static Map<Class, TableId> tablePagingMap;
// static {
// tablePagingMap = new HashMap<Class, TableId>();
// tablePagingMap.put(PageResources.class, TableId.PAGE_RESOURCES_PANEL);
// tablePagingMap.put(PageReports.class, TableId.PAGE_REPORTS);
// tablePagingMap.put(PageRoles.class, TableId.TABLE_ROLES);
// tablePagingMap.put(PageServices.class, TableId.TABLE_SERVICES);
// tablePagingMap.put(PageUsers.class, TableId.TABLE_USERS);
// }
public ObjectListPanel(String id, Class<O> type, TableId tableId, Collection<SelectorOptions<GetOperationOptions>> options,
PageBase parentPage) {
super(id);
this.type = type;
this.parentPage = parentPage;
this.options = options;
this.tableId = tableId;
initLayout();
}
ObjectListPanel(String id, Class<O> type, boolean multiselect, PageBase parentPage) {
super(id);
this.type = type;
this.parentPage = parentPage;
this.multiselect = multiselect;
initLayout();
}
public boolean isMultiselect() {
return multiselect;
}
public void setProvider(BaseSortableDataProvider<SelectableBean<O>> provider) {
this.provider = provider;
}
public List<O> getSelectedObjects() {
BaseSortableDataProvider<SelectableBean<O>> dataProvider = getDataProvider();
if (dataProvider instanceof SelectableBeanObjectDataProvider) {
return ((SelectableBeanObjectDataProvider) dataProvider).getSelectedData();
} else if (dataProvider instanceof ListDataProvider2) {
return ((ListDataProvider2) dataProvider).getSelectedObjects();
}
return new ArrayList<>();
}
private void initLayout() {
Form<O> mainForm = new Form<O>(ID_MAIN_FORM);
add(mainForm);
searchModel = new LoadableModel<Search>(false) {
private static final long serialVersionUID = 1L;
@Override
public Search load() {
String storageKey = getStorageKey();
Search search = null;
if (StringUtils.isNotEmpty(storageKey)) {
PageStorage storage = getPageStorage(storageKey);
if (storage != null) {
search = storage.getSearch();
}
}
if (search == null) {
search = SearchFactory.createSearch(type, parentPage.getPrismContext(), true);
}
return search;
}
};
BoxedTablePanel<SelectableBean<O>> table = createTable();
mainForm.add(table);
}
protected BaseSortableDataProvider<SelectableBean<O>> getProvider() {
if (provider != null) {
return provider;
}
SelectableBeanObjectDataProvider<O> objProvider = new SelectableBeanObjectDataProvider<O>(
parentPage, type) {
private static final long serialVersionUID = 1L;
@Override
protected void saveProviderPaging(ObjectQuery query, ObjectPaging paging) {
String storageKey = getStorageKey();
if (StringUtils.isNotEmpty(storageKey)) {
PageStorage storage = getPageStorage(storageKey);
if (storage != null) {
storage.setPaging(paging);
}
}
}
@Override
public SelectableBean<O> createDataObjectWrapper(O obj) {
SelectableBean<O> bean = super.createDataObjectWrapper(obj);
List<InlineMenuItem> inlineMenu = createInlineMenu();
if (inlineMenu != null) {
bean.getMenuItems().addAll(inlineMenu);
}
return bean;
}
};
if (options == null){
if (ResourceType.class.equals(type)) {
options = SelectorOptions.createCollection(GetOperationOptions.createNoFetch());
}
} else {
if (ResourceType.class.equals(type)) {
GetOperationOptions root = SelectorOptions.findRootOptions(options);
root.setNoFetch(Boolean.TRUE);
}
objProvider.setOptions(options);
}
provider = objProvider;
return provider;
}
private BoxedTablePanel<SelectableBean<O>> createTable() {
List<IColumn<SelectableBean<O>, String>> columns = initColumns();
provider = getProvider();
provider.setQuery(getQuery());
// TableId tableId = tablePagingMap.get(parentPage.getClass());
BoxedTablePanel<SelectableBean<O>> table = new BoxedTablePanel<SelectableBean<O>>(ID_TABLE, provider,
columns, tableId, tableId == null ? 10 : parentPage.getSessionStorage().getUserProfile().getPagingSize(tableId)) {
private static final long serialVersionUID = 1L;
@Override
protected WebMarkupContainer createHeader(String headerId) {
return initSearch(headerId);
}
@Override
public String getAdditionalBoxCssClasses() {
return ObjectListPanel.this.getAdditionalBoxCssClasses();
}
@Override
protected WebMarkupContainer createButtonToolbar(String id) {
WebMarkupContainer bar = ObjectListPanel.this.createTableButtonToolbar(id);
return bar != null ? bar : super.createButtonToolbar(id);
}
};
table.setOutputMarkupId(true);
String storageKey = getStorageKey();
if (StringUtils.isNotEmpty(storageKey)) {
PageStorage storage = getPageStorage(storageKey);
if (storage != null) {
table.setCurrentPage(storage.getPaging());
}
}
return table;
}
public String getAdditionalBoxCssClasses() {
return addutionalBoxCssClasses;
}
public void setAdditionalBoxCssClasses(String boxCssClasses) {
this.addutionalBoxCssClasses = boxCssClasses;
}
/**
* there's no way to do it properly...
*/
@Deprecated
protected WebMarkupContainer createTableButtonToolbar(String id) {
return null;
}
private BaseSortableDataProvider<SelectableBean<O>> getDataProvider() {
BoxedTablePanel<SelectableBean<O>> table = getTable();
BaseSortableDataProvider<SelectableBean<O>> provider = (BaseSortableDataProvider<SelectableBean<O>>) table
.getDataTable().getDataProvider();
return provider;
}
protected BoxedTablePanel<SelectableBean<O>> getTable() {
return (BoxedTablePanel<SelectableBean<O>>) get(createComponentPath(ID_MAIN_FORM, ID_TABLE));
}
private String getStorageKey() {
return storageMap.get(parentPage.getClass());
}
private PageStorage getPageStorage(String storageKey){
PageStorage storage = getSession().getSessionStorage().getPageStorageMap().get(storageKey);
if (storage == null) {
storage = getSession().getSessionStorage().initPageStorage(storageKey);
}
return storage;
}
private void searchPerformed(ObjectQuery query, AjaxRequestTarget target) {
BaseSortableDataProvider<SelectableBean<O>> provider = getDataProvider();
provider.setQuery(query);
String storageKey = getStorageKey();
if (StringUtils.isNotEmpty(storageKey)) {
PageStorage storage = getPageStorage(storageKey);
if (storage != null) {
storage.setSearch(searchModel.getObject());
storage.setPaging(null);
}
}
Table table = getTable();
table.setCurrentPage(null);
target.add((Component) table);
target.add(parentPage.getFeedbackPanel());
}
public void refreshTable(Class<O> newType, AjaxRequestTarget target) {
BaseSortableDataProvider<SelectableBean<O>> provider = getDataProvider();
provider.setQuery(getQuery());
if (newType != null && provider instanceof SelectableBeanObjectDataProvider) {
((SelectableBeanObjectDataProvider) provider).setType(newType);
}
if (newType != null && !this.type.equals(newType)) {
this.type = newType;
searchModel.reset();
} else {
saveSearchModel();
}
BoxedTablePanel table = getTable();
((WebMarkupContainer) table.get("box")).addOrReplace(initSearch("header"));
table.setCurrentPage(null);
target.add((Component) table);
target.add(parentPage.getFeedbackPanel());
}
private SearchFormPanel initSearch(String headerId) {
SearchFormPanel searchPanel = new SearchFormPanel(headerId, searchModel) {
private static final long serialVersionUID = 1L;
@Override
protected void searchPerformed(ObjectQuery query, AjaxRequestTarget target) {
ObjectListPanel.this.searchPerformed(query, target);
}
};
return searchPanel;
}
private void saveSearchModel() {
String storageKey = getStorageKey();
if (StringUtils.isNotEmpty(storageKey)) {
PageStorage storage = getPageStorage(storageKey);
if (storage != null) {
storage.setSearch(searchModel.getObject());
storage.setPaging(null);
}
}
}
public void clearCache() {
BaseSortableDataProvider provider = getDataProvider();
provider.clearCache();
if (provider instanceof SelectableBeanObjectDataProvider) {
((SelectableBeanObjectDataProvider) provider).clearSelectedObjects();
}
}
public ObjectQuery getQuery() {
ObjectQuery customQuery = createContentQuery();
return customQuery;
}
protected ObjectQuery createContentQuery() {
Search search = searchModel.getObject();
ObjectQuery query = search.createObjectQuery(parentPage.getPrismContext());
query = addFilterToContentQuery(query);
return query;
}
protected ObjectQuery addFilterToContentQuery(ObjectQuery query) {
return query;
}
public StringResourceModel createStringResource(String resourceKey, Object... objects) {
return PageBase.createStringResourceStatic(this, resourceKey, objects);
}
protected abstract IColumn<SelectableBean<O>, String> createCheckboxColumn();
protected abstract IColumn<SelectableBean<O>, String> createNameColumn();
protected abstract List<IColumn<SelectableBean<O>, String>> createColumns();
protected abstract List<InlineMenuItem> createInlineMenu();
protected List<IColumn<SelectableBean<O>, String>> initColumns() {
List<IColumn<SelectableBean<O>, String>> columns = new ArrayList<IColumn<SelectableBean<O>, String>>();
CheckBoxHeaderColumn<SelectableBean<O>> checkboxColumn = (CheckBoxHeaderColumn<SelectableBean<O>>) createCheckboxColumn();
if (checkboxColumn != null) {
columns.add(checkboxColumn);
}
IColumn<SelectableBean<O>, String> iconColumn = ColumnUtils.createIconColumn(type);
columns.add(iconColumn);
IColumn<SelectableBean<O>, String> nameColumn = createNameColumn();
columns.add(nameColumn);
List<IColumn<SelectableBean<O>, String>> others = createColumns();
columns.addAll(others);
return columns;
}
public void addPerformed(AjaxRequestTarget target, List<O> selected) {
parentPage.hideMainPopup(target);
}
}