View Javadoc
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 org.apache.commons.lang3.tuple.Pair;
22  import org.apache.syncope.common.lib.request.UserCR;
23  import org.apache.syncope.common.lib.request.UserUR;
24  import org.apache.syncope.common.lib.to.LinkedAccountTO;
25  import org.apache.syncope.common.lib.to.UserTO;
26  import org.apache.syncope.core.persistence.api.entity.user.LinkedAccount;
27  import org.apache.syncope.core.persistence.api.entity.user.User;
28  import org.apache.syncope.core.provisioning.api.PropagationByResource;
29  
30  public interface UserDataBinder {
31  
32      UserTO getAuthenticatedUserTO();
33  
34      UserTO getUserTO(String key);
35  
36      UserTO getUserTO(User user, boolean details);
37  
38      LinkedAccountTO getLinkedAccountTO(LinkedAccount account);
39  
40      void create(User user, UserCR userCR);
41  
42      /**
43       * Update user, given {@link UserUR}.
44       *
45       * @param toBeUpdated user to be updated
46       * @param userUR bean containing update request
47       * @return updated user + propagation by resource
48       * @see PropagationByResource
49       */
50      Pair<PropagationByResource<String>, PropagationByResource<Pair<String, String>>> update(
51              User toBeUpdated, UserUR userUR);
52  }