/
ConnectorFactoryBuiltinImpl.java
302 lines (265 loc) · 14 KB
/
ConnectorFactoryBuiltinImpl.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
/**
* Copyright (c) 2017-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.provisioning.ucf.impl.builtin;
import java.beans.PropertyDescriptor;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
import javax.xml.namespace.QName;
import com.evolveum.midpoint.casemgmt.api.CaseEventDispatcher;
import com.evolveum.midpoint.casemgmt.api.CaseEventDispatcherAware;
import com.evolveum.midpoint.prism.MutablePrismContainerDefinition;
import com.evolveum.midpoint.prism.PrismPropertyDefinition;
import com.evolveum.midpoint.prism.schema.MutablePrismSchema;
import com.evolveum.midpoint.provisioning.ucf.api.*;
import com.evolveum.midpoint.security.api.SecurityContextManager;
import com.evolveum.midpoint.security.api.SecurityContextManagerAware;
import com.evolveum.midpoint.task.api.TaskManager;
import com.evolveum.midpoint.task.api.TaskManagerAware;
import com.evolveum.midpoint.task.api.Tracer;
import org.springframework.beans.BeanWrapper;
import org.springframework.beans.BeanWrapperImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider;
import org.springframework.core.type.filter.AnnotationTypeFilter;
import org.springframework.stereotype.Component;
import com.evolveum.midpoint.prism.ItemDefinition;
import com.evolveum.midpoint.prism.PrismContext;
import com.evolveum.midpoint.prism.schema.PrismSchema;
import com.evolveum.midpoint.prism.xml.XsdTypeMapper;
import com.evolveum.midpoint.provisioning.ucf.api.connectors.AbstractManagedConnectorInstance;
import com.evolveum.midpoint.repo.api.RepositoryAware;
import com.evolveum.midpoint.repo.api.RepositoryService;
import com.evolveum.midpoint.schema.constants.SchemaConstants;
import com.evolveum.midpoint.schema.result.OperationResult;
import com.evolveum.midpoint.util.exception.ObjectNotFoundException;
import com.evolveum.midpoint.util.exception.SchemaException;
import com.evolveum.midpoint.util.logging.Trace;
import com.evolveum.midpoint.util.logging.TraceManager;
import com.evolveum.midpoint.xml.ns._public.common.common_3.ConnectorHostType;
import com.evolveum.midpoint.xml.ns._public.common.common_3.ConnectorType;
import com.evolveum.midpoint.xml.ns._public.common.common_3.ResourceType;
/**
* Connector factory for the connectors built-in to midPoint, such as
* the "manual connector".
*
* @author Radovan Semancik
*
*/
@Component
public class ConnectorFactoryBuiltinImpl implements ConnectorFactory {
public static final String SCAN_PACKAGE = "com.evolveum.midpoint";
private static final String CONFIGURATION_NAMESPACE_PREFIX = SchemaConstants.UCF_FRAMEWORK_URI_BUILTIN + "/bundle/";
private static final Trace LOGGER = TraceManager.getTrace(ConnectorFactoryBuiltinImpl.class);
@Autowired private PrismContext prismContext;
@Autowired @Qualifier("cacheRepositoryService") private RepositoryService repositoryService;
@Autowired private CaseEventDispatcher caseManager;
@Autowired private TaskManager taskManager;
@Autowired private SecurityContextManager securityContextManager;
@Autowired private UcfExpressionEvaluator ucfExpressionEvaluator;
@Autowired private Tracer tracer;
private final Object connectorDiscovery = new Object();
private Map<String,ConnectorStruct> connectorMap;
@Override
public Set<ConnectorType> listConnectors(ConnectorHostType host, OperationResult parentResult) {
if (host != null) {
return null;
}
discoverConnectorsIfNeeded();
return connectorMap.values().stream().map(connectorStruct -> connectorStruct.connectorObject).collect(Collectors.toSet());
}
private void discoverConnectorsIfNeeded() {
synchronized (connectorDiscovery) {
if (connectorMap == null) {
connectorMap = new HashMap<>();
ClassPathScanningCandidateComponentProvider scanner =
new ClassPathScanningCandidateComponentProvider(false);
scanner.addIncludeFilter(new AnnotationTypeFilter(ManagedConnector.class));
LOGGER.trace("Scanning package {}", SCAN_PACKAGE);
for (BeanDefinition bd : scanner.findCandidateComponents(SCAN_PACKAGE)) {
LOGGER.debug("Found connector class {}", bd);
String beanClassName = bd.getBeanClassName();
try {
Class connectorClass = Class.forName(beanClassName);
ManagedConnector annotation = (ManagedConnector) connectorClass.getAnnotation(ManagedConnector.class);
String type = annotation.type();
LOGGER.debug("Found connector {} class {}", type, connectorClass);
ConnectorStruct struct = createConnectorStruct(connectorClass, annotation);
connectorMap.put(type, struct);
} catch (ClassNotFoundException e) {
LOGGER.error("Error loading connector class {}: {}", beanClassName, e.getMessage(), e);
} catch (ObjectNotFoundException | SchemaException e) {
LOGGER.error("Error discovering the connector {}: {}", beanClassName, e.getMessage(), e);
}
}
LOGGER.trace("Scan done");
}
}
}
private ConnectorStruct createConnectorStruct(Class connectorClass, ManagedConnector annotation) throws ObjectNotFoundException, SchemaException {
ConnectorStruct struct = new ConnectorStruct();
//noinspection unchecked
struct.connectorClass = connectorClass;
ConnectorType connectorType = new ConnectorType();
String bundleName = connectorClass.getPackage().getName();
String type = annotation.type();
if (type == null || type.isEmpty()) {
type = connectorClass.getSimpleName();
}
String version = annotation.version();
UcfUtil.addConnectorNames(connectorType, "Built-in", bundleName, type, version, null);
connectorType.setConnectorBundle(bundleName);
connectorType.setConnectorType(type);
connectorType.setVersion(version);
connectorType.setFramework(SchemaConstants.UCF_FRAMEWORK_URI_BUILTIN);
String namespace = CONFIGURATION_NAMESPACE_PREFIX + bundleName + "/" + type;
connectorType.setNamespace(namespace);
struct.connectorObject = connectorType;
PrismSchema connectorSchema = generateConnectorConfigurationSchema(struct);
if (connectorSchema != null) {
LOGGER.trace("Generated connector schema for {}: {} definitions",
connectorType, connectorSchema.getDefinitions().size());
UcfUtil.setConnectorSchema(connectorType, connectorSchema);
struct.connectorConfigurationSchema = connectorSchema;
} else {
LOGGER.warn("No connector schema generated for {}", connectorType);
}
return struct;
}
private ConnectorStruct getConnectorStruct(ConnectorType connectorType) throws ObjectNotFoundException {
discoverConnectorsIfNeeded();
String type = connectorType.getConnectorType();
ConnectorStruct struct = connectorMap.get(type);
if (struct == null) {
LOGGER.error("No built-in connector type {}; known types: {}", type, connectorMap);
throw new ObjectNotFoundException("No built-in connector type "+type);
}
return struct;
}
@Override
public PrismSchema generateConnectorConfigurationSchema(ConnectorType connectorType)
throws ObjectNotFoundException {
ConnectorStruct struct = getConnectorStruct(connectorType);
return generateConnectorConfigurationSchema(struct);
}
private PrismSchema generateConnectorConfigurationSchema(ConnectorStruct struct) {
Class<? extends ConnectorInstance> connectorClass = struct.connectorClass;
PropertyDescriptor connectorConfigurationProp = UcfUtil.findAnnotatedProperty(connectorClass, ManagedConnectorConfiguration.class);
MutablePrismSchema connectorSchema = prismContext.schemaFactory().createPrismSchema(struct.connectorObject.getNamespace());
// Create configuration type - the type used by the "configuration" element
MutablePrismContainerDefinition<?> configurationContainerDef = connectorSchema.createPropertyContainerDefinition(
ResourceType.F_CONNECTOR_CONFIGURATION.getLocalPart(),
SchemaConstants.CONNECTOR_SCHEMA_CONFIGURATION_TYPE_LOCAL_NAME);
Class<?> configurationClass = connectorConfigurationProp.getPropertyType();
BeanWrapper configurationClassBean = new BeanWrapperImpl(configurationClass);
for (PropertyDescriptor prop: configurationClassBean.getPropertyDescriptors()) {
if (!UcfUtil.hasAnnotation(prop, ConfigurationProperty.class)) {
continue;
}
ItemDefinition<?> itemDef = createPropertyDefinition(configurationContainerDef, prop);
LOGGER.trace("Configuration item definition for {}: {}", prop.getName(), itemDef);
}
return connectorSchema;
}
private ItemDefinition<?> createPropertyDefinition(MutablePrismContainerDefinition<?> configurationContainerDef,
PropertyDescriptor prop) {
String propName = prop.getName();
Class<?> propertyType = prop.getPropertyType();
Class<?> baseType = propertyType;
int minOccurs = 1;
int maxOccurs = 1;
if (propertyType.isArray()) {
maxOccurs = -1;
baseType = propertyType.getComponentType();
}
// TODO: minOccurs: define which properties are optional/mandatory
// TODO: display names, ordering, help texts
QName propType = XsdTypeMapper.getJavaToXsdMapping(baseType);
if (propType == null) {
PrismPropertyDefinition propDef = prismContext.getSchemaRegistry()
.findItemDefinitionByCompileTimeClass(baseType, PrismPropertyDefinition.class);
if (propDef != null) {
propType = propDef.getTypeName();
} else {
throw new IllegalStateException("Property " + propName + " of " + baseType + " cannot be resolved to a XSD type or a prism property");
}
}
return configurationContainerDef.createPropertyDefinition(
new QName(configurationContainerDef.getItemName().getNamespaceURI(), propName), propType, minOccurs, maxOccurs);
}
@Override
public ConnectorInstance createConnectorInstance(ConnectorType connectorType, String namespace, String instanceName,
String desc) throws ObjectNotFoundException {
ConnectorStruct struct = getConnectorStruct(connectorType);
Class<? extends ConnectorInstance> connectorClass = struct.connectorClass;
ConnectorInstance connectorInstance;
try {
connectorInstance = connectorClass.newInstance();
} catch (InstantiationException | IllegalAccessException e) {
throw new ObjectNotFoundException("Cannot create instance of connector "+connectorClass+": "+e.getMessage(), e);
}
if (connectorInstance instanceof AbstractManagedConnectorInstance) {
setupAbstractConnectorInstance((AbstractManagedConnectorInstance)connectorInstance, instanceName, connectorType,
namespace, desc, struct);
}
if (connectorInstance instanceof RepositoryAware) {
((RepositoryAware)connectorInstance).setRepositoryService(repositoryService);
}
if (connectorInstance instanceof CaseEventDispatcherAware) {
((CaseEventDispatcherAware)connectorInstance).setDispatcher(caseManager);
}
if (connectorInstance instanceof TaskManagerAware) {
((TaskManagerAware)connectorInstance).setTaskManager(taskManager);
}
if (connectorInstance instanceof SecurityContextManagerAware) {
((SecurityContextManagerAware) connectorInstance).setSecurityContextManager(securityContextManager);
}
if (connectorInstance instanceof UcfExpressionEvaluatorAware) {
((UcfExpressionEvaluatorAware) connectorInstance).setUcfExpressionEvaluator(ucfExpressionEvaluator);
}
if (connectorInstance instanceof TracerAware) {
((TracerAware) connectorInstance).setTracer(tracer);
}
if (connectorInstance instanceof RepositoryAware) {
((RepositoryAware) connectorInstance).setRepositoryService(repositoryService);
}
return connectorInstance;
}
private void setupAbstractConnectorInstance(AbstractManagedConnectorInstance connectorInstance, String instanceName,
ConnectorType connectorObject, String namespace,
String desc, ConnectorStruct struct) {
connectorInstance.setInstanceName(instanceName);
connectorInstance.setConnectorObject(connectorObject);
connectorInstance.setResourceSchemaNamespace(namespace);
connectorInstance.setPrismContext(prismContext);
connectorInstance.setConnectorConfigurationSchema(struct.connectorConfigurationSchema);
}
@Override
public void selfTest(OperationResult parentTestResult) {
// Nothing to do
}
@Override
public boolean supportsFramework(String frameworkIdentifier) {
return SchemaConstants.UCF_FRAMEWORK_URI_BUILTIN.equals(frameworkIdentifier);
}
@Override
public String getFrameworkVersion() {
return "1.0.0";
}
@Override
public void shutdown() {
// Nothing to do
}
private static class ConnectorStruct {
Class<? extends ConnectorInstance> connectorClass;
ConnectorType connectorObject;
PrismSchema connectorConfigurationSchema;
}
}