![]() |
![]() |
You can configure JAX-RS applications in multiple ways depending on your needs. To take advantage of the Java Platform, Enterprise Edition (Java EE) 6 functionality, you can use the annotation scanning capabilities. By using annotation scanning, you can omit a JAX-RS javax.ws.rs.core.Application subclass or have a minimally defined javax.ws.rs.core.Application subclass. Alternatively, you can specify the IBM® JAX-RS servlet or filter if you want to use the functionality available in the IBM® JAX-RS servlet and filter.
Using one of the JAX-RS Version 1.1 configuration methods, you can omit a javax.ws.rs.core.Application subclass in your application or have a javax.ws.rs.core.Application subclass that returns an empty set of classes to inform the JAX-RS runtime environment to find and use all the JAX-RS classes in the application. You might want to use this method when you do not want to have to manually add every relevant JAX-RS class to a javax.ws.rs.core.Application subclass as you develop the application.
By specifying the specific IBM® JAX-RS servlet and filter, you can take advantage of and ensure specific IBM® JAX-RS behavior. For example, using the IBM® JAX-RS filter can be helpful in developing a web application with a mix of JAX-RS resources and JavaServer Pages (JSP) files with the same URL patterns.
Even though there is a JAX-RS V1.1 configuration method that supports the use of an optional web.xml file, if you want to specify security constraints or roles, or you want to take advantage of other features enabled using a web.xml file, you must specify the information in a web.xml file.
Choose one of the following three methods to configure your JAX-RS application:
Use this method if you want to use the annotation scanning capabilities or to use the JAX-RS 1.1 configuration methods. You can use the annotation scanning capabilities to promote application portability, to minimize the amount of configuration code, or to dynamically modify the application without changes to the application code.
Use this method if you want to specify features that are enabled using servlet initialization parameters to change the behavior and ensure that you get the IBM® JAX-RS servlet. When using servlets, you can define a servlet path in the web.xml file that is appended to the base URL.
Use this method if you want to use the filter when you have JSPs, other servlets and filters, and JAX-RS resources with a mix of URL patterns. You can configure the web.xml file to define filters that indicate the possible URLs on which the filter can be invoked.
Implement a resource method using JAXB objects for XML content.
![]() |
![]() |