jenkins.model

Class PeepholePermalink

java.lang.Object

hudson.model.PermalinkProjectAction.Permalink

jenkins.model.PeepholePermalink

All Implemented Interfaces:

com.google.common.base.Predicate<Run<?,?>>

public abstract class PeepholePermalink
extends PermalinkProjectAction.Permalink
implements com.google.common.base.Predicate<Run<?,?>>

Convenient base implementation for PermalinkProjectAction.Permalinks that satisfy certain properties.

For a permalink to be able to use this, it has to satisfy the following:

Given a job J, permalink is a function F that computes a build B. A peephole permalink is a subset of this function that can be deduced to the "peep-hole" function G(B)→bool:

         F(J) = { newest B | G(B)==true }
     

Intuitively speaking, a peep-hole permalink resolves to the latest build that satisfies a certain characteristics that can be determined solely by looking at the build and nothing else (most commonly its build result.)

This base class provides a file-based caching mechanism that avoids walking the long build history. The cache is a symlink to the build directory where symlinks are supported, and text file that contains the build number otherwise.

The implementation transparently tolerates G(B) that goes from true to false over time (it simply scans the history till find the new matching build.) To tolerate G(B) that goes from false to true, you need to be able to intercept whenever G(B) changes from false to true, then call resolve(Job) to check the current permalink target is up to date, then call updateCache(Job, Run) if it needs updating.

Since:

1.507

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PeepholePermalink.RunListenerImpl

Field Summary

Fields inherited from class hudson.model.PermalinkProjectAction.Permalink

BUILTIN, LAST_BUILD, LAST_COMPLETED_BUILD, LAST_FAILED_BUILD, LAST_STABLE_BUILD, LAST_SUCCESSFUL_BUILD, LAST_UNSTABLE_BUILD, LAST_UNSUCCESSFUL_BUILD

Constructor Summary

Constructors

Constructor and Description
PeepholePermalink()

Method Summary

Modifier and Type	Method and Description
abstract boolean	apply(Run<?,?> run) Checks if the given build satisfies the peep-hole criteria.
protected File	getPermalinkFile(Job<?,?> job) The file in which the permalink target gets recorded.
Run<?,?>	resolve(Job<?,?> job) Resolves the permalink by using the cache if possible.
protected void	updateCache(Job<?,?> job, Run<?,?> b) Remembers the value 'n' in the cache for future resolve(Job).

Methods inherited from class hudson.model.PermalinkProjectAction.Permalink

getDisplayName, getId

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.base.Predicate

equals

Constructor Detail

PeepholePermalink

public PeepholePermalink()

Method Detail

apply

public abstract boolean apply(Run<?,?> run)

Checks if the given build satisfies the peep-hole criteria. This is the "G(B)" as described in the class javadoc.

Specified by:

apply in interface com.google.common.base.Predicate<Run<?,?>>

getPermalinkFile

protected File getPermalinkFile(Job<?,?> job)

The file in which the permalink target gets recorded.

resolve

public Run<?,?> resolve(Job<?,?> job)

Resolves the permalink by using the cache if possible.

Specified by:

resolve in class PermalinkProjectAction.Permalink

Returns:

null if the target of the permalink doesn't exist.

updateCache

protected void updateCache(@Nonnull
                           Job<?,?> job,
                           @Nullable
                           Run<?,?> b)

Remembers the value 'n' in the cache for future resolve(Job).