Instances of JarCache provides jar index information.

Implementation is threadsafe. Since loading index information is O(jar-entries) we cache the snapshot in a WeakHashMap. The implementation pays attention to lastModified timestamp of the jar and will invalidate the cache entry if jar has been updated since the snapshot calculation.

****************************************************************************************** DANGER DANGER DANGER DANGER DANGER DANGER DANGER DANGER DANGER DANGER DANGER DANGER DANGER ****************************************************************************************** The spec for this cache is disabled currently for #2655, because of last-modified time oddities on CloudBees. Please be cautious modifying this code and make sure you run the associated spec locally.

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	JarCache.JarIndex
private static class	JarCache.SoftJarIndex

Modifier and Type	Field and Description
private final Map<String, JarCache.SoftJarIndex>	indexCache
private final ReferenceQueue<JarCache.JarIndex>	indexQueue

Constructor Summary

Access	Constructor and Description
pack-priv	JarCache()

Modifier and Type	Method and Description
private void	cleanup()
public JarCache.JarIndex	getIndex(String jarPath)
public void	remove(String jarPath)

indexCache	back to summary
private final Map<String, JarCache.SoftJarIndex> indexCache

indexQueue	back to summary
private final ReferenceQueue<JarCache.JarIndex> indexQueue

Constructor Detail

JarCache	back to summary
pack-priv JarCache()

cleanup	back to summary
private void cleanup()

getIndex	back to summary
public JarCache.JarIndex getIndex(String jarPath)

remove	back to summary
public void remove(String jarPath)

org.jruby.util back to summary

pack-priv Class JarCache.JarIndex

Class Inheritance

extends Object

java.lang.Object
org.jruby.util.JarCache.JarIndex

Field Summary

Modifier and Type	Field and Description
private final Map<String, String[]>	cachedDirEntries
private final JarFile	jar
private final long	lastModified
private Long	lastModifiedExpiration
private static final String	ROOT_KEY

Constructor Summary

Access	Constructor and Description
pack-priv	JarIndex(String jarPath)

Method Summary

Modifier and Type	Method and Description
private static String	canonicalJarPath(String path)
public String[]	getDirEntries(String entryPath)
public InputStream	getInputStream(JarEntry entry)
public JarEntry	getJarEntry(String entryPath)
private long	Returns: The last modification timestamp. getLastModified(String The path to the JAR file. jarPath) Determines the last modification timestamp of a file.
public boolean	isValid()
public void	release()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cachedDirEntries	back to summary
private final Map<String, String[]> cachedDirEntries

jar	back to summary
private final JarFile jar

lastModified	back to summary
private final long lastModified

lastModifiedExpiration	back to summary
private Long lastModifiedExpiration

ROOT_KEY	back to summary
private static final String ROOT_KEY

Constructor Detail

JarIndex	back to summary
pack-priv JarIndex(String jarPath) throws IOException

Method Detail

canonicalJarPath	back to summary
private static String canonicalJarPath(String path)

getDirEntries	back to summary
public String[] getDirEntries(String entryPath)

getInputStream	back to summary
public InputStream getInputStream(JarEntry entry) throws IOException, IllegalStateException

getJarEntry	back to summary
public JarEntry getJarEntry(String entryPath)

getLastModified back to summary

getLastModified	back to summary
private long getLastModified(String jarPath) Determines the last modification timestamp of a file. Note Getting the value is an expensive operation on Windows systems (see `href="https://github.com/jruby/jruby/issues/6730`"). Therefore a cached value is used with a maximum lifetime of `Options#JAR_CACHE_EXPIRATION` milliseconds. Parameters jarPath:String The path to the JAR file. Returns:long The last modification timestamp.

private long getLastModified(String jarPath)

Determines the last modification timestamp of a file.

Note

Getting the value is an expensive operation on Windows systems (see href="https://github.com/jruby/jruby/issues/6730"). Therefore a cached value is used with a maximum lifetime of Options#JAR_CACHE_EXPIRATION milliseconds.

Parameters

jarPath:String: The path to the JAR file.

Returns:long

The last modification timestamp.

isValid	back to summary
public boolean isValid()

release	back to summary
public void release()

org.jruby.util back to summary

private Class JarCache.SoftJarIndex

Class Inheritance

extends SoftReference<JarCache.JarIndex>

Field Summary

Modifier and Type	Field and Description
private final String	key

Constructor Summary

Access	Constructor and Description
public	SoftJarIndex(String key, JarCache.JarIndex index)

Method Summary

Modifier and Type	Method and Description
public String	getKey()

Inherited from java.lang.ref.SoftReference:: get

Field Detail

key	back to summary
private final String key

Constructor Detail

SoftJarIndex	back to summary
public SoftJarIndex(String key, JarCache.JarIndex index)

Method Detail

getKey	back to summary
public String getKey()