Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

Dynamic Provider Registration in JAX-RS

DZone's Guide to

Dynamic Provider Registration in JAX-RS

Wondering if it's possible to register providers dynamically in JEE? The answer is yes, it is possible! Read on to find out how it's done.

· Java Zone
Free Resource

Get the Edge with a Professional Java IDE. 30-day free trial.

The DynamicFeature class in JAX-RS (2.0) allows you to register providers:

  • Dynamically i.e. without any pre-defined binding strategy (e.g. annotations).
  • Based on criteria i.e. to help decide which provider to bind to which JAX-RS resource(s).

The JAX-RS implementation detects and executes the DynamicFeature implementations at deployment time

Here is an example where we instruct the JAX-RS runtime to dynamically bind the AuthenticationFilter (a JAX-RS post construct filter) to be applied when a PUT is invoked on UserResource (which is a JAX-RS resource class):

@Provider
public class DynamicFilter implements DynamicFeature {
  @Override
  public void configure(ResourceInfo resInfo, FeatureContext ctx) {
    if (UserResource.class.equals(resInfo.getResourceClass()) &&
      resInfo.getResourceMethod().getName().contains("PUT")) {
      ctx.register(AuthenticationFilter.class);
    }
  }
}


Criteria-Based

Criteria are provided by ResourceInfo, and they're based on two attributes:

  • The resource class
  • The resource method

Dynamic

Dynamic registration is achieved using FeatureContext, whose register method can be used to bind the provider.

Note

  • @Provider is needed for automatic discovery by the JAX-RS runtime.
  • Applicable for: filters, interceptors and  any Feature
  • In case of filters, the following applicability criteria apply
    • Post matching (@PreMatching filters excluded).
    • Server side filters i.e. ClientRequestFilter and ClientResponseFilter cannot be registered using this method.
  • Once used, it overrides other bindings (static or using @NameBinding).

Get the Java IDE that understands code & makes developing enjoyable. Level up your code with IntelliJ IDEA. Download the free trial.

Topics:
java ee ,java ,jax-rs ,dynamic provider ,registration

Published at DZone with permission of Abhishek Gupta, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}