Dependency injection with Jersey 2 0

Question

Starting from scratch without any previous Jersey 1 x knowledge  I m having a hard time understanding how to setup dependency injection in my Jersey 2 0 project     I also understand that HK2 is available in Jersey 2 0  but I cannot seem to find docs that help with Jersey 2 0 integration    ManagedBean  Path  myresource   public class MyResource         Inject     MyService myService                  Method handling HTTP GET requests  The returned object will be sent        to the client as  text plain  media type                 return String that will be returned as a text plain response               GET      Produces MediaType APPLICATION JSON       Path   getit       public String getIt             return  Got it      myService                  Resource  ManagedBean public class MyService       void serviceCall             System out print  Service calls              pom xml   lt properties gt       lt jersey version gt 2 0-rc1 lt  jersey version gt       lt project build sourceEncoding gt UTF-8 lt  project build sourceEncoding gt   lt  properties gt    lt dependencyManagement gt       lt dependencies gt           lt dependency gt               lt groupId gt org glassfish jersey lt  groupId gt               lt artifactId gt jersey-bom lt  artifactId gt               lt version gt   jersey version  lt  version gt               lt type gt pom lt  type gt               lt scope gt import lt  scope gt           lt  dependency gt       lt  dependencies gt   lt  dependencyManagement gt    lt dependencies gt       lt dependency gt           lt groupId gt org glassfish jersey core lt  groupId gt           lt artifactId gt jersey-common lt  artifactId gt       lt  dependency gt       lt dependency gt           lt groupId gt org glassfish jersey core lt  groupId gt           lt artifactId gt jersey-server lt  artifactId gt       lt  dependency gt       lt dependency gt           lt groupId gt org glassfish jersey lt  groupId gt           lt artifactId gt jax-rs-ri lt  artifactId gt       lt  dependency gt   lt  dependencies gt    I can get the container to start and serve up my resource  but as soon as I add  Inject to MyService  the framework throws an exception   SEVERE  Servlet service   for servlet  com noip MyApplication  in context with path   jaxrs  threw exception  A MultiException has 3 exceptions   They are  1  org glassfish hk2 api UnsatisfiedDependencyException  There was no object available for injection at Injectee requiredType MyService parent MyResource qualifiers     position -1 optional false self false unqualified null 1039471128  2  java lang IllegalArgumentException  While attempting to resolve the dependencies of com noip MyResource errors were found 3  java lang IllegalStateException  Unable to perform operation  resolve on com noip MyResource   with root cause org glassfish hk2 api UnsatisfiedDependencyException  There was no object available for injection at Injectee requiredType MyService parent MyResource qualifiers     position -1 optional false self false unqualified null 1039471128      at org jvnet hk2 internal ThreeThirtyResolver resolve ThreeThirtyResolver java 74     My starter project is available at GitHub  https   github com donaldjarmstrong jaxrs

User · Answer

Dependency required for jersey restful service and Tomcat is the server. where ${jersey.version} is 2.29.1

    <dependency>
        <groupId>javax.enterprise</groupId>
        <artifactId>cdi-api</artifactId>
        <version>2.0.SP1</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.core</groupId>
        <artifactId>jersey-server</artifactId>
        <version>${jersey.version}</version>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.containers</groupId>
        <artifactId>jersey-container-servlet</artifactId>
        <version>${jersey.version}</version>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.inject</groupId>
        <artifactId>jersey-hk2</artifactId>
        <version>${jersey.version}</version>
    </dependency>

The basic code will be as follows:

@RequestScoped
@Path("test")
public class RESTEndpoint {

