-
Notifications
You must be signed in to change notification settings - Fork 188
/
ProgressReporter.java
322 lines (275 loc) · 13.5 KB
/
ProgressReporter.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
/*
* Copyright (c) 2010-2018 Evolveum and contributors
*
* This work is dual-licensed under the Apache License 2.0
* and European Union Public License. See LICENSE file for details.
*/
package com.evolveum.midpoint.web.component.progress;
import com.evolveum.midpoint.model.api.ProgressInformation;
import com.evolveum.midpoint.model.api.ProgressListener;
import com.evolveum.midpoint.model.api.context.ModelContext;
import com.evolveum.midpoint.model.api.context.ModelElementContext;
import com.evolveum.midpoint.model.api.context.ModelProjectionContext;
import com.evolveum.midpoint.prism.PrismObject;
import com.evolveum.midpoint.prism.delta.ObjectDelta;
import com.evolveum.midpoint.prism.polystring.PolyString;
import com.evolveum.midpoint.schema.GetOperationOptions;
import com.evolveum.midpoint.schema.ObjectDeltaOperation;
import com.evolveum.midpoint.schema.SelectorOptions;
import com.evolveum.midpoint.schema.processor.ResourceAttribute;
import com.evolveum.midpoint.schema.result.OperationResult;
import com.evolveum.midpoint.schema.result.OperationResultStatus;
import com.evolveum.midpoint.schema.util.ShadowUtil;
import com.evolveum.midpoint.task.api.Task;
import com.evolveum.midpoint.util.exception.CommonException;
import com.evolveum.midpoint.util.logging.LoggingUtils;
import com.evolveum.midpoint.util.logging.Trace;
import com.evolveum.midpoint.util.logging.TraceManager;
import com.evolveum.midpoint.web.security.MidPointApplication;
import com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType;
import com.evolveum.midpoint.xml.ns._public.common.common_3.OperationResultStatusType;
import com.evolveum.midpoint.xml.ns._public.common.common_3.ResourceType;
import com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType;
import org.apache.commons.lang.StringUtils;
import org.jetbrains.annotations.NotNull;
import java.util.*;
import static com.evolveum.midpoint.model.api.ProgressInformation.ActivityType.*;
import static com.evolveum.midpoint.model.api.ProgressInformation.StateType.ENTERING;
import static com.evolveum.midpoint.model.api.ProgressInformation.StateType.EXITING;
/**
* @author Viliam Repan (lazyman)
* @author mederly
*/
public class ProgressReporter implements ProgressListener {
private static final Trace LOGGER = TraceManager.getTrace(ProgressReporter.class);
private MidPointApplication application;
private Map<String, String> nameCache = new HashMap<>();
private ProgressDto progress = new ProgressDto();
private boolean abortRequested;
// Operation result got from the asynchronous operation (null if async op not yet finished)
private OperationResult asyncOperationResult;
private ModelContext<? extends ObjectType> previewResult;
private Collection<ObjectDeltaOperation<? extends ObjectType>> objectDeltaOperation;
private long operationStartTime; // if 0, operation hasn't start yet
private long operationDurationTime; // if >0, operation has finished
// configuration properties
private int refreshInterval;
private boolean asynchronousExecution;
private boolean abortEnabled;
public ProgressReporter(MidPointApplication application) {
this.application = application;
}
public OperationResult getAsyncOperationResult() {
return asyncOperationResult;
}
public int getRefreshInterval() {
return refreshInterval;
}
public boolean isAsynchronousExecution() {
return asynchronousExecution;
}
public boolean isAbortEnabled() {
return abortEnabled;
}
public ModelContext<? extends ObjectType> getPreviewResult() {
return previewResult;
}
public void setAsyncOperationResult(OperationResult asyncOperationResult) {
this.asyncOperationResult = asyncOperationResult;
}
public Collection<ObjectDeltaOperation<? extends ObjectType>> getObjectDeltaOperation() {
return objectDeltaOperation;
}
public void setObjectDeltaOperation(Collection<ObjectDeltaOperation<? extends ObjectType>> objectDeltaOperation) {
this.objectDeltaOperation = objectDeltaOperation;
}
public void setPreviewResult(ModelContext<? extends ObjectType> previewResult) {
this.previewResult = previewResult;
}
public void setRefreshInterval(int refreshInterval) {
this.refreshInterval = refreshInterval;
}
public void setAsynchronousExecution(boolean asynchronousExecution) {
this.asynchronousExecution = asynchronousExecution;
}
public void setAbortEnabled(boolean abortEnabled) {
this.abortEnabled = abortEnabled;
}
public void recordExecutionStart() {
operationDurationTime = 0;
operationStartTime = System.currentTimeMillis();
}
public void recordExecutionStop() {
operationDurationTime = System.currentTimeMillis() - operationStartTime;
}
public ProgressDto getProgress() {
return progress;
}
public long getOperationStartTime() {
return operationStartTime;
}
public long getOperationDurationTime() {
return operationDurationTime;
}
@Override
public void onProgressAchieved(ModelContext modelContext, ProgressInformation progressInformation) {
if (LOGGER.isTraceEnabled()) {
LOGGER.trace("onProgressAchieved: {}\n, modelContext = \n{}", progressInformation.debugDump(),
modelContext.debugDump(2));
}
if (progress == null) {
LOGGER.error("No progress, exiting"); // should not occur
return;
}
if (StringUtils.isNotEmpty(progressInformation.getMessage())) {
progress.log(progressInformation.getMessage());
}
ProgressInformation.ActivityType activity = progressInformation.getActivityType();
if (activity != CLOCKWORK && activity != WAITING) {
List<ProgressReportActivityDto> progressReportActivities = progress.getProgressReportActivities();
ProgressReportActivityDto si = findRelevantStatusItem(progressReportActivities, progressInformation);
if (si == null) {
progress.add(createStatusItem(progressInformation, modelContext));
} else {
updateStatusItemState(si, progressInformation, modelContext);
}
addExpectedStatusItems(progressReportActivities, modelContext);
} else {
// these two should not be visible in the list of activities
}
}
@Override
public boolean isAbortRequested() {
return abortRequested;
}
public void setAbortRequested(boolean value) {
this.abortRequested = value;
}
private void addExpectedStatusItems(List<ProgressReportActivityDto> progressReportActivities, ModelContext modelContext) {
if (modelContext.getFocusContext() != null) {
ModelElementContext fc = modelContext.getFocusContext();
if (isNotEmpty(fc.getPrimaryDelta()) || isNotEmpty(fc.getSecondaryDelta())) {
ProgressInformation modelStatus = new ProgressInformation(FOCUS_OPERATION, (ProgressInformation.StateType) null);
if (findRelevantStatusItem(progressReportActivities, modelStatus) == null) {
progressReportActivities.add(createStatusItem(modelStatus, modelContext));
}
}
}
if (modelContext.getProjectionContexts() != null) {
Collection<ModelProjectionContext> projectionContexts = modelContext.getProjectionContexts();
for (ModelProjectionContext mpc : projectionContexts) {
ProgressInformation projectionStatus = new ProgressInformation(RESOURCE_OBJECT_OPERATION,
mpc.getResourceShadowDiscriminator(), (ProgressInformation.StateType) null);
if (findRelevantStatusItem(progressReportActivities, projectionStatus) == null) {
progressReportActivities.add(createStatusItem(projectionStatus, modelContext));
}
}
}
}
private boolean isNotEmpty(ObjectDelta delta) {
return delta != null && !delta.isEmpty();
}
private ProgressReportActivityDto findRelevantStatusItem(List<ProgressReportActivityDto> progressReportActivities,
ProgressInformation progressInformation) {
for (ProgressReportActivityDto si : progressReportActivities) {
if (si.correspondsTo(progressInformation)) {
return si;
}
}
return null;
}
private void updateStatusItemState(ProgressReportActivityDto si, ProgressInformation progressInformation,
ModelContext modelContext) {
si.setActivityType(progressInformation.getActivityType());
si.setResourceShadowDiscriminator(progressInformation.getResourceShadowDiscriminator());
if (progressInformation.getResourceShadowDiscriminator() != null) {
String resourceOid = progressInformation.getResourceShadowDiscriminator().getResourceOid();
String resourceName = resourceOid != null ? getResourceName(resourceOid) : "";
si.setResourceName(resourceName);
}
if (progressInformation.getStateType() == null) {
si.setStatus(null);
} else if (progressInformation.getStateType() == ENTERING) {
si.setStatus(OperationResultStatusType.IN_PROGRESS);
} else {
OperationResult result = progressInformation.getOperationResult();
if (result != null) {
OperationResultStatus status = result.getStatus();
if (status == OperationResultStatus.UNKNOWN) {
status = result.getComputeStatus();
}
si.setStatus(status.createStatusType());
} else {
si.setStatus(OperationResultStatusType.UNKNOWN);
}
}
// information about modifications on a resource
if (progressInformation.getActivityType() == RESOURCE_OBJECT_OPERATION &&
progressInformation.getStateType() == EXITING &&
progressInformation.getResourceShadowDiscriminator() != null &&
progressInformation.getResourceShadowDiscriminator().getResourceOid() != null) {
ModelProjectionContext mpc = modelContext.findProjectionContext(progressInformation.getResourceShadowDiscriminator());
if (mpc != null) { // it shouldn't be null!
// operations performed (TODO aggregate them somehow?)
List<ProgressReportActivityDto.ResourceOperationResult> resourceOperationResultList = new ArrayList<>();
List<? extends ObjectDeltaOperation> executedDeltas = mpc.getExecutedDeltas();
for (ObjectDeltaOperation executedDelta : executedDeltas) {
ObjectDelta delta = executedDelta.getObjectDelta();
if (delta != null) {
OperationResult r = executedDelta.getExecutionResult();
OperationResultStatus status = r.getStatus();
if (status == OperationResultStatus.UNKNOWN) {
status = r.getComputeStatus();
}
resourceOperationResultList.add(
new ProgressReportActivityDto.ResourceOperationResult(delta.getChangeType(), status));
}
}
si.setResourceOperationResultList(resourceOperationResultList);
// object name
PrismObject<ShadowType> object = mpc.getObjectNew();
if (object == null) {
object = mpc.getObjectOld();
}
String name = null;
if (object != null) {
if (object.asObjectable().getName() != null) {
name = PolyString.getOrig(object.asObjectable().getName());
} else {
// determine from attributes
ResourceAttribute nameAttribute = ShadowUtil.getNamingAttribute(object);
if (nameAttribute != null) {
name = String.valueOf(nameAttribute.getAnyRealValue());
}
}
}
if (name != null) {
si.setResourceObjectName(name);
}
}
}
}
private ProgressReportActivityDto createStatusItem(ProgressInformation progressInformation, ModelContext modelContext) {
ProgressReportActivityDto si = new ProgressReportActivityDto();
updateStatusItemState(si, progressInformation, modelContext);
return si;
}
private String getResourceName(@NotNull String oid) {
String name = nameCache.get(oid);
if (name != null) {
return name;
}
Task task = application.createSimpleTask("getResourceName");
OperationResult result = new OperationResult("getResourceName");
Collection<SelectorOptions<GetOperationOptions>> options = GetOperationOptions.createNoFetchCollection();
try {
PrismObject<ResourceType> object = application.getModel().getObject(ResourceType.class, oid, options, task, result);
name = PolyString.getOrig(object.asObjectable().getName());
} catch (CommonException e) {
LoggingUtils.logUnexpectedException(LOGGER, "Couldn't determine the name of resource {}", e, oid);
name = "(" + oid + ")";
}
nameCache.put(oid, name);
return name;
}
}