Fixes for Spring Boot 3.5.0 API

Spring Boot renamed the property methods to determine if HAL is enabled
or not.  Use reflection to determine which method to call so we can
support both versions

Fixes #3005

Author: mschout

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocHateoasConfiguration.java

@@ -26,6 +26,7 @@
 
 package org.springdoc.core.configuration;
 
+import java.util.List;
 import java.util.Optional;
 
 import com.fasterxml.jackson.core.JsonGenerator;
@@ -50,6 +51,8 @@
 import org.springframework.context.annotation.Lazy;
 import org.springframework.hateoas.Links;
 import org.springframework.hateoas.server.LinkRelationProvider;
+import org.springframework.lang.NonNull;
+import org.springframework.util.ReflectionUtils;
 
 /**
  * The type Spring doc hateoas configuration.
@@ -89,7 +92,7 @@ HateoasHalProvider hateoasHalProvider(Optional<HateoasProperties> hateoasPropert
 	@ConditionalOnMissingBean
 	@Lazy(false)
 	CollectionModelContentConverter collectionModelContentConverter(HateoasHalProvider halProvider, LinkRelationProvider linkRelationProvider) {
-		return halProvider.isHalEnabled() ? new CollectionModelContentConverter(linkRelationProvider) : null;
+		return isHalEnabled(halProvider) ? new CollectionModelContentConverter(linkRelationProvider) : null;
 	}
 
 	/**
@@ -105,7 +108,7 @@ CollectionModelContentConverter collectionModelContentConverter(HateoasHalProvid
 	@ConditionalOnMissingBean(name = Constants.LINKS_SCHEMA_CUSTOMIZER)
 	@Lazy(false)
 	GlobalOpenApiCustomizer linksSchemaCustomizer(HateoasHalProvider halProvider, SpringDocConfigProperties springDocConfigProperties) {
-		if (!halProvider.isHalEnabled()) {
+		if (isHalEnabled(halProvider)) {
 			return openApi -> {
 			};
 		}
@@ -124,6 +127,24 @@ GlobalOpenApiCustomizer linksSchemaCustomizer(HateoasHalProvider halProvider, Sp
 	HateoasLinksConverter hateoasLinksConverter(ObjectMapperProvider springDocObjectMapper) {
 		return new HateoasLinksConverter(springDocObjectMapper) ;
 	}
-	
-	
-}
+
+	private boolean isHalEnabled(@NonNull HateoasHalProvider halProvider) {
+		// in SB 3.5.0 isHalEnabled was renamed to isUseHalAsDefaultJsonMediaType
+		// We have to use reflection to support both versions
+		var possibleMethodNames = List.of("isUseHalAsDefaultJsonMediaType", "isHalEnabled");
+
+		for (var methodName : possibleMethodNames) {
+			var method = ReflectionUtils.findMethod(halProvider.getClass(), methodName);
+			if (method != null) {
+				var retval = ReflectionUtils.invokeMethod(method, halProvider);
+				if (retval == null) {
+					throw new IllegalStateException("Unable to determine if HAL is enabled");
+				}
+
+				return (Boolean) retval;
+			}
+		}
+
+		throw new IllegalStateException("Unable to determine if HAL is enabled, no method found");
+	}
+}

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/providers/HateoasHalProvider.java

@@ -26,12 +26,16 @@
 
 package org.springdoc.core.providers;
 
+import java.util.List;
 import java.util.Optional;
 
 import jakarta.annotation.PostConstruct;
 
+import org.jetbrains.annotations.NotNull;
 import org.springframework.boot.autoconfigure.hateoas.HateoasProperties;
 import org.springframework.hateoas.mediatype.hal.Jackson2HalModule;
+import org.springframework.lang.NonNull;
+import org.springframework.util.ReflectionUtils;
 
 /**
  * The type Hateoas hal provider.
@@ -79,8 +83,28 @@ protected void init() {
 	 */
 	public boolean isHalEnabled() {
 		return hateoasPropertiesOptional
-				.map(HateoasProperties::getUseHalAsDefaultJsonMediaType)
+				.map(this::isUseHalAsDefaultJsonMediaType)
 				.orElse(true);
 	}
 
+	private Boolean isUseHalAsDefaultJsonMediaType(@NonNull HateoasProperties hateoasProperties) {
+		// in SB 3.5.0 getUseHalAsDefaultJsonMediaType was renamed to isUseHalAsDefaultJsonMediaType
+		// We have to use reflection to support both versions
+		var possibleMethodNames = List.of("isUseHalAsDefaultJsonMediaType", "getUseHalAsDefaultJsonMediaType");
+
+		for (var methodName : possibleMethodNames) {
+			var method = ReflectionUtils.findMethod(hateoasProperties.getClass(), methodName);
+			if (method != null) {
+				var retval = ReflectionUtils.invokeMethod(method, hateoasProperties);
+				if (retval == null) {
+					return null;
+				}
+
+				return (Boolean) retval;
+			}
+		}
+
+		// We should have found a method, if not, throw an exception
+		throw new IllegalStateException("Unable to determine if HAL is enabled, no method found");
+	}
 }