jenkins.fingerprints

Class FingerprintStorage

java.lang.Object

jenkins.fingerprints.FingerprintStorage

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

FileFingerprintStorage

@Restricted(value=org.kohsuke.accmod.restrictions.Beta.class)
public abstract class FingerprintStorage
extends Object
implements ExtensionPoint

Pluggable fingerprint storage API for fingerprints.

Author:

Sumit Sarin

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
FingerprintStorage()

Method Summary

Modifier and Type	Method and Description
abstract void	delete(String id) Deletes the Fingerprint with the given unique ID.
static FingerprintStorage	get() Returns the first implementation of FingerprintStorage for the instance.
abstract boolean	isReady() Returns true if there's some data in the fingerprint database.
abstract Fingerprint	load(String id) Returns the Fingerprint with the given unique ID.
abstract void	save(Fingerprint fp) Saves the given Fingerprint in the storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

FingerprintStorage

public FingerprintStorage()

Method Detail

get

public static FingerprintStorage get()

Returns the first implementation of FingerprintStorage for the instance. External storage plugins which implement FingerprintStorage are given a higher priority.

save

public abstract void save(Fingerprint fp)
                   throws IOException

Saves the given Fingerprint in the storage. This acts as a blocking operation. For file system based default storage, throws IOException when it fails.

Throws:

IOException - Save error

load

@CheckForNull
public abstract Fingerprint load(String id)
                                        throws IOException

Returns the Fingerprint with the given unique ID. The unique ID for a fingerprint is defined by Fingerprint.getHashString().

Throws:

IOException - Load error

delete

public abstract void delete(String id)
                     throws IOException

Deletes the Fingerprint with the given unique ID. This acts as a blocking operation. For file system based default storage, throws IOException when it fails. The unique ID for a fingerprint is defined by Fingerprint.getHashString(). TODO: Needed for external storage fingerprint cleanup.

Throws:

IOException - Deletion error

isReady

public abstract boolean isReady()

Returns true if there's some data in the fingerprint database.