All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.glassfish.jersey.message.internal.AbstractRootElementJaxbProvider Maven / Gradle / Ivy

Go to download

A bundle project producing JAX-RS RI bundles. The primary artifact is an "all-in-one" OSGi-fied JAX-RS RI bundle (jaxrs-ri.jar). Attached to that are two compressed JAX-RS RI archives. The first archive (jaxrs-ri.zip) consists of binary RI bits and contains the API jar (under "api" directory), RI libraries (under "lib" directory) as well as all external RI dependencies (under "ext" directory). The secondary archive (jaxrs-ri-src.zip) contains buildable JAX-RS RI source bundle and contains the API jar (under "api" directory), RI sources (under "src" directory) as well as all external RI dependencies (under "ext" directory). The second archive also contains "build.xml" ANT script that builds the RI sources. To build the JAX-RS RI simply unzip the archive, cd to the created jaxrs-ri directory and invoke "ant" from the command line.

There is a newer version: 3.1.8
Show newest version
/*
 * 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.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.nio.charset.Charset;

import javax.ws.rs.BadRequestException;
import javax.ws.rs.InternalServerErrorException;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.ext.Providers;

import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.bind.UnmarshalException;
import javax.xml.bind.Unmarshaller;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import javax.xml.transform.stream.StreamSource;

import org.glassfish.jersey.internal.LocalizationMessages;
import javax.ws.rs.core.NoContentException;

/**
 * An abstract provider for JAXB types that are annotated with
 * {@link XmlRootElement} or {@link XmlType}.
 * 

* Implementing classes may extend this class to provide specific marshalling * and unmarshalling behaviour. *

* When unmarshalling a {@link UnmarshalException} will result in a * {@link WebApplicationException} being thrown with a status of 400 * (Client error), and a {@link JAXBException} will result in a * {@link WebApplicationException} being thrown with a status of 500 * (Internal Server error). *

* When marshalling a {@link JAXBException} will result in a * {@link WebApplicationException} being thrown with a status of 500 * (Internal Server error). * * @author Paul Sandoz * @author Marek Potociar (marek.potociar at oracle.com) */ public abstract class AbstractRootElementJaxbProvider extends AbstractJaxbProvider { public AbstractRootElementJaxbProvider(Providers ps) { super(ps); } public AbstractRootElementJaxbProvider(Providers ps, MediaType mt) { super(ps, mt); } @Override public boolean isReadable(Class type, Type genericType, Annotation annotations[], MediaType mediaType) { return (type.getAnnotation(XmlRootElement.class) != null || type.getAnnotation(XmlType.class) != null) && isSupported(mediaType); } @Override public boolean isWriteable(Class type, Type genericType, Annotation annotations[], MediaType mediaType) { return type.getAnnotation(XmlRootElement.class) != null && isSupported(mediaType); } @Override public final Object readFrom( Class type, Type genericType, Annotation annotations[], MediaType mediaType, MultivaluedMap httpHeaders, InputStream inputStream) throws IOException { try { final EntityInputStream entityStream = EntityInputStream.create(inputStream); if (entityStream.isEmpty()) { throw new NoContentException(LocalizationMessages.ERROR_READING_ENTITY_MISSING()); } return readFrom(type, mediaType, getUnmarshaller(type, mediaType), entityStream); } catch (UnmarshalException ex) { throw new BadRequestException(ex); } catch (JAXBException ex) { throw new InternalServerErrorException(ex); } } /** * Unmarshal a JAXB type. *

* Implementing classes may override this method. * * @param type the JAXB type * @param mediaType the media type * @param u the unmarshaller to use for unmarshalling. * @param entityStream the input stream to unmarshal from. * @return an instance of the JAXB type. * @throws javax.xml.bind.JAXBException */ protected Object readFrom(Class type, MediaType mediaType, Unmarshaller u, InputStream entityStream) throws JAXBException { if (type.isAnnotationPresent(XmlRootElement.class)) { return u.unmarshal(entityStream); } else { return u.unmarshal(new StreamSource(entityStream), type).getValue(); } } @Override public final void writeTo( Object t, Class type, Type genericType, Annotation annotations[], MediaType mediaType, MultivaluedMap httpHeaders, OutputStream entityStream) throws IOException { try { final Marshaller m = getMarshaller(type, mediaType); final Charset c = getCharset(mediaType); if (c != UTF8) { m.setProperty(Marshaller.JAXB_ENCODING, c.name()); } setHeader(m, annotations); writeTo(t, mediaType, c, m, entityStream); } catch (JAXBException ex) { throw new InternalServerErrorException(ex); } } /** * Marshal an instance of a JAXB type. *

* Implementing classes may override this method. * * @param t the instance of the JAXB type. * @param mediaType the meida type. * @param c the character set to serialize characters to. * @param m the marshaller to marshaller the instance of the JAXB type. * @param entityStream the output stream to marshal to. * @throws javax.xml.bind.JAXBException */ protected void writeTo(Object t, MediaType mediaType, Charset c, Marshaller m, OutputStream entityStream) throws JAXBException { m.marshal(t, entityStream); } }