(Jakarta migration) Deprecate JAX-RS 2 modules #84

RELEASE-NOTES.md

@@ -1,3 +1,7 @@
+## 3.0-M3
+
+* #84 (Jakarta migration) Deprecate JAX-RS 2 modules
+
 ## 3.0.M2
 
 * #65 Upgrade to Jersey 2.38 / 3.0.9

bootique-jersey-beanvalidation/src/main/java/io/bootique/jersey/beanvalidation/JerseyBeanValidationModule.java

@@ -23,7 +23,9 @@
 
 /**
  * @since 2.0
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
  */
+@Deprecated(since = "3.0", forRemoval = true)
 public class JerseyBeanValidationModule extends ConfigModule {
 
     public static JerseyBeanValidationModuleExtender extend(Binder binder) {

bootique-jersey-beanvalidation/src/main/java/io/bootique/jersey/beanvalidation/JerseyBeanValidationModuleExtender.java

@@ -25,7 +25,9 @@
 
 /**
  * @since 2.0
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
  */
+@Deprecated(since = "3.0", forRemoval = true)
 public class JerseyBeanValidationModuleExtender extends ModuleExtender<JerseyBeanValidationModuleExtender> {
 
     public JerseyBeanValidationModuleExtender(Binder binder) {

bootique-jersey-beanvalidation/src/main/java/io/bootique/jersey/beanvalidation/JerseyBeanValidationModuleProvider.java

@@ -23,7 +23,9 @@
 
 /**
  * @since 2.0
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
  */
+@Deprecated(since = "3.0", forRemoval = true)
 public class JerseyBeanValidationModuleProvider implements BQModuleProvider {
 
     @Override

bootique-jersey-client-instrumented/src/main/java/io/bootique/jersey/client/instrumented/InstrumentedFeature.java

@@ -22,6 +22,10 @@
 import javax.ws.rs.core.Feature;
 import javax.ws.rs.core.FeatureContext;
 
+/**
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
+ */
+@Deprecated(since = "3.0", forRemoval = true)
 public class InstrumentedFeature implements Feature {
 
     private final RequestTimer filter;

bootique-jersey-client-instrumented/src/main/java/io/bootique/jersey/client/instrumented/InstrumentedHttpClientFactoryFactory.java

@@ -27,7 +27,9 @@
 
 /**
  * @since 3.0
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
  */
+@Deprecated(since = "3.0", forRemoval = true)
 @BQConfig
 public class InstrumentedHttpClientFactoryFactory extends HttpClientFactoryFactory {
 

bootique-jersey-client-instrumented/src/main/java/io/bootique/jersey/client/instrumented/JerseyClientHealthChecks.java

@@ -5,6 +5,10 @@
 
 import java.util.Map;
 
+/**
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
+ */
+@Deprecated(since = "3.0", forRemoval = true)
 public class JerseyClientHealthChecks implements HealthCheckGroup {
     private final Map<String, HealthCheck> healthChecks;
 

bootique-jersey-client-instrumented/src/main/java/io/bootique/jersey/client/instrumented/JerseyClientHealthChecksFactory.java

@@ -12,6 +12,10 @@
 import java.util.Map;
 import java.util.function.Supplier;
 
+/**
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
+ */
+@Deprecated(since = "3.0", forRemoval = true)
 @BQConfig
 public class JerseyClientHealthChecksFactory {
 

bootique-jersey-client-instrumented/src/main/java/io/bootique/jersey/client/instrumented/JerseyClientInstrumentedModule.java

@@ -31,6 +31,10 @@
 
 import javax.inject.Singleton;
 
+/**
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
+ */
+@Deprecated(since = "3.0", forRemoval = true)
 public class JerseyClientInstrumentedModule extends ConfigModule {
 
     public static final MetricNaming METRIC_NAMING = MetricNaming.forModule(JerseyClientInstrumentedModule.class);

bootique-jersey-client-instrumented/src/main/java/io/bootique/jersey/client/instrumented/JerseyClientInstrumentedModuleProvider.java

@@ -30,6 +30,10 @@
 
 import static java.util.Arrays.asList;
 
+/**
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
+ */
+@Deprecated(since = "3.0", forRemoval = true)
 public class JerseyClientInstrumentedModuleProvider implements BQModuleProvider {
 
     @Override

bootique-jersey-client-instrumented/src/main/java/io/bootique/jersey/client/instrumented/RequestTimer.java

@@ -33,6 +33,10 @@
 import java.util.List;
 import java.util.Map;
 
+/**
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
+ */
+@Deprecated(since = "3.0", forRemoval = true)
 // The priority must be higher than that of RequestLogger, so that the Timer could print its output inside the Logger
 @Priority(200)
 public class RequestTimer implements ClientRequestFilter, ClientResponseFilter {

bootique-jersey-client-instrumented/src/main/java/io/bootique/jersey/client/instrumented/healthcheck/HttpHealthCheck.java

@@ -31,7 +31,10 @@
 
 /**
  * Provides a simple HTTP health check to verify that remote endpoints are alive and accessible.
+ *
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
  */
+@Deprecated(since = "3.0", forRemoval = true)
 public class HttpHealthCheck implements HealthCheck {
 
     private Supplier<Response> responseSupplier;

bootique-jersey-client-instrumented/src/main/java/io/bootique/jersey/client/instrumented/mdc/MDCAwareClientAsyncExecutorProvider.java

@@ -19,15 +19,17 @@
 package io.bootique.jersey.client.instrumented.mdc;
 
 import io.bootique.jersey.client.ClientAsyncExecutorProvider;
-import javax.inject.Inject;
-import javax.inject.Named;
 import org.glassfish.jersey.client.ClientAsyncExecutor;
 
+import javax.inject.Inject;
+import javax.inject.Named;
 import java.util.concurrent.*;
 
 /**
  * @since 3.0
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
  */
+@Deprecated(since = "3.0", forRemoval = true)
 @ClientAsyncExecutor
 public class MDCAwareClientAsyncExecutorProvider extends ClientAsyncExecutorProvider {
 

bootique-jersey-client-instrumented/src/main/java/io/bootique/jersey/client/instrumented/mdc/MDCAwareThreadPoolExecutor.java

@@ -24,7 +24,9 @@
 
 /**
  * @since 3.0
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
  */
+@Deprecated(since = "3.0", forRemoval = true)
 public class MDCAwareThreadPoolExecutor extends ThreadPoolExecutor {
 
     public MDCAwareThreadPoolExecutor(

bootique-jersey-client/src/main/java/io/bootique/jersey/client/BaseClientBqHk2Bridge.java

@@ -1,19 +1,22 @@
 package io.bootique.jersey.client;
 
-import java.lang.annotation.Annotation;
-import java.lang.reflect.ParameterizedType;
-import java.lang.reflect.Type;
-import javax.inject.Provider;
-
 import io.bootique.BootiqueException;
 import io.bootique.di.Injector;
 import io.bootique.di.Key;
 import io.bootique.di.TypeLiteral;
 import org.glassfish.hk2.api.Injectee;
 
+import javax.inject.Provider;
+import java.lang.annotation.Annotation;
+import java.lang.reflect.ParameterizedType;
+import java.lang.reflect.Type;
+
 /**
  * Base utilities for bridge between Bootique DI and HK2 container
+ *
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
  */
+@Deprecated(since = "3.0", forRemoval = true)
 class BaseClientBqHk2Bridge {
 
     protected final Injector injector;
@@ -24,9 +27,9 @@ protected BaseClientBqHk2Bridge(Injector injector) {
 
     protected Provider<?> resolveBqProvider(Injectee injectee) {
         TypeLiteral<?> typeLiteral = TypeLiteral.of(injectee.getRequiredType());
-        if(Provider.class.equals(typeLiteral.getRawType())) {
+        if (Provider.class.equals(typeLiteral.getRawType())) {
             Type requiredType = getGenericParameterType(injectee.getRequiredType());
-            if(requiredType == null) {
+            if (requiredType == null) {
                 throw new BootiqueException(-1, "Not specified generic type for Provider injection point.");
             }
             typeLiteral = TypeLiteral.of(requiredType);
@@ -39,7 +42,7 @@ protected Provider<?> resolveBqProvider(Injectee injectee) {
                 ? Key.get(typeLiteral)
                 : Key.get(typeLiteral, bindingAnnotation);
 
-        if(!injector.hasProvider(key) && !allowDynamicInjectionForKey(injectee, key)) {
+        if (!injector.hasProvider(key) && !allowDynamicInjectionForKey(injectee, key)) {
             return null;
         }
 

bootique-jersey-client/src/main/java/io/bootique/jersey/client/ClientAsyncExecutorProvider.java

@@ -29,6 +29,10 @@
 import javax.inject.Named;
 import java.util.logging.Logger;
 
+/**
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
+ */
+@Deprecated(since = "3.0", forRemoval = true)
 // a copy of non-public Jersey DefaultClientAsyncExecutorProvider that allows us to customize async pool parameters
 @ClientAsyncExecutor
 public class ClientAsyncExecutorProvider extends ThreadPoolExecutorProvider {

bootique-jersey-client/src/main/java/io/bootique/jersey/client/ClientBqInjectInjector.java

@@ -19,16 +19,20 @@
 
 package io.bootique.jersey.client;
 
-import javax.inject.Inject;
-import javax.inject.Provider;
-
 import io.bootique.di.BQInject;
 import io.bootique.di.Injector;
 import io.bootique.di.TypeLiteral;
 import org.glassfish.hk2.api.Injectee;
 import org.glassfish.hk2.api.InjectionResolver;
 import org.glassfish.hk2.api.ServiceHandle;
 
+import javax.inject.Inject;
+import javax.inject.Provider;
+
+/**
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
+ */
+@Deprecated(since = "3.0", forRemoval = true)
 public class ClientBqInjectInjector extends BaseClientBqHk2Bridge implements InjectionResolver<BQInject> {
 
     @Inject

bootique-jersey-client/src/main/java/io/bootique/jersey/client/ClientBqInjectorBridge.java

@@ -19,27 +19,25 @@
 
 package io.bootique.jersey.client;
 
-import java.lang.annotation.Annotation;
-import java.lang.reflect.Type;
-import java.util.Collections;
-import java.util.Set;
-
-import javax.inject.Inject;
-import javax.inject.Provider;
-import javax.inject.Singleton;
-
 import io.bootique.di.Injector;
 import io.bootique.di.Key;
 import io.bootique.di.TypeLiteral;
-import org.glassfish.hk2.api.DescriptorType;
-import org.glassfish.hk2.api.DescriptorVisibility;
-import org.glassfish.hk2.api.Injectee;
-import org.glassfish.hk2.api.JustInTimeInjectionResolver;
-import org.glassfish.hk2.api.ServiceHandle;
-import org.glassfish.hk2.api.ServiceLocator;
+import org.glassfish.hk2.api.*;
 import org.glassfish.hk2.utilities.AbstractActiveDescriptor;
 import org.glassfish.hk2.utilities.ServiceLocatorUtilities;
 
+import javax.inject.Inject;
+import javax.inject.Provider;
+import javax.inject.Singleton;
+import java.lang.annotation.Annotation;
+import java.lang.reflect.Type;
+import java.util.Collections;
+import java.util.Set;
+
+/**
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
+ */
+@Deprecated(since = "3.0", forRemoval = true)
 public class ClientBqInjectorBridge extends BaseClientBqHk2Bridge implements JustInTimeInjectionResolver {
 
 	/*

bootique-jersey-client/src/main/java/io/bootique/jersey/client/DefaultHttpClientFactory.java

@@ -27,6 +27,10 @@
 import java.security.KeyStore;
 import java.util.Map;
 
+/**
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
+ */
+@Deprecated(since = "3.0", forRemoval = true)
 public class DefaultHttpClientFactory implements HttpClientFactory {
 
     private ClientConfig config;

bootique-jersey-client/src/main/java/io/bootique/jersey/client/DefaultHttpTargets.java

@@ -24,6 +24,10 @@
 import java.util.Set;
 import java.util.function.Supplier;
 
+/**
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
+ */
+@Deprecated(since = "3.0", forRemoval = true)
 public class DefaultHttpTargets implements HttpTargets {
 
     private final Map<String, Supplier<WebTarget>> namedTargets;

bootique-jersey-client/src/main/java/io/bootique/jersey/client/HttpClientBuilder.java

@@ -24,7 +24,10 @@
 /**
  * JAX RS {@link javax.ws.rs.client.Client} builder that builds the client with references to various parts of
  * "jerseyclient" Bootique configuration.
+ *
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
  */
+@Deprecated(since = "3.0", forRemoval = true)
 public interface HttpClientBuilder {
 
     Client build();

bootique-jersey-client/src/main/java/io/bootique/jersey/client/HttpClientFactory.java

@@ -23,7 +23,10 @@
 
 /**
  * An injectable factory for creating JAX RS clients based on Bootique configuration.
+ *
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
  */
+@Deprecated(since = "3.0", forRemoval = true)
 public interface HttpClientFactory {
 
     /**

bootique-jersey-client/src/main/java/io/bootique/jersey/client/HttpClientFactoryFactory.java

@@ -45,6 +45,10 @@
 import java.util.Set;
 import java.util.function.Supplier;
 
+/**
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
+ */
+@Deprecated(since = "3.0", forRemoval = true)
 @BQConfig("Configures HttpClientFactory, including named authenticators, timeouts, SSL certificates, etc.")
 public class HttpClientFactoryFactory {
 

bootique-jersey-client/src/main/java/io/bootique/jersey/client/HttpTargets.java

@@ -24,7 +24,10 @@
 
 /**
  * An injectable manager of preconfigured JAX RS {@link WebTarget} objects.
+ *
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
  */
+@Deprecated(since = "3.0", forRemoval = true)
 public interface HttpTargets {
 
     /**

bootique-jersey-client/src/main/java/io/bootique/jersey/client/JerseyClientFeatures.java

@@ -19,17 +19,19 @@
 
 package io.bootique.jersey.client;
 
+import javax.inject.Qualifier;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-import javax.inject.Qualifier;
-
 /**
  * A DI annotation for a set of JAXRS client features.
+ *
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
  */
-@Target({ ElementType.PARAMETER, ElementType.FIELD, ElementType.METHOD })
+@Deprecated(since = "3.0", forRemoval = true)
+@Target({ElementType.PARAMETER, ElementType.FIELD, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 @Qualifier
 public @interface JerseyClientFeatures {

bootique-jersey-client/src/main/java/io/bootique/jersey/client/JerseyClientModule.java

@@ -29,6 +29,10 @@
 import javax.ws.rs.core.Feature;
 import java.util.Set;
 
+/**
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
+ */
+@Deprecated(since = "3.0", forRemoval = true)
 public class JerseyClientModule extends ConfigModule {
 
     /**

bootique-jersey-client/src/main/java/io/bootique/jersey/client/JerseyClientModuleExtender.java

@@ -24,6 +24,10 @@
 
 import javax.ws.rs.core.Feature;
 
+/**
+ * @deprecated The users are encouraged to switch to the Jakarta-based flavor
+ */
+@Deprecated(since = "3.0", forRemoval = true)
 public class JerseyClientModuleExtender {
 
     private Binder binder;