org.glassfish.jersey.message.internal.AbstractJaxbProvider Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ehcache Show documentation
Show all versions of ehcache Show documentation
Ehcache is an open source, standards-based cache used to boost performance,
offload the database and simplify scalability. Ehcache is robust, proven and full-featured and
this has made it the most widely-used Java-based cache.
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.jersey.message.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.logging.Level;
import java.util.logging.Logger;
import javax.ws.rs.core.Configuration;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.ext.ContextResolver;
import javax.ws.rs.ext.Providers;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.bind.PropertyException;
import javax.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.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 (marek.potociar at oracle.com)
*/
public abstract class AbstractJaxbProvider extends AbstractMessageReaderWriterProvider {
private static final Map, WeakReference> jaxbContexts =
new WeakHashMap, WeakReference>();
private final Providers ps;
private final boolean fixedMediaType;
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);
public AbstractJaxbProvider(final Providers ps) {
this(ps, null);
}
public AbstractJaxbProvider(final Providers ps, final MediaType mt) {
this.ps = ps;
fixedMediaType = mt != null;
if (fixedMediaType) {
this.mtContext = Values.lazy(new Value>() {
@Override
public ContextResolver get() {
return ps.getContextResolver(JAXBContext.class, mt);
}
});
this.mtUnmarshaller = Values.lazy(new Value>() {
@Override
public ContextResolver get() {
return ps.getContextResolver(Unmarshaller.class, mt);
}
});
this.mtMarshaller = Values.lazy(new Value>() {
@Override
public ContextResolver get() {
return ps.getContextResolver(Marshaller.class, mt);
}
});
} else {
this.mtContext = null;
this.mtUnmarshaller = null;
this.mtMarshaller = null;
}
}
// TODO This provider should be registered and configured via a feature.
@Context
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));
}
});
}
protected boolean isSupported(MediaType m) {
return true;
}
protected final Unmarshaller getUnmarshaller(Class type, MediaType mt) throws JAXBException {
if (fixedMediaType) {
return getUnmarshaller(type);
}
final ContextResolver uncr = ps.getContextResolver(Unmarshaller.class, mt);
if (uncr != null) {
Unmarshaller u = uncr.getContext(type);
if (u != null) {
return u;
}
}
final JAXBContext ctx = getJAXBContext(type, mt);
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();
}
protected final Marshaller getMarshaller(Class type, MediaType mt) throws JAXBException {
if (fixedMediaType) {
return getMarshaller(type);
}
final ContextResolver mcr = ps.getContextResolver(Marshaller.class, mt);
if (mcr != null) {
Marshaller m = mcr.getContext(type);
if (m != null) {
return m;
}
}
final JAXBContext ctx = getJAXBContext(type, mt);
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 = ps.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);
}
protected JAXBContext getStoredJaxbContext(Class type) throws JAXBException {
synchronized (jaxbContexts) {
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;
}
}
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();
}
protected void setHeader(Marshaller m, Annotation[] annotations) throws PropertyException {
for (Annotation a : annotations) {
if (a instanceof XmlHeader) {
try {
// standalone jaxb ri
m.setProperty("com.sun.xml.bind.xmlHeaders", ((XmlHeader) a).value());
} catch (PropertyException e) {
try {
// jaxb ri from jdk
m.setProperty("com.sun.xml.internal.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;
}
}
}
}