Add Example Logging Http Notifier (#439)

Author: sghill

src/main/java/org/jenkinsci/plugins/stashNotifier/example/LoggingHttpNotifier.java

@@ -0,0 +1,41 @@
+package org.jenkinsci.plugins.stashNotifier.example;
+
+import java.io.PrintStream;
+import java.net.URI;
+
+import org.jenkinsci.plugins.stashNotifier.HttpNotifier;
+import org.jenkinsci.plugins.stashNotifier.NotificationContext;
+import org.jenkinsci.plugins.stashNotifier.NotificationResult;
+import org.jenkinsci.plugins.stashNotifier.NotificationSettings;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.cloudbees.plugins.credentials.Credentials;
+
+import edu.umd.cs.findbugs.annotations.NonNull;
+import net.sf.json.JSONObject;
+
+/**
+ * Included as an example to demonstrate how alternative notifiers work.
+ * Set the system property <code>-Dorg.jenkinsci.plugins.stashNotifier.HttpNotifierSelector.className=org.jenkinsci.plugins.stashNotifier.example.LoggingHttpNotifierSelector<code>
+ * to tell the system to choose this implementation.
+ */
+class LoggingHttpNotifier implements HttpNotifier {
+    private static final Logger LOGGER = LoggerFactory.getLogger(LoggingHttpNotifier.class);
+
+    @Override
+    public @NonNull NotificationResult send(@NonNull URI uri, @NonNull JSONObject payload, @NonNull NotificationSettings settings, @NonNull NotificationContext context) {
+        Credentials creds = settings.getCredentials();
+        String runId = context.getRunId();
+        PrintStream buildLog = context.getLogger();
+        String target = uri == null ? "(undefined)" : uri.toASCIIString();
+        buildLog.println("[stash-notifier] would have notified " + target + " with " + payload);
+        if (creds != null) {
+            Class<?> credsClass = creds.getClass();
+            LOGGER.info("{} would have used {} to notify {} with payload {}", runId, credsClass.getSimpleName(), target, payload);
+        } else {
+            LOGGER.info("{} would have notified {} with payload {}", runId, target, payload);
+        }
+        return NotificationResult.newSuccess();
+    }
+}

src/main/java/org/jenkinsci/plugins/stashNotifier/example/LoggingHttpNotifierSelector.java

@@ -0,0 +1,22 @@
+package org.jenkinsci.plugins.stashNotifier.example;
+
+import org.jenkinsci.plugins.stashNotifier.HttpNotifier;
+import org.jenkinsci.plugins.stashNotifier.HttpNotifierSelector;
+import org.jenkinsci.plugins.stashNotifier.SelectionContext;
+
+import edu.umd.cs.findbugs.annotations.NonNull;
+
+/**
+ * This is an example alternative way of selecting a {@link HttpNotifier}.
+ */
+class LoggingHttpNotifierSelector implements HttpNotifierSelector {
+
+    /**
+     * @param context unused
+     * @return {@link LoggingHttpNotifier}
+     */
+    @Override
+    public @NonNull HttpNotifier select(@NonNull SelectionContext context) {
+        return new LoggingHttpNotifier();
+    }
+}

src/main/java/org/jenkinsci/plugins/stashNotifier/example/LoggingNotifierModule.java

@@ -0,0 +1,15 @@
+package org.jenkinsci.plugins.stashNotifier.example;
+
+import com.google.inject.AbstractModule;
+import com.google.inject.Provides;
+import hudson.Extension;
+import jakarta.inject.Singleton;
+
+@Extension
+public class LoggingNotifierModule extends AbstractModule {
+    @Provides
+    @Singleton
+    LoggingHttpNotifierSelector providesLoggingNotifierSelector() {
+        return new LoggingHttpNotifierSelector();
+    }
+}