Make autowired CacheManager nullable to support disabling dynamic upd…

…ating
MarcGiffing · Jan 20, 2024 · 550df72 · 550df72
1 parent a2e4574
commit 550df72
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 9 deletions.
diff --git a/.../main/java/com/giffing/bucket4j/spring/boot/starter/examples/caffeine/TestController.java b/.../main/java/com/giffing/bucket4j/spring/boot/starter/examples/caffeine/TestController.java
@@ -5,6 +5,7 @@
 import java.util.Optional;
 import java.util.Set;
 
+import jakarta.annotation.Nullable;
 import jakarta.validation.ConstraintViolation;
 import jakarta.validation.Valid;
 import jakarta.validation.Validator;
@@ -26,9 +27,10 @@
 public class TestController {
 
 	private final Validator validator;
+
 	private final CacheManager<String, Bucket4JConfiguration> configCacheManager;
 
-	public TestController(Validator validator, CacheManager<String, Bucket4JConfiguration> configCacheManager) {
+	public TestController(Validator validator, @Nullable CacheManager<String, Bucket4JConfiguration> configCacheManager) {
 		this.validator = validator;
 		this.configCacheManager = configCacheManager;
 	}
@@ -60,6 +62,7 @@ public ResponseEntity<?> updateConfig(
 			@PathVariable String filterId,
 			@RequestBody @Valid Bucket4JConfiguration newConfig,
 			BindingResult bindingResult) {
+		if(configCacheManager == null) return ResponseEntity.status(HttpStatus.FORBIDDEN).body("Dynamic updating is disabled");
 
 		//validate that the path id matches the body
 		if (!newConfig.getId().equals(filterId)) {

diff --git a/.../com/giffing/bucket4j/spring/boot/starter/examples/ehcache/controller/TestController.java b/.../com/giffing/bucket4j/spring/boot/starter/examples/ehcache/controller/TestController.java
@@ -3,10 +3,13 @@
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
+import java.util.Optional;
 
 import com.giffing.bucket4j.spring.boot.starter.utils.Bucket4JUtils;
+import jakarta.annotation.Nullable;
 import jakarta.validation.Valid;
 import org.springframework.context.support.DefaultMessageSourceResolvable;
+import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
 import org.springframework.security.core.Authentication;
@@ -29,7 +32,7 @@ public class TestController {
 
 	private final CacheManager<String, Bucket4JConfiguration> configCacheManager;
 
-	public TestController(CacheManager<String, Bucket4JConfiguration> configCacheManager) {
+	public TestController(@Nullable CacheManager<String, Bucket4JConfiguration> configCacheManager) {
 		this.configCacheManager = configCacheManager;
 	}
 
@@ -93,6 +96,7 @@ public ResponseEntity<?> updateConfig(
 		@PathVariable String filterId,
 		@RequestBody @Valid Bucket4JConfiguration newConfig,
 		BindingResult bindingResult) {
+		if(configCacheManager == null) return ResponseEntity.status(HttpStatus.FORBIDDEN).body("Dynamic updating is disabled");
 
 		//validate that the path id matches the body
 		if (!newConfig.getId().equals(filterId)) {

diff --git a/...c/main/java/com/giffing/bucket4j/spring/boot/starter/examples/gateway/TestController.java b/...c/main/java/com/giffing/bucket4j/spring/boot/starter/examples/gateway/TestController.java
@@ -1,11 +1,13 @@
 package com.giffing.bucket4j.spring.boot.starter.examples.gateway;
 
 import com.giffing.bucket4j.spring.boot.starter.utils.Bucket4JUtils;
+import jakarta.annotation.Nullable;
 import jakarta.validation.ConstraintViolation;
 import jakarta.validation.Valid;
 import jakarta.validation.Validator;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.support.DefaultMessageSourceResolvable;
+import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.validation.BindingResult;
 import org.springframework.web.bind.annotation.*;
@@ -14,6 +16,7 @@
 import com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration;
 
 import java.util.List;
+import java.util.Optional;
 import java.util.Set;
 
 @RestController
@@ -25,7 +28,7 @@ public class TestController {
 
 	private final CacheManager<String, Bucket4JConfiguration> configCacheManager;
 
-	public TestController(CacheManager<String, Bucket4JConfiguration> configCacheManager){
+	public TestController(@Nullable CacheManager<String, Bucket4JConfiguration> configCacheManager){
 		this.configCacheManager = configCacheManager;
 	}
 
@@ -39,6 +42,7 @@ public TestController(CacheManager<String, Bucket4JConfiguration> configCacheMan
 	public ResponseEntity<?> updateConfig(
 		@PathVariable String filterId,
 		@RequestBody Bucket4JConfiguration newConfig) {
+		if(configCacheManager == null) return ResponseEntity.status(HttpStatus.FORBIDDEN).body("Dynamic updating is disabled");
 
 		//validate that the path id matches the body
 		if (!newConfig.getId().equals(filterId)) {

diff --git a/...main/java/com/giffing/bucket4j/spring/boot/starter/examples/hazelcast/TestController.java b/...main/java/com/giffing/bucket4j/spring/boot/starter/examples/hazelcast/TestController.java
@@ -1,8 +1,10 @@
 package com.giffing.bucket4j.spring.boot.starter.examples.hazelcast;
 
 import com.giffing.bucket4j.spring.boot.starter.utils.Bucket4JUtils;
+import jakarta.annotation.Nullable;
 import jakarta.validation.Valid;
 import org.springframework.context.support.DefaultMessageSourceResolvable;
+import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.validation.BindingResult;
 import org.springframework.web.bind.annotation.*;
@@ -18,7 +20,7 @@ public class TestController {
 
 	private final CacheManager<String, Bucket4JConfiguration> configCacheManager;
 
-	public TestController(CacheManager<String, Bucket4JConfiguration> configCacheManager) {
+	public TestController(@Nullable CacheManager<String, Bucket4JConfiguration> configCacheManager) {
 		this.configCacheManager = configCacheManager;
 	}
 
@@ -40,6 +42,7 @@ public ResponseEntity<?> updateConfig(
 		@PathVariable String filterId,
 		@RequestBody @Valid Bucket4JConfiguration newConfig,
 		BindingResult bindingResult) {
+		if(configCacheManager == null) return ResponseEntity.status(HttpStatus.FORBIDDEN).body("Dynamic updating is disabled");
 
 		//validate that the path id matches the body
 		if (!newConfig.getId().equals(filterId)) {

diff --git a/...es/redis-jedis/src/main/java/com/giffing/bucket4j/spring/boot/starter/TestController.java b/...es/redis-jedis/src/main/java/com/giffing/bucket4j/spring/boot/starter/TestController.java
@@ -1,8 +1,10 @@
 package com.giffing.bucket4j.spring.boot.starter;
 
 import com.giffing.bucket4j.spring.boot.starter.utils.Bucket4JUtils;
+import jakarta.annotation.Nullable;
 import jakarta.validation.Valid;
 import org.springframework.context.support.DefaultMessageSourceResolvable;
+import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.validation.BindingResult;
 import org.springframework.web.bind.annotation.*;
@@ -17,7 +19,7 @@ public class TestController {
 
 	private final CacheManager<String, Bucket4JConfiguration> configCacheManager;
 
-	public TestController(CacheManager<String,Bucket4JConfiguration> configCacheManager){
+	public TestController(@Nullable CacheManager<String,Bucket4JConfiguration> configCacheManager){
 		this.configCacheManager = configCacheManager;
 	}
 
@@ -44,6 +46,7 @@ public ResponseEntity<?> updateConfig(
 		@PathVariable String filterId,
 		@RequestBody @Valid Bucket4JConfiguration newConfig,
 		BindingResult bindingResult) {
+		if(configCacheManager == null) return ResponseEntity.status(HttpStatus.FORBIDDEN).body("Dynamic updating is disabled");
 
 		//validate that the path id matches the body
 		if (!newConfig.getId().equals(filterId)) {

diff --git a/.../redis-lettuce/src/main/java/com/giffing/bucket4j/spring/boot/starter/TestController.java b/.../redis-lettuce/src/main/java/com/giffing/bucket4j/spring/boot/starter/TestController.java
@@ -3,9 +3,11 @@
 import com.giffing.bucket4j.spring.boot.starter.config.cache.CacheManager;
 import com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration;
 import com.giffing.bucket4j.spring.boot.starter.utils.Bucket4JUtils;
+import jakarta.annotation.Nullable;
 import jakarta.validation.ConstraintViolation;
 import jakarta.validation.Validator;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
 
@@ -20,7 +22,7 @@ public class TestController {
 
 	private final CacheManager<String, Bucket4JConfiguration> configCacheManager;
 
-	public TestController(CacheManager<String,Bucket4JConfiguration> configCacheManager){
+	public TestController(@Nullable CacheManager<String,Bucket4JConfiguration> configCacheManager){
 		this.configCacheManager = configCacheManager;
 	}
 
@@ -45,6 +47,7 @@ public ResponseEntity<String> world() {
 	public ResponseEntity<?> updateConfig(
 		@PathVariable String filterId,
 		@RequestBody Bucket4JConfiguration newConfig) {
+		if(configCacheManager == null) return ResponseEntity.status(HttpStatus.FORBIDDEN).body("Dynamic updating is disabled");
 
 		//validate that the path id matches the body
 		if (!newConfig.getId().equals(filterId)) {

diff --git a/...redis-redisson/src/main/java/com/giffing/bucket4j/spring/boot/starter/TestController.java b/...redis-redisson/src/main/java/com/giffing/bucket4j/spring/boot/starter/TestController.java
@@ -20,7 +20,7 @@ public class TestController {
 
 	private final CacheManager<String, Bucket4JConfiguration> configCacheManager;
 
-	public TestController(CacheManager<String, Bucket4JConfiguration> configCacheManager){
+	public TestController(@Nullable CacheManager<String, Bucket4JConfiguration> configCacheManager){
 		this.configCacheManager = configCacheManager;
 	}
 
@@ -45,6 +45,7 @@ public ResponseEntity<String> world() {
 	public ResponseEntity<?> updateConfig(
 		@PathVariable String filterId,
 		@RequestBody Bucket4JConfiguration newConfig) {
+		if(configCacheManager == null) return ResponseEntity.status(HttpStatus.FORBIDDEN).body("Dynamic updating is disabled");
 
 		//validate that the path id matches the body
 		if (!newConfig.getId().equals(filterId)) {

diff --git a/...src/main/java/com/giffing/bucket4j/spring/boot/starter/examples/webflux/MyController.java b/...src/main/java/com/giffing/bucket4j/spring/boot/starter/examples/webflux/MyController.java
@@ -3,9 +3,11 @@
 import com.giffing.bucket4j.spring.boot.starter.config.cache.CacheManager;
 import com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration;
 import com.giffing.bucket4j.spring.boot.starter.utils.Bucket4JUtils;
+import jakarta.annotation.Nullable;
 import jakarta.validation.ConstraintViolation;
 import jakarta.validation.Validator;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
 import reactor.core.publisher.Mono;
@@ -22,7 +24,7 @@ public class MyController {
 
     private final CacheManager<String, Bucket4JConfiguration> configCacheManager;
 
-    public MyController(CacheManager<String, Bucket4JConfiguration> configCacheManager) {
+    public MyController(@Nullable CacheManager<String, Bucket4JConfiguration> configCacheManager) {
         this.configCacheManager = configCacheManager;
     }
 
@@ -55,6 +57,7 @@ public Mono<String> world(
     public ResponseEntity<?> updateConfig(
         @PathVariable String filterId,
         @RequestBody Bucket4JConfiguration newConfig) {
+        if(configCacheManager == null) return ResponseEntity.status(HttpStatus.FORBIDDEN).body("Dynamic updating is disabled");
 
 		//validate that the path id matches the body
 		if (!newConfig.getId().equals(filterId)) {

diff --git a/...src/main/java/com/giffing/bucket4j/spring/boot/starter/examples/webflux/MyController.java b/...src/main/java/com/giffing/bucket4j/spring/boot/starter/examples/webflux/MyController.java
@@ -1,11 +1,13 @@
 package com.giffing.bucket4j.spring.boot.starter.examples.webflux;
 
 import com.giffing.bucket4j.spring.boot.starter.utils.Bucket4JUtils;
+import jakarta.annotation.Nullable;
 import jakarta.validation.ConstraintViolation;
 import jakarta.validation.Valid;
 import jakarta.validation.Validator;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.support.DefaultMessageSourceResolvable;
+import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.validation.BindingResult;
 import org.springframework.web.bind.annotation.*;
@@ -27,7 +29,7 @@ public class MyController {
 
 	private final CacheManager<String, Bucket4JConfiguration> configCacheManager;
 
-	public MyController(CacheManager<String, Bucket4JConfiguration> configCacheManager) {
+	public MyController(@Nullable CacheManager<String, Bucket4JConfiguration> configCacheManager) {
 		this.configCacheManager = configCacheManager;
 	}
 
@@ -60,6 +62,7 @@ public Mono<String> world(
 	public ResponseEntity<?> updateConfig(
 		@PathVariable String filterId,
 		@RequestBody Bucket4JConfiguration newConfig) {
+		if(configCacheManager == null) return ResponseEntity.status(HttpStatus.FORBIDDEN).body("Dynamic updating is disabled");
 
 		//validate that the path id matches the body
 		if (!newConfig.getId().equals(filterId)) {