feat: Refactoring of CurrentUserService and introduction of UserDetails and more

dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/DimensionService.java

@@ -31,7 +31,6 @@
 import java.util.Map;
 import java.util.Set;
 import org.hisp.dhis.feedback.NotFoundException;
-import org.hisp.dhis.user.User;
 
 /**
  * @author Lars Helge Overland
@@ -47,7 +46,7 @@ public interface DimensionService {
 
   <T extends IdentifiableObject> List<T> getCanReadObjects(List<T> objects);
 
-  <T extends IdentifiableObject> List<T> getCanReadObjects(User user, List<T> objects);
+  <T extends IdentifiableObject> List<T> getCanReadObjects(String username, List<T> objects);
 
   DimensionType getDimensionType(String uid);
 

dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/IdentifiableObjectManager.java

@@ -55,16 +55,10 @@ public interface IdentifiableObjectManager {
 
   void update(@Nonnull IdentifiableObject object);
 
-  void update(@Nonnull IdentifiableObject object, @CheckForNull User user);
-
   void update(@Nonnull List<IdentifiableObject> objects);
 
-  void update(@Nonnull List<IdentifiableObject> objects, @CheckForNull User user);
-
   void delete(@Nonnull IdentifiableObject object);
 
-  void delete(@Nonnull IdentifiableObject object, @CheckForNull User user);
-
   /**
    * Lookup objects of unknown type.
    *
@@ -192,7 +186,7 @@ <T extends IdentifiableObject> T getByUniqueAttributeValue(
       @Nonnull Class<T> type,
       @Nonnull Attribute attribute,
       @Nonnull String value,
-      @CheckForNull User userInfo);
+      @CheckForNull String username);
 
   @CheckForNull
   <T extends IdentifiableObject> T search(@Nonnull Class<T> type, @Nonnull String query);

dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/IdentifiableObjectStore.java

@@ -34,6 +34,7 @@
 import javax.annotation.CheckForNull;
 import javax.annotation.Nonnull;
 import org.hisp.dhis.attribute.Attribute;
+import org.hisp.dhis.user.CurrentUserDetails;
 import org.hisp.dhis.user.User;
 
 /**
@@ -75,9 +76,8 @@
    * Removes the given object instance.
    *
    * @param object the object instance to delete.
-   * @param user User
    */
-  void delete(@Nonnull T object, @CheckForNull User user);
+  void delete(@Nonnull T object);
 
   /**
    * Retrieves the object with the given UID, or null if no object exists.
@@ -160,12 +160,14 @@
    *
    * @param attribute the attribute.
    * @param value the value.
-   * @param user the user.
+   * @param userDetails the user.
    * @return the attribute value or null if not found
    */
   @CheckForNull
   T getByUniqueAttributeValue(
-      @Nonnull Attribute attribute, @Nonnull String value, @CheckForNull User user);
+      @Nonnull Attribute attribute,
+      @Nonnull String value,
+      @CheckForNull CurrentUserDetails userDetails);
 
   /**
    * Retrieves a List of all objects (sorted on name).
@@ -274,16 +276,6 @@
   @Nonnull
   List<T> getById(@Nonnull Collection<Long> ids);
 
-  /**
-   * Retrieves a list of objects referenced by the given collection of ids.
-   *
-   * @param ids a collection of ids.
-   * @param user the {@link User} for sharing restrictions
-   * @return a list of objects.
-   */
-  @Nonnull
-  List<T> getById(@Nonnull Collection<Long> ids, @CheckForNull User user);
-
   /**
    * Retrieves a list of objects referenced by the given collection of uids.
    *
@@ -293,18 +285,6 @@
   @Nonnull
   List<T> getByUid(@Nonnull Collection<String> uids);
 
-  /**
-   * Retrieves a list of objects referenced by the given collection of uids.
-   *
-   * <p>Objects which are soft-deleted (deleted=true) are filtered out
-   *
-   * @param uids a collection of uids.
-   * @param user the {@link User} for sharing restrictions
-   * @return a list of objects.
-   */
-  @Nonnull
-  List<T> getByUid(@Nonnull Collection<String> uids, @CheckForNull User user);
-
   /**
    * Retrieves a list of objects referenced by the given collection of codes.
    *
@@ -314,16 +294,6 @@
   @Nonnull
   List<T> getByCode(@Nonnull Collection<String> codes);
 
-  /**
-   * Retrieves a list of objects referenced by the given collection of codes.
-   *
-   * @param codes a collection of codes.
-   * @param user the {@link User} for sharing restrictions
-   * @return a list of objects.
-   */
-  @Nonnull
-  List<T> getByCode(@Nonnull Collection<String> codes, @CheckForNull User user);
-
   /**
    * Retrieves a list of objects referenced by the given collection of names.
    *
@@ -333,16 +303,6 @@
   @Nonnull
   List<T> getByName(@Nonnull Collection<String> names);
 
-  /**
-   * Retrieves a list of objects referenced by the given collection of names.
-   *
-   * @param names a collection of names.
-   * @param user the {@link User} for sharing restrictions
-   * @return a list of objects.
-   */
-  @Nonnull
-  List<T> getByName(@Nonnull Collection<String> names, @CheckForNull User user);
-
   /**
    * Retrieves a list of objects referenced by the given List of uids. Bypasses the ACL system.
    *
@@ -415,13 +375,13 @@
   List<T> getDataReadAll();
 
   @Nonnull
-  List<T> getDataReadAll(@CheckForNull User user);
+  List<T> getDataReadAll(@CheckForNull CurrentUserDetails userDetails);
 
   @Nonnull
   List<T> getDataWriteAll();
 
   @Nonnull
-  List<T> getDataWriteAll(@CheckForNull User user);
+  List<T> getDataWriteAll(@CheckForNull CurrentUserDetails userDetails);
 
   /** Remove given UserGroup UID from all sharing records in database */
   void removeUserGroupFromSharing(@Nonnull String userGroupUID, @Nonnull String tableName);
