Skip to content

Commit

Permalink
closes #1
Browse files Browse the repository at this point in the history
  • Loading branch information
@valerio-crescia
valerio-crescia committed Sep 23, 2022
1 parent 3c4006a commit 1d1c46a
Show file tree
Hide file tree
Showing 7 changed files with 577 additions and 233 deletions.
246 changes: 246 additions & 0 deletions .../apache/syncope/core/provisioning/java/pushpull/stream/AbstractStreamPullJobDelegate.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,246 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.syncope.core.provisioning.java.pushpull.stream;

import java.util.HashSet;
import java.util.List;
import java.util.Objects;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.apache.syncope.common.lib.to.Item;
import org.apache.syncope.common.lib.to.Mapping;
import org.apache.syncope.common.lib.to.Provision;
import org.apache.syncope.common.lib.to.ProvisioningReport;
import org.apache.syncope.common.lib.to.PullTaskTO;
import org.apache.syncope.common.lib.types.ConflictResolutionAction;
import org.apache.syncope.common.lib.types.IdMImplementationType;
import org.apache.syncope.common.lib.types.MappingPurpose;
import org.apache.syncope.common.lib.types.PullMode;
import org.apache.syncope.core.persistence.api.dao.ImplementationDAO;
import org.apache.syncope.core.persistence.api.dao.RealmDAO;
import org.apache.syncope.core.persistence.api.entity.AnyType;
import org.apache.syncope.core.persistence.api.entity.AnyUtils;
import org.apache.syncope.core.persistence.api.entity.ExternalResource;
import org.apache.syncope.core.persistence.api.entity.Implementation;
import org.apache.syncope.core.persistence.api.entity.PlainSchema;
import org.apache.syncope.core.persistence.api.entity.VirSchema;
import org.apache.syncope.core.persistence.api.entity.policy.PullCorrelationRuleEntity;
import org.apache.syncope.core.persistence.api.entity.policy.PullPolicy;
import org.apache.syncope.core.persistence.api.entity.task.PullTask;
import org.apache.syncope.core.provisioning.api.Connector;
import org.apache.syncope.core.provisioning.api.pushpull.GroupPullResultHandler;
import org.apache.syncope.core.provisioning.api.pushpull.ProvisioningProfile;
import org.apache.syncope.core.provisioning.api.pushpull.PullActions;
import org.apache.syncope.core.provisioning.api.pushpull.SyncopePullResultHandler;
import org.apache.syncope.core.provisioning.api.pushpull.stream.SyncopeStreamPullExecutor;
import org.apache.syncope.core.provisioning.java.pushpull.PullJobDelegate;
import org.apache.syncope.core.provisioning.java.utils.MappingUtils;
import org.apache.syncope.core.spring.security.SecureRandomUtils;
import org.quartz.JobExecutionException;
import org.springframework.beans.factory.annotation.Autowired;

