Module http.client.ext

Package io.github.nstdio.http.ext

Interface Cache

public interface Cache

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Cache.CacheBuilder
static interface	Cache.CacheEntry
static interface	Cache.CacheStats
static class	Cache.DiskCacheBuilder	The builder for in persistent cache.
static class	Cache.EncryptedDiskCacheBuilder	The Cache.DiskCacheBuilder that will create Cache that maintains all files in encrypted manner.
static class	Cache.InMemoryCacheBuilder	The builder for in memory cache.
static interface	Cache.Writer<T>

Method Summary

Modifier and Type	Method	Description
void	evict(java.net.http.HttpRequest request)	Evicts cache entry (if any) associated with request.
void	evictAll()	Removes all cache entries.
void	evictAll(java.net.http.HttpRequest request)	Evicts all cache entries associated with request.
Cache.CacheEntry	get(java.net.http.HttpRequest request)	Gets the cache entry associated with request.
static Cache.DiskCacheBuilder	newDiskCacheBuilder()	Creates a new DiskCacheBuilder instance.
static Cache.InMemoryCacheBuilder	newInMemoryCacheBuilder()	Creates a new InMemoryCacheBuilder instance.
static Cache	noop()	Gets the Cache effectively does not do anything.
void	put(java.net.http.HttpRequest request, Cache.CacheEntry entry)	Associates request with entry and stores it in this cache.
Cache.CacheStats	stats()	Gets the statistics for this cache.
<T> Cache.Writer<T>	writer(CacheEntryMetadata metadata)	Creates a Writer.

Method Detail

newInMemoryCacheBuilder

static Cache.InMemoryCacheBuilder newInMemoryCacheBuilder()

Creates a new InMemoryCacheBuilder instance.

Returns:

the new InMemoryCacheBuilder.

newDiskCacheBuilder

static Cache.DiskCacheBuilder newDiskCacheBuilder()

Creates a new DiskCacheBuilder instance.

Returns:

the new DiskCacheBuilder.

noop

static Cache noop()

Gets the Cache effectively does not do anything.

Returns:

a stub cache.

get

Cache.CacheEntry get(java.net.http.HttpRequest request)

Gets the cache entry associated with request.

Parameters:

request - The request.

Returns:

the cache entry associated with request or null.

put

void put(java.net.http.HttpRequest request,
         Cache.CacheEntry entry)

Associates request with entry and stores it in this cache. The previously (if any) associated entry will be evicted.

Parameters:

request - The request.

entry - The entry.

evict

void evict(java.net.http.HttpRequest request)

Evicts cache entry (if any) associated with request.

Parameters:

request - The request.

evictAll

void evictAll(java.net.http.HttpRequest request)

Evicts all cache entries associated with request.

Parameters:

request - The request.

evictAll

void evictAll()

Removes all cache entries. This cache will be empty after method invocation.

stats

Cache.CacheStats stats()

Gets the statistics for this cache.

Returns:

The statistics for this cache.

See Also:

Cache.CacheStats

writer

<T> Cache.Writer<T> writer(CacheEntryMetadata metadata)

Creates a Writer.

Type Parameters:

T - The response body type.

Parameters:

metadata - The metadata.

Returns:

a Writer.