dev.vankka.dependencydownload

Class DependencyManager

java.lang.Object

dev.vankka.dependencydownload.DependencyManager

public class DependencyManager
extends java.lang.Object

The main class responsible for downloading, optionally relocating and loading in dependencies.

Constructor Summary

Constructors

Constructor and Description
DependencyManager(@NotNull DependencyPathProvider dependencyPathProvider) Creates a DependencyManager.
DependencyManager(@NotNull java.nio.file.Path cacheDirectory) Creates a DependencyManager.

Method Summary

Modifier and Type	Method and Description
void	addDependency(@NotNull Dependency dependency) Adds a dependency to this DependencyManager.
void	addRelocation(@NotNull Relocation relocation) Adds a relocation to this DependencyManager.
void	cleanupCacheDirectory() Removes files that are not known dependencies of this DependencyManager from CleanupPathProvider.getCleanupPath() implementation.
java.util.concurrent.CompletableFuture<java.lang.Void>[]	download(@Nullable java.util.concurrent.Executor executor, @NotNull java.util.List<Repository> repositories) Download all the dependencies in this DependencyManager.
java.util.concurrent.CompletableFuture<java.lang.Void>	downloadAll(@Nullable java.util.concurrent.Executor executor, @NotNull java.util.List<Repository> repositories) Download all the dependencies in this DependencyManager.
@NotNull java.util.Set<java.nio.file.Path>	getAllPaths(boolean includeRelocated) Gets Paths to all Dependencies in this DependencyManager, optionally also including the relocated paths if includeRelocated is set to true.
@NotNull java.util.List<Dependency>	getDependencies() Gets the dependencies in this DependencyManager.
@NotNull DependencyPathProvider	getDependencyPathProvider() Gets the dependency path provider for this DependencyManager.
@NotNull java.nio.file.Path	getPathForDependency(@NotNull Dependency dependency, boolean relocated) Gets the Path where the given Dependency will be stored once downloaded.
@NotNull java.util.Set<Relocation>	getRelocations() Gets the relocations in this DependencyManager.
java.util.concurrent.CompletableFuture<java.lang.Void>[]	load(@Nullable java.util.concurrent.Executor executor, @NotNull ClasspathAppender classpathAppender) Loads all the (potentially relocated) dependencies with provided ClasspathAppender.
java.util.concurrent.CompletableFuture<java.lang.Void>	loadAll(@Nullable java.util.concurrent.Executor executor, @NotNull ClasspathAppender classpathAppender) Loads all the (potentially relocated) dependencies with provided ClasspathAppender.
void	loadFromResource(@NotNull java.util.List<java.lang.String> fileLines) Loads dependencies and relocations from the resource generated by the gradle plugin.
void	loadFromResource(@NotNull java.lang.String fileContents) Loads dependencies and relocations from the resource generated by the gradle plugin.
void	loadFromResource(@NotNull java.net.URL resourceURL) Loads dependencies and relocations from the resource generated by the gradle plugin.
java.util.concurrent.CompletableFuture<java.lang.Void>[]	relocate(@Nullable java.util.concurrent.Executor executor) Relocates all the dependencies with the relocations in this DependencyManager.
java.util.concurrent.CompletableFuture<java.lang.Void>[]	relocate(@Nullable java.util.concurrent.Executor executor, @Nullable java.lang.ClassLoader jarRelocatorLoader) Relocates all the dependencies with the relocations in this DependencyManager.
java.util.concurrent.CompletableFuture<java.lang.Void>	relocateAll(@Nullable java.util.concurrent.Executor executor) Relocates all the dependencies with the relocations in this DependencyManager.
java.util.concurrent.CompletableFuture<java.lang.Void>	relocateAll(@Nullable java.util.concurrent.Executor executor, @Nullable java.lang.ClassLoader jarRelocatorLoader) Relocates all the dependencies with the relocations in this DependencyManager.

Methods inherited from class java.lang.Object

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

Constructor Detail

DependencyManager

public DependencyManager(@NotNull
                         @NotNull java.nio.file.Path cacheDirectory)

Creates a DependencyManager.

Parameters:

cacheDirectory - the directory used for downloaded and relocated dependencies.

DependencyManager

