com.sun.jersey.api.json.package-info Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2011 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.
*/
/**
* Provides support for enabling and configuring JSON.
*
* Besides enabling JSON, the API also allows customization of the JSON format
* produced and consumed with JAXB beans.
* Such customization requires that an implementation of
* {@link javax.ws.rs.ext.ContextResolver} returns a configured
* {@link com.sun.jersey.api.json.JSONJAXBContext} instance.
*
*
For example, if the following two JAXB beans are defined:
*
* @XmlRootElement
* public class BeanOne {
* public String name;
* public int number;
* }
*
* @XmlRootElement
* public class BeanTwo {
* public List<String> titles;
* }
*
*
* And the following resource class uses the above JAXB beans:
*
*
* @Path("beans")
* public class MyResource {
*
* @GET @Path("one") @Produces(MediaType.APPLICATION_JSON)
* public BeanOne getOne() {
* BeanOne one = new BeanOne();
* one.name = "Howard";
* one.number = 3;
* return one;
* }
*
* @GET @Path("two") @Produces(MediaType.APPLICATION_JSON)
* public BeanTwo getTwo() {
* BeanTwo two = new BeanTwo();
* two.titles = new ArrayList(1){{add("Title1");}};
* return two;
* }
*
*
*
* Then, for the URI path beans/one, the following JSON will be
* produced:
*
* {"name":"Howard","number":"3"}
*
* However, it might be required that the JSON object named number have
* a non-String value 3.
*
* And, for the URI path beans/two, the following JSON will be
* produced:
*
* {"titles":"Title1"}
*
* However, it might be required that the JSON object named titles
* have a JSON array value ["Title1"],
* since the titles field on the JAXB bean BeanTwo
* represents an array, thus enabling consuming of such JSON values the same way on
* the client side no matter how many elements the array contains.
*
* The {@link com.sun.jersey.api.json.JSONJAXBContext} may be configured to enable
* such required production of JSON as described above in the following manner:
*
* @Provider
* public final class JAXBContextResolver implements ContextResolver<JAXBContext> {
*
* private final JAXBContext context;
*
* private final Set<Class> types;
*
* private final Class[] cTypes = {BeanOne.class, BeanTwo.class};
*
* public JAXBContextResolver() throws JAXBException {
* this.context = new JSONJAXBContext(JSONConfiguration.natural().build(), cTypes);
* this.types = new HashSet(Arrays.asList(cTypes));
* }
*
* public JAXBContext getContext(Class<?> objectType) {
* return (types.contains(objectType)) ? context : null;
* }
* }
*
*
* Then, the produced JSON would become: {"name":"Howard","number":3}
* and {"titles":["Title1"]} respectively for the URI paths
* beans/one and beans/two. Please note, that you do not need
* to configure this in much detail. Using {@link com.sun.jersey.api.json.JSONConfiguration.Notation#NATURAL} notation
* means that Jersey JSON processor will autamatically take care about numbers, booleans and arrays. This notation
* will probably become the default one for Jersey in one of the future releases.
*
* For a complete set of supported properties, see
* {@link com.sun.jersey.api.json.JSONConfiguration.Builder}.
*/
package com.sun.jersey.api.json;