org.glassfish.jersey.internal.inject.Providers Maven / Gradle / Ivy
Show all versions of jaxrs-ri Show documentation
/*
* Copyright (c) 2012, 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
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.jersey.internal.inject;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.IdentityHashMap;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.stream.Collectors;
import java.util.stream.StreamSupport;
import javax.ws.rs.ConstrainedTo;
import javax.ws.rs.Priorities;
import javax.ws.rs.RuntimeType;
import javax.ws.rs.core.Feature;
import javax.annotation.Priority;
import org.glassfish.jersey.JerseyPriorities;
import org.glassfish.jersey.innate.inject.spi.ExternalRegistrables;
import org.glassfish.jersey.internal.LocalizationMessages;
import org.glassfish.jersey.internal.ServiceFinder;
import org.glassfish.jersey.model.ContractProvider;
import org.glassfish.jersey.model.internal.RankedComparator;
import org.glassfish.jersey.model.internal.RankedProvider;
import org.glassfish.jersey.spi.Contract;
/**
* Utility class providing a set of utility methods for easier and more type-safe
* interaction with an injection layer.
*
* @author Marek Potociar
* @author Miroslav Fuksa
*/
public final class Providers {
private static final Logger LOGGER = Logger.getLogger(Providers.class.getName());
/**
* Map of all standard JAX-RS providers and their run-time affinity.
*/
private static final Map, ProviderRuntime> JAX_RS_PROVIDER_INTERFACE_WHITELIST =
getJaxRsProviderInterfaces();
/**
* Map of all supported external (i.e. non-Jersey) contracts and their run-time affinity.
*/
private static final Map, ProviderRuntime> EXTERNAL_PROVIDER_INTERFACE_WHITELIST =
getExternalProviderInterfaces();
private Providers() {
}
private static Map, ProviderRuntime> getJaxRsProviderInterfaces() {
final Map, ProviderRuntime> interfaces = new HashMap, ProviderRuntime>();
interfaces.put(javax.ws.rs.ext.ContextResolver.class, ProviderRuntime.BOTH);
interfaces.put(javax.ws.rs.ext.ExceptionMapper.class, ProviderRuntime.BOTH);
interfaces.put(javax.ws.rs.ext.MessageBodyReader.class, ProviderRuntime.BOTH);
interfaces.put(javax.ws.rs.ext.MessageBodyWriter.class, ProviderRuntime.BOTH);
interfaces.put(javax.ws.rs.ext.ReaderInterceptor.class, ProviderRuntime.BOTH);
interfaces.put(javax.ws.rs.ext.WriterInterceptor.class, ProviderRuntime.BOTH);
interfaces.put(javax.ws.rs.ext.ParamConverterProvider.class, ProviderRuntime.BOTH);
interfaces.put(javax.ws.rs.container.ContainerRequestFilter.class, ProviderRuntime.SERVER);
interfaces.put(javax.ws.rs.container.ContainerResponseFilter.class, ProviderRuntime.SERVER);
interfaces.put(javax.ws.rs.container.DynamicFeature.class, ProviderRuntime.SERVER);
interfaces.put(javax.ws.rs.client.ClientResponseFilter.class, ProviderRuntime.CLIENT);
interfaces.put(javax.ws.rs.client.ClientRequestFilter.class, ProviderRuntime.CLIENT);
interfaces.put(javax.ws.rs.client.RxInvokerProvider.class, ProviderRuntime.CLIENT);
return interfaces;
}
private static Map, ProviderRuntime> getExternalProviderInterfaces() {
final Map, ProviderRuntime> interfaces = new HashMap, ProviderRuntime>();
// JAX-RS
interfaces.putAll(JAX_RS_PROVIDER_INTERFACE_WHITELIST);
interfaces.put(javax.ws.rs.core.Feature.class, ProviderRuntime.BOTH);
interfaces.put(Binder.class, ProviderRuntime.BOTH);
try {
ServiceFinder registerables = ServiceFinder.find(ExternalRegistrables.class, true);
registerables.forEach(regs -> regs.registrableContracts()
.forEach(pair -> interfaces.put(pair.getContract(), ProviderRuntime.fromRuntimeType(pair.getRuntimeType()))));
} catch (Throwable t) {
LOGGER.warning(LocalizationMessages.ERROR_EXTERNAL_REGISTERABLES_IGNORED(t.getMessage()));
}
return interfaces;
}
private enum ProviderRuntime {
BOTH(null), SERVER(RuntimeType.SERVER), CLIENT(RuntimeType.CLIENT);
private final RuntimeType runtime;
private ProviderRuntime(final RuntimeType runtime) {
this.runtime = runtime;
}
public RuntimeType getRuntime() {
return runtime;
}
private static ProviderRuntime fromRuntimeType(RuntimeType type) {
return type == null ? BOTH : (type == RuntimeType.SERVER ? SERVER : CLIENT);
}
}
/**
* Get the set of default providers registered for the given service provider contract
* in the underlying {@link InjectionManager injection manager} container.
*
* @param service provider contract Java type.
* @param injectionManager underlying injection manager.
* @param contract service provider contract.
* @return set of all available default service provider instances for the contract.
*/
public static Set getProviders(InjectionManager injectionManager, Class contract) {
Collection> providers = getServiceHolders(injectionManager, contract);
return getProviderClasses(providers);
}
/**
* Get the set of all custom providers registered for the given service provider contract
* in the underlying {@link InjectionManager injection manager} container.
*
* Returned providers are sorted based on {@link Priority} (lower {@code Priority} value is higher priority,
* see {@link Priorities}.
*
* @param service provider contract Java type.
* @param injectionManager underlying injection manager.
* @param contract service provider contract.
* @return set of all available service provider instances for the contract.
*/
public static Set getCustomProviders(InjectionManager injectionManager, Class contract) {
List> providers = getServiceHolders(injectionManager,
contract,
Comparator.comparingInt(Providers::getPriority),
CustomAnnotationLiteral.INSTANCE);
return getProviderClasses(providers);
}
/**
* Get the iterable of all providers (custom and default) registered for the given service provider contract
* in the underlying {@link InjectionManager injection manager} container.
*
* @param service provider contract Java type.
* @param injectionManager underlying injection manager.
* @param contract service provider contract.
* @return iterable of all available service provider instances for the contract. Return value is never null.
*/
public static Iterable getAllProviders(InjectionManager injectionManager, Class contract) {
return getAllProviders(injectionManager, contract, (Comparator) null);
}
/**
* Get the iterable of all {@link RankedProvider providers} (custom and default) registered for the given service provider
* contract in the underlying {@link InjectionManager injection manager} container.
*
* @param service provider contract Java type.
* @param injectionManager underlying injection manager.
* @param contract service provider contract.
* @return iterable of all available ranked service providers for the contract. Return value is never {@code null}.
*/
public static Iterable> getAllRankedProviders(InjectionManager injectionManager, Class contract) {
final List> providers = getServiceHolders(injectionManager, contract, CustomAnnotationLiteral.INSTANCE);
providers.addAll(getServiceHolders(injectionManager, contract));
final LinkedHashMap, RankedProvider> providerMap = new LinkedHashMap<>();
for (final ServiceHolder provider : providers) {
final Class implClass = getImplementationClass(contract, provider);
if (!providerMap.containsKey(implClass)) {
Set contracts = isProxyGenerated(contract, provider) ? provider.getContractTypes() : null;
providerMap.put(implClass, new RankedProvider<>(provider.getInstance(), provider.getRank(), contracts));
}
}
return providerMap.values();
}
/**
* Sort given providers with {@link RankedComparator ranked comparator}.
*
* @param comparator comparator to sort the providers with.
* @param providers providers to be sorted.
* @param service provider contract Java type.
* @return sorted {@link Iterable iterable} instance containing given providers.
* The returned value is never {@code null}.
*/
@SuppressWarnings("TypeMayBeWeakened")
public static Iterable sortRankedProviders(final RankedComparator comparator,
final Iterable> providers) {
return StreamSupport.stream(providers.spliterator(), false)
.sorted(comparator)
.map(RankedProvider::getProvider)
.collect(Collectors.toList());
}
/**
* Get the iterable of all providers (custom and default) registered for the given service provider contract in the underlying
* {@link InjectionManager injection manager} container and automatically sorted using
* {@link RankedComparator ranked comparator}.
*
* @param service provider contract Java type.
* @param injectionManager underlying injection manager.
* @param contract service provider contract.
* @return iterable of all available service providers for the contract. Return value is never {@code null}.
*/
@SuppressWarnings("TypeMayBeWeakened")
public static Iterable getAllRankedSortedProviders(InjectionManager injectionManager, Class contract) {
Iterable> allRankedProviders = Providers.getAllRankedProviders(injectionManager, contract);
return Providers.sortRankedProviders(new RankedComparator<>(), allRankedProviders);
}
/**
* Merge and sort given providers with {@link RankedComparator ranked comparator}.
*
* @param comparator comparator to sort the providers with.
* @param providerIterables providers to be sorted.
* @param service provider contract Java type.
* @return merged and sorted {@link Iterable iterable} instance containing given providers.
* The returned value is never {@code null}.
*/
@SuppressWarnings("TypeMayBeWeakened")
public static Iterable mergeAndSortRankedProviders(final RankedComparator comparator,
final Iterable>> providerIterables) {
return StreamSupport.stream(providerIterables.spliterator(), false)
.flatMap(rankedProviders -> StreamSupport.stream(rankedProviders.spliterator(), false))
.sorted(comparator)
.map(RankedProvider::getProvider)
.collect(Collectors.toList());
}
/**
* Get the sorted iterable of all {@link RankedProvider providers} (custom and default) registered for the given service
* provider contract in the underlying {@link InjectionManager injection manager} container.
*
* @param service provider contract Java type.
* @param injectionManager underlying injection manager.
* @param contract service provider contract.
* @param comparator comparator to sort the providers with.
* @return set of all available ranked service providers for the contract. Return value is never null.
*/
public static Iterable getAllProviders(
InjectionManager injectionManager, Class contract, RankedComparator comparator) {
//noinspection unchecked
return sortRankedProviders(comparator, getAllRankedProviders(injectionManager, contract));
}
/**
* Get collection of all {@link ServiceHolder}s bound for providers (custom and default) registered for the given service
* provider contract in the underlying {@link InjectionManager injection manager} container.
*
* @param service provider contract Java type.
* @param injectionManager underlying injection manager.
* @param contract service provider contract.
* @return set of all available service provider instances for the contract
*/
public static Collection> getAllServiceHolders(InjectionManager injectionManager, Class contract) {
List> providers = getServiceHolders(injectionManager,
contract,
Comparator.comparingInt(Providers::getPriority),
CustomAnnotationLiteral.INSTANCE);
providers.addAll(getServiceHolders(injectionManager, contract));
final LinkedHashMap, ServiceHolder> providerMap = new LinkedHashMap<>();
for (final ServiceHolder provider : providers) {
final Class implClass = getImplementationClass(contract, provider);
if (!providerMap.containsKey(implClass)) {
providerMap.put(implClass, provider);
}
}
return providerMap.values();
}
private static List> getServiceHolders(
InjectionManager bm, Class contract, Annotation... qualifiers) {
return bm.getAllServiceHolders(contract, qualifiers);
}
private static List> getServiceHolders(InjectionManager injectionManager,
Class contract,
Comparator> objectComparator,
Annotation... qualifiers) {
List> serviceHolders = injectionManager.getAllServiceHolders(contract, qualifiers);
serviceHolders.sort((o1, o2) -> objectComparator.compare(
getImplementationClass(contract, o1), getImplementationClass(contract, o2))
);
return serviceHolders;
}
/**
* Returns {@code true} if given component class is a JAX-RS provider.
*
* @param clazz class to check.
* @return {@code true} if the class is a JAX-RS provider, {@code false} otherwise.
*/
public static boolean isJaxRsProvider(final Class clazz) {
for (final Class providerType : JAX_RS_PROVIDER_INTERFACE_WHITELIST.keySet()) {
if (providerType.isAssignableFrom(clazz)) {
return true;
}
}
return false;
}
/**
* Get the iterable of all providers (custom and default) registered for the given service provider contract
* in the underlying {@link InjectionManager injection manager} container ordered based on the given {@code comparator}.
*
* @param service provider contract Java type.
* @param injectionManager underlying injection manager.
* @param contract service provider contract.
* @param comparator comparator to be used for sorting the returned providers.
* @return set of all available service provider instances for the contract ordered using the given
* {@link Comparator comparator}.
*/
public static Iterable getAllProviders(
InjectionManager injectionManager, Class contract, Comparator comparator) {
List providerList = new ArrayList<>(getProviderClasses(getAllServiceHolders(injectionManager, contract)));
if (comparator != null) {
providerList.sort(comparator);
}
return providerList;
}
private static Set getProviderClasses(final Collection> providers) {
return providers.stream()
.map(Providers::holder2service)
.collect(Collectors.toCollection(LinkedHashSet::new));
}
private static T holder2service(ServiceHolder holder) {
return (holder != null) ? holder.getInstance() : null;
}
private static int getPriority(Class serviceClass) {
return JerseyPriorities.getPriorityValue(serviceClass, /* default priority */ Priorities.USER);
}
private static Class getImplementationClass(Class contract, ServiceHolder serviceHolder) {
return isProxyGenerated(contract, serviceHolder)
? serviceHolder.getContractTypes().stream().filter(a -> Class.class.isInstance(a))
.map(a -> (Class) a).reduce(contract, (a, b) -> a.isAssignableFrom(b) ? b : a)
: serviceHolder.getImplementationClass();
}
private static boolean isProxyGenerated(Class contract, ServiceHolder serviceHolder) {
return !contract.isAssignableFrom(serviceHolder.getImplementationClass());
}
/**
* Returns provider contracts recognized by Jersey that are implemented by the {@code clazz}.
* Recognized provider contracts include all JAX-RS providers as well as all Jersey SPI
* components annotated with {@link Contract @Contract} annotation.
*
* @param clazz class to extract the provider interfaces from.
* @return set of provider contracts implemented by the given class.
*/
public static Set> getProviderContracts(final Class clazz) {
final Set> contracts = Collections.newSetFromMap(new IdentityHashMap<>());
computeProviderContracts(clazz, contracts);
return contracts;
}
private static void computeProviderContracts(final Class clazz, final Set> contracts) {
for (final Class contract : getImplementedContracts(clazz)) {
if (isSupportedContract(contract)) {
contracts.add(contract);
}
computeProviderContracts(contract, contracts);
}
}
/**
* Check the {@code component} whether it is appropriate correctly configured for client or server
* {@link RuntimeType runtime}.
*
* If a problem occurs a warning is logged and if the component is not usable at all in the current runtime
* {@code false} is returned. For classes found during component scanning (scanned=true) certain warnings are
* completely ignored (e.g. components {@link ConstrainedTo constrained to} the client runtime and found by
* server-side class path scanning will be silently ignored and no warning will be logged).
*
* @param component the class of the component being checked.
* @param model model of the component.
* @param runtimeConstraint current runtime (client or server).
* @param scanned {@code false} if the component type has been registered explicitly;
* {@code true} if the class has been discovered during any form of component scanning.
* @param isResource {@code true} if the component is also a resource class.
* @return {@code true} if component is acceptable for use in the given runtime type, {@code false} otherwise.
*/
public static boolean checkProviderRuntime(final Class component,
final ContractProvider model,
final RuntimeType runtimeConstraint,
final boolean scanned,
final boolean isResource) {
final Set> contracts = model.getContracts();
final ConstrainedTo constrainedTo = component.getAnnotation(ConstrainedTo.class);
final RuntimeType componentConstraint = constrainedTo == null ? null : constrainedTo.value();
if (Feature.class.isAssignableFrom(component)) {
return true;
}
final StringBuilder warnings = new StringBuilder();
try {
/*
* Indicates that the provider implements at least one contract compatible
* with it's implementation class constraint.
*/
boolean foundComponentCompatible = componentConstraint == null;
boolean foundRuntimeCompatibleContract = isResource && runtimeConstraint == RuntimeType.SERVER;
for (final Class contract : contracts) {
// if the contract is common/not constrained, default to provider constraint
final RuntimeType contractConstraint = getContractConstraint(contract, componentConstraint);
foundRuntimeCompatibleContract |= contractConstraint == null || contractConstraint == runtimeConstraint;
if (componentConstraint != null) {
if (contractConstraint != componentConstraint) {
//noinspection ConstantConditions
warnings.append(LocalizationMessages.WARNING_PROVIDER_CONSTRAINED_TO_WRONG_PACKAGE(
component.getName(),
componentConstraint.name(),
contract.getName(),
contractConstraint.name())) // is never null
.append(" ");
} else {
foundComponentCompatible = true;
}
}
}
if (!foundComponentCompatible) {
//noinspection ConstantConditions
warnings.append(LocalizationMessages.ERROR_PROVIDER_CONSTRAINED_TO_WRONG_PACKAGE(
component.getName(),
componentConstraint.name())) // is never null
.append(" ");
logProviderSkipped(warnings, component, isResource);
return false;
}
final boolean isProviderRuntimeCompatible;
// runtimeConstraint vs. providerConstraint
isProviderRuntimeCompatible = componentConstraint == null || componentConstraint == runtimeConstraint;
if (!isProviderRuntimeCompatible && !scanned) {
// log failure for manually registered providers
warnings.append(LocalizationMessages.ERROR_PROVIDER_CONSTRAINED_TO_WRONG_RUNTIME(
component.getName(),
componentConstraint.name(),
runtimeConstraint.name()))
.append(" ");
logProviderSkipped(warnings, component, isResource);
}
// runtimeConstraint vs contractConstraint
if (!foundRuntimeCompatibleContract && !scanned) {
warnings.append(LocalizationMessages.ERROR_PROVIDER_REGISTERED_WRONG_RUNTIME(
component.getName(),
runtimeConstraint.name()))
.append(" ");
logProviderSkipped(warnings, component, isResource);
return false;
}
return isProviderRuntimeCompatible && foundRuntimeCompatibleContract;
} finally {
if (warnings.length() > 0) {
LOGGER.log(Level.WARNING, warnings.toString());
}
}
}
private static void logProviderSkipped(final StringBuilder sb, final Class provider, final boolean alsoResourceClass) {
sb.append(alsoResourceClass
? LocalizationMessages.ERROR_PROVIDER_AND_RESOURCE_CONSTRAINED_TO_IGNORED(provider.getName())
: LocalizationMessages.ERROR_PROVIDER_CONSTRAINED_TO_IGNORED(provider.getName())).append(" ");
}
/**
* Check if the given Java type is a Jersey-supported contract.
*
* @param type contract type.
* @return {@code true} if given type is a Jersey-supported contract, {@code false} otherwise.
*/
public static boolean isSupportedContract(final Class type) {
return (EXTERNAL_PROVIDER_INTERFACE_WHITELIST.get(type) != null || type.isAnnotationPresent(Contract.class));
}
private static RuntimeType getContractConstraint(final Class clazz, final RuntimeType defaultConstraint) {
final ProviderRuntime jaxRsProvider = EXTERNAL_PROVIDER_INTERFACE_WHITELIST.get(clazz);
RuntimeType result = null;
if (jaxRsProvider != null) {
result = jaxRsProvider.getRuntime();
} else if (clazz.getAnnotation(Contract.class) != null) {
final ConstrainedTo constrainedToAnnotation = clazz.getAnnotation(ConstrainedTo.class);
if (constrainedToAnnotation != null) {
result = constrainedToAnnotation.value();
}
}
return (result == null) ? defaultConstraint : result;
}
private static Iterable> getImplementedContracts(final Class clazz) {
final Collection> list = new LinkedList<>();
Collections.addAll(list, clazz.getInterfaces());
final Class superclass = clazz.getSuperclass();
if (superclass != null) {
list.add(superclass);
}
return list;
}
/**
* Returns {@code true} if the given component class is a provider (implements specific interfaces).
* See {@link #getProviderContracts}.
*
* @param clazz class to test.
* @return {@code true} if the class is provider, {@code false} otherwise.
*/
public static boolean isProvider(final Class clazz) {
return findFirstProviderContract(clazz);
}
/**
* Ensure the supplied implementation classes implement the expected contract.
*
* @param contract contract that is expected to be implemented by the implementation classes.
* @param implementations contract implementations.
* @throws java.lang.IllegalArgumentException in case any of the implementation classes does not
* implement the expected contract.
*/
public static void ensureContract(final Class contract, final Class... implementations) {
if (implementations == null || implementations.length <= 0) {
return;
}
final StringBuilder invalidClassNames = new StringBuilder();
for (final Class impl : implementations) {
if (!contract.isAssignableFrom(impl)) {
if (invalidClassNames.length() > 0) {
invalidClassNames.append(", ");
}
invalidClassNames.append(impl.getName());
}
}
if (invalidClassNames.length() > 0) {
throw new IllegalArgumentException(LocalizationMessages.INVALID_SPI_CLASSES(
contract.getName(),
invalidClassNames.toString()));
}
}
private static boolean findFirstProviderContract(final Class clazz) {
for (final Class contract : getImplementedContracts(clazz)) {
if (isSupportedContract(contract)) {
return true;
}
if (findFirstProviderContract(contract)) {
return true;
}
}
return false;
}
}