svn commit: r1887214 - in /jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/user/monitor: UserMonitor.java UserMonitorImpl.java

[an...@apache.org]

Author: angela
Date: Fri Mar  5 16:27:56 2021
New Revision: 1887214

URL: http://svn.apache.org/viewvc?rev=1887214&view=rev
Log:
OAK-9366 : Monitoring for user management implementation (javadoc)

Modified:
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/user/monitor/UserMonitor.java
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/user/monitor/UserMonitorImpl.java

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/user/monitor/UserMonitor.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/user/monitor/UserMonitor.java?rev=1887214&r1=1887213&r2=1887214&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/user/monitor/UserMonitor.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/user/monitor/UserMonitor.java Fri Mar  5 16:27:56 2021
@@ -28,10 +28,31 @@ public interface UserMonitor extends Mon
 
     UserMonitor NOOP = new UserMonitor() {};
 
+    /**
+     * Called to record the time it takes to compute the members of a group.
+     *
+     * @param timeTakenNanos The time in nanoseconds
+     * @param declaredOnly {@code true} if only declared members were retrieved; {@code false} if declared and
+     * inherited members were retrieved.
+     */
     default void doneGetMembers(long timeTakenNanos, boolean declaredOnly) {}
 
+    /**
+     * Called to record the time it takes to compute the group membership of a given user or group.
+     *
+     * @param timeTakenNanos The time in nanoseconds
+     * @param declaredOnly {@code true} if only declared membership was retrieved; {@code false} otherwise.
+     */
     default void doneMemberOf(long timeTakenNanos, boolean declaredOnly) {}
 
+    /**
+     * Called to record changes to members of a group.
+     *
+     * @param timeTakenNanos The time in nanoseconds
+     * @param totalProcessed The total number of processed members
+     * @param failed The number of unsuccessful updates (either members added or removed)
+     * @param isRemove {@code true} if members were being removed; {@code false} if added.
+     */
     default void doneUpdateMembers(long timeTakenNanos, long totalProcessed, long failed, boolean isRemove) {}
 
     default @NotNull Class<UserMonitor> getMonitorClass() {

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/user/monitor/UserMonitorImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/user/monitor/UserMonitorImpl.java?rev=1887214&r1=1887213&r2=1887214&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/user/monitor/UserMonitorImpl.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/security/user/monitor/UserMonitorImpl.java Fri Mar  5 16:27:56 2021
@@ -20,6 +20,7 @@ import org.apache.jackrabbit.oak.stats.M
 import org.apache.jackrabbit.oak.stats.StatisticsProvider;
 import org.apache.jackrabbit.oak.stats.StatsOptions;
 import org.apache.jackrabbit.oak.stats.TimerStats;
+import org.jetbrains.annotations.NotNull;
 
 import static java.util.concurrent.TimeUnit.NANOSECONDS;
 
@@ -53,7 +54,7 @@ public class UserMonitorImpl implements
     private final TimerStats memberOfTimer;
     private final TimerStats declaredMemberOfTimer;
 
-    public UserMonitorImpl(StatisticsProvider statisticsProvider) {
+    public UserMonitorImpl(@NotNull StatisticsProvider statisticsProvider) {
         addMembersFailed = statisticsProvider.getMeter(ADD_MEMBERS_FAILED, StatsOptions.DEFAULT);
         addMembersSucceeded = statisticsProvider.getMeter(ADD_MEMBERS_SUCCEEDED, StatsOptions.DEFAULT);
         addMembersTimer = statisticsProvider.getTimer(ADD_MEMBERS_TIMER, StatsOptions.METRICS_ONLY);