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 java.util.List;
23 import org.apache.syncope.common.lib.to.PropagationStatus;
24 import org.apache.syncope.common.lib.types.ExecStatus;
25 import org.identityconnectors.framework.common.objects.ConnectorObject;
26
27 /**
28 * Report propagation status after executions.
29 */
30 public interface PropagationReporter {
31
32 /**
33 * Report propagation status after executions in case blocking failure (e.g. on priority resources).
34 *
35 * @param failingResource failing resource name
36 * @param taskInfos propagation tasks performed before failure
37 */
38 void onPriorityResourceFailure(String failingResource, Collection<PropagationTaskInfo> taskInfos);
39
40 /**
41 * Report propagation status after executions in case of success or non-blocking failure
42 * (e.g. on non-priority resources).
43 *
44 * @param taskInfo propagation task
45 * @param execStatus propagation execution status
46 * @param failureReason propagation execution failure message
47 * @param fiql FIQL string to match the connector objects into the external resource
48 * @param beforeObj retrieved connector object before operation execution
49 * @param afterObj retrieved connector object after operation execution
50 */
51 void onSuccessOrNonPriorityResourceFailures(
52 PropagationTaskInfo taskInfo,
53 ExecStatus execStatus,
54 String failureReason,
55 String fiql,
56 ConnectorObject beforeObj,
57 ConnectorObject afterObj);
58
59 /**
60 * Returns the list of propagation statuses.
61 *
62 * @return the list of propagation statuses
63 */
64 List<PropagationStatus> getStatuses();
65 }