Package org.hl7.fhir.utilities.npm

Class FilesystemPackageCacheManager

java.lang.Object

org.hl7.fhir.utilities.npm.BasePackageCacheManager

org.hl7.fhir.utilities.npm.FilesystemPackageCacheManager

All Implemented Interfaces:

IPackageCacheManager

public class FilesystemPackageCacheManager
extends BasePackageCacheManager
implements IPackageCacheManager

This is a package cache manager implementation that uses a local disk cache

API:

constructor getPackageUrl getPackageId findPackageCache addPackageToCache

Author:

Grahame Grieve

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	FilesystemPackageCacheManager.BuildRecord
class	FilesystemPackageCacheManager.BuildRecordSorter
class	FilesystemPackageCacheManager.CacheLock
static interface	FilesystemPackageCacheManager.CacheLockFunction<T>
static interface	FilesystemPackageCacheManager.INetworkServices	if you don't provide and implementation of this interface, the PackageCacheManager will use the web directly.
class	FilesystemPackageCacheManager.PackageEntry
class	FilesystemPackageCacheManager.VersionHistory

Nested classes/interfaces inherited from class org.hl7.fhir.utilities.npm.BasePackageCacheManager

BasePackageCacheManager.InputStreamWithSrc

Field Summary

Fields

Modifier and Type	Field	Description
static String	PACKAGE_REGEX
static String	PACKAGE_VERSION_REGEX
static String	PACKAGE_VERSION_REGEX_OPT

Constructor Summary

Constructors

Constructor	Description
FilesystemPackageCacheManager(boolean userMode, int toolsVersion)	Constructor

Method Summary

Modifier and Type	Method	Description
NpmPackage	addPackageToCache(String id, String version, InputStream packageTgzInputStream, String sourceDesc)	Add an already fetched package to the cache
void	clear()	Clear the cache
String	findCanonicalInLocalCache(String canonicalUrl)
String	getFolder()
String	getLatestVersion(String id)
String	getPackageId(String canonicalUrl)
String	getPackageUrl(String packageId)
void	listAllIds(Map<String,String> specList)
List<String>	listPackages()
void	loadFromFolder(String packagesFolder)
protected BasePackageCacheManager.InputStreamWithSrc	loadFromPackageServer(String id, String version)	Try to load a package from all registered package servers, and return null if it can not be found at any of them.
NpmPackage	loadPackage(String id, String version)
NpmPackage	loadPackageFromCacheOnly(String id, String version)	Load the identified package from the cache - if it exists
boolean	packageExists(String id, String ver)
boolean	packageInstalled(String id, String version)
void	removePackage(String id, String ver)	Remove a particular package from the cache

Methods inherited from class org.hl7.fhir.utilities.npm.BasePackageCacheManager

addPackageServer, getPackageServers, loadPackage, loadPackageFromCacheOnly, setClientFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hl7.fhir.utilities.npm.IPackageCacheManager

loadPackage

Field Detail

PACKAGE_REGEX

public static final String PACKAGE_REGEX

See Also:

Constant Field Values

PACKAGE_VERSION_REGEX

public static final String PACKAGE_VERSION_REGEX

See Also:

Constant Field Values

PACKAGE_VERSION_REGEX_OPT

public static final String PACKAGE_VERSION_REGEX_OPT

See Also:

Constant Field Values

Constructor Detail

FilesystemPackageCacheManager

public FilesystemPackageCacheManager(boolean userMode,
                                     int toolsVersion)
                              throws IOException

Constructor

Throws:

IOException

Method Detail

loadFromFolder

public void loadFromFolder(String packagesFolder)
                    throws IOException

Throws:

IOException

getFolder

public String getFolder()

loadFromPackageServer

protected BasePackageCacheManager.InputStreamWithSrc loadFromPackageServer(String id,
                                                                           String version)

Description copied from class: BasePackageCacheManager

Try to load a package from all registered package servers, and return null if it can not be found at any of them.

Overrides:

loadFromPackageServer in class BasePackageCacheManager

getLatestVersion

public String getLatestVersion(String id)
                        throws IOException

Throws:

IOException

clear

public void clear()
           throws IOException

Clear the cache

Throws:

IOException

removePackage

public void removePackage(String id,
                          String ver)
                   throws IOException

Remove a particular package from the cache

Parameters:

id -

ver -

Throws:

IOException

loadPackageFromCacheOnly

public NpmPackage loadPackageFromCacheOnly(String id,
                                           String version)
                                    throws IOException

Load the identified package from the cache - if it exists

This is for special purpose only (testing, control over speed of loading). Generally, use the loadPackage method

Specified by:

loadPackageFromCacheOnly in class BasePackageCacheManager

Parameters:

id -

version -

Returns:

Throws:

IOException

addPackageToCache

public NpmPackage addPackageToCache(String id,
                                    String version,
                                    InputStream packageTgzInputStream,
                                    String sourceDesc)
                             throws IOException

Add an already fetched package to the cache

Specified by:

addPackageToCache in interface IPackageCacheManager

Throws:

IOException

getPackageUrl

public String getPackageUrl(String packageId)
                     throws IOException

Specified by:

getPackageUrl in interface IPackageCacheManager

Overrides:

getPackageUrl in class BasePackageCacheManager

Throws:

IOException

listAllIds

public void listAllIds(Map<String,String> specList)
                throws IOException

Throws:

IOException

loadPackage

public NpmPackage loadPackage(String id,
                              String version)
                       throws FHIRException,
                              IOException

Specified by:

loadPackage in interface IPackageCacheManager

Throws:

FHIRException

IOException

getPackageId

public String getPackageId(String canonicalUrl)
                    throws IOException

Specified by:

getPackageId in interface IPackageCacheManager

Overrides:

getPackageId in class BasePackageCacheManager

Throws:

IOException

findCanonicalInLocalCache

public String findCanonicalInLocalCache(String canonicalUrl)

listPackages

public List<String> listPackages()

packageExists

public boolean packageExists(String id,
                             String ver)
                      throws IOException

Throws:

IOException

packageInstalled

public boolean packageInstalled(String id,
                                String version)