com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JBootProperties Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bucket4j-spring-boot-starter-context Show documentation

The newest version!

package com.giffing.bucket4j.spring.boot.starter.context.properties;

import java.util.ArrayList;
import java.util.List;

import com.giffing.bucket4j.spring.boot.starter.context.RateLimiting;
import jakarta.validation.Valid;
import jakarta.validation.constraints.AssertTrue;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.NotNull;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.validation.annotation.Validated;

import lombok.Data;

/**
 * Holds all the relevant starter properties which can be configured with
 * Spring Boots application.properties / application.yml configuration files.
 */
@Data
@ConfigurationProperties(prefix = Bucket4JBootProperties.PROPERTY_PREFIX)
@Validated
public class Bucket4JBootProperties {

    public static final String PROPERTY_PREFIX = "bucket4j";

    /**
     * Enables or disables the Bucket4j Spring Boot Starter.
     */
    @NotNull
    private Boolean enabled = true;

    /**
     * Sets the cache implementation which should be auto configured.
     * This property can be used if multiple caches are configured by the starter
     * and you have to choose one due to a startup error.
     * 
     * 	jcache
     *  hazelcast
     *  ignite
     *  redis
     * 
     */
    private String cacheToUse;

    /**
     * Configuration for the {@link RateLimiting} annotation on method level.
     */
    @Valid
    private List methods = new ArrayList<>();

    private boolean filterConfigCachingEnabled = false;

    /**
     * If Filter configuration caching is enabled, a cache with this name should exist, or it will cause an exception.
     */
    @NotBlank
    private String filterConfigCacheName = "filterConfigCache";


    @Valid
    private List filters = new ArrayList<>();

    @AssertTrue(message = "FilterConfiguration caching is enabled, but not all filters have an identifier configured")
    public boolean isValidFilterIds() {
        return !filterConfigCachingEnabled || filters.stream().noneMatch(filter -> filter.getId() == null);
    }

    /**
     * A list of default metric tags which should be applied to all filters
     */
    @Valid
    private List defaultMetricTags = new ArrayList<>();

    public static String getPropertyPrefix() {
        return PROPERTY_PREFIX;
    }

}