   @GET
   public String getMessage() {

User · Answer

For me it works without the AbstractBinder if I include the following dependencies in my web application  running on Tomcat 8 5  Jersey 2 27     lt dependency gt       lt groupId gt javax ws rs lt  groupId gt       lt artifactId gt javax ws rs-api lt  artifactId gt       lt version gt 2 1 lt  version gt   lt  dependency gt   lt dependency gt       lt groupId gt org glassfish jersey containers lt  groupId gt       lt artifactId gt jersey-container-servlet lt  artifactId gt       lt version gt   jersey-version  lt  version gt   lt  dependency gt   lt dependency gt       lt groupId gt org glassfish jersey ext cdi lt  groupId gt       lt artifactId gt jersey-cdi1x lt  artifactId gt       lt version gt   jersey-version  lt  version gt   lt  dependency gt   lt dependency gt       lt groupId gt org glassfish jersey inject lt  groupId gt       lt artifactId gt jersey-hk2 lt  artifactId gt       lt version gt   jersey-version  lt  version gt   lt  dependency gt    It works with CDI 1 2   CDI 2 0 for me  using Weld 2   3 respectively

User · Answer

The selected answer dates from a while back  It is not practical to declare every binding in a custom HK2 binder  I m using Tomcat and I just had to add one dependency  Even though it was designed for Glassfish it fits perfectly into other containers        lt dependency gt           lt groupId gt org glassfish jersey containers glassfish lt  groupId gt           lt artifactId gt jersey-gf-cdi lt  artifactId gt           lt version gt   jersey version  lt  version gt       lt  dependency gt    Make sure your container is properly configured too  see the documentation

User · Answer

Oracle recommends to add the  Path annotation to all types to be injected when combining JAX-RS with CDI  http   docs oracle com javaee 7 tutorial jaxrs-advanced004 htm Though this is far from perfect  e g  you will get warning from Jersey on startup   I decided to take this route  which saves me from maintaining all supported types within a binder   Example    Singleton  Path  singleton-configuration-service   public class ConfigurationService             Path  my-path   class MyProvider      Inject ConfigurationService  configuration      GET   public Object get

User · Answer

If you prefer to use Guice and you don t want to declare all the bindings  you can also try this adapter   guice-bridge-jit-injector

User · Answer

Late but I hope this helps someone   I have my JAX RS defined like this    Path   examplepath    RequestScoped   this make the diference public class ExampleResource     Then  in my code finally I can inject    Inject SomeManagedBean bean    In my case  the SomeManagedBean is an ApplicationScoped bean   Hope this helps to anyone

User · Answer

First just to answer a comment in the accepts answer    quot What does bind do  What if I have an interface and an implementation  quot   It simply reads bind  implementation   to  contract    You can alternative chain  in  scope    Default scope of PerLookup  So if you want a singleton  you can bind  implementation   to  contract   in  Singleton class     There s also a RequestScoped available Also  instead of bind Class  to Class   you can also bind Instance  to Class   which will be automatically be a singleton   Adding to the accepted answer For those trying to figure out how to register your AbstractBinder implementation in your web xml  i e  you re not using a ResourceConfig   it seems the binder won t be discovered through package scanning  i e   lt servlet-class gt org glassfish jersey servlet ServletContainer lt  servlet-class gt   lt init-param gt       lt param-name gt jersey config server provider packages lt  param-name gt       lt param-value gt          your packages to scan      lt  param-value gt   lt  init-param gt   Or this either  lt init-param gt       lt param-name gt jersey config server provider classnames lt  param-name gt       lt param-value gt          com foo YourBinderImpl      lt  param-value gt   lt  init-param gt   To get it to work  I had to implement a Feature  import javax ws rs core Feature  import javax ws rs core FeatureContext  import javax ws rs ext Provider    Provider public class Hk2Feature implements Feature         Override     public boolean configure FeatureContext context            context register new AppBinder             return true           The  Provider annotation should allow the Feature to be picked up by the package scanning  Or without package scanning  you can explicitly register the Feature in the web xml  lt servlet gt       lt servlet-name gt Jersey Web Application lt  servlet-name gt       lt servlet-class gt org glassfish jersey servlet ServletContainer lt  servlet-class gt       lt init-param gt           lt param-name gt jersey config server provider classnames lt  param-name gt           lt param-value gt              com foo Hk2Feature          lt  param-value gt       lt  init-param gt               lt load-on-startup gt 1 lt  load-on-startup gt   lt  servlet gt    See Also   Custom Method Parameter Injection with Jersey How to inject an object into jersey request context  How do I properly configure an EntityManager in a jersey   hk2 application  Request Scoped Injection into Singletons  and for general information from the Jersey documentation  Custom Injection and Lifecycle Management   UPDATE Factories Aside from the basic binding in the accepted answer  you also have factories  where you can have more complex creation logic  and also have access to request context information  For example public class MyServiceFactory implements Factory lt MyService gt         Context     private HttpHeaders headers        Override     public MyService provide             return new MyService headers getHeaderString  quot X-Header quot                 Override     public void dispose MyService service       noop         register new AbstractBinder          Override     public void configure             bindFactory MyServiceFactory class  to MyService class                   in RequestScoped class              Then you can inject MyService into your resource class

User · Answer

You need to define an AbstractBinder and register it in your JAX-RS application  The binder specifies how the dependency injection should create your classes   public class MyApplicationBinder extends AbstractBinder        Override     protected void configure             bind MyService class  to MyService class             When  Inject is detected on a parameter or field of type MyService class it is instantiated using the class MyService  To use this binder  it need to be registered with the JAX-RS application  In your web xml  define a JAX-RS application like this    lt servlet gt     lt servlet-name gt MyApplication lt  servlet-name gt     lt servlet-class gt org glassfish jersey servlet ServletContainer lt  servlet-class gt     lt init-param gt       lt param-name gt javax ws rs Application lt  param-name gt       lt param-value gt com mypackage MyApplication lt  param-value gt     lt  init-param gt     lt load-on-startup gt 1 lt  load-on-startup gt   lt  servlet gt   lt servlet-mapping gt     lt servlet-name gt MyApplication lt  servlet-name gt     lt url-pattern gt    lt  url-pattern gt   lt  servlet-mapping gt    Implement the MyApplication class  specified above in the init-param    public class MyApplication extends ResourceConfig       public MyApplication             register new MyApplicationBinder             packages true   com mypackage rest              The binder specifying dependency injection is registered in the constructor of the class  and we also tell the application where to find the REST resources  in your case  MyResource  using the packages   method call

[java] Dependency injection with Jersey 2.0

Examples related to java

Examples related to dependency-injection

Examples related to jersey

Examples related to jersey-2.0

Examples related to hk2