Since 2.45.
diff --git a/docs/src/main/docbook/jersey.ent b/docs/src/main/docbook/jersey.ent
index c8022b9ad1..2d32c33ca0 100644
--- a/docs/src/main/docbook/jersey.ent
+++ b/docs/src/main/docbook/jersey.ent
@@ -392,6 +392,7 @@
CommonProperties.JSON_BINDING_FEATURE_DISABLE" >
CommonProperties.JSON_BINDING_FEATURE_DISABLE_CLIENT" >
CommonProperties.JSON_BINDING_FEATURE_DISABLE_SERVER" >
+CommonProperties.JSON_BINDING_FEATURE_DISABLE_PACKAGE" >
CommonProperties.JSON_PROCESSING_FEATURE_DISABLE" >
CommonProperties.JSON_PROCESSING_FEATURE_DISABLE_CLIENT" >
CommonProperties.JSON_PROCESSING_FEATURE_DISABLE_SERVER" >
diff --git a/media/json-binding/src/main/java/org/glassfish/jersey/jsonb/JsonBindingFeature.java b/media/json-binding/src/main/java/org/glassfish/jersey/jsonb/JsonBindingFeature.java
index 005613842b..17ce7ce16d 100644
--- a/media/json-binding/src/main/java/org/glassfish/jersey/jsonb/JsonBindingFeature.java
+++ b/media/json-binding/src/main/java/org/glassfish/jersey/jsonb/JsonBindingFeature.java
@@ -16,16 +16,26 @@
package org.glassfish.jersey.jsonb;
+import javax.ws.rs.RuntimeType;
+import javax.ws.rs.core.Application;
import javax.ws.rs.core.Configuration;
import javax.ws.rs.core.Feature;
import javax.ws.rs.core.FeatureContext;
+import org.glassfish.jersey.ApplicationSupplier;
import org.glassfish.jersey.CommonProperties;
import org.glassfish.jersey.internal.InternalProperties;
+import org.glassfish.jersey.internal.inject.InjectionManagerSupplier;
import org.glassfish.jersey.internal.util.PropertiesHelper;
+import org.glassfish.jersey.internal.util.ReflectionHelper;
import org.glassfish.jersey.jsonb.internal.JsonBindingAutoDiscoverable;
import org.glassfish.jersey.jsonb.internal.JsonBindingProvider;
+import java.security.AccessController;
+import java.util.HashSet;
+import java.util.Set;
+import java.util.logging.Logger;
+
/**
* Feature used to register JSON-B providers.
*
@@ -50,17 +60,85 @@
*/
public class JsonBindingFeature implements Feature {
+ private static final Logger LOGGER = Logger.getLogger(JsonBindingFeature.class.getName());
private static final String JSON_FEATURE = JsonBindingFeature.class.getSimpleName();
@Override
public boolean configure(final FeatureContext context) {
final Configuration config = context.getConfiguration();
- if (CommonProperties.getValue(config.getProperties(), config.getRuntimeType(),
- CommonProperties.JSON_BINDING_FEATURE_DISABLE, Boolean.FALSE, Boolean.class)) {
+ // ---- Allow to disable for compatibility with Pre JAX-RS 2.1 Jersey.
+
+ /* Either system properties */
+ final String bindingDisabledBySystemProperty = AccessController.doPrivileged(
+ PropertiesHelper.getSystemProperty(CommonProperties.JSON_BINDING_FEATURE_DISABLE));
+
+ final String bindingDisabledBySystemPropertyClient = AccessController.doPrivileged(
+ PropertiesHelper.getSystemProperty(CommonProperties.JSON_BINDING_FEATURE_DISABLE_CLIENT));
+
+ final String bindingDisabledBySystemPropertyServer = AccessController.doPrivileged(
+ PropertiesHelper.getSystemProperty(CommonProperties.JSON_BINDING_FEATURE_DISABLE_SERVER));
+
+ final RuntimeType runtimeType = config.getRuntimeType();
+
+ boolean bindingDisabledBySystem = PropertiesHelper.isPropertyOrNotSet(bindingDisabledBySystemProperty)
+ || (runtimeType == RuntimeType.CLIENT
+ && PropertiesHelper.isPropertyOrNotSet(bindingDisabledBySystemPropertyClient))
+ || (runtimeType == RuntimeType.SERVER
+ && PropertiesHelper.isPropertyOrNotSet(bindingDisabledBySystemPropertyServer));
+
+ /* Or config property */
+ final Boolean bindingDisabled = CommonProperties.getValue(config.getProperties(), runtimeType,
+ CommonProperties.JSON_BINDING_FEATURE_DISABLE, Boolean.class);
+
+ /* Config property takes precedence */
+ if ((bindingDisabledBySystem && !Boolean.FALSE.equals(bindingDisabled)) || Boolean.TRUE.equals(bindingDisabled)) {
return false;
}
+ final Set disabledPackageNames = new HashSet<>();
+
+ /* Only a certain package names */
+ final String bindingDisabledPackageBySystemProperty = RuntimeType.SERVER == runtimeType
+ ? AccessController.doPrivileged(PropertiesHelper.getSystemProperty(
+ CommonProperties.JSON_BINDING_FEATURE_DISABLE_PACKAGE))
+ : null;
+
+ final String bindingDisabledPackage = RuntimeType.SERVER == runtimeType
+ ? CommonProperties.getValue(config.getProperties(), runtimeType,
+ CommonProperties.JSON_BINDING_FEATURE_DISABLE_PACKAGE, String.class)
+ : null;
+
+ separatePackageNames(disabledPackageNames, bindingDisabledPackageBySystemProperty);
+ separatePackageNames(disabledPackageNames, bindingDisabledPackage);
+
+ if (!disabledPackageNames.isEmpty() && !Boolean.FALSE.equals(bindingDisabled)) {
+ try {
+ Application app = null;
+ if (InjectionManagerSupplier.class.isInstance(context)) {
+ app = ((InjectionManagerSupplier) context).getInjectionManager().getInstance(Application.class);
+ if (app != null) {
+ while (ApplicationSupplier.class.isInstance(app) && ((ApplicationSupplier) app).getApplication() != app) {
+ app = ((ApplicationSupplier) app).getApplication();
+ }
+ for (String disabledPackageName : disabledPackageNames) {
+ if (app.getClass().getName().startsWith(disabledPackageName)) {
+ return false;
+ }
+ }
+ }
+ }
+ if (app == null) {
+ LOGGER.warning(LocalizationMessages.ERROR_JSONB_DETECTING_APPLICATION(
+ LocalizationMessages.ERROR_JSONB_APPLICATION_NOT_FOUND()));
+ }
+ } catch (Throwable throwable) {
+ LOGGER.warning(LocalizationMessages.ERROR_JSONB_DETECTING_APPLICATION(throwable.getMessage()));
+ }
+ }
+
+ // ---- End of disabling for compatibility with Pre JAX-RS 2.1 Jersey.
+
final String jsonFeature = CommonProperties.getValue(
config.getProperties(),
config.getRuntimeType(),
@@ -79,4 +157,12 @@ public boolean configure(final FeatureContext context) {
return true;
}
+
+ private static void separatePackageNames(Set set, String packages) {
+ if (packages != null) {
+ for (String packageName : packages.split(",")) {
+ set.add(packageName.trim());
+ }
+ }
+ }
}
diff --git a/media/json-binding/src/main/resources/org/glassfish/jersey/jsonb/localization.properties b/media/json-binding/src/main/resources/org/glassfish/jersey/jsonb/localization.properties
index 4eee493a70..371e641b3d 100644
--- a/media/json-binding/src/main/resources/org/glassfish/jersey/jsonb/localization.properties
+++ b/media/json-binding/src/main/resources/org/glassfish/jersey/jsonb/localization.properties
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2017, 2024 Oracle and/or its affiliates. All rights reserved.
#
# This program and the accompanying materials are made available under the
# terms of the Eclipse Public License v. 2.0, which is available at
@@ -14,6 +14,8 @@
# SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
#
+error.jsonb.application.not.found=Application not found.
+error.jsonb.detecting.application=JSON-B could not detect the application name: {0}.
error.jsonb.serialization=Error writing JSON-B serialized object.
error.jsonb.deserialization=Error deserializing object from entity stream.
error.jsonb.emptystream=JSON-B cannot parse empty input stream.
diff --git a/media/json-binding/src/test/java/org/glassfish/jersey/jsonb/internal/JsonbDisabledTest.java b/media/json-binding/src/test/java/org/glassfish/jersey/jsonb/internal/JsonbDisabledTest.java
index 4882fe88b0..77a453d237 100644
--- a/media/json-binding/src/test/java/org/glassfish/jersey/jsonb/internal/JsonbDisabledTest.java
+++ b/media/json-binding/src/test/java/org/glassfish/jersey/jsonb/internal/JsonbDisabledTest.java
@@ -17,6 +17,11 @@
package org.glassfish.jersey.jsonb.internal;
import org.glassfish.jersey.CommonProperties;
+import org.glassfish.jersey.internal.inject.AbstractBinder;
+import org.glassfish.jersey.internal.inject.InjectionManager;
+import org.glassfish.jersey.internal.inject.InjectionManagerSupplier;
+import org.glassfish.jersey.internal.inject.Injections;
+import org.glassfish.jersey.internal.util.PropertiesHelper;
import org.glassfish.jersey.jsonb.JsonBindingFeature;
import org.glassfish.jersey.model.internal.CommonConfig;
import org.glassfish.jersey.model.internal.ComponentBag;
@@ -24,32 +29,200 @@
import org.junit.jupiter.api.Test;
import javax.ws.rs.RuntimeType;
+import javax.ws.rs.core.Application;
import javax.ws.rs.core.FeatureContext;
import java.lang.reflect.Proxy;
import java.util.concurrent.atomic.AtomicReference;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
public class JsonbDisabledTest {
@Test
public void testDisabled() {
AtomicReference configReference = new AtomicReference<>();
- FeatureContext featureContext1 = (FeatureContext) Proxy.newProxyInstance(
- getClass().getClassLoader(),
- new Class[] {FeatureContext.class}, (proxy, method, args) -> {
- switch (method.getName()) {
- case "getConfiguration":
- return configReference.get();
- }
- return null;
- });
+ FeatureContext featureContext1 = featureContextForConfig(configReference);
CommonConfig config1 = new CommonConfig(RuntimeType.SERVER, ComponentBag.INCLUDE_ALL);
configReference.set(config1);
Assertions.assertTrue(new JsonBindingFeature().configure(featureContext1));
-
CommonConfig config2 = new CommonConfig(RuntimeType.SERVER, ComponentBag.INCLUDE_ALL);
config2.property(CommonProperties.JSON_BINDING_FEATURE_DISABLE, true);
configReference.set(config2);
Assertions.assertFalse(new JsonBindingFeature().configure(featureContext1));
}
+
+ @Test
+ public void testDisabledBySystemProperty() {
+ AtomicReference configReference = new AtomicReference<>();
+ FeatureContext featureContext1 = featureContextForConfig(configReference);
+
+ CommonConfig config1 = new CommonConfig(RuntimeType.SERVER, ComponentBag.INCLUDE_ALL);
+ configReference.set(config1);
+ Assertions.assertTrue(new JsonBindingFeature().configure(featureContext1));
+
+ CommonConfig config2 = new CommonConfig(RuntimeType.SERVER, ComponentBag.INCLUDE_ALL);
+ System.setProperty(CommonProperties.JSON_BINDING_FEATURE_DISABLE_SERVER, "true");
+ configReference.set(config2);
+ Assertions.assertFalse(new JsonBindingFeature().configure(featureContext1));
+ System.clearProperty(CommonProperties.JSON_BINDING_FEATURE_DISABLE_SERVER);
+ }
+
+ @Test
+ public void testDisabledBySystemPropertyOverridenByConfigProperty() {
+ AtomicReference configReference = new AtomicReference<>();
+ FeatureContext featureContext1 = featureContextForConfig(configReference);
+
+ CommonConfig config1 = new CommonConfig(RuntimeType.SERVER, ComponentBag.INCLUDE_ALL);
+ configReference.set(config1);
+ Assertions.assertTrue(new JsonBindingFeature().configure(featureContext1));
+
+ CommonConfig config2 = new CommonConfig(RuntimeType.SERVER, ComponentBag.INCLUDE_ALL);
+ System.setProperty(CommonProperties.JSON_BINDING_FEATURE_DISABLE, "true");
+ config2.property(CommonProperties.JSON_BINDING_FEATURE_DISABLE, false);
+ configReference.set(config2);
+ Assertions.assertTrue(new JsonBindingFeature().configure(featureContext1));
+ System.clearProperty(CommonProperties.JSON_BINDING_FEATURE_DISABLE);
+ }
+
+ @Test
+ public void testDisabledByPropertyApplicationPackage() {
+ Application application = new Application() {
+ };
+ InjectionManager injectionManager = Injections.createInjectionManager();
+ injectionManager.register(new AbstractBinder() {
+ @Override
+ protected void configure() {
+ bind(application).to(Application.class);
+ }
+ });
+ AtomicReference injectionManagerReference = new AtomicReference<>(injectionManager);
+ AtomicReference configReference = new AtomicReference<>();
+ FeatureContext featureContext1 = featureContextForConfig(configReference, injectionManagerReference);
+
+ CommonConfig config1 = new CommonConfig(RuntimeType.SERVER, ComponentBag.INCLUDE_ALL);
+ configReference.set(config1);
+ Assertions.assertTrue(new JsonBindingFeature().configure(featureContext1));
+
+ System.setProperty(CommonProperties.JSON_BINDING_FEATURE_DISABLE_PACKAGE,
+ "some.does.not.matter, org.glassfish.jersey.jsonb.internal");
+ CommonConfig config2 = new CommonConfig(RuntimeType.SERVER, ComponentBag.INCLUDE_ALL);
+ configReference.set(config2);
+ Assertions.assertFalse(new JsonBindingFeature().configure(featureContext1));
+ System.clearProperty(CommonProperties.JSON_BINDING_FEATURE_DISABLE_PACKAGE);
+ }
+
+ @Test
+ public void disableOnClientOnlyTest() {
+ AtomicReference configReference = new AtomicReference<>();
+ FeatureContext featureContext1 = featureContextForConfig(configReference);
+
+ CommonConfig config1 = new CommonConfig(RuntimeType.CLIENT, ComponentBag.INCLUDE_ALL);
+ configReference.set(config1);
+ Assertions.assertTrue(new JsonBindingFeature().configure(featureContext1));
+
+ config1.property(CommonProperties.JSON_BINDING_FEATURE_DISABLE_SERVER, true);
+ Assertions.assertTrue(new JsonBindingFeature().configure(featureContext1));
+
+ config1.property(CommonProperties.JSON_BINDING_FEATURE_DISABLE_CLIENT, true);
+ Assertions.assertFalse(new JsonBindingFeature().configure(featureContext1));
+
+ CommonConfig config2 = new CommonConfig(RuntimeType.CLIENT, ComponentBag.INCLUDE_ALL);
+ System.setProperty(CommonProperties.JSON_BINDING_FEATURE_DISABLE_SERVER, "true");
+ configReference.set(config2);
+ Assertions.assertTrue(new JsonBindingFeature().configure(featureContext1));
+
+ System.setProperty(CommonProperties.JSON_BINDING_FEATURE_DISABLE_CLIENT, "true");
+ Assertions.assertFalse(new JsonBindingFeature().configure(featureContext1));
+
+ System.clearProperty(CommonProperties.JSON_BINDING_FEATURE_DISABLE_SERVER);
+ System.clearProperty(CommonProperties.JSON_BINDING_FEATURE_DISABLE_CLIENT);
+ }
+
+ @Test
+ public void testDisabledBySystemPropertyApplicationPackage() {
+ Application application = new Application() {
+ };
+ InjectionManager injectionManager = Injections.createInjectionManager();
+ injectionManager.register(new AbstractBinder() {
+ @Override
+ protected void configure() {
+ bind(application).to(Application.class);
+ }
+ });
+ AtomicReference injectionManagerReference = new AtomicReference<>(injectionManager);
+ AtomicReference configReference = new AtomicReference<>();
+ FeatureContext featureContext1 = featureContextForConfig(configReference, injectionManagerReference);
+
+ System.setProperty(CommonProperties.JSON_BINDING_FEATURE_DISABLE_PACKAGE,
+ "some.does.not.matter, org.glassfish.jersey.jsonb.internal");
+
+ CommonConfig config1 = new CommonConfig(RuntimeType.SERVER, ComponentBag.INCLUDE_ALL);
+ configReference.set(config1);
+ Assertions.assertFalse(new JsonBindingFeature().configure(featureContext1));
+
+ CommonConfig config2 = new CommonConfig(RuntimeType.SERVER, ComponentBag.INCLUDE_ALL);
+ configReference.set(config2);
+ Assertions.assertFalse(new JsonBindingFeature().configure(featureContext1));
+ System.clearProperty(CommonProperties.JSON_BINDING_FEATURE_DISABLE_PACKAGE);
+ }
+
+ @Test
+ public void testDisabledBySystemPropertyApplicationPackageEnabledByProperty() {
+ Application application = new Application() {
+ };
+ InjectionManager injectionManager = Injections.createInjectionManager();
+ injectionManager.register(new AbstractBinder() {
+ @Override
+ protected void configure() {
+ bind(application).to(Application.class);
+ }
+ });
+ AtomicReference injectionManagerReference = new AtomicReference<>(injectionManager);
+ AtomicReference configReference = new AtomicReference<>();
+ FeatureContext featureContext1 = featureContextForConfig(configReference, injectionManagerReference);
+
+ CommonConfig config1 = new CommonConfig(RuntimeType.SERVER, ComponentBag.INCLUDE_ALL);
+ configReference.set(config1);
+ Assertions.assertTrue(new JsonBindingFeature().configure(featureContext1));
+
+ System.setProperty(CommonProperties.JSON_BINDING_FEATURE_DISABLE_PACKAGE,
+ "some.does.not.matter, org.glassfish.jersey.jsonb.internal");
+
+ CommonConfig config2 = new CommonConfig(RuntimeType.SERVER, ComponentBag.INCLUDE_ALL);
+ config2.property(CommonProperties.JSON_BINDING_FEATURE_DISABLE, Boolean.FALSE);
+ configReference.set(config2);
+ Assertions.assertTrue(new JsonBindingFeature().configure(featureContext1));
+ System.clearProperty(CommonProperties.JSON_BINDING_FEATURE_DISABLE_PACKAGE);
+ }
+
+ @Test
+ public void isPropertyOrNotSetTest() {
+ assertEquals(false, PropertiesHelper.isPropertyOrNotSet((Boolean) null));
+ assertEquals(true, PropertiesHelper.isPropertyOrNotSet(Boolean.TRUE));
+ assertEquals(false, PropertiesHelper.isPropertyOrNotSet(Boolean.FALSE));
+ assertEquals(false, PropertiesHelper.isPropertyOrNotSet((String) null));
+ assertEquals(true, PropertiesHelper.isPropertyOrNotSet(""));
+ assertEquals(false, PropertiesHelper.isPropertyOrNotSet("treu")); // false for non-boolean values
+ assertEquals(true, PropertiesHelper.isPropertyOrNotSet("TRUE"));
+ assertEquals(false, PropertiesHelper.isPropertyOrNotSet("false"));
+ }
+
+ private static FeatureContext featureContextForConfig(AtomicReference configReference) {
+ return featureContextForConfig(configReference, new AtomicReference<>());
+ }
+ private static FeatureContext featureContextForConfig(AtomicReference configReference,
+ AtomicReference injectionManager) {
+ return (FeatureContext) Proxy.newProxyInstance(
+ JsonbDisabledTest.class.getClassLoader(),
+ new Class[] {FeatureContext.class, InjectionManagerSupplier.class}, (proxy, method, args) -> {
+ switch (method.getName()) {
+ case "getConfiguration":
+ return configReference.get();
+ case "getInjectionManager":
+ return injectionManager.get();
+ }
+ return null;
+ });
+ }
}