-
Notifications
You must be signed in to change notification settings - Fork 188
/
ContainerDelta.java
344 lines (303 loc) · 14 KB
/
ContainerDelta.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
/*
* Copyright (c) 2010-2013 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.prism.delta;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import javax.xml.namespace.QName;
import com.evolveum.midpoint.prism.Containerable;
import com.evolveum.midpoint.prism.Item;
import com.evolveum.midpoint.prism.ItemDefinition;
import com.evolveum.midpoint.prism.Objectable;
import com.evolveum.midpoint.prism.PrismContainer;
import com.evolveum.midpoint.prism.PrismContainerDefinition;
import com.evolveum.midpoint.prism.PrismContainerValue;
import com.evolveum.midpoint.prism.PrismContainerable;
import com.evolveum.midpoint.prism.PrismContext;
import com.evolveum.midpoint.prism.PrismObject;
import com.evolveum.midpoint.prism.PrismObjectDefinition;
import com.evolveum.midpoint.prism.PrismValue;
import com.evolveum.midpoint.prism.path.ItemPath;
import com.evolveum.midpoint.util.MiscUtil;
import com.evolveum.midpoint.util.exception.SchemaException;
public class ContainerDelta<V extends Containerable> extends ItemDelta<PrismContainerValue<V>> implements PrismContainerable<V> {
public ContainerDelta(PrismContainerDefinition itemDefinition, PrismContext prismContext) {
super(itemDefinition, prismContext);
}
public ContainerDelta(ItemPath propertyPath, PrismContainerDefinition itemDefinition, PrismContext prismContext) {
super(propertyPath, itemDefinition, prismContext);
}
public ContainerDelta(ItemPath parentPath, QName name, PrismContainerDefinition itemDefinition, PrismContext prismContext) {
super(parentPath, name, itemDefinition, prismContext);
// Extra check. It makes no sense to create container delta with object definition
if (itemDefinition instanceof PrismObjectDefinition<?>) {
throw new IllegalArgumentException("Cannot apply "+definition+" to container delta");
}
}
public ContainerDelta(QName name, PrismContainerDefinition itemDefinition, PrismContext prismContext) {
super(name, itemDefinition, prismContext);
// Extra check. It makes no sense to create container delta with object definition
if (itemDefinition instanceof PrismObjectDefinition<?>) {
throw new IllegalArgumentException("Cannot apply "+definition+" to container delta");
}
}
@Override
public Class<PrismContainer> getItemClass() {
return PrismContainer.class;
}
/**
* Returns all values regardless of whether they are added or removed or replaced.
* Useful for iterating over all the changed values.
*/
public <T extends Containerable> Collection<PrismContainerValue<T>> getValues(Class<T> type) {
checkConsistence();
if (valuesToReplace != null) {
return (Collection) valuesToReplace;
}
return (Collection) MiscUtil.union(valuesToAdd, valuesToDelete);
}
@Override
public PrismContainerDefinition<V> getDefinition() {
return (PrismContainerDefinition<V>) super.getDefinition();
}
@Override
public void setDefinition(ItemDefinition definition) {
if (!(definition instanceof PrismContainerDefinition)) {
throw new IllegalArgumentException("Cannot apply "+definition+" to container delta");
}
// Extra check. It makes no sense to create container delta with object definition
if (definition instanceof PrismObjectDefinition<?>) {
throw new IllegalArgumentException("Cannot apply "+definition+" to container delta");
}
super.setDefinition(definition);
}
@Override
public void applyDefinition(ItemDefinition definition) throws SchemaException {
if (!(definition instanceof PrismContainerDefinition)) {
throw new IllegalArgumentException("Cannot apply definition "+definition+" to container delta "+this);
}
super.applyDefinition(definition);
}
@Override
public boolean hasCompleteDefinition() {
if (!super.hasCompleteDefinition()) {
return false;
}
if (!hasCompleteDefinition(getValuesToAdd())) {
return false;
}
if (!hasCompleteDefinition(getValuesToDelete())) {
return false;
}
if (!hasCompleteDefinition(getValuesToReplace())) {
return false;
}
return true;
}
private boolean hasCompleteDefinition(Collection<PrismContainerValue<V>> values) {
if (values == null) {
return true;
}
for (PrismContainerValue<V> value: values) {
if (!value.hasCompleteDefinition()) {
return false;
}
}
return true;
}
@Override
public Class<V> getCompileTimeClass() {
if (getDefinition() != null) {
return getDefinition().getCompileTimeClass();
}
return null;
}
@Override
protected boolean isApplicableToType(Item item) {
return item instanceof PrismContainer;
}
public ItemDelta<?> findItemDelta(ItemPath path) {
if (path.isEmpty()) {
return this;
}
ItemDefinition itemDefinition = getDefinition().findItemDefinition(path);
ItemDelta<?> itemDelta = itemDefinition.createEmptyDelta(getPath().subPath(path));
itemDelta.addValuesToAdd(findItemValues(path, getValuesToAdd()));
itemDelta.addValuesToDelete(findItemValues(path, getValuesToDelete()));
itemDelta.setValuesToReplace(findItemValues(path, getValuesToReplace()));
if (itemDelta.isEmpty()) {
return null;
}
return itemDelta;
}
private Collection findItemValues(ItemPath path, Collection<PrismContainerValue<V>> cvalues) {
if (cvalues == null) {
return null;
}
Collection<PrismValue> subValues = new ArrayList<PrismValue>();
for (PrismContainerValue<V> cvalue: cvalues) {
Item<?> item = cvalue.findItem(path);
if (item != null) {
subValues.addAll(item.getValues());
}
}
return subValues;
}
/**
* Post processing of delta to expand missing values from the object. E.g. a delete deltas may
* be "id-only" so they contain only id of the value to delete. In such case locate the full value
* in the object and fill it into the delta.
* This method may even delete in-only values that are no longer present in the object.
*/
public <O extends Objectable> void expand(PrismObject<O> object) throws SchemaException {
if (valuesToDelete != null) {
ItemPath path = this.getPath();
PrismContainer<Containerable> container = null;
if (object != null) {
container = object.findContainer(path);
}
Iterator<PrismContainerValue<V>> iterator = valuesToDelete.iterator();
while (iterator.hasNext()) {
PrismContainerValue<V> deltaCVal = iterator.next();
if ((deltaCVal.getItems() == null || deltaCVal.getItems().isEmpty())) {
Long id = deltaCVal.getId();
if (id == null) {
throw new IllegalArgumentException("No id and no items in value "+deltaCVal+" in delete set in "+this);
}
if (container != null) {
PrismContainerValue<Containerable> containerCVal = container.findValue(id);
if (containerCVal != null) {
for (Item<?> containerItem: containerCVal.getItems()) {
deltaCVal.add(containerItem.clone());
}
continue;
}
}
// id-only value with ID that is not in the object any more: delete the value from delta
iterator.remove();
}
}
}
}
@Override
public ContainerDelta<V> clone() {
ContainerDelta<V> clone = new ContainerDelta<V>(getElementName(), getDefinition(), getPrismContext());
copyValues(clone);
return clone;
}
protected void copyValues(ContainerDelta<V> clone) {
super.copyValues(clone);
}
public static <T extends Containerable,O extends Objectable> ContainerDelta<T> createDelta(QName containerName,
Class<O> type, PrismContext prismContext) {
return createDelta(new ItemPath(containerName), type, prismContext);
}
public static <T extends Containerable,O extends Objectable> ContainerDelta<T> createDelta(ItemPath containerPath,
Class<O> type, PrismContext prismContext) {
PrismObjectDefinition<O> objectDefinition = prismContext.getSchemaRegistry().findObjectDefinitionByCompileTimeClass(type);
return createDelta(containerPath, objectDefinition);
}
public static <T extends Containerable,O extends Objectable> ContainerDelta<T> createDelta(QName containerName,
PrismObjectDefinition<O> objectDefinition) {
return createDelta(new ItemPath(containerName), objectDefinition);
}
public static <T extends Containerable,O extends Objectable> ContainerDelta<T> createDelta(ItemPath containerPath,
PrismObjectDefinition<O> objectDefinition) {
PrismContainerDefinition<T> containerDefinition = objectDefinition.findContainerDefinition(containerPath);
if (containerDefinition == null) {
throw new IllegalArgumentException("No definition for "+containerPath+" in "+objectDefinition);
}
ContainerDelta<T> delta = new ContainerDelta<T>(containerPath, containerDefinition, objectDefinition.getPrismContext());
return delta;
}
public static <T extends Containerable,O extends Objectable> ContainerDelta<T> createModificationAdd(QName containerName,
Class<O> type, PrismContext prismContext, T containerable) throws SchemaException {
return createModificationAdd(new ItemPath(containerName), type, prismContext, containerable);
}
public static <T extends Containerable,O extends Objectable> ContainerDelta<T> createModificationAdd(ItemPath containerPath,
Class<O> type, PrismContext prismContext, T containerable) throws SchemaException {
return createModificationAdd(containerPath, type, prismContext, containerable.asPrismContainerValue());
}
public static <T extends Containerable,O extends Objectable> ContainerDelta<T> createModificationAdd(QName containerName,
Class<O> type, PrismContext prismContext, PrismContainerValue<T> cValue) throws SchemaException {
return createModificationAdd(new ItemPath(containerName), type, prismContext, cValue);
}
public static <T extends Containerable,O extends Objectable> ContainerDelta<T> createModificationAdd(ItemPath containerPath,
Class<O> type, PrismContext prismContext, PrismContainerValue<T> cValue) throws SchemaException {
ContainerDelta<T> delta = createDelta(containerPath, type, prismContext);
prismContext.adopt(cValue, type, containerPath);
delta.addValuesToAdd(cValue);
return delta;
}
public static <T extends Containerable,O extends Objectable> ContainerDelta<T> createModificationDelete(QName containerName,
Class<O> type, PrismContext prismContext, T containerable) throws SchemaException {
return createModificationDelete(new ItemPath(containerName), type, prismContext, containerable);
}
public static <T extends Containerable,O extends Objectable> ContainerDelta<T> createModificationDelete(ItemPath containerPath,
Class<O> type, PrismContext prismContext, T containerable) throws SchemaException {
return createModificationDelete(containerPath, type, prismContext, containerable.asPrismContainerValue());
}
public static <T extends Containerable,O extends Objectable> ContainerDelta<T> createModificationDelete(QName containerName,
Class<O> type, PrismContext prismContext, PrismContainerValue<T> cValue) throws SchemaException {
return createModificationDelete(new ItemPath(containerName), type, prismContext, cValue);
}
public static <T extends Containerable,O extends Objectable> ContainerDelta<T> createModificationDelete(ItemPath containerPath,
Class<O> type, PrismContext prismContext, PrismContainerValue<T> cValue) throws SchemaException {
ContainerDelta<T> delta = createDelta(containerPath, type, prismContext);
prismContext.adopt(cValue, type, containerPath);
delta.addValuesToDelete(cValue);
return delta;
}
public static <T extends Containerable,O extends Objectable> ContainerDelta<T> createModificationReplace(QName containerName,
Class<O> type, PrismContext prismContext, T containerable) throws SchemaException {
return createModificationReplace(new ItemPath(containerName), type, prismContext, containerable);
}
public static <T extends Containerable,O extends Objectable> ContainerDelta<T> createModificationReplace(ItemPath containerPath,
Class<O> type, PrismContext prismContext, T containerable) throws SchemaException {
return createModificationReplace(containerPath, type, prismContext, containerable.asPrismContainerValue());
}
public static <T extends Containerable,O extends Objectable> ContainerDelta<T> createModificationReplace(QName containerName,
Class<O> type, PrismContext prismContext, PrismContainerValue<T> cValue) throws SchemaException {
return createModificationReplace(new ItemPath(containerName), type, prismContext, cValue);
}
public static <T extends Containerable,O extends Objectable> ContainerDelta<T> createModificationReplace(ItemPath containerPath,
Class<O> type, PrismContext prismContext, PrismContainerValue<T> cValue) throws SchemaException {
ContainerDelta<T> delta = createDelta(containerPath, type, prismContext);
prismContext.adopt(cValue, type, containerPath);
delta.setValuesToReplace(cValue);
return delta;
}
@Override
protected void dumpValues(StringBuilder sb, String label, Collection<PrismContainerValue<V>> values, int indent) {
for (int i = 0; i < indent; i++) {
sb.append(INDENT_STRING);
}
sb.append(label).append(":");
if (values == null) {
sb.append(" (null)");
} else {
sb.append("\n");
Iterator<PrismContainerValue<V>> i = values.iterator();
while (i.hasNext()) {
sb.append(i.next().debugDump(indent+1));
if (i.hasNext()) {
sb.append("\n");
}
}
}
}
}