Package jenkins.model

Interface PeepholePermalink.Cache

All Superinterfaces:

ExtensionPoint

All Known Implementing Classes:

PeepholePermalink.DefaultCache

Enclosing class:

PeepholePermalink

@Restricted(org.kohsuke.accmod.restrictions.Beta.class)
public static interface PeepholePermalink.Cache
extends ExtensionPoint

Persistable cache of peephole permalink targets.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PeepholePermalink.Cache.Known	The cache entry for this target is present.
static final record	PeepholePermalink.Cache.None	There is known to be no matching build.
static interface	PeepholePermalink.Cache.PermalinkTarget	Cacheable target of a permalink.
static final record	PeepholePermalink.Cache.Some	A matching build, indicated by Run.getNumber().
static final record	PeepholePermalink.Cache.Unknown	The cache entry for this target is missing.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final PeepholePermalink.Cache.None	NONE	Singleton of PeepholePermalink.Cache.None.
static final PeepholePermalink.Cache.Unknown	UNKNOWN

Method Summary

Modifier and Type	Method	Description
PeepholePermalink.Cache.PermalinkTarget	get(Job<?,?> job, String id)	Looks for any existing cache hit.
void	put(Job<?,?> job, String id, PeepholePermalink.Cache.Known target)	Updates the cache.

Field Details

UNKNOWN

static final PeepholePermalink.Cache.Unknown UNKNOWN

NONE

static final PeepholePermalink.Cache.None NONE

Singleton of PeepholePermalink.Cache.None.

Method Details

get

@NonNull
PeepholePermalink.Cache.PermalinkTarget get(@NonNull
 Job<?,?> job,
 @NonNull
 String id)

Looks for any existing cache hit.

Parameters:

id - PermalinkProjectAction.Permalink.getId()

Returns:

PeepholePermalink.Cache.Some or NONE or UNKNOWN

put

void put(@NonNull
 Job<?,?> job,
 @NonNull
 String id,
 @NonNull
 PeepholePermalink.Cache.Known target)

Updates the cache. Note that this may be called not just when a build completes or is deleted (meaning that the logical value of the cache has changed), but also when PeepholePermalink.resolve(hudson.model.Job<?, ?>) has failed to find a cached value (or determined that a previously cached value is in fact invalid).

Parameters:

id - PermalinkProjectAction.Permalink.getId()

target - PeepholePermalink.Cache.Some or NONE