Jersey 2.29.1 User Guide

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. Deployment agnostic application model

4.2. Reusing Jersey implementation in your custom application model

4.3. Registering SPI implementations using ResourceConfig

4.4. Registering SPI implementations using ResourceConfig subclass

4.5. Using Jersey with JDK HTTP Server

4.6. Using Jersey with Grizzly HTTP Server

4.7. Using Jersey with the Simple framework

4.8. Using Jersey with Jetty HTTP Server

4.9. Using Jersey with Netty HTTP Server

4.10. Hooking up Jersey as a Servlet

4.11. Hooking up Jersey as a Servlet Filter

4.12. Configuring Jersey container Servlet or Filter to use custom Application subclass

4.13. Configuring Jersey container Servlet or Filter to use package scanning

4.14. Configuring Jersey container Servlet or Filter to use a list of classes

4.15. Deployment of a JAX-RS application using @ApplicationPath with Servlet 3.0

4.16. Configuration of maven-war-plugin to ignore missing web.xml

4.17. Deployment of a JAX-RS application using web.xml with Servlet 3.0

4.18. web.xml of a JAX-RS application without an Application subclass

4.19.

4.20.

5.1. POST request with form parameters

5.2. Using JAX-RS Client API

5.3. Using JAX-RS Client API fluently

5.4. Setting JAX-RS Client ExecutorService

5.5. Sending restricted headers with HttpUrlConnector

5.6. Closing connections

5.7. ServiceLocatorClientProvider example

6.1. Excerpt from a synchronous approach while implementing the orchestration layer

6.2. Excerpt from an asynchronous approach while implementing the orchestration layer

6.3. Excerpt from a reactive approach while implementing the orchestration layer

6.4. Synchronous invocation of HTTP requests

6.5. Asynchronous invocation of HTTP requests

6.6. Reactive invocation of HTTP requests

6.7. Creating JAX-RS Client with RxJava reactive extension

6.8. Obtaining Observable<Response> from Jersey/RxJava Client

6.9. Creating JAX-RS Client with RxJava2 reactive extension

6.10. Obtaining Flowable<Response> from Jersey/RxJava Client

6.11. Creating Jersey/Guava Client

6.12. Obtaining ListenableFuture<Response> from Jersey/Guava Client

6.13. Extending RxIvoker

6.14. Extending RxInvokerProvider

7.1. Using File with a specific media type to produce a response

7.2. Returning 201 status code and adding Location header in response to POST request

7.3. Adding an entity body to a custom response

7.4. Throwing exceptions to control response

7.5. Application specific exception implementation

7.6. Mapping generic exceptions to responses

7.7. Conditional GET support

8.1. Example resource class

8.2. MyBean entity class

8.3. MessageBodyWriter example

8.4. Example of assignment of annotations to a response entity

8.5. Client code testing MyBeanMessageBodyWriter

8.6. Result of MyBeanMessageBodyWriter test

8.7. MessageBodyReader example

8.8. Testing MyBeanMessageBodyReader

8.9. Result of testing MyBeanMessageBodyReader

8.10. MessageBodyReader registered on a JAX-RS client

8.11. Result of client code execution

8.12. Usage of MessageBodyWorkers interface

9.1. Simple JAXB bean implementation

9.2. JAXB bean used to generate JSON representation

9.3. Tweaking JSON format using JAXB

9.4. JAXB bean creation

9.5. Constructing a JsonObject (JSON-Processing)

9.6. Constructing a JSONObject (Jettison)

9.7. MoxyJsonConfig - Setting properties.

9.8. Creating ContextResolver<MoxyJsonConfig>

9.9. Setting properties for MOXy providers into Configurable

9.10. Building client with MOXy JSON feature enabled.

9.11. Creating JAX-RS application with MOXy JSON feature enabled.

9.12. Building client with JSON-Processing JSON feature enabled.

9.13. Creating JAX-RS application with JSON-Processing JSON feature enabled.

9.14. ContextResolver<ObjectMapper>

9.15. Building client with Jackson JSON feature enabled.

9.16. Creating JAX-RS application with Jackson JSON feature enabled.

9.17. JAXB beans for JSON supported notations description, simple address bean

9.18. JAXB beans for JSON supported notations description, contact bean

9.19. JAXB beans for JSON supported notations description, initialization

9.20. XML namespace to JSON mapping configuration for Jettison based mapped notation

9.21. JSON expression with XML namespaces mapped into JSON

9.22. JSON Array configuration for Jettison based mapped notation

9.23. JSON expression with JSON arrays explicitly configured via Jersey

9.24. JSON expression produced using badgerfish notation

9.25. ContextResolver<ObjectMapper>

9.26. Building client with Jettison JSON feature enabled.

9.27. Creating JAX-RS application with Jettison JSON feature enabled.

9.28. Simplest case of using @JSONP

9.29. JaxbBean for @JSONP example

9.30. Example of @JSONP with configured parameters.

9.31. Low level XML test - methods added to HelloWorldResource.java

9.32. Planet class

9.33. Resource class

9.34. Method for consuming Planet

9.35. Resource class - JAXBElement

9.36. Client side - JAXBElement

9.37. PlanetJAXBContextProvider

9.38. Using Provider with JAX-RS client

9.39. Add jersey-media-moxy dependency.

9.40. Register the MoxyXmlFeature class.

9.41. Configure and register an MoxyXmlFeature instance.

9.42. Building client with MultiPart feature enabled.

9.43. Creating JAX-RS application with MultiPart feature enabled.

9.44. MultiPart entity

