org.jboss.resteasy.plugins.providers.jaxb.JAXBElementProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of resteasy-jaxb-provider Show documentation
There is a newer version: 7.0.0.Alpha4
Show newest version
package org.jboss.resteasy.plugins.providers.jaxb;

import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.nio.charset.StandardCharsets;
import java.util.concurrent.CompletionStage;

import javax.xml.transform.sax.SAXSource;
import javax.xml.transform.stream.StreamSource;

import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.MultivaluedMap;
import jakarta.ws.rs.ext.Provider;
import jakarta.xml.bind.JAXBContext;
import jakarta.xml.bind.JAXBElement;
import jakarta.xml.bind.JAXBException;
import jakarta.xml.bind.Unmarshaller;

import org.jboss.resteasy.resteasy_jaxrs.i18n.LogMessages;
import org.jboss.resteasy.spi.AsyncOutputStream;
import org.jboss.resteasy.spi.util.Types;
import org.jboss.resteasy.util.NoContent;
import org.xml.sax.InputSource;

/**
 * 
 * A JAXB Provider which handles parameter and return types of {@link JAXBElement}. This provider will be
 * selected when the resource is declared as:
 * 
 * 
 * @POST

 * @Consumes("applictaion/xml")

 * @Produces("applictaion/xml")

 * public JAXBElement<Contact> getContact(JAXBElement<Contact> value);

 * 
 *
 * @author Ryan J. McDonough
 * @version $Revision:$
 */
@Provider
@Produces({ "application/xml", "application/*+xml", "text/xml", "text/*+xml" })
@Consumes({ "application/xml", "application/*+xml", "text/xml", "text/*+xml" })
public class JAXBElementProvider extends AbstractJAXBProvider> {

    @Override
    protected boolean isReadWritable(Class type,
            Type genericType,
            Annotation[] annotations,
            MediaType mediaType) {

        return JAXBElement.class.equals(type);
    }

    /**
    *
    */
    public JAXBElement readFrom(Class> type,
            Type genericType,
            Annotation[] annotations,
            MediaType mediaType,
            MultivaluedMap httpHeaders,
            InputStream entityStream) throws IOException {
        LogMessages.LOGGER.debugf("Provider : %s,  Method : readFrom", getClass().getName());
        NoContent.contentLengthCheck(httpHeaders);
        Class typeArg = Object.class;
        if (genericType != null)
            typeArg = Types.getTypeArgument(genericType);
        JAXBContext jaxb = null;
        try {
            jaxb = findJAXBContext(typeArg, annotations, mediaType, true);
        } catch (JAXBException e) {
            throw new JAXBUnmarshalException(e);
        }
        JAXBElement result;
        try {
            Unmarshaller unmarshaller = jaxb.createUnmarshaller();
            unmarshaller = decorateUnmarshaller(type, annotations, mediaType, unmarshaller);

            if (needsSecurity()) {
                unmarshaller = new SecureUnmarshaller(unmarshaller, isDisableExternalEntities(),
                        isEnableSecureProcessingFeature(), isDisableDTDs());
                SAXSource source = null;
                if (getCharset(mediaType) == null) {
                    source = new SAXSource(new InputSource(new InputStreamReader(entityStream, StandardCharsets.UTF_8)));
                } else {
                    source = new SAXSource(new InputSource(entityStream));
                }
                result = unmarshaller.unmarshal(source, (Class) typeArg);
            } else {
                if (getCharset(mediaType) == null) {
                    InputSource is = new InputSource(entityStream);
                    is.setEncoding(StandardCharsets.UTF_8.name());
                    StreamSource source = new StreamSource(new InputStreamReader(entityStream, StandardCharsets.UTF_8));
                    source.setInputStream(entityStream);
                    result = unmarshaller.unmarshal(source, (Class) typeArg);
                } else {
                    JAXBElement e = unmarshaller.unmarshal(new StreamSource(entityStream), (Class) typeArg);
                    result = e;
                }
            }
        } catch (JAXBException e) {
            throw new JAXBUnmarshalException(e);
        }
        JAXBElement element = result;
        return element;
    }

    @Override
    public void writeTo(JAXBElement t,
            Class type,
            Type genericType,
            Annotation[] annotations,
            MediaType mediaType,
            MultivaluedMap httpHeaders,
            OutputStream outputStream) throws IOException {
        LogMessages.LOGGER.debugf("Provider : %s,  Method : writeTo", getClass().getName());
        Class typeArg = Object.class;
        if (genericType != null)
            typeArg = Types.getTypeArgument(genericType);
        super.writeTo(t, typeArg, genericType, annotations, mediaType, httpHeaders, outputStream);
    }

    @Override
    public CompletionStage asyncWriteTo(JAXBElement t, Class type, Type genericType, Annotation[] annotations,
            MediaType mediaType, MultivaluedMap httpHeaders,
            AsyncOutputStream outputStream) {
        LogMessages.LOGGER.debugf("Provider : %s,  Method : writeTo", getClass().getName());
        Class typeArg = Object.class;
        if (genericType != null)
            typeArg = Types.getTypeArgument(genericType);
        return super.asyncWriteTo(t, typeArg, genericType, annotations, mediaType, httpHeaders, outputStream);
    }
}