Add nullability annotations to module/spring-boot-jersey

See gh-46587

Author: mhalbritter

module/spring-boot-jersey/build.gradle

@@ -32,7 +32,9 @@ dependencies {
 	api("org.glassfish.jersey.core:jersey-server")
 	api("org.glassfish.jersey.ext:jersey-spring6")
 	api("org.glassfish.jersey.media:jersey-media-json-jackson")
+
 	compileOnly("jakarta.servlet:jakarta.servlet-api")
+	compileOnly("com.google.code.findbugs:jsr305")
 
 	implementation("org.springframework:spring-web")
 

module/spring-boot-jersey/src/main/java/org/springframework/boot/jersey/actuate/endpoint/web/JerseyEndpointResourceFactory.java

@@ -37,6 +37,7 @@
 import org.glassfish.jersey.server.ContainerRequest;
 import org.glassfish.jersey.server.model.Resource;
 import org.glassfish.jersey.server.model.Resource.Builder;
+import org.jspecify.annotations.Nullable;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 
@@ -109,8 +110,8 @@ protected Resource createResource(EndpointMapping endpointMapping, WebOperation
 	}
 
 	protected Resource getResource(EndpointMapping endpointMapping, WebOperation operation,
-			WebOperationRequestPredicate requestPredicate, String path, WebServerNamespace serverNamespace,
-			JerseyRemainingPathSegmentProvider remainingPathSegmentProvider) {
+			WebOperationRequestPredicate requestPredicate, String path, @Nullable WebServerNamespace serverNamespace,
+			@Nullable JerseyRemainingPathSegmentProvider remainingPathSegmentProvider) {
 		Builder resourceBuilder = Resource.builder()
 			.path(endpointMapping.getPath())
 			.path(endpointMapping.createSubPath(path));
@@ -138,10 +139,10 @@ private static final class OperationInflector implements Inflector<ContainerRequ
 
 		private static final String PATH_SEPARATOR = AntPathMatcher.DEFAULT_PATH_SEPARATOR;
 
-		private static final List<Function<Object, Object>> BODY_CONVERTERS;
+		private static final List<Function<@Nullable Object, @Nullable Object>> BODY_CONVERTERS;
 
 		static {
-			List<Function<Object, Object>> converters = new ArrayList<>();
+			List<Function<@Nullable Object, @Nullable Object>> converters = new ArrayList<>();
 			converters.add(new ResourceBodyConverter());
 			if (ClassUtils.isPresent("reactor.core.publisher.Mono", OperationInflector.class.getClassLoader())) {
 				converters.add(new FluxBodyConverter());
@@ -154,12 +155,13 @@ private static final class OperationInflector implements Inflector<ContainerRequ
 
 		private final boolean readBody;
 
-		private final WebServerNamespace serverNamespace;
+		private final @Nullable WebServerNamespace serverNamespace;
 
-		private final JerseyRemainingPathSegmentProvider remainingPathSegmentProvider;
+		private final @Nullable JerseyRemainingPathSegmentProvider remainingPathSegmentProvider;
 
-		private OperationInflector(WebOperation operation, boolean readBody, WebServerNamespace serverNamespace,
-				JerseyRemainingPathSegmentProvider remainingPathSegments) {
+		private OperationInflector(WebOperation operation, boolean readBody,
+				@Nullable WebServerNamespace serverNamespace,
+				@Nullable JerseyRemainingPathSegmentProvider remainingPathSegments) {
 			this.operation = operation;
 			this.readBody = readBody;
 			this.serverNamespace = serverNamespace;
@@ -209,15 +211,15 @@ private Map<String, Object> extractPathParameters(ContainerRequestContext reques
 			return pathParameters;
 		}
 
-		private String getRemainingPathSegments(ContainerRequestContext requestContext,
+		private @Nullable String getRemainingPathSegments(ContainerRequestContext requestContext,
 				Map<String, Object> pathParameters, String matchAllRemainingPathSegmentsVariable) {
 			if (this.remainingPathSegmentProvider != null) {
 				return this.remainingPathSegmentProvider.get(requestContext, matchAllRemainingPathSegmentsVariable);
 			}
 			return (String) pathParameters.get(matchAllRemainingPathSegmentsVariable);
 		}
 
-		private String[] tokenizePathSegments(String path) {
+		private String[] tokenizePathSegments(@Nullable String path) {
 			String[] segments = StringUtils.tokenizeToStringArray(path, PATH_SEPARATOR, false, true);
 			for (int i = 0; i < segments.length; i++) {
 				if (segments[i].contains("%")) {
@@ -241,7 +243,7 @@ private Map<String, Object> extract(MultivaluedMap<String, String> multivaluedMa
 			return result;
 		}
 
-		private Response convertToJaxRsResponse(Object response, String httpMethod) {
+		private Response convertToJaxRsResponse(@Nullable Object response, String httpMethod) {
 			if (response == null) {
 				boolean isGet = HttpMethod.GET.equals(httpMethod);
 				Status status = isGet ? Status.NOT_FOUND : Status.NO_CONTENT;
@@ -256,8 +258,8 @@ private Response convertToJaxRsResponse(Object response, String httpMethod) {
 				.build();
 		}
 
-		private Object convertIfNecessary(Object body) {
-			for (Function<Object, Object> converter : BODY_CONVERTERS) {
+		private @Nullable Object convertIfNecessary(@Nullable Object body) {
+			for (Function<@Nullable Object, @Nullable Object> converter : BODY_CONVERTERS) {
 				body = converter.apply(body);
 			}
 			return body;
@@ -289,10 +291,10 @@ public Object apply(Object body) {
 	/**
 	 * Body converter from {@link Mono} to {@link Mono#block()}.
 	 */
-	private static final class MonoBodyConverter implements Function<Object, Object> {
+	private static final class MonoBodyConverter implements Function<@Nullable Object, @Nullable Object> {
 
 		@Override
-		public Object apply(Object body) {
+		public @Nullable Object apply(@Nullable Object body) {
 			if (body instanceof Mono) {
 				return ((Mono<?>) body).block();
 			}
@@ -304,10 +306,10 @@ public Object apply(Object body) {
 	/**
 	 * Body converter from {@link Flux} to {@link Flux#collectList Mono&lt;List&gt;}.
 	 */
-	private static final class FluxBodyConverter implements Function<Object, Object> {
+	private static final class FluxBodyConverter implements Function<@Nullable Object, @Nullable Object> {
 
 		@Override
-		public Object apply(Object body) {
+		public @Nullable Object apply(@Nullable Object body) {
 			if (body instanceof Flux) {
 				return ((Flux<?>) body).collectList();
 			}

module/spring-boot-jersey/src/main/java/org/springframework/boot/jersey/actuate/endpoint/web/package-info.java

@@ -17,4 +17,7 @@
 /**
  * Jersey support for actuator endpoints.
  */
+@NullMarked
 package org.springframework.boot.jersey.actuate.endpoint.web;
+
+import org.jspecify.annotations.NullMarked;

module/spring-boot-jersey/src/main/java/org/springframework/boot/jersey/autoconfigure/DefaultJerseyApplicationPath.java

@@ -18,6 +18,7 @@
 
 import jakarta.ws.rs.ApplicationPath;
 import org.glassfish.jersey.server.ResourceConfig;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.core.annotation.MergedAnnotation;
 import org.springframework.core.annotation.MergedAnnotations;
@@ -33,11 +34,11 @@
  */
 public class DefaultJerseyApplicationPath implements JerseyApplicationPath {
 
-	private final String applicationPath;
+	private final @Nullable String applicationPath;
 
 	private final ResourceConfig config;
 
-	public DefaultJerseyApplicationPath(String applicationPath, ResourceConfig config) {
+	public DefaultJerseyApplicationPath(@Nullable String applicationPath, ResourceConfig config) {
 		this.applicationPath = applicationPath;
 		this.config = config;
 	}

module/spring-boot-jersey/src/main/java/org/springframework/boot/jersey/autoconfigure/JerseyProperties.java

@@ -19,6 +19,8 @@
 import java.util.HashMap;
 import java.util.Map;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.context.properties.ConfigurationProperties;
 
 /**
@@ -50,7 +52,7 @@ public class JerseyProperties {
 	 * Path that serves as the base URI for the application. If specified, overrides the
 	 * value of "@ApplicationPath".
 	 */
-	private String applicationPath;
+	private @Nullable String applicationPath;
 
 	public Filter getFilter() {
 		return this.filter;
@@ -76,11 +78,11 @@ public void setInit(Map<String, String> init) {
 		this.init = init;
 	}
 
-	public String getApplicationPath() {
+	public @Nullable String getApplicationPath() {
 		return this.applicationPath;
 	}
 
-	public void setApplicationPath(String applicationPath) {
+	public void setApplicationPath(@Nullable String applicationPath) {
 		this.applicationPath = applicationPath;
 	}
 

module/spring-boot-jersey/src/main/java/org/springframework/boot/jersey/autoconfigure/actuate/endpoint/web/HealthEndpointJerseyExtensionAutoConfiguration.java

@@ -24,6 +24,7 @@
 import org.glassfish.jersey.server.ResourceConfig;
 import org.glassfish.jersey.server.model.Resource;
 import org.glassfish.jersey.servlet.ServletContainer;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.boot.actuate.autoconfigure.endpoint.condition.ConditionalOnAvailableEndpoint;
@@ -73,7 +74,7 @@ JerseyAdditionalHealthEndpointPathsResourcesRegistrar jerseyAdditionalHealthEndp
 		return new JerseyAdditionalHealthEndpointPathsResourcesRegistrar(health, healthEndpointGroups);
 	}
 
-	private static ExposableWebEndpoint getHealthEndpoint(WebEndpointsSupplier webEndpointsSupplier) {
+	private static @Nullable ExposableWebEndpoint getHealthEndpoint(WebEndpointsSupplier webEndpointsSupplier) {
 		Collection<ExposableWebEndpoint> webEndpoints = webEndpointsSupplier.getEndpoints();
 		return webEndpoints.stream()
 			.filter((endpoint) -> endpoint.getEndpointId().equals(HealthEndpoint.ID))
@@ -110,11 +111,11 @@ ServletRegistrationBean<ServletContainer> jerseyServletRegistration(JerseyApplic
 
 	static class JerseyAdditionalHealthEndpointPathsResourcesRegistrar implements ResourceConfigCustomizer {
 
-		private final ExposableWebEndpoint endpoint;
+		private final @Nullable ExposableWebEndpoint endpoint;
 
 		private final HealthEndpointGroups groups;
 
-		JerseyAdditionalHealthEndpointPathsResourcesRegistrar(ExposableWebEndpoint endpoint,
+		JerseyAdditionalHealthEndpointPathsResourcesRegistrar(@Nullable ExposableWebEndpoint endpoint,
 				HealthEndpointGroups groups) {
 			this.endpoint = endpoint;
 			this.groups = groups;

module/spring-boot-jersey/src/main/java/org/springframework/boot/jersey/autoconfigure/actuate/endpoint/web/package-info.java

@@ -17,4 +17,7 @@
 /**
  * Auto-configuration for Jersey actuator web endpoint support.
  */
+@NullMarked
 package org.springframework.boot.jersey.autoconfigure.actuate.endpoint.web;
+
+import org.jspecify.annotations.NullMarked;

module/spring-boot-jersey/src/main/java/org/springframework/boot/jersey/autoconfigure/actuate/web/JerseyWebEndpointManagementContextConfiguration.java

@@ -29,6 +29,7 @@
 import jakarta.ws.rs.ext.ContextResolver;
 import org.glassfish.jersey.server.ResourceConfig;
 import org.glassfish.jersey.server.model.Resource;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.boot.actuate.autoconfigure.endpoint.condition.ConditionalOnAvailableEndpoint;
 import org.springframework.boot.actuate.autoconfigure.endpoint.expose.EndpointExposure;
@@ -179,11 +180,11 @@ private void register(Collection<Resource> resources, ResourceConfig config) {
 	class JerseyAdditionalHealthEndpointPathsManagementResourcesRegistrar
 			implements ManagementContextResourceConfigCustomizer {
 
-		private final ExposableWebEndpoint healthEndpoint;
+		private final @Nullable ExposableWebEndpoint healthEndpoint;
 
 		private final HealthEndpointGroups groups;
 
-		JerseyAdditionalHealthEndpointPathsManagementResourcesRegistrar(ExposableWebEndpoint healthEndpoint,
+		JerseyAdditionalHealthEndpointPathsManagementResourcesRegistrar(@Nullable ExposableWebEndpoint healthEndpoint,
 				HealthEndpointGroups groups) {
 			this.healthEndpoint = healthEndpoint;
 			this.groups = groups;
@@ -192,16 +193,16 @@ class JerseyAdditionalHealthEndpointPathsManagementResourcesRegistrar
 		@Override
 		public void customize(ResourceConfig config) {
 			if (this.healthEndpoint != null) {
-				register(config);
+				register(config, this.healthEndpoint);
 			}
 		}
 
-		private void register(ResourceConfig config) {
+		private void register(ResourceConfig config, ExposableWebEndpoint healthEndpoint) {
 			EndpointMapping mapping = new EndpointMapping("");
 			JerseyHealthEndpointAdditionalPathResourceFactory resourceFactory = new JerseyHealthEndpointAdditionalPathResourceFactory(
 					WebServerNamespace.MANAGEMENT, this.groups);
 			Collection<Resource> endpointResources = resourceFactory
-				.createEndpointResources(mapping, Collections.singletonList(this.healthEndpoint))
+				.createEndpointResources(mapping, Collections.singletonList(healthEndpoint))
 				.stream()
 				.filter(Objects::nonNull)
 				.toList();
@@ -228,7 +229,7 @@ private EndpointObjectMapperContextResolver(EndpointObjectMapper endpointObjectM
 		}
 
 		@Override
-		public ObjectMapper getContext(Class<?> type) {
+		public @Nullable ObjectMapper getContext(Class<?> type) {
 			for (Class<?> supportedType : this.endpointObjectMapper.getSupportedTypes()) {
 				if (supportedType.isAssignableFrom(type)) {
 					return this.endpointObjectMapper.get();

module/spring-boot-jersey/src/main/java/org/springframework/boot/jersey/autoconfigure/actuate/web/package-info.java

@@ -17,4 +17,7 @@
 /**
  * Auto-configuration for Jersey actuator web concerns.
  */
+@NullMarked
 package org.springframework.boot.jersey.autoconfigure.actuate.web;
+
+import org.jspecify.annotations.NullMarked;

module/spring-boot-jersey/src/main/java/org/springframework/boot/jersey/autoconfigure/metrics/package-info.java

@@ -17,4 +17,7 @@
 /**
  * Auto-configuration for Jersey metrics.
  */
+@NullMarked
 package org.springframework.boot.jersey.autoconfigure.metrics;
+
+import org.jspecify.annotations.NullMarked;