JBoss.orgCommunity Documentation

Next

RESTEasy JAX-RS

RESTFul Web Services for Java

1. Overview

3. Installation/Configuration

3.1. Upgrading Resteasy Within JBoss AS 7
3.2. Configuring in JBoss AS 7
3.1. Resteasy Modules in AS7
3.3. Standalone Resteasy
3.4. Configuration Switches
3.5. javax.ws.rs.core.Application
3.6. RESTEasy as a ServletContextListener
3.7. RESTEasy as a servlet Filter
3.8. 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

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
21.2. JSONP Support

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
22.15. Overwriting the content type for multipart messages
22.16. Overwriting the default fallback charset for multipart messages

23. YAML Provider

24. String marshalling for String based @*Param

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. Filters and Interceptors

30.1. Server Side Filters
30.2. Client Side Filters
30.3. Reader and Writer Interceptors
30.4. Per Resource Method Filters and Interceptors
30.5. Ordering

31. Asynchronous HTTP Request Processing

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
33.3. Netty

34. Server-side Mock Framework

35. Securing JAX-RS and RESTeasy

36. OAuth 2.0 and Resteasy Skeleton Key

36.1. System Requirements

36.2. Generate the Security Domain Key Pair

36.3. Setting up the Auth Server

36.3.1. Setting up your Security Domain
36.3.2. Auth Server Config File
36.3.3. Set up web.xml
36.3.4. Set up jboss-web.xml
36.3.5. Set up jboss-deployment-structure.xml
36.3.6. Tweak your login page

36.4. Setting Up An App for SSO

36.4.1. SSO config file
36.4.2. Set up web.xml
36.4.3. Set up jboss-web.xml
36.4.4. Set up jboss-deployment-structure.xml

36.5. Bearer Token only Setup

36.5.1. Bearer token auth config file
36.5.2. Set up web.xml
36.5.3. Set up jboss-web.xml
36.5.4. Set up jboss-deployment-structure.xml

36.6. Obtaining an access token programmatically.

36.7. Access remote services securely in a secure web session

36.8. Check Out the OAuth2 Example!

36.9. Auth Server Action URLs

37. Authentication

37.1. OAuth core 1.0a

37.1.1. Authenticating with OAuth 1.0a
37.1.2. Accessing protected resources
37.1.3. Implementing an OAuthProvider

38. Doseta Digital Signature Framework

38.1. Maven settings

38.2. Signing API

38.2.1. @Signed annotation

38.3. Signature Verification API

38.3.1. Annotation-based verification

38.4. Managing Keys via a KeyRepository

38.4.1. Create a KeyStore
38.4.2. Configure Restreasy to use the KeyRepository
38.4.3. Using DNS to Discover Public Keys

39. Body Encryption and Signing via SMIME

39.1. Maven settings
39.2. Message Body Encryption
39.3. Message Body Signing
39.4. application/pkcs7-signature

40. EJB Integration

41. Spring Integration

42. CDI Integration

42.1. Using CDI beans as JAX-RS components
42.2. Default scopes
42.3. Configuration within JBoss 6 M4 and Higher
42.4. Configuration with different distributions

43. Seam Integration

44. Guice 3.0 Integration

44.1. Configuring Stage

45. Resteasy Client API

45.1. JAX-RS 2.0 Client API
45.2. Resteasy Proxy Framework
45.3. Apache HTTP Client 4.x and other backends

46. AJAX Client

46.1. Generated JavaScript API

46.1.1. JavaScript API servlet
46.1.2. JavaScript API usage
46.1.3. Work with @Form
46.1.4. MIME types and unmarshalling.
46.1.5. MIME types and marshalling.

46.2. Using the JavaScript API to build AJAX queries

46.2.1. The REST object
46.2.2. The REST.Request class

46.3. Caching Features

47. Validation

47.1. Providing a ValidatorAdapter to RESTEasy
47.2. Telling RESTEasy what needs validation
47.3. Bean Validation API integration

48. Maven and RESTEasy

49. JBoss AS 5.x Integration

50. JBoss AS 6/7 Integration

51. Documentation Support

52. Migration from older versions

52.1. Migrating from 3.0-beta-4 and 3.0-beta-4
52.2. Migrating from 3.0-beta-1 and 3.0-beta-4
52.3. Migrating from 2.x to 3.0-beta-1
52.4. Migrating from 2.3.2 to 2.3.3
52.5. Migrating from 2.3.0 to 2.3.1
52.6. Migrating from 2.2.x to 2.3
52.7. Migrating from 2.2.0 to 2.2.1
52.8. Migrating from 2.1.x to 2.2
52.9. Migrating from 2.0.x to 2.1
52.10. Migrating from 1.2.x to 2.0
52.11. Migrating from 1.2.GA to 1.2.1.GA
52.12. Migrating from 1.1 to 1.2

53. Books You Can Read

NextPreface