Configure the JAX-RS application.
Define resources in JAX-RS web applications.
Parent
Implement secure JAX-RS applications
With Java EE 6 functionality we can use the annotation scanning capabilities. By using annotation scanning, we can omit a JAX-RS javax.ws.rs.core.Application subclass or have a minimally defined javax.ws.rs.core.Application subclass. Alternatively, we can specify the IBM JAX-RS servlet or filter to use the functionality available in the IBM JAX-RS servlet and filter.
Using one of the JAX-RS Version 1.1 configuration methods, we can omit a javax.ws.rs.core.Application subclass in the 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. Use this method to avoid manually adding 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, we 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 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, to specify security constraints or roles, or to take advantage of other features enabled using a web.xml file, specify the information in a web.xml file.
Choose one of the following three methods to configure the JAX-RS application:
- Configure JAX-RS applications using JAX-RS 1.1 methods
Use this method to use the annotation scanning capabilities or to use the JAX-RS 1.1 configuration methods. We 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.
- Configure web.xml for JAX-RS servlets
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, we can define a servlet path in web.xml appended to the base URL.
- Configure web.xml for JAX-RS filters
Use this method to use the filter when we have JSPs, other servlets and filters, and JAX-RS resources with a mix of URL patterns. We can configure web.xml to define filters indicating URLs on which the filter can be invoked.
What to do next
Secure JAX-RS applications within the web container.
Subtopics
Related tasks
Configure JAX-RS web applications