Class HttpProfileCache.CacheBucketMeta

java.lang.Object

com.thecsdev.common.resource.http.HttpProfileCache.CacheBucketMeta

Enclosing class:

HttpProfileCache

@Experimental
public static final class HttpProfileCache.CacheBucketMeta
extends Object

Represents metadata for a HttpProfileCache.CacheBucket, such as expiration time. This metadata is stored in a "meta.json" file within the HttpProfileCache.CacheBucket directory.

Constructor Summary

Constructors

Constructor	Description
CacheBucketMeta(@NotNull HttpProfileCache.CacheBucket cacheBucket)

Method Summary

Modifier and Type	Method	Description
final @NotNull Path	getFilename()	The Path to the metadata file of this HttpProfileCache.CacheBucketMeta.
final long	getMaxAge()	The maximum age (in seconds) a cached resource may exist before being considered as "expired".
final @NonNull List<String>	getVary()	The "Vary" header values associated with a HttpProfileCache.CacheBucket.
final void	loadFromFile()	Loads this HttpProfileCache.CacheBucketMeta from the file specified by filename.
final void	loadFromJson(@NotNull com.google.gson.JsonObject from)	Loads this HttpProfileCache.CacheBucketMeta from a JsonObject, overriding any properties of this JsonConfig that were stored in the JsonObject.
final @NotNull Path	resolveCacheFile(@NotNull ResourceRequest request)	Resolves the cache file path for the given ResourceRequest, based on the "Vary" header values stored in this HttpProfileCache.CacheBucketMeta.
final void	saveToFile()	Saves this HttpProfileCache.CacheBucketMeta to the file specified by filename.
final @NotNull com.google.gson.JsonObject	saveToJson()	Saves this HttpProfileCache.CacheBucketMeta instance to a new JsonObject instance and returns the JsonObject.
final void	saveToJson(@NotNull com.google.gson.JsonObject to)	Saves this HttpProfileCache.CacheBucketMeta to an existing JsonObject instance.
final void	setMaxAge(long maxAge)	Sets the maximum age (in seconds) for this HttpProfileCache.CacheBucketMeta.
final void	setVary(@NotNull Collection<String> varyHeaders)	Sets the "Vary" header values for this HttpProfileCache.CacheBucketMeta.

Methods inherited from class Object

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

Constructor Details

CacheBucketMeta

public CacheBucketMeta(@NotNull
 @NotNull HttpProfileCache.CacheBucket cacheBucket)
                throws NullPointerException

Throws:

NullPointerException

Method Details

getFilename

@NotNull
public final @NotNull Path getFilename()

The Path to the metadata file of this HttpProfileCache.CacheBucketMeta.

getMaxAge

public final long getMaxAge()

The maximum age (in seconds) a cached resource may exist before being considered as "expired".

getVary

public final @NonNull List<String> getVary()

The "Vary" header values associated with a HttpProfileCache.CacheBucket. The returned Collection is sorted and immutable.

setMaxAge

public final void setMaxAge(long maxAge)

Sets the maximum age (in seconds) for this HttpProfileCache.CacheBucketMeta. The value is clamped to a minimum of 0.

Parameters:

maxAge - The maximum age in seconds.

setVary

public final void setVary(@NotNull
 @NotNull Collection<String> varyHeaders)
                   throws NullPointerException

Sets the "Vary" header values for this HttpProfileCache.CacheBucketMeta. The provided collection is sorted and stored as an immutable list.

Parameters:

varyHeaders - The collection of "Vary" header values to set.

Throws:

NullPointerException - If the argument is null.

saveToJson

@NotNull
public final @NotNull com.google.gson.JsonObject saveToJson()

Saves this HttpProfileCache.CacheBucketMeta instance to a new JsonObject instance and returns the JsonObject.

saveToJson

public final void saveToJson(@NotNull
 @NotNull com.google.gson.JsonObject to)
                      throws NullPointerException

Saves this HttpProfileCache.CacheBucketMeta to an existing JsonObject instance.

Parameters:

to - The JsonObject to save to.

Throws:

NullPointerException - If the argument is null.

loadFromJson

public final void loadFromJson(@NotNull
 @NotNull com.google.gson.JsonObject from)
                        throws NullPointerException

Loads this HttpProfileCache.CacheBucketMeta from a JsonObject, overriding any properties of this JsonConfig that were stored in the JsonObject.

Parameters:

from - The JsonObject to load from.

Throws:

NullPointerException - If the argument is null.

saveToFile

public final void saveToFile()
                      throws IOException

Saves this HttpProfileCache.CacheBucketMeta to the file specified by filename.

Throws:

IOException - If an I/O error occurs while writing to the file.

loadFromFile

public final void loadFromFile()
                        throws IOException

Loads this HttpProfileCache.CacheBucketMeta from the file specified by filename. If the file does not exist, this method does nothing.

Throws:

IOException - If an I/O error occurs while reading from the file or parsing its contents.

resolveCacheFile

@NotNull
public final @NotNull Path resolveCacheFile(@NotNull
 @NotNull ResourceRequest request)
                                     throws NullPointerException

Resolves the cache file path for the given ResourceRequest, based on the "Vary" header values stored in this HttpProfileCache.CacheBucketMeta. The returned path is relative to the HttpProfileCache.CacheBucket directory.

Parameters:

request - The ResourceRequest for which to resolve the cache file path.

Throws:

NullPointerException - If the argument is null.