All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
io.quarkus.resteasy.reactive.jaxb.deployment.ResteasyReactiveJaxbProcessor Maven / Gradle / Ivy
package io.quarkus.resteasy.reactive.jaxb.deployment;
import static org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames.REST_RESPONSE;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Set;
import jakarta.enterprise.inject.spi.DeploymentException;
import jakarta.ws.rs.Priorities;
import jakarta.ws.rs.RuntimeType;
import jakarta.ws.rs.core.MediaType;
import jakarta.xml.bind.JAXBContext;
import org.jboss.jandex.AnnotationInstance;
import org.jboss.jandex.AnnotationValue;
import org.jboss.jandex.ClassInfo;
import org.jboss.jandex.FieldInfo;
import org.jboss.jandex.IndexView;
import org.jboss.jandex.MethodInfo;
import org.jboss.jandex.MethodParameterInfo;
import org.jboss.jandex.Type;
import org.jboss.resteasy.reactive.common.model.MethodParameter;
import org.jboss.resteasy.reactive.common.model.ParameterType;
import org.jboss.resteasy.reactive.common.model.ResourceMethod;
import org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames;
import io.quarkus.arc.deployment.AdditionalBeanBuildItem;
import io.quarkus.deployment.Capabilities;
import io.quarkus.deployment.Capability;
import io.quarkus.deployment.Feature;
import io.quarkus.deployment.annotations.BuildProducer;
import io.quarkus.deployment.annotations.BuildStep;
import io.quarkus.deployment.builditem.FeatureBuildItem;
import io.quarkus.jaxb.deployment.JaxbClassesToBeBoundBuildItem;
import io.quarkus.resteasy.reactive.common.deployment.JaxRsResourceIndexBuildItem;
import io.quarkus.resteasy.reactive.jaxb.runtime.JAXBContextContextResolver;
import io.quarkus.resteasy.reactive.jaxb.runtime.serialisers.ServerJaxbMessageBodyReader;
import io.quarkus.resteasy.reactive.jaxb.runtime.serialisers.ServerJaxbMessageBodyWriter;
import io.quarkus.resteasy.reactive.server.deployment.ResteasyReactiveResourceMethodEntriesBuildItem;
import io.quarkus.resteasy.reactive.spi.ContextResolverBuildItem;
import io.quarkus.resteasy.reactive.spi.MessageBodyReaderBuildItem;
import io.quarkus.resteasy.reactive.spi.MessageBodyWriterBuildItem;
public class ResteasyReactiveJaxbProcessor {
private static final List XML_TYPES = List.of(MediaType.APPLICATION_XML, MediaType.TEXT_XML);
@BuildStep
void feature(BuildProducer feature) {
feature.produce(new FeatureBuildItem(Feature.REST_JAXB));
}
@BuildStep
void additionalProviders(BuildProducer additionalBean,
BuildProducer additionalReaders,
BuildProducer additionalWriters,
BuildProducer additionalResolvers) {
// make these beans to they can get instantiated with the Quarkus CDI
additionalBean.produce(AdditionalBeanBuildItem.builder()
.addBeanClass(ServerJaxbMessageBodyReader.class.getName())
.addBeanClass(ServerJaxbMessageBodyWriter.class.getName())
.setUnremovable().build());
additionalReaders
.produce(new MessageBodyReaderBuildItem(ServerJaxbMessageBodyReader.class.getName(), Object.class.getName(),
XML_TYPES, RuntimeType.SERVER, true, Priorities.USER));
additionalWriters
.produce(new MessageBodyWriterBuildItem(ServerJaxbMessageBodyWriter.class.getName(), Object.class.getName(),
XML_TYPES, RuntimeType.SERVER, true, Priorities.USER));
additionalResolvers
.produce(new ContextResolverBuildItem(JAXBContextContextResolver.class.getName(), XML_TYPES,
JAXBContext.class.getName()));
}
@BuildStep
void registerClassesToBeBound(ResteasyReactiveResourceMethodEntriesBuildItem resourceMethodEntries,
JaxRsResourceIndexBuildItem index,
BuildProducer classesToBeBoundBuildItemBuildProducer) {
Set classesInfo = new HashSet<>();
IndexView indexView = index.getIndexView();
for (ResteasyReactiveResourceMethodEntriesBuildItem.Entry entry : resourceMethodEntries.getEntries()) {
ResourceMethod resourceInfo = entry.getResourceMethod();
MethodInfo methodInfo = entry.getMethodInfo();
ClassInfo effectiveReturnType = getEffectiveClassInfo(methodInfo.returnType(), indexView);
if (effectiveReturnType != null) {
// When using "application/xml", the return type needs to be registered
if (producesXml(resourceInfo)) {
if (!isTypeCompatibleWithJaxb(methodInfo.returnType())) {
throw new DeploymentException(
"Cannot directly return collections or arrays using JAXB. You need to wrap it "
+ "into a root element class. Problematic method is '"
+ entry.getActualClassInfo().name() + "." + methodInfo.name() + "'");
}
classesInfo.add(effectiveReturnType);
}
// When using "multipart/form-data", the parts that use "application/xml" need to be registered
if (producesMultipart(resourceInfo)) {
classesInfo.addAll(getEffectivePartsUsingXml(effectiveReturnType, indexView));
}
}
// If consumes "application/xml" or "multipart/form-data", we register all the classes of the parameters
boolean consumesXml = consumesXml(resourceInfo);
boolean consumesMultipart = consumesMultipart(resourceInfo);
if (consumesXml || consumesMultipart) {
for (MethodParameterInfo parameter : methodInfo.parameters()) {
if (isParameterBody(parameter, resourceInfo) && !isTypeCompatibleWithJaxb(parameter.type())) {
throw new DeploymentException(
"Cannot handle collections or arrays as parameters using JAXB. You need to wrap it "
+ "into a root element class. Problematic parameter is '" + parameter.name()
+ "' in the method '" + entry.getActualClassInfo().name() + "." + methodInfo.name()
+ "'");
}
ClassInfo effectiveParameter = getEffectiveClassInfo(parameter.type(), indexView);
if (effectiveParameter != null) {
if (consumesXml) {
classesInfo.add(effectiveParameter);
} else if (consumesMultipart) {
classesInfo.addAll(getEffectivePartsUsingXml(effectiveParameter, indexView));
}
}
}
}
}
classesToBeBoundBuildItemBuildProducer.produce(new JaxbClassesToBeBoundBuildItem(toClasses(classesInfo)));
}
@BuildStep
void setupJaxbContextConfigForValidator(Capabilities capabilities,
BuildProducer classesToBeBoundProducer) {
if (capabilities.isPresent(Capability.HIBERNATE_VALIDATOR)) {
classesToBeBoundProducer.produce(new JaxbClassesToBeBoundBuildItem(
Collections.singletonList("io.quarkus.hibernate.validator.runtime.jaxrs.ViolationReport")));
}
}
private List getEffectivePartsUsingXml(ClassInfo returnType, IndexView indexView) {
List classInfos = new ArrayList<>();
for (FieldInfo field : returnType.fields()) {
if (isPartTypeXml(field)) {
classInfos.add(getEffectiveClassInfo(field.type(), indexView));
}
}
return classInfos;
}
private boolean isPartTypeXml(FieldInfo field) {
AnnotationInstance partType = field.annotation(ResteasyReactiveDotNames.PART_TYPE_NAME);
if (partType != null) {
AnnotationValue partTypeValue = partType.value();
if (containsMediaType(new String[] { partTypeValue.asString() }, XML_TYPES)) {
return true;
}
}
return false;
}
private ClassInfo getEffectiveClassInfo(Type type, IndexView indexView) {
if (type.kind() == Type.Kind.VOID || type.kind() == Type.Kind.PRIMITIVE) {
return null;
}
Type effectiveType = type;
if (isContainerType(effectiveType)) {
if (effectiveType.kind() != Type.Kind.PARAMETERIZED_TYPE) {
return null;
}
effectiveType = type.asParameterizedType().arguments().get(0);
}
if (isCollectionType(effectiveType)) {
effectiveType = effectiveType.asParameterizedType().arguments().get(0);
} else if (isMapType(effectiveType)) {
effectiveType = effectiveType.asParameterizedType().arguments().get(1);
}
ClassInfo effectiveReturnClassInfo = indexView.getClassByName(effectiveType.name());
if ((effectiveReturnClassInfo == null) || effectiveReturnClassInfo.name().equals(ResteasyReactiveDotNames.OBJECT)) {
return null;
}
return effectiveReturnClassInfo;
}
private boolean consumesXml(ResourceMethod resourceInfo) {
return containsMediaType(resourceInfo.getConsumes(), XML_TYPES);
}
private boolean consumesMultipart(ResourceMethod resourceInfo) {
return containsMediaType(resourceInfo.getConsumes(), List.of(MediaType.MULTIPART_FORM_DATA));
}
private boolean producesXml(ResourceMethod resourceInfo) {
return containsMediaType(resourceInfo.getProduces(), XML_TYPES);
}
private boolean producesMultipart(ResourceMethod resourceInfo) {
return containsMediaType(resourceInfo.getProduces(), List.of(MediaType.MULTIPART_FORM_DATA));
}
private boolean containsMediaType(String[] types, List mediaTypes) {
if (types != null) {
for (String type : types) {
for (String mediaType : mediaTypes) {
if (type.toLowerCase(Locale.ROOT).contains(mediaType)) {
return true;
}
}
}
}
return false;
}
private List toClasses(Collection classesInfo) {
List classes = new ArrayList<>();
for (ClassInfo classInfo : classesInfo) {
classes.add(classInfo.toString());
}
return classes;
}
private boolean isParameterBody(MethodParameterInfo parameter, ResourceMethod resourceInfo) {
for (MethodParameter parameterInfo : resourceInfo.getParameters()) {
if (parameterInfo.name != null && parameterInfo.name.equals(parameter.name())) {
return parameterInfo.parameterType == ParameterType.BODY;
}
}
return false;
}
private boolean isCollectionType(Type type) {
return type.name().equals(ResteasyReactiveDotNames.SET) ||
type.name().equals(ResteasyReactiveDotNames.COLLECTION) ||
type.name().equals(ResteasyReactiveDotNames.LIST);
}
private boolean isMapType(Type type) {
return type.name().equals(ResteasyReactiveDotNames.MAP);
}
private boolean isContainerType(Type type) {
return type.name().equals(REST_RESPONSE) ||
type.name().equals(ResteasyReactiveDotNames.UNI) ||
type.name().equals(ResteasyReactiveDotNames.COMPLETABLE_FUTURE) ||
type.name().equals(ResteasyReactiveDotNames.COMPLETION_STAGE) ||
type.name().equals(ResteasyReactiveDotNames.REST_MULTI) ||
type.name().equals(ResteasyReactiveDotNames.MULTI);
}
private boolean isTypeCompatibleWithJaxb(Type type) {
if (type.kind() == Type.Kind.PRIMITIVE) {
return true;
}
if (type.kind() == Type.Kind.ARRAY || isCollectionType(type) || isMapType(type)) {
return false;
}
if (isContainerType(type)) {
if (type.kind() != Type.Kind.PARAMETERIZED_TYPE) {
return true;
}
return isTypeCompatibleWithJaxb(type.asParameterizedType().arguments().get(0));
}
return true;
}
}
