JBoss.orgCommunity Documentation

RESTEasy JAX-RS

RESTFul Web Services for Java

2.3.3.Final


Preface
1. Overview
2. License
3. Installation/Configuration
3.1. Standalone Resteasy
3.2. Configuration Switches
3.3. javax.ws.rs.core.Application
3.4. RESTEasy as a ServletContextListener
3.5. RESTEasy as a servlet Filter
3.6. Install/Config in JBoss 6-M4 and Higher
3.7. RESTEasyLogging
4. Using @Path and @GET, @POST, etc.
4.1. @Path and regular expression mappings
5. @PathParam
5.1. Advanced @PathParam and Regular Expressions
5.2. @PathParam and PathSegment
6. @QueryParam
7. @HeaderParam
8. Linking resources
8.1. Link Headers
8.2. Atom links in the resource representations
8.2.1. Configuration
8.2.2. Your first links injected
8.2.3. Customising how the Atom links are serialised
8.2.4. Specifying which JAX-RS methods are tied to which resources
8.2.5. Specifying path parameter values for URI templates
8.2.6. Securing entities
8.2.7. Extending the UEL context
8.2.8. Resource facades
9. @MatrixParam
10. @CookieParam
11. @FormParam
12. @Form
13. @DefaultValue
14. @Encoded and encoding
15. @Context
16. JAX-RS Resource Locators and Sub Resources
17. JAX-RS Content Negotiation
17.1. URL-based negotiation
17.2. Query String Parameter-based negotiation
18. Content Marshalling/Providers
18.1. Default Providers and default JAX-RS Content Marshalling
18.2. Content Marshalling with @Provider classes
18.3. Providers Utility Class
18.4. Configuring Document Marshalling
19. JAXB providers
19.1. JAXB Decorators
19.2. Pluggable JAXBContext's with ContextResolvers
19.3. JAXB + XML provider
19.3.1. @XmlHeader and @Stylesheet
19.4. JAXB + JSON provider
19.5. JAXB + FastinfoSet provider
19.6. Arrays and Collections of JAXB Objects
19.6.1. JSON and JAXB Collections/arrays
19.7. Maps of JAXB Objects
19.7.1. JSON and JAXB maps
19.7.2. Possible Problems with Jettison Provider
19.8. Interfaces, Abstract Classes, and JAXB
19.9. Configurating JAXB Marshalling
20. Resteasy Atom Support
20.1. Resteasy Atom API and Provider
20.2. Using JAXB with the Atom Provider
21. JSON Support via Jackson
21.1. Possible Conflict With JAXB Provider
22. Multipart Providers
22.1. Input with multipart/mixed
22.2. java.util.List with multipart data
22.3. Input with multipart/form-data
22.4. java.util.Map with multipart/form-data
22.5. Input with multipart/related
22.6. Output with multipart
22.7. Multipart Output with java.util.List
22.8. Output with multipart/form-data
22.9. Multipart FormData Output with java.util.Map
22.10. Output with multipart/related
22.11. @MultipartForm and POJOs
22.12. XML-binary Optimized Packaging (Xop)
22.13. Note about multipart parsing and working with other frameworks
22.14. Overwriting the default fallback content type for multipart messages
23. YAML Provider
24. String marshalling for String based @*Param
24.1. StringConverter
24.2. StringParamUnmarshaller
25. Responses using javax.ws.rs.core.Response
26. Exception Handling
26.1. Exception Mappers
26.2. Resteasy Built-in Internally-Thrown Exceptions
26.3. Overriding Resteasy Builtin Exceptions
27. Configuring Individual JAX-RS Resource Beans
28. GZIP Compression/Decompression
29. Resteasy Caching Features
29.1. @Cache and @NoCache Annotations
29.2. Client "Browser" Cache
29.3. Local Server-Side Response Cache
30. Interceptors
30.1. MessageBodyReader/Writer Interceptors
30.2. PreProcessInterceptor
30.3. PostProcessInterceptors
30.4. ClientExecutionInterceptors
30.5. Binding Interceptors
30.6. Registering Interceptors
30.7. Interceptor Ordering and Precedence
30.7.1. Custom Precedence
31. Asynchronous HTTP Request Processing
31.1. Tomcat 6 and JBoss 4.2.3 Support
31.2. Servlet 3.0 Support
31.3. JBossWeb, JBoss AS 5.0.x Support
32. Asynchronous Job Service
32.1. Using Async Jobs
32.2. Oneway: Fire and Forget
32.3. Setup and Configuration
33. Embedded Containers
33.1. Sun JDK HTTP Server
33.2. TJWS Embeddable Servlet Container
34. Server-side Mock Framework
35. Securing JAX-RS and RESTeasy
36. Authentication
36.1. OAuth core 1.0a
36.1.1. Authenticating with OAuth
36.1.2. Accessing protected resources
36.1.3. Implementing an OAuthProvider
37. Doseta Digital Signature Framework
37.1. Maven settings
37.2. Signing API
37.2.1. @Signed annotation
37.3. Signature Verification API
37.3.1. Annotation-based verification
37.4. Managing Keys via a KeyRepository
37.4.1. Create a KeyStore
37.4.2. Configure Restreasy to use the KeyRepository
37.4.3. Using DNS to Discover Public Keys
38. Body Encryption and Signing via SMIME
38.1. Maven settings
38.2. Message Body Encryption
38.3. Message Body Signing
39. EJB Integration
40. Spring Integration
41. CDI Integration
41.1. Using CDI beans as JAX-RS components
41.2. Default scopes
41.3. Configuration within JBoss 6 M4 and Higher
41.4. Configuration with different distributions
42. Seam Integration
43. Guice 2.0 Integration
43.1. Configuring Stage
44. Client Framework
44.1. Abstract Responses
44.2. Sharing an interface between client and server
44.3. Client Error Handling
44.4. Manual ClientRequest API
44.5. Spring integration on client side
44.6. Transport Layer
45. AJAX Client
45.1. Generated JavaScript API
45.1.1. JavaScript API servlet
45.1.2. JavaScript API usage
45.1.3. MIME types and unmarshalling.
45.1.4. MIME types and marshalling.
45.2. Using the JavaScript API to build AJAX queries
45.2.1. The REST object
45.2.2. The REST.Request class
46. Validation
46.1. Providing a ValidatorAdapter to RESTEasy
46.2. Telling RESTEasy what needs validation
46.3. Bean Validation API integration
47. Maven and RESTEasy
48. JBoss AS 5.x Integration
49. JBoss AS 6 Integration
50. Documentation Support
51. Migration from older versions
51.1. Migrating from 2.3.2 to 2.3.3
51.2. Migrating from 2.3.0 to 2.3.1
51.3. Migrating from 2.2.x to 2.3
51.4. Migrating from 2.2.0 to 2.2.1
51.5. Migrating from 2.1.x to 2.2
51.6. Migrating from 2.0.x to 2.1
51.7. Migrating from 1.2.x to 2.0
51.8. Migrating from 1.2.GA to 1.2.1.GA
51.9. Migrating from 1.1 to 1.2
52. Books You Can Read