Skip to content

Latest commit

 

History

History
 
 

jacksonjsonprovider

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
README.html
README.html
 
 
pom.xml
pom.xml
 
 

README.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!--

    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.

    Portions Copyright 2012 Talend
-->
<html>
<head>
<title>Jackson JAX-RS JSON Provider Example</title>
<style type="text/css"><!--
  .figure { text-align:center;
            margin: 20px}
  .cliSample { background-color:lightgray }
--></style>
</head>


  <body>
    <h1>Jackson JAX-RS JSON Provider Example</h1>
    <p>This example demonstrates how to produce/consume JSON representation from Java objects. This applies not only to JAXB beans, as shown at <tt>json-from-jaxb</tt> example
    but also to ordinary, unannotated, POJOs.
    <p>A simple web application is presented with three simple read-only resources: One is based on a simple unannotated POJO, and can only provide JSON based representations.  For this resource the JSON representation is produced by the Jackson JAX-RS provider, while the XML representation is generated by JAXB as usual. The second web resource is based on a simple un-annotated POJO and provides only JSON-based representations: JSON and JSON with padding (JSONP). The third resource depicts how Jackson and JAXB annotations could be mixed together within a single POJO.</p>


    <h2>Contents</h2>
    <p>The "empty array" web resource is implemented by <code>com.sun.jersey.samples.jacksonjsonprovider.EmptyArrayResource</code> class.
    The "non JAXB" web resource is implemented by <code>com.sun.jersey.samples.jacksonjsonprovider.NonJAXBBeanResource</code> class.
    <p>The mapping of the URI path space is presented in the following table:</p>
	<table border="1">
	<tr>
	<th>URI path</th>
	<th>Resource class</th>
	<th>HTTP methods</th>
	</tr>

	<tr>
	<td>/emptyArrayResource</td>
	<td>EmptyArrayResource</td>
	<td>GET</td>
	</tr>

	<tr>
	<td>/nonJAXBResource</td>
	<td>NonJAXBBeanResource</td>
	<td>GET</td>
	</tr>

    </table>
    
    <p>Please note the <code>JSONConfiguration.FEATURE_POJO_MAPPING</code> 
    feature set with the init parameters in the example Main class. 
    This feature enables the Jackson JAX-RS provider. 
    It the feature would be set to false or was missing,
    the Jackson entity providers would not be utilized.

    <p>To use Jackson specific configuration options, one can implement
        a <code>ContextResolver&lt;ObjectMapper&gt;</code> provider.
        For an example of such implementation, see <code>MyObjectMapperProvider</code> class.
    
    <h2>Running the Example</h2>
         <p>Run the example as follows:</p>
        <blockquote><pre>
mvn clean compile exec:java</pre></blockquote>
        <p>This deploys the JSON from JAXB example using 
            <a href="http://grizzly.java.net/">Grizzly</a>
        </p>
        <p>A <a href="http://wadl.java.net/#spec">WADL description</a> may be accessed at the URL:</p>
        <blockquote><code><a href="http://localhost:9998/jacksonjsonprovider?_wadl">http://localhost:9998/jacksonjsonprovider?_wadl</a></code></blockquote>
	
	<p>The three resources can be accessed via</p>
	<blockquote><code><a href="http://localhost:9998/jacksonjsonprovider/emptyArrayResource">http://localhost:9998/jacksonjsonprovider/emptyArrayResource</a></code></blockquote>
	<blockquote><code><a href="http://localhost:9998/jacksonjsonprovider/nonJAXBResource">http://localhost:9998/jacksonjsonprovider/nonJAXBResource</a></code></blockquote>
	<blockquote><code><a href="http://localhost:9998/jacksonjsonprovider/combinedAnnotations">http://localhost:9998/jacksonjsonprovider/combinedAnnotations</a></code></blockquote>
	
        <p>To easily obtain the different output types available, <a href="http://curl.haxx.se/">cURL</a> can be used as follows:</p>

        <p>Obtain the JSON output of EmptyArrayResource (use <code>-HAccept:application/xml</code> for XML output):</p>
        <blockquote><pre>curl -HAccept:application/json http://localhost:9998/jacksonjsonprovider/emptyArrayResource</pre></blockquote>
    
        <p>Obtain the JSON output of NonJAXBBeanResource:</p>
        <blockquote><pre>curl -HAccept:application/json http://localhost:9998/jacksonjsonprovider/nonJAXBResource</pre></blockquote>
	
        <p>Obtain the JSONP output of NonJAXBBeanResource:</p>
        <blockquote><pre>curl -HAccept:application/x+javascript http://localhost:9998/jacksonjsonprovider/nonJAXBResource?_jsonp=myCallback</pre></blockquote>

	<p>Obtain the JSON output of CombinedAnnotationResource:</p>
	<blockquote><pre>curl -HAccept:application/json http://localhost:9998/jacksonjsonprovider/combinedAnnotations</pre></blockquote>
  </body>
</html>