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;
20
21 import java.util.Map;
22 import org.apache.syncope.core.persistence.api.entity.Any;
23 import org.apache.syncope.core.persistence.api.entity.DerSchema;
24 import org.apache.syncope.core.persistence.api.entity.GroupableRelatable;
25 import org.apache.syncope.core.persistence.api.entity.Membership;
26
27 public interface DerAttrHandler {
28
29 /**
30 * Calculates derived attribute value associated to the given any, for the given derived schema.
31 *
32 * @param any any object
33 * @param schema derived schema
34 * @return derived attribute value
35 */
36 String getValue(Any<?> any, DerSchema schema);
37
38 /**
39 * Calculates derived attributes values associated to the given any.
40 *
41 * @param any any object
42 * @return derived attribute values
43 */
44 Map<DerSchema, String> getValues(Any<?> any);
45
46 /**
47 * Calculates derived attribute value associated to the given any, for the given membership and
48 * derived schema.
49 *
50 * @param any any object
51 * @param membership membership
52 * @param schema derived schema
53 * @return derived attribute value
54 */
55 String getValue(Any<?> any, Membership<?> membership, DerSchema schema);
56
57 /**
58 * Calculates derived attributes values associated to the given any, for the given membership.
59 *
60 * @param any any object
61 * @param membership membership
62 * @return derived attribute values
63 */
64 Map<DerSchema, String> getValues(GroupableRelatable<?, ?, ?, ?, ?> any, Membership<?> membership);
65 }