org.glassfish.jersey.jaxb.internal.AbstractJaxbProvider Maven / Gradle / Ivy
/*
* Copyright (c) 2010, 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.jaxb.internal;
import java.io.InputStream;
import java.lang.annotation.Annotation;
import java.lang.ref.WeakReference;
import java.util.Map;
import java.util.WeakHashMap;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;
import java.util.logging.Level;
import java.util.logging.Logger;
import jakarta.ws.rs.core.Configuration;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.ext.ContextResolver;
import jakarta.ws.rs.ext.Providers;
import jakarta.xml.bind.JAXBContext;
import jakarta.xml.bind.JAXBException;
import jakarta.xml.bind.Marshaller;
import jakarta.xml.bind.PropertyException;
import jakarta.xml.bind.Unmarshaller;
import javax.xml.parsers.SAXParserFactory;
import javax.xml.transform.sax.SAXSource;
import org.glassfish.jersey.internal.util.PropertiesHelper;
import org.glassfish.jersey.internal.util.collection.Value;
import org.glassfish.jersey.internal.util.collection.Values;
import org.glassfish.jersey.message.MessageProperties;
import org.glassfish.jersey.message.XmlHeader;
import org.glassfish.jersey.message.internal.AbstractMessageReaderWriterProvider;
import org.xml.sax.InputSource;
/**
* A base class for implementing JAXB-based readers and writers.
*
* @param Java type supported by the provider.
* @author Paul Sandoz
* @author Marek Potociar
*/
public abstract class AbstractJaxbProvider extends AbstractMessageReaderWriterProvider {
private static final Map, WeakReference> jaxbContexts =
new WeakHashMap, WeakReference>();
private static final Lock jaxbContextsLock = new ReentrantLock();
private final Providers jaxrsProviders;
private final boolean fixedResolverMediaType;
private final Value> mtContext;
private final Value> mtUnmarshaller;
private final Value> mtMarshaller;
private Value formattedOutput = Values.of(Boolean.FALSE);
private Value xmlRootElementProcessing = Values.of(Boolean.FALSE);
/**
* Inheritance constructor.
*
* @param providers JAX-RS providers.
*/
public AbstractJaxbProvider(final Providers providers, final Configuration config) {
this(providers, null, config);
}
/**
* Inheritance constructor.
*
* @param providers JAX-RS providers.
* @param resolverMediaType JAXB component context resolver media type to be used.
*/
public AbstractJaxbProvider(final Providers providers, final MediaType resolverMediaType, final Configuration config) {
this.jaxrsProviders = providers;
fixedResolverMediaType = resolverMediaType != null;
if (fixedResolverMediaType) {
this.mtContext = Values.lazy(new Value>() {
@Override
public ContextResolver get() {
return providers.getContextResolver(JAXBContext.class, resolverMediaType);
}
});
this.mtUnmarshaller = Values.lazy(new Value>() {
@Override
public ContextResolver get() {
return providers.getContextResolver(Unmarshaller.class, resolverMediaType);
}
});
this.mtMarshaller = Values.lazy(new Value>() {
@Override
public ContextResolver get() {
return providers.getContextResolver(Marshaller.class, resolverMediaType);
}
});
} else {
this.mtContext = null;
this.mtUnmarshaller = null;
this.mtMarshaller = null;
}
setConfiguration(config);
}
// TODO This provider should be registered and configured via a feature.
public void setConfiguration(final Configuration config) {
formattedOutput = Values.lazy(new Value() {
@Override
public Boolean get() {
return PropertiesHelper.isProperty(config.getProperty(MessageProperties.XML_FORMAT_OUTPUT));
}
});
xmlRootElementProcessing = Values.lazy(new Value() {
@Override
public Boolean get() {
return PropertiesHelper.isProperty(config.getProperty(MessageProperties.JAXB_PROCESS_XML_ROOT_ELEMENT));
}
});
}
/**
* Check if the given media type is supported by this JAXB entity provider.
*
* Subclasses can override this method. Default implementation always returns {@code true}.
*
*
* @param mediaType media type to be checked for support.
* @return {@code true} if the media type is supported by the entity provider, {@code false} otherwise.
*/
protected boolean isSupported(MediaType mediaType) {
return true;
}
/**
* Get the JAXB unmarshaller for the given class and media type.
*
* In case this provider instance has been {@link AbstractJaxbProvider(Providers, MediaType)
* created with a fixed resolver media type}, the supplied media type argument will be ignored.
*
*
* @param type Java type to be unmarshalled.
* @param mediaType entity media type.
* @return JAXB unmarshaller for the requested Java type, media type combination.
* @throws JAXBException in case retrieving the unmarshaller fails with a JAXB exception.
*/
protected final Unmarshaller getUnmarshaller(Class type, MediaType mediaType) throws JAXBException {
if (fixedResolverMediaType) {
return getUnmarshaller(type);
}
final ContextResolver unmarshallerResolver =
jaxrsProviders.getContextResolver(Unmarshaller.class, mediaType);
if (unmarshallerResolver != null) {
Unmarshaller u = unmarshallerResolver.getContext(type);
if (u != null) {
return u;
}
}
final JAXBContext ctx = getJAXBContext(type, mediaType);
return (ctx == null) ? null : ctx.createUnmarshaller();
}
private Unmarshaller getUnmarshaller(Class type) throws JAXBException {
final ContextResolver resolver = mtUnmarshaller.get();
if (resolver != null) {
Unmarshaller u = resolver.getContext(type);
if (u != null) {
return u;
}
}
final JAXBContext ctx = getJAXBContext(type);
return (ctx == null) ? null : ctx.createUnmarshaller();
}
/**
* Get the JAXB marshaller for the given class and media type.
*
* In case this provider instance has been {@link AbstractJaxbProvider(Providers, MediaType)
* created with a fixed resolver media type}, the supplied media type argument will be ignored.
*
*
* @param type Java type to be marshalled.
* @param mediaType entity media type.
* @return JAXB marshaller for the requested Java type, media type combination.
* @throws JAXBException in case retrieving the marshaller fails with a JAXB exception.
*/
protected final Marshaller getMarshaller(Class type, MediaType mediaType) throws JAXBException {
if (fixedResolverMediaType) {
return getMarshaller(type);
}
final ContextResolver mcr = jaxrsProviders.getContextResolver(Marshaller.class, mediaType);
if (mcr != null) {
Marshaller m = mcr.getContext(type);
if (m != null) {
return m;
}
}
final JAXBContext ctx = getJAXBContext(type, mediaType);
if (ctx == null) {
return null;
}
Marshaller m = ctx.createMarshaller();
if (formattedOutput.get()) {
m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, formattedOutput.get());
}
return m;
}
private Marshaller getMarshaller(Class type) throws JAXBException {
final ContextResolver resolver = mtMarshaller.get();
if (resolver != null) {
Marshaller u = resolver.getContext(type);
if (u != null) {
return u;
}
}
final JAXBContext ctx = getJAXBContext(type);
if (ctx == null) {
return null;
}
Marshaller m = ctx.createMarshaller();
if (formattedOutput.get()) {
m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, formattedOutput.get());
}
return m;
}
private JAXBContext getJAXBContext(Class type, MediaType mt) throws JAXBException {
final ContextResolver cr = jaxrsProviders.getContextResolver(JAXBContext.class, mt);
if (cr != null) {
JAXBContext c = cr.getContext(type);
if (c != null) {
return c;
}
}
return getStoredJaxbContext(type);
}
private JAXBContext getJAXBContext(Class type) throws JAXBException {
final ContextResolver resolver = mtContext.get();
if (resolver != null) {
JAXBContext c = resolver.getContext(type);
if (c != null) {
return c;
}
}
return getStoredJaxbContext(type);
}
/**
* Retrieve cached JAXB context capable of handling the given Java type.
*
* @param type Java type .
* @return JAXB context associated with the Java type.
* @throws JAXBException in case the JAXB context retrieval fails.
*/
protected JAXBContext getStoredJaxbContext(Class type) throws JAXBException {
jaxbContextsLock.lock();
try {
final WeakReference ref = jaxbContexts.get(type);
JAXBContext c = (ref != null) ? ref.get() : null;
if (c == null) {
c = JAXBContext.newInstance(type);
jaxbContexts.put(type, new WeakReference(c));
}
return c;
} finally {
jaxbContextsLock.unlock();
}
}
/**
* Create new {@link javax.xml.transform.sax.SAXSource} for a given entity input stream.
*
* @param spf SAX parser factory to be used to create the SAX source.
* @param entityStream entity input stream.
* @return new {@link javax.xml.transform.sax.SAXSource} representing the entity input stream.
* @throws JAXBException in case SAX source creation fails.
*/
protected static SAXSource getSAXSource(SAXParserFactory spf, InputStream entityStream) throws JAXBException {
try {
return new SAXSource(spf.newSAXParser().getXMLReader(), new InputSource(entityStream));
} catch (Exception ex) {
throw new JAXBException("Error creating SAXSource", ex);
}
}
protected boolean isFormattedOutput() {
return formattedOutput.get();
}
protected boolean isXmlRootElementProcessing() {
return xmlRootElementProcessing.get();
}
/**
* Set the custom XML header on a JAXB marshaller if specified via {@link org.glassfish.jersey.message.XmlHeader} annotation,
* present in the supplied array of annotations.
*
* @param marshaller JAXB marshaller.
* @param annotations array of annotations that MAY contain a {@code XmlHeader} annotation instance.
*/
protected void setHeader(Marshaller marshaller, Annotation[] annotations) {
for (Annotation a : annotations) {
if (a instanceof XmlHeader) {
try {
// standalone jaxb ri
marshaller.setProperty("org.glassfish.jaxb.xmlHeaders", ((XmlHeader) a).value());
} catch (PropertyException e) {
try {
// older name
marshaller.setProperty("com.sun.xml.bind.xmlHeaders", ((XmlHeader) a).value());
} catch (PropertyException ex) {
// other jaxb implementation
Logger.getLogger(AbstractJaxbProvider.class.getName()).log(
Level.WARNING, "@XmlHeader annotation is not supported with this JAXB implementation."
+ " Please use JAXB RI if you need this feature.");
}
}
break;
}
}
}
}