Merge pull request #295 from meiswjn/feature/credential-usage-event

Add CredentialsUseListener to improve tracking of Credentials usage

Author: jglick

src/main/java/com/cloudbees/plugins/credentials/CredentialsProvider.java

@@ -1479,6 +1479,9 @@ public static <C extends Credentials> List<C> trackAll(@NonNull Run build, @NonN
         } else {
             LOGGER.log(Level.FINEST, "TrackAll method (Run variant) called but fingerprints disabled by {0}", FINGERPRINT_ENABLED_NAME);
         }
+        for (Credentials c : credentials) {
+            CredentialsUseListener.fireUse(c, build);
+        }
         return credentials;
     }
 
@@ -1578,6 +1581,9 @@ public static <C extends Credentials> List<C> trackAll(@NonNull Node node, @NonN
         } else {
             LOGGER.log(Level.FINEST, "TrackAll method (Node variant) called but fingerprints disabled by {0}", FINGERPRINT_ENABLED_NAME);
         }
+        for (Credentials c : credentials) {
+            CredentialsUseListener.fireUse(c, node);
+        }
         return credentials;
     }
 
@@ -1663,6 +1669,9 @@ public static <C extends Credentials> List<C> trackAll(@NonNull Item item, @NonN
         } else {
             LOGGER.log(Level.FINEST, "TrackAll method (Item variant) called but fingerprints disabled by {0}", FINGERPRINT_ENABLED_NAME);
         }
+        for (Credentials c : credentials) {
+            CredentialsUseListener.fireUse(c, item);
+        }
         return credentials;
     }
 

src/main/java/com/cloudbees/plugins/credentials/CredentialsUseListener.java

@@ -0,0 +1,68 @@
+package com.cloudbees.plugins.credentials;
+
+import hudson.ExtensionPoint;
+import hudson.model.Item;
+import hudson.model.ModelObject;
+import hudson.model.Node;
+import hudson.model.Run;
+import jenkins.util.Listeners;
+
+import java.util.List;
+
+
+/**
+ * A Listener to track {@link Credentials} usage.
+ * @see CredentialsProvider#trackAll(Item, List) 
+ * @see CredentialsProvider#trackAll(Run, List) 
+ * @see CredentialsProvider#trackAll(Node, List) 
+ */
+public interface CredentialsUseListener extends ExtensionPoint {
+
+    /**
+     * Called when {@link Credentials} is read by a run.
+     *
+     * @param c   The used Credentials.
+     * @param run The run using the credentials.
+     */
+    void onUse(Credentials c, Run run);
+
+    /**
+     * Called when {@link Credentials} is read by a node.
+     *
+     * @param c   The used Credentials.
+     * @param node The node using the credentials.
+     */
+    void onUse(Credentials c, Node node);
+
+    /**
+     * Called when {@link Credentials} is read by an item.
+     *
+     * @param c   The used Credentials.
+     * @param item The item using the credentials.
+     */
+    void onUse(Credentials c, Item item);
+
+    /**
+     * Fires the {@link #onUse} event to track the run that uses credentials.
+     *  @see CredentialsProvider#trackAll(Run, List)
+     */
+    static void fireUse(Credentials c, Run run) {
+        Listeners.notify(CredentialsUseListener.class, true, listener -> listener.onUse(c, run));
+    }
+
+    /**
+     * Fires the {@link #onUse} event to track the node that uses credentials.
+     *  @see CredentialsProvider#trackAll(Node, List)
+     */
+    static void fireUse(Credentials c, Node node) {
+        Listeners.notify(CredentialsUseListener.class, true, listener -> listener.onUse(c, node));
+    }
+
+    /**
+     * Fires the {@link #onUse} event to track the item that uses credentials.
+     *  @see CredentialsProvider#trackAll(Item, List)
+     */
+    static void fireUse(Credentials c, Item item) {
+        Listeners.notify(CredentialsUseListener.class, true, listener -> listener.onUse(c, item));
+    }
+}