hudson.model

Class Fingerprint

java.lang.Object

hudson.model.Fingerprint

All Implemented Interfaces:

ModelObject, Saveable

@ExportedBean
public class Fingerprint
extends Object
implements ModelObject, Saveable

A file being tracked by Jenkins.

Lifecycle is managed by FingerprintMap.

Author:

Kohsuke Kawaguchi

See Also:

FingerprintMap

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Fingerprint.BuildPtr Pointer to a Build.
static class	Fingerprint.ProjectRenameListener
static class	Fingerprint.Range Range of build numbers [start,end).
static class	Fingerprint.RangeItem
static class	Fingerprint.RangeSet Set of Fingerprint.Ranges.

Field Summary

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
Fingerprint(Run build, String fileName, byte[] md5sum)

Method Summary

Modifier and Type	Method and Description
List<Fingerprint.RangeItem>	_getUsages()
void	add(AbstractBuild b) Deprecated. Use addFor(hudson.model.Run)
void	add(String jobFullName, int n) Records that a build of a job has used this file.
void	addFor(Run b) Adds a usage reference to the build.
static void	delete(String id) Deletes the Fingerprint in the configured storage with the given unique id.
List<Action>	getActions() Returns the actions contributed from getFacets()
Api	getApi()
String	getDisplayName()
<T extends FingerprintFacet> T	getFacet(Class<T> type) Finds a facet of the specific type (including subtypes.)
FingerprintFacet	getFacetBlockingDeletion() Returns a facet that blocks the deletion of the fingerprint.
Collection<FingerprintFacet>	getFacets() Gets the associated FingerprintFacets.
String	getFileName() The file name (like "foo.jar" without path).
String	getHashString() Gets the MD5 hash string.
List<String>	getJobs() Gets the sorted list of job names where this jar is used.
Fingerprint.BuildPtr	getOriginal() The first build in which this file showed up, if the file looked like it's created there.
PersistedList<FingerprintFacet>	getPersistedFacets() Returns the persisted facets.
Fingerprint.RangeSet	getRangeSet(Job job)
Fingerprint.RangeSet	getRangeSet(String jobFullName) Gets the build range set for the given job name.
Collection<FingerprintFacet>	getSortedFacets() Sorts FingerprintFacets by their timestamps.
Date	getTimestamp() Gets the timestamp when this record is created.
String	getTimestampString() Gets the string that says how long since this build has scheduled.
Hashtable<String,Fingerprint.RangeSet>	getUsages()
static XStream2	getXStream() Provides the XStream instance this class is using for serialization.
boolean	isAlive() Returns true if any of the builds recorded in this fingerprint is still retained.
static Fingerprint	load(String id) Loads a Fingerprint from the Storage with the given unique id.
protected Object	readResolve()
void	rename(String oldName, String newName) Update references to a renamed job in the fingerprint
void	save() Save the Fingerprint in the Fingerprint Storage
String	toString()
boolean	trim() Trim off references to non-existent builds and jobs, thereby making the fingerprint smaller.

Methods inherited from class java.lang.Object

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

Constructor Detail

Fingerprint

public Fingerprint(@CheckForNull
                   Run build,
                   @NonNull
                   String fileName,
                   @NonNull
                   byte[] md5sum)
            throws IOException

Throws:

IOException

Method Detail

getOriginal

@Exported
 @CheckForNull
public Fingerprint.BuildPtr getOriginal()

The first build in which this file showed up, if the file looked like it's created there.

This is considered as the "source" of this file, or the owner, in the sense that this project "owns" this file.

Returns:

null if the file is apparently created outside Hudson or if the current user has no permission to discover the job.

getDisplayName

@NonNull
public String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

getFileName

@Exported
 @NonNull
public String getFileName()

The file name (like "foo.jar" without path).

getHashString

@Exported(name="hash")
 @NonNull
public String getHashString()

Gets the MD5 hash string.

getTimestamp

@Exported
 @NonNull
public Date getTimestamp()

Gets the timestamp when this record is created.

getTimestampString

@NonNull
public String getTimestampString()

Gets the string that says how long since this build has scheduled.

Returns:

