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.rules;
20
21 import java.util.function.BiFunction;
22 import org.apache.syncope.common.lib.policy.PushCorrelationRuleConf;
23 import org.apache.syncope.common.lib.to.Provision;
24 import org.apache.syncope.core.persistence.api.entity.Any;
25 import org.apache.syncope.core.persistence.api.entity.ExternalResource;
26 import org.identityconnectors.framework.common.objects.ConnectorObject;
27 import org.identityconnectors.framework.common.objects.Uid;
28 import org.identityconnectors.framework.common.objects.filter.Filter;
29
30 /**
31 * Interface for correlation rule to be evaluated during PushJob execution.
32 */
33 @FunctionalInterface
34 public interface PushCorrelationRule {
35
36 /**
37 * Default FIQL builder using __UID__.
38 */
39 BiFunction<ConnectorObject, Provision, String> DEFAULT_FIQL_BUILDER =
40 (connectorObject, provision) -> Uid.NAME + "==" + connectorObject.getUid().getUidValue();
41
42 default void setConf(PushCorrelationRuleConf conf) {
43 }
44
45 /**
46 * Returns a filter to match the given any with a connector object on the external resource identified by
47 * the given provision.
48 *
49 * @param any user, group or any object
50 * @param resource external resource
51 * @param provision resource provision
52 * @return filter.
53 */
54 Filter getFilter(Any<?> any, ExternalResource resource, Provision provision);
55
56 /**
57 * Returns a FIQL string to match the given connector object when searching into the external resource identified by
58 * the given provision.
59 *
60 * @param connectorObject connector object
61 * @param provision resource provision
62 * @return fiql
63 */
64 default String getFIQL(ConnectorObject connectorObject, Provision provision) {
65 return DEFAULT_FIQL_BUILDER.apply(connectorObject, provision);
66 }
67 }