/*
* 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.api.propagation;
import java.util.Collection;
import org.apache.syncope.core.persistence.api.entity.task.PropagationTask;
import org.apache.syncope.core.persistence.api.entity.task.TaskExec;
/**
* Execute propagation tasks.
*
* @see PropagationTask
*/
public interface PropagationTaskExecutor {
/**
* Name for special propagation attribute used to indicate whether there are attributes, marked as mandatory in the
* mapping but not to be propagated.
*/
String MANDATORY_MISSING_ATTR_NAME = "__MANDATORY_MISSING__";
/**
* Name for special propagation attribute used to indicate whether there are attributes, marked as mandatory in the
* mapping but about to be propagated as null or empty.
*/
String MANDATORY_NULL_OR_EMPTY_ATTR_NAME = "__MANDATORY_NULL_OR_EMPTY__";
/**
* Execute the given PropagationTask and returns the generated {@link TaskExec}.
*
* @param task to be executed
* @return the generated TaskExec
*/
TaskExec execute(PropagationTask task);
/**
* Execute a collection of PropagationTask objects.
* The process is interrupted as soon as the result of the communication with a primary resource is in error.
*
* @param tasks to be executed
*/
void execute(Collection<PropagationTask> tasks);
/**
* Execute a collection of PropagationTask objects.
* The process is interrupted as soon as the result of the communication with a resource with non-null priority is
* in error.
*
* @param tasks to be execute, in given order
* @param nullPriorityAsync asynchronously executes tasks related to resources with no priority
* @return reporter to report propagation execution status
*/
PropagationReporter execute(Collection<PropagationTask> tasks, boolean nullPriorityAsync);
}