Jersey 2.0.1 User Guide
   Next
Links: Table of Contents | Single HTML

Jersey 2.0.1 User Guide

Table of Contents

1. Preface
1. Getting Started
1.1. Creating a New Project from Maven Archetype
1.2. Exploring the Newly Created Project
1.3. Customizing the JAX-RS Resource
1.4. Running the Project
1.5. Creating a JavaEE Web Application
1.6. Exploring Other Jersey Examples
2. Jersey Modules and Dependencies
2.1. Sample Scenarios
2.1.1. Basic Server-Side Application
3. JAX-RS Application, Resources and Sub-Resources
3.1. Root Resource Classes
3.1.1. @Path
3.1.2. @GET, @PUT, @POST, @DELETE, ... (HTTP Methods)
3.1.3. @Produces
3.1.4. @Consumes
3.2. Parameter Annotations (@*Param)
3.3. Sub-resources
3.4. Life-cycle of Root Resource Classes
3.5. Rules of Injection
3.6. Use of @Context
3.7. Programmatic resource model
4. Representations and Responses
4.1. Representations and Java Types
4.2. Building Responses
4.3. WebApplicationException and Mapping Exceptions to Responses
4.4. Conditional GETs and Returning 304 (Not Modified) Responses
5. URIs and Links
5.1. Building URIs
6. Deploying a RESTful Web Service
7. Client API
7.1. Uniform Interface Constraint
7.2. Ease of use and reusing JAX-RS artifacts
7.3. Getting started with the Jersey client
7.4. Overview of the API
7.4.1. Configuring a Client and WebResource
7.4.2. Building a request
7.4.3. Receiving a response
7.4.4. Creating new WebResources from a WebResource
7.4.5. Java instances and types for representations
7.5. Adding support for new representations
7.6. Using filters
7.6.1. Supported filters
7.7. Testing services
7.8. Security with Http(s)URLConnection
7.8.1. With Http(s)URLConnection
7.8.2. With Apache HTTP client
8. Filters and Interceptors
9. Message Body Workers
10. Asynchronous Services and Clients
11. Programmatic API for Building Resources
11.1. Introduction
11.2. Programmatic Hello World example
11.2.1. Deployment of programmatic resources
11.3. Additional examples
11.4. Model processors
12. Support for Common Media Types
12.1. JSON
12.2. XML
12.3. Multipart
13. Support for Server-Sent Events
14. Security
15. WADL Support
16. Jersey Test Framework
17. Building and Testing Jersey
17.1. Checking Out the Source
17.2. Building the Source
17.3. Testing
17.4. Using NetBeans
18. Migrating from Jersey 1.x
18.1. Server API
18.1.1. Injecting custom objects
18.1.2. ResourceConfig Reload
18.1.3. MessageBodyReaders and MessageBodyWriters ordering
18.2. Client API
18.2.1. Making a simple client request
18.2.2. Registering filters
18.2.3. Setting "Accept" header
18.2.4. Attaching entity to request
18.2.5. Setting SSLContext and/or HostnameVerifier

List of Tables

2.1. Jersey modules and dependencies
3.1.
3.2.
18.1. Mapping of Jersey 1.x to JAX-RS 2.0 client classes

List of Examples

3.1. Simple hello world root resource class
3.2. Specifying URI path parameter
3.3. PUT method
3.4. Specifying output MIME type
3.5. Using multiple output MIME types
3.6. Server-side content negotiation
3.7. Specifying input MIME type
3.8. Query parameters
3.9. Custom Java type for consuming request parameters
3.10. Processing POSTed HTML form
3.11. Obtaining general map of URI path and/or query parameters
3.12. Obtaining general map of header parameters
3.13. Obtaining general map of form parameters
3.14. Example of the bean which will be used as @BeanParam
3.15. Injection of MyBeanParam as a method parameter:
3.16. Injection of more beans into one resource methods:
3.17. Sub-resource methods
3.18. Sub-resource locators
3.19. Sub-resource locators with empty path
3.20. Sub-resource locators returning sub-type
3.21. Sub-resource locators created from classes
3.22. Sub-resource locators returning resource model
3.23. Injection
3.24. Wrong injection into a singleton scope
3.25. Injection of proxies into singleton
3.26. Example of possible injections
4.1. Using File with a specific MIME type to produce a response
4.2. Returning 201 status code and adding Location header in response to POST request
4.3. Adding an entity body to a custom response
4.4. Throwing Jersey specific exceptions to control response
4.5. Jersey specific exception implementation
4.6. Mapping generic exceptions to responses
4.7. Conditional GET support
5.1. URI building
5.2. Building URIs using query parameters
6.1. Deployment agnostic application model
6.2. Reusing Jersey implementation in your custom application model
6.3. Deployment of a JAX-RS application using @ApplicationPath with Servlet 3.0
6.4. Configuration of maven-war-plugin in pom.xml with Servlet 3.0
6.5. Deployment of a JAX-RS application using web.xml with Servlet 3.0
6.6. Deployment of your application using Jersey specific servlet
6.7. Using Jersey specific servlet without an application model instance
7.1. POST request with form parameters
11.1. A standard resource class
11.2. A programmatic resource
11.3. A programmatic resource
11.4. A programmatic resource
11.5. A programmatic resource
11.6. A programmatic resource
14.1. Accessing SecurityContext
18.1. Jersey 1 reloader implementation
18.2. Jersey 1 reloader registration
18.3. Jersey 2 reloader implementation
18.4. Jersey 2 reloader registration
   Next