Class HttpProfileCache

java.lang.Object

com.thecsdev.common.resource.http.HttpProfileCache

@Experimental
public final class HttpProfileCache
extends Object

Represents a "cache" for storing cached HTTP resources.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HttpProfileCache.CacheBucket	Represents a directory where cache data for a given URI is stored.
static final class	HttpProfileCache.CacheBucketMeta	Represents metadata for a HttpProfileCache.CacheBucket, such as expiration time.

Field Summary

Fields

Modifier and Type	Field	Description
static final com.google.gson.Gson	GSON

Constructor Summary

Constructors

Constructor	Description
HttpProfileCache(@NotNull Path dirname)

Method Summary

Modifier and Type	Method	Description
final boolean	equals(@Nullable Object obj)
final CompletableFuture<@Nullable ResourceResponse>	fetchAsync(@NotNull ResourceRequest request)	Fetches the cached ResourceResponse for the given ResourceRequest, if it exists and is valid.
final @NotNull Path	getDirname()	Returns the Path to the directory where the HttpProfileCache data and cached HTTP resources are stored.
static final @NotNull Path	hash2path(@NotNull String hash)	Generates relative a cache path for the given ResourceRequest, based on the given hash.
final int	hashCode()
CompletableFuture<@Nullable Void>	storeAsync(@NotNull ResourceRequest request, @NotNull ResourceResponse response)	Stores the given ResourceResponse in the cache for the given ResourceRequest.

Methods inherited from class Object

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

Field Details

GSON

@Internal
public static final com.google.gson.Gson GSON

Constructor Details

HttpProfileCache

public HttpProfileCache(@NotNull
 @NotNull Path dirname)
                 throws NullPointerException

Throws:

NullPointerException

Method Details

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(@Nullable
 @Nullable Object obj)

Overrides:

equals in class Object

getDirname

@NotNull
public final @NotNull Path getDirname()

Returns the Path to the directory where the HttpProfileCache data and cached HTTP resources are stored.

fetchAsync

public final CompletableFuture<@Nullable ResourceResponse> fetchAsync(@NotNull
 @NotNull ResourceRequest request)
                                                               throws NullPointerException

Fetches the cached ResourceResponse for the given ResourceRequest, if it exists and is valid. Returns a CompletableFuture that completes with the cached response, or null the cache is a "miss".

Parameters:

request - The ResourceRequest for which to fetch the cached response.

Throws:

NullPointerException - If the argument is null.

storeAsync

public CompletableFuture<@Nullable Void> storeAsync(@NotNull
 @NotNull ResourceRequest request,
 @NotNull
 @NotNull ResourceResponse response)
                                             throws NullPointerException

Stores the given ResourceResponse in the cache for the given ResourceRequest. Returns a CompletableFuture that completes when the response has been stored.

Parameters:

request - The ResourceRequest associated with the response to store.

response - The ResourceResponse to store in the cache.

Throws:

NullPointerException - If an argument is null.

hash2path

@NotNull
public static final @NotNull Path hash2path(@NotNull
 @NotNull String hash)
                                     throws NullPointerException

Generates relative a cache path for the given ResourceRequest, based on the given hash. The path is structured to provide directory nesting based on the hash.

Throws:

NullPointerException