org.codehaus.mojo.license.download

Class LicenseDownloader

java.lang.Object

org.codehaus.mojo.license.download.LicenseDownloader

All Implemented Interfaces:

AutoCloseable

public class LicenseDownloader
extends Object
implements AutoCloseable

Utilities for downloading remote license files.

Since:

1.0

Author:

pgier

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LicenseDownloader.LicenseDownloadResult A result of a license download operation.

Constructor Summary

Constructors

Constructor and Description
LicenseDownloader(org.apache.maven.settings.Proxy proxy, int connectTimeout, int socketTimeout, int connectionRequestTimeout, Map<String,SpdxLicenseList.Attachments.ContentSanitizer> contentSanitizers, Charset charset)

Method Summary

Modifier and Type	Method and Description
void	close()
LicenseDownloader.LicenseDownloadResult	downloadLicense(String licenseUrlString, FileNameEntry fileNameEntry, org.apache.maven.plugin.logging.Log log) Downloads a license file from the given licenseUrlString stores it locally and returns the local path where the license file was stored.

Methods inherited from class java.lang.Object

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

Constructor Detail

LicenseDownloader

public LicenseDownloader(org.apache.maven.settings.Proxy proxy,
                         int connectTimeout,
                         int socketTimeout,
                         int connectionRequestTimeout,
                         Map<String,SpdxLicenseList.Attachments.ContentSanitizer> contentSanitizers,
                         Charset charset)

Method Detail

downloadLicense

public LicenseDownloader.LicenseDownloadResult downloadLicense(String licenseUrlString,
                                                               FileNameEntry fileNameEntry,
                                                               org.apache.maven.plugin.logging.Log log)
                                                        throws IOException,
                                                               URISyntaxException,
                                                               org.apache.maven.plugin.MojoFailureException

Downloads a license file from the given licenseUrlString stores it locally and returns the local path where the license file was stored. Note that the outputFile name can be further modified by this method, esp. the file extension can be adjusted based on the mime type of the HTTP response.

Parameters:

licenseUrlString - the URL

outputFile - a hint where to store the license file

log -

Returns:

the path to the file where the downloaded license file was stored

Throws:

IOException

URISyntaxException

org.apache.maven.plugin.MojoFailureException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException