Class ResourcesDownloader

Object

InstallationResources

OptionalInstallations

ResourcesDownloader

All Implemented Interfaces:

Localized

public class ResourcesDownloader
extends OptionalInstallations

A provider for data licensed under different terms of use than the Apache license. This class is in charge of downloading the data if necessary and asking user's agreement before to install them. Authorities managed by the current implementation are:

• "EPSG" for the EPSG geodetic dataset.

This is an implementation of Optional­Installations in which user's permission is asked on the Console. By comparison, the org.apache.sis.gui module (for example) contains a similar implementation but asking for permission in a JavaFX dialog.

Since:

0.7

Field Summary

Fields inherited from class OptionalInstallations

destination­Directory

Modifier and Type	Field	Description
protected final Path	destination­Directory	The target directory where to install the resources, or null if none.

Constructor Summary

Constructors

Constructor	Description
Resources­Downloader()	Creates a new installation scripts provider.

Method Summary

Modifier and Type	Method	Description
protected boolean	ask­User­Agreement(String authority, String license)	Asks to the user if (s)he agree to download and install the resource for the given authority.
Set<String>	get­Authorities()	Returns the name of the authority who provides data under non-Apache terms of use.
Locale	get­Locale()	Returns the locale to use for messages shown to the user.

Methods inherited from class OptionalInstallations

get­License, get­Resource, get­Resource­Names, get­Space­Requirement, open­Script

Modifier and Type	Method	Description
String	get­License(String authority, Locale locale, String mime­Type)	Returns the terms of use of the dataset provided by the given authority, or null if none.
Object	get­Resource(String authority, int index)	Returns an installation resource for the given authority.
String[]	get­Resource­Names(String authority)	Returns the names of installation scripts provided by the given authority.
int	get­Space­Requirement(String authority)	Returns an estimation of the space required on the host computer after download and installation.
Buffered­Reader	open­Script(String authority, int resource)	Returns a reader for the installation script at the given index.

Methods inherited from class InstallationResources

get­Instruction­URL, load

Modifier and Type	Method	Description
String	get­Instruction­URL()	Returns a URL where users can get more information about the installation process.
static Service­Loader<Installation­Resources>	load()	Returns all installation resources found on the module path, regardless if supported or not.

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, to­String, wait, wait, wait

Constructor Details

ResourcesDownloader

public ResourcesDownloader()

Creates a new installation scripts provider.

Method Details

getLocale

public Locale getLocale()

Returns the locale to use for messages shown to the user.

Specified by:

get­Locale in interface Localized

Overrides:

get­Locale in class Optional­Installations

Returns:

the locale of messages shown to the user.

getAuthorities

public Set<String> getAuthorities()

Returns the name of the authority who provides data under non-Apache terms of use. If this Resources­Downloader cannot ask user's agreement because there is no Console attached to the current Java virtual machine or the console is not a terminal, then this method returns an empty set.

Overrides:

get­Authorities in class Optional­Installations

Returns:

"EPSG" or an empty set in this class cannot ask user's agreement.

askUserAgreement

protected boolean askUserAgreement(String authority,
 String license)

Asks to the user if (s)he agree to download and install the resource for the given authority. This method may be invoked twice for the same authority argument: first with a null license argument for asking if the user agrees to download the data, then with a non-null license argument for asking if the user agrees with the license terms.

Specified by:

ask­User­Agreement in class Optional­Installations

Parameters:

authority - "EPSG".

license - the license, or null for asking if the user wants to download the data.

Returns:

whether user accepted.