Package net.sourceforge.jnlp.cache

Class CacheUtil

java.lang.Object
net.sourceforge.jnlp.cache.CacheUtil
public class CacheUtil extends Object
Provides static methods to interact with the cache, download indicator, and other utility methods.

  • Constructor Details

    • CacheUtil

      public CacheUtil()

  • Method Details

    • getCachedResourceURL

      public static URL getCachedResourceURL(URL location, Version version, UpdatePolicy policy)
      Caches a resource and returns a URL for it in the cache; blocks until resource is cached. If the resource location is not cacheable (points to a local file, etc) then the original URL is returned.
      Parameters:
      location - location of the resource
      version - the version, or null
      policy - how to handle update
      Returns:
      either the location in the cache or the original location

    • getCachedResourceFile

      public static File getCachedResourceFile(URL location, Version version, UpdatePolicy policy)
      This is returning File object of cached resource originally from URL
      Parameters:
      location - original location of blob
      version - version of resource
      policy - update policy of resource
      Returns:
      location in ITW cache on filesystem

    • getReadPermission

      public static Permission getReadPermission(URL location, Version version)
      Returns the Permission object necessary to access the resource, or null if no permission is needed.
      Parameters:
      location - location of the resource
      version - the version, or null
      Returns:
      permissions of the location

    • clearCache

      public static boolean clearCache()
      Clears the cache by deleting all the Netx cache files Note: Because of how our caching system works, deleting jars of another javaws process is using them can be quite disasterous. Hence why Launcher creates lock files and we check for those by calling okToClearCache()
      Returns:
      true if the cache could be cleared and was cleared

    • clearCache

      public static boolean clearCache(String application, boolean jnlpPath, boolean domain)

    • checkToClearCache

      public static boolean checkToClearCache()

    • removeWindowsShortcuts

      public static void removeWindowsShortcuts(String jnlpApp) throws IOException
      Throws:
      IOException

    • listCacheIds

      public static void listCacheIds(String filter, boolean jnlpPath, boolean domain)

    • getCacheIds

      public static List<CacheUtil.CacheId> getCacheIds(String filter, boolean jnlpPath, boolean domain)
      This method load all known IDs of applications and will gather all members, which share the id
      Parameters:
      filter - - regex to filter keys
      Returns:

    • isCurrent

      public static boolean isCurrent(URL source, Version version, long lastModifed, CacheEntry entry, File cachedFile)
      Returns whether there is a version of the URL contents in the cache and it is up to date. This method may not return immediately.
      Parameters:
      source - the source URL
      version - the versions to check for
      lastModifed - time in milis since epoch of last modfication
      Returns:
      whether the cache contains the version
      Throws:
      IllegalArgumentException - if the source is not cacheable

    • isCached

      public static boolean isCached(URL source, Version version)
      Returns true if the cache has a local copy of the contents of the URL matching the specified version string.
      Parameters:
      source - the source URL
      version - the versions to check for
      Returns:
      true if the source is in the cache
      Throws:
      IllegalArgumentException - if the source is not cacheable

    • isCacheable

      public static boolean isCacheable(URL source, Version version)
      Returns whether the resource can be cached as a local file; if not, then URLConnection.openStream can be used to obtain the contents.
      Parameters:
      source - the url of resource
      version - version of resource
      Returns:
      whether this resource can be cached

    • getCacheFile

      public static File getCacheFile(URL source, Version version)
      Returns the file for the locally cached contents of the source. This method returns the file location only and does not download the resource. The latest version of the resource that matches the specified version will be returned.
      Parameters:
      source - the source URL
      version - the version id of the local file
      Returns:
      the file location in the cache, or null if no versions cached
      Throws:
      IllegalArgumentException - if the source is not cacheable

    • getCacheParentDirectory

      public static String getCacheParentDirectory(String filePath)
      Returns the parent directory of the cached resource.
      Parameters:
      filePath - The path of the cached resource directory.
      Returns:
      parent dir of cache

    • makeNewCacheFile

      public static File makeNewCacheFile(URL source, Version version)
      This will create a new entry for the cache item. It is however not initialized but any future calls to getCacheFile with the source and version given to here, will cause it to return this item.
      Parameters:
      source - the source URL
      version - the version id of the local file
      Returns:
      the file location in the cache.

    • getOutputStream

      public static OutputStream getOutputStream(URL source, Version version) throws IOException
      Returns a buffered output stream open for writing to the cache file.
      Parameters:
      source - the remote location
      version - the file version to write to
      Returns:
      the stream to write to resource
      Throws:
      IOException - if IO breaks

    • streamCopy

      public static void streamCopy(InputStream is, OutputStream os) throws IOException
      Copies from an input stream to an output stream. On completion, both streams will be closed. Streams are buffered automatically.
      Parameters:
      is - stream to read from
      os - stream to write to
      Throws:
      IOException - if copy fails

    • urlToPath

      public static File urlToPath(URL location, String subdir)
      Converts a URL into a local path string within the given directory. For example a url with subdirectory /tmp/ will result in a File that is located somewhere within /tmp/
      Parameters:
      location - the url
      subdir - the subdirectory
      Returns:
      the file

    • hex

      public static String hex(String origName, String candidate) throws NoSuchAlgorithmException
      Throws:
      NoSuchAlgorithmException

    • waitForResources

      public static void waitForResources(ApplicationInstance app, ResourceTracker tracker, URL[] resources, String title)
      Waits until the resources are downloaded, while showing a progress indicator.
      Parameters:
      app - application instance with context for this resource
      tracker - the resource tracker
      resources - the resources to wait for
      title - name of the download

    • cleanCache

      public static void cleanCache()
      This will remove all old cache items.