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.data;
20
21 import java.util.List;
22 import org.apache.commons.lang3.tuple.Pair;
23 import org.apache.syncope.common.lib.to.EntityTO;
24 import org.apache.syncope.common.lib.to.Item;
25 import org.apache.syncope.common.lib.types.AttrSchemaType;
26 import org.apache.syncope.core.persistence.api.entity.Any;
27 import org.apache.syncope.core.persistence.api.entity.PlainAttrValue;
28
29 /**
30 * Transforms values to be propagated to (or pulling from) external resources right before they leave (or enter)
31 * the Syncope internal storage.
32 *
33 * These transformations are not applied to virtual attribute values.
34 */
35 public interface ItemTransformer {
36
37 /**
38 * Invoked while preparing attribute values to be sent out to external resource during propagation.
39 *
40 * @param item mapping item
41 * @param any any
42 * @param schemaType schema type
43 * @param values original values
44 * @return transformed values
45 */
46 default Pair<AttrSchemaType, List<PlainAttrValue>> beforePropagation(
47 Item item,
48 Any<?> any,
49 AttrSchemaType schemaType,
50 List<PlainAttrValue> values) {
51
52 return Pair.of(schemaType, values);
53 }
54
55 /**
56 * Invoked while reading attribute values from external resource during pull.
57 *
58 * @param item mapping item
59 * @param entityTO entity
60 * @param values original values
61 * @return transformed values
62 */
63 default List<Object> beforePull(
64 Item item,
65 EntityTO entityTO,
66 List<Object> values) {
67
68 return values;
69 }
70 }