9.45. MultiPart entity in HTTP message.

9.46. FormDataMultiPart entity

9.47. FormDataMultiPart entity in HTTP message.

9.48. Multipart - sending files.

9.49. Resource method using MultiPart as input parameter / return value.

9.50. Use of @FormDataParam annotation

10.1. Container response filter

10.2. Container request filter

10.3. Pre-matching request filter

10.4. Client request filter

10.5. GZIP writer interceptor

10.6. GZIP reader interceptor

10.7. @NameBinding example

10.8. Dynamic binding example

10.9. Priorities example

11.1. Simple async resource

11.2. Simple async method with timeout

11.3. CompletionCallback example

11.4. ChunkedOutput example

11.5. Simple client async invocation

11.6. Simple client fluent async invocation

11.7. Client async callback

11.8. Client async callback for specific entity

11.9. ChunkedInput example

12.1. URI building

12.2. Building URIs using query parameters

13.1. Creating JAX-RS application with Declarative Linking feature enabled.

14.1. A standard resource class

14.2. A programmatic resource

14.3. A programmatic resource

14.4. A programmatic resource

14.5. A programmatic resource

14.6. A programmatic resource

15.1. Adding the SSE dependency

15.2. Simple SSE resource method

15.3. Broadcasting SSE messages (with JAX-RS 2.1 API)

15.4. Consuming SSE events with SseEventSource

15.5. SseEventSource subscribe() methods

15.6. Add jersey-media-sse dependency.

15.7. Simple SSE resource method

15.8. Broadcasting SSE messages

15.9. Registering EventListener with EventSource

15.10. Overriding EventSource.onEvent(InboundEvent) method

16.1. Using SecurityContext for a Resource Selection

16.2. Injecting SecurityContext into a singleton resource

16.3. Securing resources using web.xml

16.4. Registering RolesAllowedDynamicFeature using ResourceConfig

16.5. Registering RolesAllowedDynamicFeature by extending ResourceConfig

16.6. Applying javax.annotation.security to JAX-RS resource methods.

16.7. Build the authorization flow utility

16.8. Perform the OAuth Authorization Flow

16.9. Authenticated requests

16.10. Build feature from Access Token

16.11. Specifying Access Token on a Request.

16.12. Creating Public/Private RSA-SHA1 keys

16.13. Building OAuth 2 Authorization Flow.

17.1. A simple WADL example - JAX-RS resource definition

17.2. A simple WADL example - WADL content

17.3. OPTIONS method returning WADL

17.4. More complex WADL example - JAX-RS resource definition

17.5. More complex WADL example - WADL content

18.1. Configuring Jersey specific properties for Bean Validation.

18.2. Using ValidationConfig to configure Validator.

18.3. Constraint annotations on input parameters

18.4. Constraint annotations on fields

18.5. Constraint annotations on class

18.6. Definition of a constraint annotation

18.7. Validator implementation.

18.8. Entity validation

18.9. Entity validation 2

18.10. Response entity validation

18.11. Validate getter on execution

18.12. Injecting UriInfo into a ConstraintValidator

18.13. Support for injecting Jersey's resources/providers via ConstraintValidatorFactory.

18.14. ValidationError to text/plain

18.15. ValidationError to text/html

18.16. ValidationError to application/xml

18.17. ValidationError to application/json

19.1. Registering and configuring entity-filtering feature on server.

19.2. Registering and configuring entity-filtering feature with security annotations on server.

19.3. Registering and configuring entity-filtering feature based on dynamic and configurable query parameters.

19.4. Registering and configuring entity-filtering feature on client.

19.5. Project

19.6. User

19.7. Task

19.8. ProjectsResource

19.9. ProjectDetailedView

19.10. Annotated Project

19.11. Annotated User

19.12. Annotated Task

19.13. ProjectsResource - Response entity-filtering annotations

19.14. ProjectsResource - Entity-filtering annotations on methods

19.15. Client - Request entity-filtering annotations

19.16. Client - Request entity-filtering annotations

19.17. Sever - Query Parameter driven entity-filtering

19.18.

19.19. Entity-filtering annotation with custom meaning

19.20. Entity Data Filtering support in MOXy JSON binding provider

20.1. Using Viewable in a resource class

20.2. Using @Template on a resource method

20.3. Using @Template on a resource class

20.4. Using absolute path to template in Viewable

20.5. Using @ErrorTemplate on a resource method

20.6. Using @ErrorTemplate with Bean Validation

20.7. Iterating through ValidationError in JSP

20.8. Registering MvcFeature

20.9. Registering FreemarkerMvcFeature

20.10. Setting MvcFeature.TEMPLATE_BASE_PATH value in ResourceConfig

20.11. Setting FreemarkerMvcProperties.TEMPLATE_BASE_PATH value in web.xml

20.12. Including JSP page into JSP page

20.13. Custom TemplateProcessor

20.14. Registering custom TemplateProcessor

21.1. Logging on the client side

21.2. Register LoggingFeature via constructor

21.3. Register LoggingFeature class

22.1. Application event listener

22.2. Request event listener

22.3. Event listener test resource

22.4. Injecting MonitoringStatistics

22.5. Summary level messages

22.6. On demand request, snippet of MVC JSP forwarding

24.1. Bootstrapping Jersey application with Weld support on Grizzly

28.1. Jersey 1 reloader implementation

28.2. Jersey 1 reloader registration

28.3. Jersey 2 reloader implementation

28.4. Jersey 2 reloader registration

28.5. Initializing JAXB-based support with MOXy