From 726cf51f06689958e53eea8b29af62e00646ab9d Mon Sep 17 00:00:00 2001
From: Daniel Hornung <d.hornung@indiscale.com>
Date: Mon, 6 Dec 2021 18:07:16 +0100
Subject: [PATCH] DOC: Comments added.
---
.../java/org/caosdb/server/accessControl/UserSources.java | 4 ++++
.../server/database/backend/interfaces/LogUserVisitImpl.java | 1 +
.../server/grpc/AccessControlManagementServiceImpl.java | 2 ++
.../org/caosdb/server/transaction/UpdateUserTransaction.java | 3 +++
4 files changed, 10 insertions(+)
diff --git a/src/main/java/org/caosdb/server/accessControl/UserSources.java b/src/main/java/org/caosdb/server/accessControl/UserSources.java
index 63254c1b..b169849b 100644
--- a/src/main/java/org/caosdb/server/accessControl/UserSources.java
+++ b/src/main/java/org/caosdb/server/accessControl/UserSources.java
@@ -282,6 +282,10 @@ public class UserSources extends HashMap<String, UserSource> {
return false;
}
+ /**
+ * Log the current time as the user's last visit.
+ *
+ */
public static void logUserVisit(String realm, String username, String type) {
try {
LogUserVisitTransaction t =
diff --git a/src/main/java/org/caosdb/server/database/backend/interfaces/LogUserVisitImpl.java b/src/main/java/org/caosdb/server/database/backend/interfaces/LogUserVisitImpl.java
index 3c18356f..38c253e2 100644
--- a/src/main/java/org/caosdb/server/database/backend/interfaces/LogUserVisitImpl.java
+++ b/src/main/java/org/caosdb/server/database/backend/interfaces/LogUserVisitImpl.java
@@ -21,5 +21,6 @@ package org.caosdb.server.database.backend.interfaces;
public interface LogUserVisitImpl extends BackendTransactionImpl {
+ /** Return true if this is not the first visit of this user. */
boolean logUserReturnIsKnown(long timestamp, String realm, String username, String type);
}
diff --git a/src/main/java/org/caosdb/server/grpc/AccessControlManagementServiceImpl.java b/src/main/java/org/caosdb/server/grpc/AccessControlManagementServiceImpl.java
index 1baf05ff..0079af6f 100644
--- a/src/main/java/org/caosdb/server/grpc/AccessControlManagementServiceImpl.java
+++ b/src/main/java/org/caosdb/server/grpc/AccessControlManagementServiceImpl.java
@@ -288,6 +288,7 @@ public class AccessControlManagementServiceImpl extends AccessControlManagementS
.build();
}
+ /** What can be done with this role. */
private Iterable<? extends RoleCapabilities> getRoleCapabilities(Role role) {
List<RoleCapabilities> result = new LinkedList<>();
if (org.caosdb.server.permissions.Role.ADMINISTRATION.toString().equals(role.name)) {
@@ -304,6 +305,7 @@ public class AccessControlManagementServiceImpl extends AccessControlManagementS
return result;
}
+ /** The permissions of the current user w.r.t. this role. */
private Iterable<? extends RolePermissions> getRolePermissions(Role role) {
List<RolePermissions> result = new LinkedList<>();
Subject current_user = SecurityUtils.getSubject();
diff --git a/src/main/java/org/caosdb/server/transaction/UpdateUserTransaction.java b/src/main/java/org/caosdb/server/transaction/UpdateUserTransaction.java
index 41322b51..1fca0525 100644
--- a/src/main/java/org/caosdb/server/transaction/UpdateUserTransaction.java
+++ b/src/main/java/org/caosdb/server/transaction/UpdateUserTransaction.java
@@ -43,6 +43,9 @@ import org.caosdb.server.utils.ServerMessages;
import org.caosdb.server.utils.Utils;
import org.jdom2.Element;
+/**
+ * This transaction also checks if the current user has sufficient permissions to make the update.
+ */
public class UpdateUserTransaction extends AccessControlTransaction {
private final String password;
--
GitLab