Package org.jenkinsci.plugins.github.admin

Class GitHubDuplicateEventsMonitor.DuplicateEventsSubscriber

java.lang.Object

org.jenkinsci.plugins.github.extension.GHEventsSubscriber

org.jenkinsci.plugins.github.admin.GitHubDuplicateEventsMonitor.DuplicateEventsSubscriber

All Implemented Interfaces:

ExtensionPoint

Enclosing class:

GitHubDuplicateEventsMonitor

@Extension
public static final class GitHubDuplicateEventsMonitor.DuplicateEventsSubscriber
extends GHEventsSubscriber

Tracks duplicate GHEvent triggering actions in Jenkins. Events are tracked for 10 minutes, with the last detected duplicate reference retained for up to 24 hours (see isDuplicateEventSeen()).

Duplicates are stored in-memory only, so a controller restart clears all entries as if none existed. Persistent storage is omitted for simplicity, since webhook misconfigurations would likely cause new duplicates.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	GitHubDuplicateEventsMonitor.DuplicateEventsSubscriber.TrackedDuplicateEvent

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
DuplicateEventsSubscriber()

Method Summary

Modifier and Type	Method	Description
protected Set<org.kohsuke.github.GHEvent>	events()	Should be not null.
GitHubDuplicateEventsMonitor.DuplicateEventsSubscriber.TrackedDuplicateEvent	getLastDuplicate()
protected boolean	isApplicable(Item item)	This subscriber is not applicable to any item
boolean	isDuplicateEventSeen()	Checks if a duplicate event was recorded in the past 24 hours.
protected void	onEvent(GHSubscriberEvent event)	This method called when root action receives webhook from GH and this extension is interested in such events (provided by GHEventsSubscriber.events() method).

Methods inherited from class org.jenkinsci.plugins.github.extension.GHEventsSubscriber

all, extractEvents, isApplicable, isApplicableFor, isApplicableFor, isInterestedIn, onEvent, processEvent, processEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DuplicateEventsSubscriber

public DuplicateEventsSubscriber()

Method Details

isApplicable

protected boolean isApplicable(@Nullable
 Item item)

This subscriber is not applicable to any item

Specified by:

isApplicable in class GHEventsSubscriber

Parameters:

item - ignored

Returns:

always false

events

protected Set<org.kohsuke.github.GHEvent> events()

Should be not null. Should return only events which this extension can parse in GHEventsSubscriber.onEvent(GHEvent, String) Don't call it directly, use GHEventsSubscriber.extractEvents() or GHEventsSubscriber.isInterestedIn(GHEvent) static functions

Subscribes to events that trigger actions in Jenkins, such as repository scans or builds.

The GHEvent enum defines about 63 events, but not all are relevant to Jenkins. Tracking unnecessary events increases memory usage, and they occur more frequently than those triggering any work.

Documentation reference (also referenced in GHEvent)

Specified by:

events in class GHEventsSubscriber

Returns:

immutable set of events this subscriber wants to register and then subscribe to.

onEvent

protected void onEvent(GHSubscriberEvent event)

Description copied from class: GHEventsSubscriber

This method called when root action receives webhook from GH and this extension is interested in such events (provided by GHEventsSubscriber.events() method). By default do nothing and can be overridden to implement any parse logic Don't call it directly, use GHEventsSubscriber.processEvent(GHSubscriberEvent) static function

Overrides:

onEvent in class GHEventsSubscriber

Parameters:

event - the event.

isDuplicateEventSeen

public boolean isDuplicateEventSeen()

Checks if a duplicate event was recorded in the past 24 hours.

Events are not stored for 24 hours—only the most recent duplicate is checked within this timeframe.

Returns:

true if a duplicate was seen in the last 24 hours, false otherwise.

getLastDuplicate

public GitHubDuplicateEventsMonitor.DuplicateEventsSubscriber.TrackedDuplicateEvent getLastDuplicate()