public abstract class AbstractStreamPullJobDelegate extends PullJobDelegate implements SyncopeStreamPullExecutor {

@Autowired
protected ImplementationDAO implementationDAO;

@Autowired
protected RealmDAO realmDAO;

protected PullPolicy pullPolicy(
final AnyType anyType,
final ConflictResolutionAction conflictResolutionAction,
final String pullCorrelationRule) {

PullCorrelationRuleEntity pullCorrelationRuleEntity = null;
if (pullCorrelationRule != null) {
Implementation impl = implementationDAO.find(pullCorrelationRule);
if (impl == null || !IdMImplementationType.PULL_CORRELATION_RULE.equals(impl.getType())) {
LOG.debug("Invalid " + Implementation.class.getSimpleName() + " {}, ignoring...", pullCorrelationRule);
} else {
pullCorrelationRuleEntity = entityFactory.newEntity(PullCorrelationRuleEntity.class);
pullCorrelationRuleEntity.setAnyType(anyType);
pullCorrelationRuleEntity.setImplementation(impl);
}
}

PullPolicy pullPolicy = entityFactory.newEntity(PullPolicy.class);
pullPolicy.setConflictResolutionAction(conflictResolutionAction);

if (pullCorrelationRuleEntity != null) {
pullPolicy.add(pullCorrelationRuleEntity);
pullCorrelationRuleEntity.setPullPolicy(pullPolicy);
}

return pullPolicy;
}

protected Provision provision(
final AnyType anyType,
final String keyColumn,
final List<String> columns) throws JobExecutionException {

Provision provision = new Provision();
provision.setAnyType(anyType.getKey());
provision.setObjectClass(anyType.getKey());

Mapping mapping = new Mapping();
provision.setMapping(mapping);

AnyUtils anyUtils = anyUtilsFactory.getInstance(anyType.getKind());
if (anyUtils.getField(keyColumn) == null) {
PlainSchema keyColumnSchema = plainSchemaDAO.find(keyColumn);
if (keyColumnSchema == null) {
throw new JobExecutionException("Plain Schema for key column not found: " + keyColumn);
}
}

Item connObjectKeyItem = new Item();
connObjectKeyItem.setExtAttrName(keyColumn);
connObjectKeyItem.setIntAttrName(keyColumn);
connObjectKeyItem.setPurpose(MappingPurpose.PULL);
mapping.setConnObjectKeyItem(connObjectKeyItem);

columns.stream().
filter(column -> anyUtils.getField(column) != null
|| plainSchemaDAO.find(column) != null || virSchemaDAO.find(column) != null).
map(column -> {
Item item = new Item();
item.setExtAttrName(column);
item.setIntAttrName(column);
item.setPurpose(MappingPurpose.PULL);
mapping.add(item);
return item;
}).forEach(mapping::add);

return provision;
}

protected ExternalResource externalResource(
final AnyType anyType,
final String keyColumn,
final List<String> columns,
final ConflictResolutionAction conflictResolutionAction,
final String pullCorrelationRule) throws JobExecutionException {

Provision provision = provision(anyType, keyColumn, columns);

ExternalResource resource = entityFactory.newEntity(ExternalResource.class);
resource.setKey("StreamPull_" + SecureRandomUtils.generateRandomUUID().toString());
resource.getProvisions().add(provision);

resource.setPullPolicy(pullPolicy(anyType, conflictResolutionAction, pullCorrelationRule));

return resource;
}

protected abstract void stream(
Connector connector,
Provision provision,
SyncopePullResultHandler handler,
Stream<Item> mapItems,
Set<String> moreAttrsToGet);

@Override
public List<ProvisioningReport> pull(
final AnyType anyType,
final String keyColumn,
final List<String> columns,
final ConflictResolutionAction conflictResolutionAction,
final String pullCorrelationRule,
final Connector connector,
final PullTaskTO pullTaskTO) throws JobExecutionException {

LOG.debug("Executing stream pull");

try {
ExternalResource resource =
externalResource(anyType, keyColumn, columns, conflictResolutionAction, pullCorrelationRule);
Provision provision = resource.getProvisions().get(0);

PullTask pullTask = entityFactory.newEntity(PullTask.class);
pullTask.setResource(resource);
pullTask.setMatchingRule(pullTaskTO.getMatchingRule());
pullTask.setUnmatchingRule(pullTaskTO.getUnmatchingRule());
pullTask.setPullMode(PullMode.FULL_RECONCILIATION);
pullTask.setPerformCreate(true);
pullTask.setPerformUpdate(true);
pullTask.setPerformDelete(false);
pullTask.setSyncStatus(false);
pullTask.setDestinationRealm(realmDAO.findByFullPath(pullTaskTO.getDestinationRealm()));
pullTask.setRemediation(pullTaskTO.isRemediation());

profile = new ProvisioningProfile<>(connector, pullTask);
profile.setDryRun(false);
profile.setConflictResolutionAction(conflictResolutionAction);
profile.getActions().addAll(getPullActions(pullTaskTO.getActions().stream().
map(implementationDAO::find).filter(Objects::nonNull).collect(Collectors.toList())));

for (PullActions action : profile.getActions()) {
action.beforeAll(profile);
}

SyncopePullResultHandler handler;
GroupPullResultHandler ghandler = buildGroupHandler();
switch (anyType.getKind()) {
case USER:
handler = buildUserHandler();
break;

case GROUP:
handler = ghandler;
break;

case ANY_OBJECT:
default:
handler = buildAnyObjectHandler();
}
handler.setProfile(profile);
handler.setPullExecutor(this);

// execute filtered pull
Set<String> moreAttrsToGet = new HashSet<>();
profile.getActions().forEach(a -> moreAttrsToGet.addAll(a.moreAttrsToGet(profile, provision)));

Stream<Item> mapItems = Stream.concat(
MappingUtils.getPullItems(provision.getMapping().getItems().stream()),
virSchemaDAO.find(resource.getKey(), anyType.getKey()).stream().
map(VirSchema::asLinkingMappingItem));

stream(connector, provision, handler, mapItems, moreAttrsToGet);

try {
setGroupOwners(ghandler);
} catch (Exception e) {
LOG.error("While setting group owners", e);
}

for (PullActions action : profile.getActions()) {
action.afterAll(profile);
}

return profile.getResults();
} catch (Exception e) {
throw e instanceof JobExecutionException
? (JobExecutionException) e
: new JobExecutionException("While stream pulling", e);
}
}
}
Loading

0 comments on commit 1d1c46a

Please # to comment.