@@ -430,26 +390,26 @@
    * Look up list objects which have property createdBy or lastUpdatedBy linked to given {@link
    * User}
    *
-   * @param user the {@link User} for filtering
+   * @param userDetails the {@link User} for filtering
    * @return List of objects found.
    */
-  List<T> findByUser(@Nonnull User user);
+  List<T> findByUser(@Nonnull CurrentUserDetails userDetails);
 
   /**
    * Look up list objects which have property lastUpdatedBy linked to given {@link User}
    *
-   * @param user the {@link User} for filtering
+   * @param userDetails the {@link User} for filtering
    * @return List of objects found.
    */
-  List<T> findByLastUpdatedBy(@Nonnull User user);
+  List<T> findByLastUpdatedBy(@Nonnull CurrentUserDetails userDetails);
 
   /**
    * Look up list objects which have property createdBy linked to given {@link User}
    *
-   * @param user the {@link User} for filtering
+   * @param userDetails the {@link User} for filtering
    * @return List of objects found.
    */
-  List<T> findByCreatedBy(@Nonnull User user);
+  List<T> findByCreatedBy(@Nonnull CurrentUserDetails userDetails);
 
   /**
    * Look up list objects which have property createdBy or lastUpdatedBy linked to given {@link

dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/adapter/BaseIdentifiableObject_.java

@@ -35,12 +35,8 @@
  */
 public class BaseIdentifiableObject_ {
   public static final String CREATED_BY = "createdBy";
-
   public static final String LAST_UPDATED_BY = "lastUpdatedBy";
-
   public static final String TRANSLATIONS = "translations";
-
   public static final String SHARING = "sharing";
-
   public static final String ATTRIBUTE_VALUES = "attributeValues";
 }

dhis-2/dhis-api/src/main/java/org/hisp/dhis/dataset/DataSetService.java

@@ -36,6 +36,7 @@
 import org.hisp.dhis.organisationunit.OrganisationUnit;
 import org.hisp.dhis.period.Period;
 import org.hisp.dhis.period.PeriodType;
+import org.hisp.dhis.user.CurrentUserDetails;
 import org.hisp.dhis.user.User;
 
 /**
@@ -122,7 +123,7 @@ public interface DataSetService extends DataSetDataIntegrityProvider {
    * @param user the user to query for data set list.
    * @return a list of data sets which the given user has data read access to.
    */
-  List<DataSet> getUserDataRead(User user);
+  List<DataSet> getUserDataRead(CurrentUserDetails user);
 
   /**
    * Returns the data sets which current user have WRITE access. If the current user has the ALL
@@ -131,7 +132,7 @@ public interface DataSetService extends DataSetDataIntegrityProvider {
    * @param user the user to query for data set list.
    * @return a list of data sets which given user has data write access to.
    */
-  List<DataSet> getUserDataWrite(User user);
+  List<DataSet> getUserDataWrite(CurrentUserDetails user);
 
   // -------------------------------------------------------------------------
   // DataSet LockExceptions