/
ProvisioningContext.java
369 lines (317 loc) · 15.9 KB
/
ProvisioningContext.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
/**
* Copyright (c) 2015-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.provisioning.impl;
import com.evolveum.midpoint.common.refinery.*;
import com.evolveum.midpoint.prism.PrismContext;
import com.evolveum.midpoint.prism.PrismObject;
import com.evolveum.midpoint.prism.path.ItemPath;
import com.evolveum.midpoint.provisioning.ucf.api.ConnectorInstance;
import com.evolveum.midpoint.provisioning.util.ProvisioningUtil;
import com.evolveum.midpoint.schema.CapabilityUtil;
import com.evolveum.midpoint.schema.GetOperationOptions;
import com.evolveum.midpoint.schema.ResourceShadowDiscriminator;
import com.evolveum.midpoint.schema.SelectorOptions;
import com.evolveum.midpoint.schema.processor.ObjectClassComplexTypeDefinition;
import com.evolveum.midpoint.schema.result.OperationResult;
import com.evolveum.midpoint.task.api.StateReporter;
import com.evolveum.midpoint.util.exception.*;
import com.evolveum.midpoint.util.logging.Trace;
import com.evolveum.midpoint.util.logging.TraceManager;
import com.evolveum.midpoint.xml.ns._public.common.common_3.*;
import com.evolveum.midpoint.xml.ns._public.resource.capabilities_3.CapabilityType;
import org.jetbrains.annotations.NotNull;
import javax.xml.namespace.QName;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
/**
* @author semancik
*
*/
public class ProvisioningContext extends StateReporter {
private static final Trace LOGGER = TraceManager.getTrace(ProvisioningContext.class);
@NotNull private final ResourceManager resourceManager;
private OperationResult parentResult;
private Collection<SelectorOptions<GetOperationOptions>> getOperationOptions;
private PrismObject<ShadowType> originalShadow;
private ResourceShadowDiscriminator shadowCoordinates;
private Collection<QName> additionalAuxiliaryObjectClassQNames;
private boolean useRefinedDefinition = true;
private boolean isPropagation;
private RefinedObjectClassDefinition objectClassDefinition;
private ResourceType resource;
private Map<Class<? extends CapabilityType>,ConnectorInstance> connectorMap;
private RefinedResourceSchema refinedSchema;
public ProvisioningContext(@NotNull ResourceManager resourceManager, OperationResult parentResult) {
this.resourceManager = resourceManager;
this.parentResult = parentResult;
}
public void setResourceOid(String resourceOid) {
super.setResourceOid(resourceOid);
this.resource = null;
this.connectorMap = null;
this.refinedSchema = null;
}
public Collection<SelectorOptions<GetOperationOptions>> getGetOperationOptions() {
return getOperationOptions;
}
public void setGetOperationOptions(Collection<SelectorOptions<GetOperationOptions>> getOperationOptions) {
this.getOperationOptions = getOperationOptions;
}
public ResourceShadowDiscriminator getShadowCoordinates() {
return shadowCoordinates;
}
public void setShadowCoordinates(ResourceShadowDiscriminator shadowCoordinates) {
this.shadowCoordinates = shadowCoordinates;
}
public PrismObject<ShadowType> getOriginalShadow() {
return originalShadow;
}
public void setOriginalShadow(PrismObject<ShadowType> originalShadow) {
this.originalShadow = originalShadow;
}
public Collection<QName> getAdditionalAuxiliaryObjectClassQNames() {
return additionalAuxiliaryObjectClassQNames;
}
public void setAdditionalAuxiliaryObjectClassQNames(Collection<QName> additionalAuxiliaryObjectClassQNames) {
this.additionalAuxiliaryObjectClassQNames = additionalAuxiliaryObjectClassQNames;
}
public boolean isUseRefinedDefinition() {
return useRefinedDefinition;
}
public void setUseRefinedDefinition(boolean useRefinedDefinition) {
this.useRefinedDefinition = useRefinedDefinition;
}
public boolean isPropagation() {
return isPropagation;
}
public void setPropagation(boolean isPropagation) {
this.isPropagation = isPropagation;
}
public void setObjectClassDefinition(RefinedObjectClassDefinition objectClassDefinition) {
this.objectClassDefinition = objectClassDefinition;
}
public void setResource(ResourceType resource) {
this.resource = resource;
}
public ResourceType getResource() throws ObjectNotFoundException, SchemaException, CommunicationException, ConfigurationException, ExpressionEvaluationException {
if (resource == null) {
if (getResourceOid() == null) {
throw new SchemaException("Null resource OID "+getDesc());
}
GetOperationOptions options = GetOperationOptions.createReadOnly();
resource = resourceManager.getResource(getResourceOid(), options, getTask(), parentResult).asObjectable();
updateResourceName();
}
return resource;
}
private void updateResourceName() {
if (resource != null && resource.getName() != null) {
super.setResourceName(resource.getName().getOrig());
}
}
public RefinedResourceSchema getRefinedSchema() throws SchemaException, ConfigurationException, ObjectNotFoundException, CommunicationException, ExpressionEvaluationException {
if (refinedSchema == null) {
refinedSchema = ProvisioningUtil.getRefinedSchema(getResource());
}
return refinedSchema;
}
public RefinedObjectClassDefinition getObjectClassDefinition() throws SchemaException, ConfigurationException, ObjectNotFoundException, CommunicationException, ExpressionEvaluationException {
if (objectClassDefinition == null) {
if (useRefinedDefinition) {
if (originalShadow != null) {
objectClassDefinition = getRefinedSchema().determineCompositeObjectClassDefinition(originalShadow, additionalAuxiliaryObjectClassQNames);
} else if (shadowCoordinates != null && !shadowCoordinates.isWildcard()) {
objectClassDefinition = getRefinedSchema().determineCompositeObjectClassDefinition(shadowCoordinates);
}
} else {
if (shadowCoordinates.getObjectClass() == null) {
throw new IllegalStateException("No objectclass");
}
ObjectClassComplexTypeDefinition origObjectClassDefinition = getRefinedSchema().getOriginalResourceSchema().findObjectClassDefinition(shadowCoordinates.getObjectClass());
if (origObjectClassDefinition == null) {
throw new SchemaException("No object class definition for "+shadowCoordinates.getObjectClass()+" in original resource schema for "+getResource());
} else {
objectClassDefinition = RefinedObjectClassDefinitionImpl.parseFromSchema(origObjectClassDefinition, getResource(), getRefinedSchema(), getResource().asPrismObject().getPrismContext(),
"objectclass "+origObjectClassDefinition+" in "+getResource());
}
}
}
return objectClassDefinition;
}
// we don't use additionalAuxiliaryObjectClassQNames as we don't know if they are initialized correctly [med] TODO: reconsider this
public CompositeRefinedObjectClassDefinition computeCompositeObjectClassDefinition(@NotNull Collection<QName> auxObjectClassQNames)
throws SchemaException, ConfigurationException, ObjectNotFoundException, CommunicationException, ExpressionEvaluationException {
RefinedObjectClassDefinition structuralObjectClassDefinition = getObjectClassDefinition();
if (structuralObjectClassDefinition == null) {
return null;
}
Collection<RefinedObjectClassDefinition> auxiliaryObjectClassDefinitions = new ArrayList<>(auxObjectClassQNames.size());
for (QName auxObjectClassQName : auxObjectClassQNames) {
RefinedObjectClassDefinition auxObjectClassDef = refinedSchema.getRefinedDefinition(auxObjectClassQName);
if (auxObjectClassDef == null) {
throw new SchemaException("Auxiliary object class " + auxObjectClassQName + " specified in " + this + " does not exist");
}
auxiliaryObjectClassDefinitions.add(auxObjectClassDef);
}
return new CompositeRefinedObjectClassDefinitionImpl(structuralObjectClassDefinition, auxiliaryObjectClassDefinitions);
}
public RefinedObjectClassDefinition computeCompositeObjectClassDefinition(PrismObject<ShadowType> shadow)
throws SchemaException, ObjectNotFoundException, CommunicationException, ConfigurationException, ExpressionEvaluationException {
return computeCompositeObjectClassDefinition(shadow.asObjectable().getAuxiliaryObjectClass());
}
public String getChannel() {
return getTask()==null?null:getTask().getChannel();
}
public <T extends CapabilityType> ConnectorInstance getConnector(Class<T> operationCapabilityClass, OperationResult parentResult) throws ObjectNotFoundException, SchemaException, CommunicationException, ConfigurationException, ExpressionEvaluationException {
if (connectorMap == null) {
connectorMap = new HashMap<>();
}
ConnectorInstance connector = connectorMap.get(operationCapabilityClass);
if (connector == null) {
connector = getConnectorInstance(operationCapabilityClass, parentResult);
connectorMap.put(operationCapabilityClass, connector);
}
return connector;
}
public boolean isWildcard() {
return (shadowCoordinates == null && originalShadow == null) || (shadowCoordinates != null && shadowCoordinates.isWildcard());
}
/**
* Creates a context for a different object class on the same resource.
*/
public ProvisioningContext spawn(ShadowKindType kind, String intent) {
ProvisioningContext ctx = spawnSameResource();
ctx.shadowCoordinates = new ResourceShadowDiscriminator(getResourceOid(), kind, intent, null, false);
return ctx;
}
/**
* Creates a context for a different object class on the same resource.
*/
public ProvisioningContext spawn(QName objectClassQName) throws SchemaException {
ProvisioningContext ctx = spawnSameResource();
ctx.shadowCoordinates = new ResourceShadowDiscriminator(getResourceOid(), null, null, null, false);
ctx.shadowCoordinates.setObjectClass(objectClassQName);
return ctx;
}
/**
* Creates a context for a different object class on the same resource.
*/
public ProvisioningContext spawn(PrismObject<ShadowType> shadow) throws SchemaException {
ProvisioningContext ctx = spawnSameResource();
ctx.setOriginalShadow(shadow);
return ctx;
}
// /**
// * Creates a context for a different object class on the same resource.
// */
// public ProvisioningContext spawn(RefinedObjectClassDefinition objectClassDefinition) throws SchemaException {
// ProvisioningContext ctx = spawnSameResource();
// ctx.setObjectClassDefinition(objectClassDefinition);
// return ctx;
// }
private ProvisioningContext spawnSameResource() {
ProvisioningContext ctx = new ProvisioningContext(resourceManager, parentResult);
ctx.setTask(this.getTask());
ctx.setResourceOid(getResourceOid());
ctx.resource = this.resource;
ctx.updateResourceName(); // TODO eliminate this mess - check if we need StateReporter any more
ctx.connectorMap = this.connectorMap;
ctx.refinedSchema = this.refinedSchema;
return ctx;
}
public void assertDefinition(String message) throws SchemaException, ConfigurationException, ObjectNotFoundException, CommunicationException, ExpressionEvaluationException {
if (getObjectClassDefinition() == null) {
throw new SchemaException(message + " " + getDesc());
}
}
public void assertDefinition() throws SchemaException, ConfigurationException, ObjectNotFoundException, CommunicationException, ExpressionEvaluationException {
assertDefinition("Cannot locate object class definition");
}
public String getDesc() {
if (originalShadow != null) {
return "for " + originalShadow + " in " + (resource==null?("resource "+getResourceOid()):resource);
} else if (shadowCoordinates != null && !shadowCoordinates.isWildcard()) {
return "for " + shadowCoordinates + " in " + (resource==null?("resource "+getResourceOid()):resource);
} else {
return "for wildcard in " + (resource==null?("resource "+getResourceOid()):resource);
}
}
private <T extends CapabilityType> ConnectorInstance getConnectorInstance(Class<T> operationCapabilityClass, OperationResult parentResult)
throws ObjectNotFoundException, SchemaException, CommunicationException, ConfigurationException, ExpressionEvaluationException {
OperationResult connectorResult = parentResult.createMinorSubresult(ProvisioningContext.class.getName() + ".getConnectorInstance");
try {
ConnectorInstance connector = resourceManager.getConfiguredConnectorInstance(getResource().asPrismObject(), operationCapabilityClass, false, connectorResult);
connectorResult.recordSuccess();
return connector;
} catch (ObjectNotFoundException | SchemaException e) {
connectorResult.recordPartialError("Could not get connector instance " + getDesc() + ": " + e.getMessage(), e);
// Wrap those exceptions to a configuration exception. In the context of the provisioning operation we really cannot throw
// ObjectNotFoundException exception. If we do that then the consistency code will interpret that as if the resource object
// (shadow) is missing. But that's wrong. We do not have connector therefore we do not know anything about the shadow. We cannot
// throw ObjectNotFoundException here.
throw new ConfigurationException(e.getMessage(), e);
} catch (CommunicationException | ConfigurationException | RuntimeException e) {
connectorResult.recordPartialError("Could not get connector instance " + getDesc() + ": " + e.getMessage(), e);
throw e;
}
}
//check connector capabilities in this order :
// 1. take additional connector capabilieis if exist, if not, take resource capabilities
// 2. apply object class specific capabilities to the one selected in step 1.
// 3. in the returned capabilieties, check first configured capabilities and then native capabilities
public <T extends CapabilityType> T getEffectiveCapability(Class<T> capabilityClass) throws SchemaException, ObjectNotFoundException, CommunicationException, ConfigurationException, ExpressionEvaluationException {
CapabilitiesType capabilitiesType = getConnectorCapabilities(capabilityClass);
if (capabilitiesType == null) {
return null;
}
return CapabilityUtil.getEffectiveCapability(capabilitiesType, capabilityClass);
}
public <T extends CapabilityType> boolean hasNativeCapability(Class<T> capabilityClass) throws SchemaException, ObjectNotFoundException, CommunicationException, ConfigurationException, ExpressionEvaluationException {
CapabilitiesType connectorCapabilities = getConnectorCapabilities(capabilityClass);
if (connectorCapabilities == null) {
return false;
}
return CapabilityUtil.hasNativeCapability(connectorCapabilities, capabilityClass);
}
public <T extends CapabilityType> boolean hasConfiguredCapability(Class<T> capabilityClass) throws SchemaException, ObjectNotFoundException, CommunicationException, ConfigurationException, ExpressionEvaluationException {
CapabilitiesType connectorCapabilities = getConnectorCapabilities(capabilityClass);
if (connectorCapabilities == null) {
return false;
}
return CapabilityUtil.hasConfiguredCapability(connectorCapabilities, capabilityClass);
}
private <T extends CapabilityType> CapabilitiesType getConnectorCapabilities(Class<T> operationCapabilityClass) throws SchemaException, ObjectNotFoundException, CommunicationException, ConfigurationException, ExpressionEvaluationException {
return resourceManager.getConnectorCapabilities(getResource(), getObjectClassDefinition(), operationCapabilityClass);
}
@Override
public String toString() {
return "ProvisioningContext("+getDesc()+")";
}
@NotNull
public PrismContext getPrismContext() {
return resourceManager.getPrismContext();
}
public ItemPath path(Object... components) {
return ItemPath.create(components);
}
public CachingStategyType getCachingStrategy()
throws ObjectNotFoundException, SchemaException, CommunicationException, ConfigurationException,
ExpressionEvaluationException {
return ProvisioningUtil.getCachingStrategy(this);
}
}