-
Notifications
You must be signed in to change notification settings - Fork 222
Smart integration: SCIM connector development support #588
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
41 changes: 0 additions & 41 deletions
41
model/smart-impl/src/main/java/com/evolveum/midpoint/smart/impl/conndev/JsonHalBackend.java
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
150 changes: 150 additions & 0 deletions
150
model/smart-impl/src/main/java/com/evolveum/midpoint/smart/impl/conndev/ScimBackend.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| package com.evolveum.midpoint.smart.impl.conndev; | ||
|
|
||
| import com.evolveum.midpoint.model.api.util.ResourceUtils; | ||
| import com.evolveum.midpoint.prism.PrismContext; | ||
| import com.evolveum.midpoint.prism.path.ItemPath; | ||
| import com.evolveum.midpoint.schema.constants.SchemaConstants; | ||
| import com.evolveum.midpoint.schema.result.OperationResult; | ||
| import com.evolveum.midpoint.smart.api.conndev.ScimRestConfigurationProperties; | ||
| import com.evolveum.midpoint.util.logging.Trace; | ||
| import com.evolveum.midpoint.util.logging.TraceManager; | ||
| import com.evolveum.midpoint.smart.impl.conndev.activity.ConnDevBeans; | ||
| import com.evolveum.midpoint.task.api.Task; | ||
| import com.evolveum.midpoint.util.exception.*; | ||
| import com.evolveum.midpoint.xml.ns._public.common.common_3.ConnDevDocumentationSourceType; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import com.evolveum.midpoint.xml.ns._public.common.common_3.ConnectorDevelopmentType; | ||
| import com.evolveum.midpoint.xml.ns._public.common.common_3.ProcessedDocumentationType; | ||
| import com.evolveum.midpoint.xml.ns._public.common.common_3.ResourceType; | ||
| import com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType; | ||
|
|
||
| import javax.xml.namespace.QName; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
| import java.util.UUID; | ||
| import java.util.stream.Stream; | ||
|
|
||
| public class ScimBackend extends RestBackend { | ||
|
|
||
| private static final Trace LOGGER = TraceManager.getTrace(ScimBackend.class); | ||
|
|
||
| private static final List<String> SCIM_OBJECT_CLASSES = List.of("conndev_ScimSchema", "conndev_ScimResource"); | ||
|
|
||
| public ScimBackend(ConnDevBeans beans, ConnectorDevelopmentType connDev, Task task, OperationResult result) { | ||
| super(beans, connDev, task, result); | ||
| } | ||
|
|
||
| @Override | ||
| public List<ConnDevDocumentationSourceType> discoverDocumentation() { | ||
| return super.discoverDocumentation(); | ||
| } | ||
|
|
||
| @Override | ||
| public void ensureDocumentationIsProcessed() throws SchemaException, ExpressionEvaluationException, CommunicationException, SecurityViolationException, ConfigurationException, ObjectNotFoundException, PolicyViolationException, ObjectAlreadyExistsException { | ||
| super.ensureDocumentationIsProcessed(); | ||
|
|
||
| refreshScimDocumentation(); | ||
| } | ||
|
|
||
| private void refreshScimDocumentation() throws SchemaException, ExpressionEvaluationException, CommunicationException, SecurityViolationException, ConfigurationException, ObjectNotFoundException, PolicyViolationException, ObjectAlreadyExistsException { | ||
| var testingResourceOid = getTestingResourceOid(); | ||
|
|
||
| if (!isScimDiscoveryConfigured(testingResourceOid)) { | ||
| LOGGER.info("Testing resource {} is not configured for SCIM discovery (missing scimBaseUrl or developmentMode), skipping", testingResourceOid); | ||
| return; | ||
| } | ||
|
|
||
| LOGGER.info("Starting SCIM schema discovery from shadows on testing resource {}", testingResourceOid); | ||
| ResourceUtils.deleteSchema(testingResourceOid, beans.modelService, task, result); | ||
| beans.provisioningService.testResource(testingResourceOid, task, result); | ||
|
|
||
| var newScimDocs = SCIM_OBJECT_CLASSES | ||
| .stream() | ||
| .flatMap(objectClass -> loadShadowsAsDocumentation(testingResourceOid, objectClass).stream()) | ||
| .map(ProcessedDocumentation::toBean) | ||
| .toList(); | ||
|
|
||
| var mergedDocs = new ArrayList<>( | ||
| developmentObject() | ||
| .getProcessedDocumentation() | ||
| .stream() | ||
| .filter(d -> SCIM_OBJECT_CLASSES.stream().noneMatch(c -> d.getUri().startsWith(c))) | ||
| .map(ProcessedDocumentationType::clone) | ||
| .toList() | ||
| ); | ||
| mergedDocs.addAll(newScimDocs); | ||
|
|
||
| var delta = PrismContext.get().deltaFor(ConnectorDevelopmentType.class) | ||
| .item(ConnectorDevelopmentType.F_PROCESSED_DOCUMENTATION) | ||
| .replaceRealValues(mergedDocs) | ||
| .<ConnectorDevelopmentType>asObjectDelta(developmentObject().getOid()); | ||
| beans.modelService.executeChanges(List.of(delta), null, task, result); | ||
| reload(); | ||
| ensureDocumentationIsUploaded(client().synchronizationClient()); | ||
| } | ||
|
|
||
| private List<ProcessedDocumentation> loadShadowsAsDocumentation(String resourceOid, String objectClassLocalName) { | ||
| try { | ||
| var objectClass = new QName(SchemaConstants.NS_RI, objectClassLocalName); | ||
| var query = PrismContext.get().queryFor(ShadowType.class) | ||
| .item(ShadowType.F_RESOURCE_REF).ref(resourceOid) | ||
| .and().item(ShadowType.F_OBJECT_CLASS).eq(objectClass) | ||
| .build(); | ||
|
|
||
| var shadows = beans.provisioningService.searchObjects(ShadowType.class, query, null, task, result); | ||
| if (shadows.isEmpty()) { | ||
| LOGGER.warn("No shadows found for object class {} on resource {}", objectClassLocalName, resourceOid); | ||
| return List.of(); | ||
| } | ||
|
|
||
| var serializer = PrismContext.get().jsonSerializer(); | ||
| var mapper = new ObjectMapper(); | ||
| var docs = new ArrayList<ProcessedDocumentation>(); | ||
| for (var shadow : shadows) { | ||
| var attrs = shadow.findContainer(ShadowType.F_ATTRIBUTES); | ||
| if (attrs != null && !attrs.isEmpty()) { | ||
| var json = serializer.serialize(attrs.getValue()); | ||
| var parsedAttrs = mapper.readTree(json).get("attributes"); | ||
| var idNode = parsedAttrs.get("id"); | ||
| var name = idNode != null | ||
| ? idNode.asText() | ||
| : shadow.getOid(); | ||
| var doc = new ProcessedDocumentation(UUID.randomUUID().toString(), objectClassLocalName + "_" + name); | ||
| doc.write(parsedAttrs.toString()); | ||
| docs.add(doc); | ||
| } | ||
| } | ||
| return docs; | ||
| } catch (Exception e) { | ||
| throw new SystemException("Could not load shadow documentation for " + objectClassLocalName, e); | ||
| } | ||
| } | ||
|
|
||
| private String getTestingResourceOid() { | ||
| var testing = developmentObject().getTesting(); | ||
| if (testing == null || testing.getTestingResource() == null) { | ||
| throw new SystemException("No testing resource configured"); | ||
| } | ||
| return testing.getTestingResource().getOid(); | ||
| } | ||
|
|
||
| private boolean isScimDiscoveryConfigured(String testingResourceOid) { | ||
| try { | ||
| var resource = beans.modelService.getObject(ResourceType.class, testingResourceOid, null, task, result).asObjectable(); | ||
| var connectorConfig = ItemPath.create(ResourceType.F_CONNECTOR_CONFIGURATION, SchemaConstants.ICF_CONFIGURATION_PROPERTIES_LOCAL_NAME); | ||
|
|
||
| var scimBaseUrl = resource.asPrismObject().findProperty(ItemPath.create(connectorConfig, ScimRestConfigurationProperties.SCIM_BASE_URL)); | ||
| var developmentMode = resource.asPrismObject().findProperty(ItemPath.create(connectorConfig, ScimRestConfigurationProperties.DEVELOPMENT_MODE)); | ||
|
|
||
| var hasScimBaseUrl = scimBaseUrl != null && scimBaseUrl.getRealValue() != null | ||
| && !((String) scimBaseUrl.getRealValue()).isBlank(); | ||
| var hasDevelopmentMode = developmentMode != null && Boolean.TRUE.equals(developmentMode.getRealValue()); | ||
|
|
||
| return hasScimBaseUrl && hasDevelopmentMode; | ||
| } catch (Exception e) { | ||
| LOGGER.warn("Could not check configuration on testing resource {}: {}", testingResourceOid, e.getMessage()); | ||
| return false; | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
MidPilot service expects one schema per file / documentation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So, implementation should not merge it into one JSON but let it as separated documentation, correct?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated