Package dev.cachly

Class EdgeCacheClient

java.lang.Object

dev.cachly.EdgeCacheClient

public class EdgeCacheClient
extends Object

Client for managing Cloudflare Edge Cache for a cachly instance.

Provides methods to get/set configuration, purge cache, and retrieve statistics. Obtain via CachlyClient.edge().

Example usage

 EdgeCacheClient edge = client.edge();

 // Enable edge caching with 120s TTL
 EdgeCacheConfig cfg = edge.setConfig(
     EdgeCacheConfigUpdate.builder()
         .enabled(true)
         .edgeTtl(120)
         .build()
 );

 // Purge specific namespaces
 EdgePurgeResult result = edge.purge(
     EdgePurgeOptions.forNamespaces(List.of("cachly:sem:qa"))
 );

 // Check stats
 EdgeCacheStats stats = edge.stats();
 System.out.printf("Hit rate: %.1f%%\n", stats.getHitRate() * 100);
 

Constructor Summary

Constructors

Constructor	Description
EdgeCacheClient(String edgeApiUrl)	Create a new EdgeCacheClient.

Method Summary

Modifier and Type	Method	Description
void	deleteConfig()	Delete the edge cache configuration (disables edge caching).
CompletableFuture<Void>	deleteConfigAsync()	Delete configuration asynchronously.
EdgeCacheConfig	getConfig()	Get the current edge cache configuration.
CompletableFuture<EdgeCacheConfig>	getConfigAsync()	Get configuration asynchronously.
EdgePurgeResult	purge()	Purge all cached entries.
EdgePurgeResult	purge(EdgePurgeOptions options)	Purge cached entries from the Cloudflare CDN.
CompletableFuture<EdgePurgeResult>	purgeAsync(EdgePurgeOptions options)	Purge asynchronously.
EdgeCacheConfig	setConfig(EdgeCacheConfigUpdate update)	Update the edge cache configuration.
CompletableFuture<EdgeCacheConfig>	setConfigAsync(EdgeCacheConfigUpdate update)	Set configuration asynchronously.
EdgeCacheStats	stats()	Get edge cache hit/miss statistics.
CompletableFuture<EdgeCacheStats>	statsAsync()	Get stats asynchronously.

Methods inherited from class java.lang.Object

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

Constructor Details

EdgeCacheClient

public EdgeCacheClient(String edgeApiUrl)

Create a new EdgeCacheClient.

Parameters:

edgeApiUrl - Edge Cache Management API URL (e.g., https://api.cachly.dev/v1/edge/{token})

Method Details

getConfig

public EdgeCacheConfig getConfig()

Get the current edge cache configuration.

Returns:

current configuration

getConfigAsync

public CompletableFuture<EdgeCacheConfig> getConfigAsync()

Get configuration asynchronously.

setConfig

public EdgeCacheConfig setConfig(EdgeCacheConfigUpdate update)

Update the edge cache configuration.

Parameters:

update - configuration update

Returns:

updated configuration

setConfigAsync

public CompletableFuture<EdgeCacheConfig> setConfigAsync(EdgeCacheConfigUpdate update)

Set configuration asynchronously.

deleteConfig

public void deleteConfig()

Delete the edge cache configuration (disables edge caching).

deleteConfigAsync

public CompletableFuture<Void> deleteConfigAsync()

Delete configuration asynchronously.

purge

public EdgePurgeResult purge(EdgePurgeOptions options)

Purge cached entries from the Cloudflare CDN.

Parameters:

options - purge options (namespaces or URLs); pass null to purge all

Returns:

purge result with count and affected URLs

purge

public EdgePurgeResult purge()

Purge all cached entries.

purgeAsync

public CompletableFuture<EdgePurgeResult> purgeAsync(EdgePurgeOptions options)

Purge asynchronously.

stats

public EdgeCacheStats stats()

Get edge cache hit/miss statistics.

Returns:

cache statistics

statsAsync

public CompletableFuture<EdgeCacheStats> statsAsync()

Get stats asynchronously.