Module org.basinmc.lavatory

Package org.basinmc.lavatory.file

Class Download

java.lang.Object

org.basinmc.lavatory.file.Download

Direct Known Subclasses:

AssetIndexReference, AssetObject, LibraryArtifact, LoggerConfigurationFile

public class Download
extends Object

Represents a downloadable artifact which identifies its location, size and file checksum.

Author:

Johannes Donath

Field Summary

Fields

Modifier and Type	Field	Description
static String	CHECKSUM_ALGORITHM	Defines the message digest algorithm name used to generate the checksum.

Constructor Summary

Constructors

Constructor	Description
Download(String sha1, long size, URL url)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
void	fetch(Path target)	Downloads the file from the server and writes it to the specified target file.
String	getSha1()	Retrieves a sha1 checksum for the file in its valid state.
byte[]	getSha1Bytes()	Retrieves the actual decoded checksum bytes.
long	getSize()	Retrieves the total file size for this download (in bytes).
URL	getUrl()	Retrieves the absolute URL from which this file may be retrieved.
int	hashCode()
boolean	verify(Path path)	Evaluates whether a specified file matches the checksum and size of this downloadable artifact.

Methods inherited from class java.lang.Object

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

Field Detail

CHECKSUM_ALGORITHM

public static final String CHECKSUM_ALGORITHM

Defines the message digest algorithm name used to generate the checksum.

See Also:

Constant Field Values

Constructor Detail

Download

public Download(@NonNull
                String sha1,
                long size,
                @NonNull
                URL url)

Method Detail

fetch

public void fetch(@NonNull
                  Path target)
           throws IOException

Downloads the file from the server and writes it to the specified target file.

Parameters:

target - a target file.

Throws:

IOException - when the server is unreachable, responds with an error code, the connection is interrupted or when writing to the file fails.

getSha1

@NonNull
public String getSha1()

Retrieves a sha1 checksum for the file in its valid state.

Returns:

a checksum.

getSha1Bytes

public byte[] getSha1Bytes()

Retrieves the actual decoded checksum bytes.

Returns:

a checksum.

Throws:

IllegalStateException - when the hash is of an illegal length.

getSize

public long getSize()

Retrieves the total file size for this download (in bytes).

Returns:

a file size.

getUrl

@NonNull
public URL getUrl()

Retrieves the absolute URL from which this file may be retrieved.

Returns:

a url.

verify

public boolean verify(@NonNull
                      Path path)
               throws IOException

Evaluates whether a specified file matches the checksum and size of this downloadable artifact.

Parameters:

path - a file path.

Returns:

true if the files match, false otherwise.

Throws:

IOException - when accessing the target file fails.

UnsupportedOperationException - when the JVM does not support the checksum algorithm.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object