com.foreach.across.modules.debugweb.events.DebugCacheStatistics Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of debug-web-module Show documentation
Debug Web Module
The newest version!
/*
 * Copyright 2014 the original author or authors
 *
 * 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.foreach.across.modules.debugweb.events;

import lombok.*;
import org.springframework.cache.Cache;
import org.springframework.core.ResolvableType;
import org.springframework.core.ResolvableTypeProvider;

import java.time.Duration;
import java.util.Iterator;
import java.util.Optional;
import java.util.function.Function;

/**
 * Published when general statistics for a {@link org.springframework.cache.Cache} are to be gathered.
 *
 * @author Arne Vandamme
 * @since 3.0.0
 */
@RequiredArgsConstructor
@Getter
@Setter
public class DebugCacheStatistics implements ResolvableTypeProvider
{
	private final String cacheName;
	private final Cache cache;

	/**
	 * Number of items present in the cache.
	 */
	private Long items;

	/**
	 * Maximum number of items that can be stored in the cache.
	 */
	private Long maxItems;

	// BEGIN statistics of CacheStatisticsMXBean

	/**
	 * @see javax.cache.management.CacheStatisticsMXBean#getCacheHits()
	 */
	private Long hits;

	/**
	 * @see javax.cache.management.CacheStatisticsMXBean#getCacheHitPercentage()
	 */
	private Float hitPercentage;

	/**
	 * @see javax.cache.management.CacheStatisticsMXBean#getCacheMisses()
	 */
	private Long misses;

	/**
	 * @see javax.cache.management.CacheStatisticsMXBean#getCacheMissPercentage()
	 */
	private Float missPercentage;

	/**
	 * @see javax.cache.management.CacheStatisticsMXBean#getCacheGets() ()
	 */
	private Long gets;

	/**
	 * @see javax.cache.management.CacheStatisticsMXBean#getCachePuts()
	 */
	private Long puts;

	/**
	 * @see javax.cache.management.CacheStatisticsMXBean#getCacheRemovals()
	 */
	private Long removals;

	/**
	 * @see javax.cache.management.CacheStatisticsMXBean#getCacheEvictions()
	 */
	private Long evictions;

	/**
	 * @see javax.cache.management.CacheStatisticsMXBean#getAverageGetTime()
	 */
	private Float averageGetTime;

	/**
	 * @see javax.cache.management.CacheStatisticsMXBean#getAveragePutTime()
	 */
	private Float averagePutTime;

	/**
	 * @see javax.cache.management.CacheStatisticsMXBean#getAverageRemoveTime()
	 */
	private Float averageRemoveTime;

	// END statistics of CacheStatisticsMXBean

	/**
	 * An {@link Iterable} to the entries of the cache. Can be {@code null} if details are not available.
	 * If you want to have lazy transformation of an original cache entry (for performance reasons you
	 * often do), you can use {@link #setCacheEntryIterator(Iterable, Function)}.
	 *
	 * @see #setCacheEntryIterator(Iterable, Function)
	 * @see CacheEntryIterator
	 */
	private Iterable cacheEntries;

	/**
	 * Short-hand for providing a cache entry iterator by transforming original entries into a {@link CacheEntry}
	 * whenever they are requested.
	 */
	public  void setCacheEntryIterator( @NonNull Iterable original, @NonNull Function transformFunction ) {
		cacheEntries = () -> new CacheEntryIterator<>( original.iterator(), transformFunction );
	}

	@Override
	public ResolvableType getResolvableType() {
		return ResolvableType.forClassWithGenerics( getClass(), ResolvableType.forInstance( cache ) );
	}

	/**
	 * Represents a single entry in the cache.
	 */
	@SuppressWarnings("OptionalUsedAsFieldOrParameterType")
	@Getter
	@RequiredArgsConstructor
	@Builder
	public static class CacheEntry
	{
		/**
		 * Key of the cache entry.
		 */
		private final Object key;

		/**
		 * Value of the cache entry. A {@code null} value means the value cannot be resolved,
		 * whereas an {@link Optional#empty()} value means the stored value is {@code null}.
		 */
		private final Optional