Skip to content

HTTPCLIENT-2406: MemcachedHttpCacheStorage to support per entry expiry setting #761

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ok2c merged 1 commit into from
Nov 24, 2025
+51 −12
Merged

HTTPCLIENT-2406: MemcachedHttpCacheStorage to support per entry expiry setting #761

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion .../src/main/java/org/apache/hc/client5/http/impl/cache/AbstractSerializingCacheStorage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
*/
package org.apache.hc.client5.http.impl.cache;

import java.time.Instant;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
Expand Down Expand Up @@ -60,6 +61,13 @@ public AbstractSerializingCacheStorage(final int maxUpdateRetries, final HttpCac

protected abstract void store(String storageKey, T storageObject) throws ResourceIOException;

/**
* @since 5.6
*/
protected void store(final String storageKey, final Instant expectedExpiry, final T storageObject) throws ResourceIOException {
store(storageKey, storageObject);
}

protected abstract T restore(String storageKey) throws ResourceIOException;

protected abstract CAS getForUpdateCAS(String storageKey) throws ResourceIOException;
Expand All @@ -76,7 +84,8 @@ public AbstractSerializingCacheStorage(final int maxUpdateRetries, final HttpCac
public final void putEntry(final String key, final HttpCacheEntry entry) throws ResourceIOException {
final String storageKey = digestToStorageKey(key);
final T storageObject = serializer.serialize(new HttpCacheStorageEntry(key, entry));
store(storageKey, storageObject);
final Instant expires = entry.getExpires();
store(storageKey, expires, storageObject);
}

@Override
Expand Down
52 changes: 41 additions & 11 deletions .../main/java/org/apache/hc/client5/http/impl/cache/memcached/MemcachedHttpCacheStorage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,24 +28,26 @@

import java.io.IOException;
import java.net.InetSocketAddress;
import java.time.Duration;
import java.time.Instant;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.CancellationException;
import java.util.function.BiFunction;

import net.spy.memcached.CASResponse;
import net.spy.memcached.CASValue;
import net.spy.memcached.MemcachedClient;
import net.spy.memcached.MemcachedClientIF;
import net.spy.memcached.OperationTimeoutException;
import org.apache.hc.client5.http.cache.HttpCacheEntrySerializer;
import org.apache.hc.client5.http.cache.ResourceIOException;
import org.apache.hc.client5.http.impl.cache.AbstractBinaryCacheStorage;
import org.apache.hc.client5.http.impl.cache.CacheConfig;
import org.apache.hc.client5.http.impl.cache.HttpByteArrayCacheEntrySerializer;
import org.apache.hc.core5.util.Args;

import net.spy.memcached.CASResponse;
import net.spy.memcached.CASValue;
import net.spy.memcached.MemcachedClient;
import net.spy.memcached.MemcachedClientIF;
import net.spy.memcached.OperationTimeoutException;

/**
* <p>
* This class is a storage backend that uses an external <i>memcached</i>
Expand Down Expand Up @@ -88,6 +90,7 @@ public class MemcachedHttpCacheStorage extends AbstractBinaryCacheStorage<CASVal

private final MemcachedClientIF client;
private final KeyHashingScheme keyHashingScheme;
private final BiFunction<String, Instant, Duration> expiryResolver;

/**
* Create a storage backend talking to a <i>memcached</i> instance
Expand Down Expand Up @@ -119,7 +122,7 @@ public MemcachedHttpCacheStorage(final MemcachedClient cache) {
* @since 5.2
*/
public MemcachedHttpCacheStorage(final MemcachedClientIF cache) {
this(cache, CacheConfig.DEFAULT, HttpByteArrayCacheEntrySerializer.INSTANCE, SHA256KeyHashingScheme.INSTANCE);
this(cache, CacheConfig.DEFAULT, HttpByteArrayCacheEntrySerializer.INSTANCE, SHA256KeyHashingScheme.INSTANCE, null);
}

/**
Expand All @@ -137,7 +140,18 @@ public MemcachedHttpCacheStorage(
final CacheConfig config,
final HttpCacheEntrySerializer<byte[]> serializer,
final KeyHashingScheme keyHashingScheme) {
this((MemcachedClientIF) client, config, serializer, keyHashingScheme);
this(client, config, serializer, keyHashingScheme, null);
}

/**
* @since 5.2
*/
public MemcachedHttpCacheStorage(
final MemcachedClientIF client,
final CacheConfig config,
final HttpCacheEntrySerializer<byte[]> serializer,
final KeyHashingScheme keyHashingScheme) {
this(client, config, serializer, keyHashingScheme, null);
}

/**
Expand All @@ -150,17 +164,20 @@ public MemcachedHttpCacheStorage(
* @param serializer alternative serialization mechanism
* @param keyHashingScheme how to map higher-level logical "storage keys"
* onto "cache keys" suitable for use with memcached
* @since 5.2
* @param expiryResolver resolver for cache entry expiry
* @since 5.6
*/
public MemcachedHttpCacheStorage(
final MemcachedClientIF client,
final CacheConfig config,
final HttpCacheEntrySerializer<byte[]> serializer,
final KeyHashingScheme keyHashingScheme) {
final KeyHashingScheme keyHashingScheme,
final BiFunction<String, Instant, Duration> expiryResolver) {
super((config != null ? config : CacheConfig.DEFAULT).getMaxUpdateRetries(),
serializer != null ? serializer : HttpByteArrayCacheEntrySerializer.INSTANCE);
this.client = Args.notNull(client, "Memcached client");
this.keyHashingScheme = keyHashingScheme;
this.expiryResolver = expiryResolver;
}

@Override
Expand All @@ -170,8 +187,21 @@ protected String digestToStorageKey(final String key) {

@Override
protected void store(final String storageKey, final byte[] storageObject) throws ResourceIOException {
store(storageKey, null, storageObject);
}

@Override
protected void store(final String storageKey, final Instant expectedExpiry, final byte[] storageObject) throws ResourceIOException {
int exp = 0;
final Duration validityduration = expiryResolver != null ? expiryResolver.apply(storageKey, expectedExpiry) : null;
if (validityduration != null) {
final long expSeconds = validityduration.getSeconds();
if (expSeconds > 0) {
exp = (int) expSeconds;
}
}
try {
client.set(storageKey, 0, storageObject);
client.set(storageKey, exp, storageObject);
} catch (final CancellationException ex) {
throw new MemcachedOperationCancellationException(ex);
}
Expand Down
Loading