+

Search Tips   |   Advanced Search

Use Java contexts and dependency injection with JAX-RS

Java API for RESTful Web Services (JAX-RS) root resources and providers can be used in a Java Contexts and Dependency Injection (JCDI) enabled web archive (WAR). Simply add a valid WEB-INF/beans.xml file to the WAR file and any JAX-RS root resources and providers that are valid JCDI beans can use JCDI functionality.

JAX-RS classes in a JCDI-enabled archive can have @javax.inject.Inject annotated injection points, participate in JCDI lifecycle scopes, raise JCDI events, and have method interceptors and decorators.

JAX-RS root resource and provider classes must have a valid JCDI managed bean constructor. In general, if the classes have a constructor that has a parameter annotated with the @javax.ws.rs.core.Context annotation or with any JAX-RS parameter annotation such as @javax.ws.rs.QueryParam, you must refactor the code to use JAX-RS-annotated bean properties or fields instead. We can add an @javax.annotation.PostConstruct annotated method to help construct the object.

Additionally, JAX-RS root resource and provider classes must have a JCDI specified scope. Scopes control the lifecycle of a JCDI managed bean. Root resource classes can have any valid scope such as @javax.enterprise.context.RequestScoped, which makes the JAX-RS root resource class behave the same as in a non-JCDI enabled application. The javax.ws.rs.core.Application subclasses and JAX-RS providers must have the @javax.enterprise.context.ApplicationScoped annotation.

We might want to use JCDI to more quickly and easily develop the application, as well as increase the testability of the code. JCDI enables modern programming techniques such as dependency injection, an event-based programming model, and a more aspect-oriented approach towards cross-cutting concerns. Developers can use aspect-oriented programming to cleanly add functionality that is not part of the core business logic to a method. For example, one cross-cutting concern is logging. Some developers need to log the entry and exit of every single time a certain business method is called in an application. Developers now can use JCDI functionality such as method interceptors and decorators to more cleanly add this functionality. Developers can use dependency injection to more easily insert their own mock implementations during unit testing. The decoupling of previously hard coded dependencies allows developers to more easily test individual components.

JCDI beans can inject Enterprise JavaBeans (EJBs) and use @javax.annotation.Resource injections to inject Java EE resources. EJBs can also be JCDI beans. EJBs with annotations such as @javax.ejb.Stateless can also use JCDI dependency injection and other JCDI features. The EJBs keep their transactional and other EJB features.

Java Contexts and Dependency Injection (JCDI) is a new Java EE 6 feature. It can change the programming model to make applications easier to develop while increasing maintainability. JAX-RS developers can use JCDI features, such as @javax.inject.Inject support, in root resource and provider classes.

  1. Configure the development environment.

  2. Define resources in JAX-RS web applications.

  3. Configure the JAX-RS application.

  4. Implement JAX-RS resources with JCDI functionality.

  5. Assemble JAX-RS web applications.

  6. Deploy JAX-RS web applications.


Results

You have enabled an enterprise bean so that JAX-RS resources with JCDI functionality are exposed for consumption.


Subtopics


Related tasks

  • Implement a JAX-RS resource with decorators and method interceptors
  • Implement JAX-RS resources with dependency injection
  • Implement JAX-RS resources with different lifecycle scopes

  • Web services specifications and APIs
  • EJB application specifications and APIs