Package io.jenkins.plugins.restlistparam

Class ValueCache

java.lang.Object

io.jenkins.plugins.restlistparam.ValueCache

public final class ValueCache
extends Object

The processed entries of successful fetches (all pages, after extraction, filter and order), kept in memory for each parameter's cache time, whatever caching headers the endpoint sent.

Entries are kept per job, parameter name and value-source configuration, so jobs with different credentials never share entries and a changed configuration makes earlier entries unreachable. The number of cached parameters is bounded; the least recently used one is evicted first. Nothing is written to disk.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ValueCache.Key	Identifies one parameter's entries: the job's full name ("" outside any job), the parameter name and the fingerprint of its value-source configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAX_ENTRIES
static final String	MAX_ENTRIES_PROPERTY	System property overriding DEFAULT_MAX_ENTRIES.

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes the entries of all parameters.
static void	clearOnStartup()	Starts every Jenkins instance with an empty cache, also when one JVM runs several instances one after another.
static ValueCache	get()
List<ValueItem>	getFresh(ValueCache.Key key, int cacheTimeMinutes)
static ValueCache.Key	keyFor(AbstractRestListParameterDefinition definition, Item context)
void	put(ValueCache.Key key, List<ValueItem> values)	Stores the entries of a successful fetch, fetched now, replacing earlier entries of the same key.
int	size()

Methods inherited from class java.lang.Object

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

Field Details

MAX_ENTRIES_PROPERTY

public static final String MAX_ENTRIES_PROPERTY

System property overriding DEFAULT_MAX_ENTRIES.

DEFAULT_MAX_ENTRIES

public static final int DEFAULT_MAX_ENTRIES

See Also:

• Constant Field Values

Method Details

get

public static ValueCache get()

clearOnStartup

@Initializer(after=PLUGINS_STARTED)
public static void clearOnStartup()

Starts every Jenkins instance with an empty cache, also when one JVM runs several instances one after another.

getFresh

public List<ValueItem> getFresh(ValueCache.Key key,
 int cacheTimeMinutes)

Parameters:

key - The parameter's key

cacheTimeMinutes - The parameter's cache time; 0 or less means nothing is fresh

Returns:

The cached entries if they were fetched less than cacheTimeMinutes ago, otherwise null

put

public void put(ValueCache.Key key,
 List<ValueItem> values)

Stores the entries of a successful fetch, fetched now, replacing earlier entries of the same key.

clear

public void clear()

Removes the entries of all parameters.

size

public int size()

Returns:

How many parameters have entries cached, fresh or not

keyFor

public static ValueCache.Key keyFor(AbstractRestListParameterDefinition definition,
 Item context)

Parameters:

definition - The parameter

context - The job the entries are fetched for, or null outside any job

Returns:

The key of definition's entries in context