keycloakjar.com.github.benmanes.caffeine.cache.LocalCache Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of camunda-bpm-identity-keycloak-all Show documentation
Show all versions of camunda-bpm-identity-keycloak-all Show documentation
Camunda Keycloak Identity Provider Plugin including all transitive dependencies
/*
* Copyright 2015 Ben Manes. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.github.benmanes.caffeine.cache;
import java.util.Map;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.Executor;
import java.util.function.BiFunction;
import java.util.function.Function;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
import com.github.benmanes.caffeine.cache.stats.StatsCounter;
/**
* An in-memory cache providing thread safety and atomicity guarantees. This interface provides an
* extension to {@link ConcurrentMap} for use with skeletal implementations.
*
* @author [email protected] (Ben Manes)
*/
interface LocalCache extends ConcurrentMap {
/** Returns whether this cache has statistics enabled. */
boolean isRecordingStats();
/** Returns the {@link StatsCounter} used by this cache. */
@NonNull StatsCounter statsCounter();
/** Returns whether this cache notifies when an entry is removed. */
boolean hasRemovalListener();
/** Returns the {@link RemovalListener} used by this cache. */
RemovalListener removalListener();
/** Asynchronously sends a removal notification to the listener. */
void notifyRemoval(@Nullable K key, @Nullable V value, RemovalCause cause);
/** Returns the {@link Executor} used by this cache. */
@NonNull Executor executor();
/** Returns whether the cache captures the write time of the entry. */
boolean hasWriteTime();
/** Returns the {@link Ticker} used by this cache for expiration. */
@NonNull Ticker expirationTicker();
/** Returns the {@link Ticker} used by this cache for statistics. */
@NonNull Ticker statsTicker();
/** See {@link Cache#estimatedSize()}. */
long estimatedSize();
/**
* See {@link Cache#getIfPresent(Object)}. This method differs by accepting a parameter of whether
* to record the hit and miss statistics based on the success of this operation.
*/
@Nullable
V getIfPresent(@NonNull Object key, boolean recordStats);
/**
* See {@link Cache#getIfPresent(Object)}. This method differs by not recording the access with
* the statistics nor the eviction policy, and populates the write time if known.
*/
@Nullable
V getIfPresentQuietly(@NonNull Object key, @NonNull long[/* 1 */] writeTime);
/** See {@link Cache#getAllPresent}. */
@NonNull
Map getAllPresent(@NonNull Iterable keys);
/**
* See {@link Cache#put(Object, Object)}. This method differs by allowing the operation to not
* notify the writer when an entry was inserted or updated.
*/
@Nullable
V put(@NonNull K key, @NonNull V value, boolean notifyWriter);
@Override
default @Nullable V compute(K key,
BiFunction remappingFunction) {
return compute(key, remappingFunction, /* recordMiss */ false,
/* recordLoad */ true, /* recordLoadFailure */ true);
}
/**
* See {@link ConcurrentMap#compute}. This method differs by accepting parameters indicating
* whether to record miss and load statistics based on the success of this operation.
*/
@Nullable V compute(K key, BiFunction remappingFunction,
boolean recordMiss, boolean recordLoad, boolean recordLoadFailure);
@Override
default @Nullable V computeIfAbsent(K key, Function mappingFunction) {
return computeIfAbsent(key, mappingFunction, /* recordStats */ true, /* recordLoad */ true);
}
/**
* See {@link ConcurrentMap#computeIfAbsent}. This method differs by accepting parameters
* indicating how to record statistics.
*/
@Nullable V computeIfAbsent(K key, Function mappingFunction,
boolean recordStats, boolean recordLoad);
/** See {@link Cache#invalidateAll(Iterable)}. */
default void invalidateAll(Iterable keys) {
for (Object key : keys) {
remove(key);
}
}
/** See {@link Cache#cleanUp}. */
void cleanUp();
/** Decorates the remapping function to record statistics if enabled. */
default Function statsAware(
Function mappingFunction, boolean recordLoad) {
if (!isRecordingStats()) {
return mappingFunction;
}
return key -> {
R value;
statsCounter().recordMisses(1);
long startTime = statsTicker().read();
try {
value = mappingFunction.apply(key);
} catch (RuntimeException | Error e) {
statsCounter().recordLoadFailure(statsTicker().read() - startTime);
throw e;
}
long loadTime = statsTicker().read() - startTime;
if (recordLoad) {
if (value == null) {
statsCounter().recordLoadFailure(loadTime);
} else {
statsCounter().recordLoadSuccess(loadTime);
}
}
return value;
};
}
/** Decorates the remapping function to record statistics if enabled. */
default BiFunction statsAware(
BiFunction remappingFunction) {
return statsAware(remappingFunction, /* recordMiss */ true,
/* recordLoad */ true, /* recordLoadFailure */ true);
}
/** Decorates the remapping function to record statistics if enabled. */
default BiFunction statsAware(
BiFunction remappingFunction,
boolean recordMiss, boolean recordLoad, boolean recordLoadFailure) {
if (!isRecordingStats()) {
return remappingFunction;
}
return (t, u) -> {
R result;
if ((u == null) && recordMiss) {
statsCounter().recordMisses(1);
}
long startTime = statsTicker().read();
try {
result = remappingFunction.apply(t, u);
} catch (RuntimeException | Error e) {
if (recordLoadFailure) {
statsCounter().recordLoadFailure(statsTicker().read() - startTime);
}
throw e;
}
long loadTime = statsTicker().read() - startTime;
if (recordLoad) {
if (result == null) {
statsCounter().recordLoadFailure(loadTime);
} else {
statsCounter().recordLoadSuccess(loadTime);
}
}
return result;
};
}
}