string like "3 minutes" "1 day" etc.

getRangeSet

@NonNull
public Fingerprint.RangeSet getRangeSet(String jobFullName)

Gets the build range set for the given job name.

These builds of this job has used this file.

Returns:

may be empty but not null.

getRangeSet

public Fingerprint.RangeSet getRangeSet(Job job)

getJobs

@NonNull
public List<String> getJobs()

Gets the sorted list of job names where this jar is used.

getUsages

@CheckForNull
public Hashtable<String,Fingerprint.RangeSet> getUsages()

_getUsages

@Exported(name="usage")
 @NonNull
public List<Fingerprint.RangeItem> _getUsages()

add

@Deprecated
public void add(@NonNull
                            AbstractBuild b)
                     throws IOException

Deprecated. Use addFor(hudson.model.Run)

Throws:

IOException

addFor

public void addFor(@NonNull
                   Run b)
            throws IOException

Adds a usage reference to the build.

Parameters:

b - Run to be referenced in usages

Throws:

IOException

Since:

1.577

add

public void add(@NonNull
                String jobFullName,
                int n)
         throws IOException

Records that a build of a job has used this file.

Throws:

IOException

readResolve

protected Object readResolve()

isAlive

public boolean isAlive()

Returns true if any of the builds recorded in this fingerprint is still retained.

This is used to find out old fingerprint records that can be removed without losing too much information.

trim

public boolean trim()
             throws IOException

Trim off references to non-existent builds and jobs, thereby making the fingerprint smaller.

Returns:

true if this record was modified.

Throws:

IOException - Save failure

getFacets

@NonNull
public Collection<FingerprintFacet> getFacets()

Gets the associated FingerprintFacets.

This method always return a non-empty collection, which is a synthetic collection. It contains persisted FingerprintFacets (those that are added explicitly, like fingerprint.getFacets().add(x)), as well those that are transient.

Mutation to this collection will manipulate persisted set of FingerprintFacets, and therefore regardless of what you do, this collection will always contain a set of FingerprintFacets that are added by TransientFingerprintFacetFactorys.

Since:

1.421

getPersistedFacets

@NonNull
public final PersistedList<FingerprintFacet> getPersistedFacets()

Returns the persisted facets.

Since:

2.242

getSortedFacets

@NonNull
public Collection<FingerprintFacet> getSortedFacets()

Sorts FingerprintFacets by their timestamps.

Returns:

Sorted list of FingerprintFacets

getFacet

@CheckForNull
public <T extends FingerprintFacet> T getFacet(Class<T> type)

Finds a facet of the specific type (including subtypes.)

Type Parameters:

T - Class of the FingerprintFacet

Returns:

First matching facet of the specified class

Since:

1.556

getActions

@NonNull
public List<Action> getActions()

Returns the actions contributed from getFacets()

save

public void save()
          throws IOException

Save the Fingerprint in the Fingerprint Storage

Specified by:

save in interface Saveable

Throws:

IOException - Save error

getFacetBlockingDeletion

@CheckForNull
public FingerprintFacet getFacetBlockingDeletion()

Returns a facet that blocks the deletion of the fingerprint. Returns null if no such facet.

Since:

2.223

rename

public void rename(String oldName,
                   String newName)
            throws IOException

Update references to a renamed job in the fingerprint

Throws:

IOException

getApi

public Api getApi()

load

@CheckForNull
public static Fingerprint load(@NonNull
                                             String id)
                                      throws IOException

Loads a Fingerprint from the Storage with the given unique id.

Returns:

Loaded Fingerprint. null if the config file does not exist or malformed. In case an external storage is configured on top of a file system based storage: 1. External storage is polled to retrieve the fingerprint 2. If not found, then the local storage is polled to retrieve the fingerprint

Throws:

IOException

delete

public static void delete(@NonNull
                          String id)
                   throws IOException

Deletes the Fingerprint in the configured storage with the given unique id.

Throws:

IOException

Since:

2.242

toString

public String toString()

Overrides:

toString in class Object

getXStream

@NonNull
public static XStream2 getXStream()

Provides the XStream instance this class is using for serialization.

Returns:

the XStream instance

Since:

1.655