public DependencyManager(@NotNull
                         @NotNull DependencyPathProvider dependencyPathProvider)

Creates a DependencyManager.

Parameters:

dependencyPathProvider - the dependencyPathProvider used for downloaded and relocated dependencies.

Method Detail

addDependency

public void addDependency(@NotNull
                          @NotNull Dependency dependency)

Adds a dependency to this DependencyManager.

Parameters:

dependency - the dependency

Throws:

java.lang.IllegalStateException - if this method is executed after downloading

getDependencies

@NotNull
public @NotNull java.util.List<Dependency> getDependencies()

Gets the dependencies in this DependencyManager.

Returns:

a unmodifiable list of dependencies

addRelocation

public void addRelocation(@NotNull
                          @NotNull Relocation relocation)

Adds a relocation to this DependencyManager.

Parameters:

relocation - the relocation

Throws:

java.lang.IllegalStateException - if this method is executed after relocating

getRelocations

@NotNull
public @NotNull java.util.Set<Relocation> getRelocations()

Gets the relocations in this DependencyManager.

Returns:

an unmodifiable set of relocations

getDependencyPathProvider

@NotNull
public @NotNull DependencyPathProvider getDependencyPathProvider()

Gets the dependency path provider for this DependencyManager.

Returns:

the instance of DependencyPathProvider or null

See Also:

DependencyPathProvider

loadFromResource

public void loadFromResource(@NotNull
                             @NotNull java.net.URL resourceURL)
                      throws java.io.IOException

Loads dependencies and relocations from the resource generated by the gradle plugin.

Parameters:

resourceURL - the url to the resource

Throws:

java.io.IOException - if the resource cannot be read

loadFromResource

public void loadFromResource(@NotNull
                             @NotNull java.lang.String fileContents)

Loads dependencies and relocations from the resource generated by the gradle plugin.

Parameters:

fileContents - the contents of the file generated by the gradle plugin as a String

loadFromResource

public void loadFromResource(@NotNull
                             @NotNull java.util.List<java.lang.String> fileLines)

Loads dependencies and relocations from the resource generated by the gradle plugin.

Parameters:

fileLines - all the lines from the file generated by the gradle plugin

downloadAll

public java.util.concurrent.CompletableFuture<java.lang.Void> downloadAll(@Nullable
                                                                          @Nullable java.util.concurrent.Executor executor,
                                                                          @NotNull
                                                                          @NotNull java.util.List<Repository> repositories)

Download all the dependencies in this DependencyManager.

Parameters:

executor - the executor that will run the downloads

repositories - an ordered list of repositories that will be tried one-by-one

Returns:

a future that will complete exceptionally if a single dependency fails to download from all repositories, otherwise completes when all dependencies are downloaded

Throws:

java.lang.IllegalStateException - if dependencies have already been queued for download once

download

public java.util.concurrent.CompletableFuture<java.lang.Void>[] download(@Nullable
                                                                         @Nullable java.util.concurrent.Executor executor,
                                                                         @NotNull
                                                                         @NotNull java.util.List<Repository> repositories)

Download all the dependencies in this DependencyManager.

Parameters:

executor - the executor that will run the downloads

repositories - an ordered list of repositories that will be tried one-by-one

Returns:

an array containing a CompletableFuture for each dependency

Throws:

java.lang.IllegalStateException - if dependencies have already been queued for download once

relocateAll

public java.util.concurrent.CompletableFuture<java.lang.Void> relocateAll(@Nullable
                                                                          @Nullable java.util.concurrent.Executor executor)

Relocates all the dependencies with the relocations in this DependencyManager. This step is not required. Uses the ClassLoader that loaded this class to acquire jar-relocator.

Parameters:

executor - the executor that will run the relocations

Returns:

a future that will complete exceptionally if any of the dependencies fail to relocate otherwise completes when all dependencies are relocated

Throws:

java.lang.IllegalStateException - if dependencies have already been queued for relocation once

relocateAll

public java.util.concurrent.CompletableFuture<java.lang.Void> relocateAll(@Nullable
                                                                          @Nullable java.util.concurrent.Executor executor,
                                                                          @Nullable
                                                                          @Nullable java.lang.ClassLoader jarRelocatorLoader)

