1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.syncope.core.provisioning.api.propagation;
20
21 import java.util.Collection;
22 import org.apache.syncope.common.lib.to.PropagationTaskTO;
23 import org.apache.syncope.core.persistence.api.entity.task.PropagationTask;
24 import org.apache.syncope.core.persistence.api.entity.task.TaskExec;
25
26 /**
27 * Execute propagation tasks.
28 *
29 * @see PropagationTaskTO
30 */
31 @SuppressWarnings("squid:S1214")
32 public interface PropagationTaskExecutor {
33
34 /**
35 * Remove any RetryTemplate defined for the given External Resource from local cache.
36 *
37 * @param resource External Resource name
38 */
39 void expireRetryTemplate(String resource);
40
41 /**
42 * Execute the given task and returns the generated {@link TaskExec}.
43 *
44 * @param taskInfo to be executed
45 * @param reporter to report propagation execution status
46 * @param executor the executor of this task
47 * @return the generated TaskExec
48 */
49 TaskExec<PropagationTask> execute(PropagationTaskInfo taskInfo, PropagationReporter reporter, String executor);
50
51 /**
52 * Execute the given collection of tasks.
53 * The process is interrupted as soon as the result of the communication with a resource with non-null priority is
54 * in error.
55 *
56 * @param taskInfos to be execute, in given order
57 * @param nullPriorityAsync asynchronously executes tasks related to resources with no priority
58 * @param executor the executor of this task
59 * @return reporter to report propagation execution status
60 */
61 PropagationReporter execute(Collection<PropagationTaskInfo> taskInfos, boolean nullPriorityAsync, String executor);
62 }