Relocates all the dependencies with the relocations in this DependencyManager. This step is not required.

Parameters:

executor - the executor that will run the relocations

jarRelocatorLoader - the ClassLoader to use to load jar-relocator, if this is set to null the current class loader will be used

Returns:

a future that will complete exceptionally if any of the dependencies fail to relocate otherwise completes when all dependencies are relocated

Throws:

java.lang.IllegalStateException - if dependencies have already been queued for relocation once

relocate

public java.util.concurrent.CompletableFuture<java.lang.Void>[] relocate(@Nullable
                                                                         @Nullable java.util.concurrent.Executor executor)

Relocates all the dependencies with the relocations in this DependencyManager. This step is not required. Uses the ClassLoader that loaded this class to acquire jar-relocator.

Parameters:

executor - the executor that will run the relocations

Returns:

an array containing a CompletableFuture for each dependency

Throws:

java.lang.IllegalStateException - if dependencies have already been queued for relocation once

relocate

public java.util.concurrent.CompletableFuture<java.lang.Void>[] relocate(@Nullable
                                                                         @Nullable java.util.concurrent.Executor executor,
                                                                         @Nullable
                                                                         @Nullable java.lang.ClassLoader jarRelocatorLoader)

Relocates all the dependencies with the relocations in this DependencyManager. This step is not required.

Parameters:

executor - the executor that will run the relocations

jarRelocatorLoader - the ClassLoader to use to load jar-relocator

Returns:

an array containing a CompletableFuture for each dependency

Throws:

java.lang.IllegalStateException - if dependencies have already been queued for relocation once

loadAll

public java.util.concurrent.CompletableFuture<java.lang.Void> loadAll(@Nullable
                                                                      @Nullable java.util.concurrent.Executor executor,
                                                                      @NotNull
                                                                      @NotNull ClasspathAppender classpathAppender)

Loads all the (potentially relocated) dependencies with provided ClasspathAppender.

Parameters:

executor - the executor that will load the dependencies

classpathAppender - the classpath appender

Returns:

a future that will complete exceptionally if any of the dependencies fail to be appended by the provided ClasspathAppender otherwise completes when all dependencies are relocated

Throws:

java.lang.IllegalStateException - if dependencies have already been queued for load once

load

public java.util.concurrent.CompletableFuture<java.lang.Void>[] load(@Nullable
                                                                     @Nullable java.util.concurrent.Executor executor,
                                                                     @NotNull
                                                                     @NotNull ClasspathAppender classpathAppender)

Loads all the (potentially relocated) dependencies with provided ClasspathAppender.

Parameters:

executor - the executor that will load the dependencies

classpathAppender - the classpath appender

Returns:

an array containing a CompletableFuture for each dependency

Throws:

java.lang.IllegalStateException - if dependencies have already been queued for load once

getPathForDependency

@NotNull
public @NotNull java.nio.file.Path getPathForDependency(@NotNull
                                                                 @NotNull Dependency dependency,
                                                                 boolean relocated)

Gets the Path where the given Dependency will be stored once downloaded.

Parameters:

dependency - the dependency.

relocated - if the path should be for the relocated or unrelocated file of the Dependency

Returns:

the path for the dependency

getAllPaths

@NotNull
public @NotNull java.util.Set<java.nio.file.Path> getAllPaths(boolean includeRelocated)

Gets Paths to all Dependencies in this DependencyManager, optionally also including the relocated paths if includeRelocated is set to true.

Parameters:

includeRelocated - if relocated paths should also be included

Returns:

paths to all dependencies (and optionally relocated dependencies)

See Also:

getPathForDependency(Dependency, boolean)

cleanupCacheDirectory

public void cleanupCacheDirectory()
                           throws java.io.IOException,
                                  java.lang.IllegalStateException

Removes files that are not known dependencies of this DependencyManager from CleanupPathProvider.getCleanupPath() implementation. This only accounts for dependencies that are included in this DependencyManager instance!

Throws:

java.io.IOException - if listing files in the cache directory or deleting files in it fails

java.lang.IllegalStateException - if this DependencyManager's dependencyPathProvider isn't an instance of CleanupPathProvider

See Also:

getAllPaths(boolean), CleanupPathProvider