How to get instance of javax.ws.rs.core.UriInfo

19,542

You simply inject it with the @Context annotation, as a field or method parameter.

@Path("resource")
public class Resource {
    @Context
    UriInfo uriInfo;

    public Response doSomthing(@Context UriInfo uriInfo) {

    }
}

Other than your resource classes, it can also be injected into other providers, like ContainerRequestContext, ContextResolver, MessageBodyReader etc.

EDIT

Actually I want to write a junit test for a function similar to your doSomthing() function.

I didn't pick that up in your post. But a couple options I can think of for unit tests

  1. Simply create a stub, implementing only the methods you use.

  2. Use a Mocking framework like Mockito, and mock the UriInfo. Example

    @Path("test")
    public class TestResource { 
        public String doSomthing(@Context UriInfo uriInfo){
            return uriInfo.getAbsolutePath().toString();
        }
    }
    [...]
    @Test
    public void doTest() {
        UriInfo uriInfo = Mockito.mock(UriInfo.class);
        Mockito.when(uriInfo.getAbsolutePath())
            .thenReturn(URI.create("http://localhost:8080/test"));
        TestResource resource = new TestResource();
        String response = resource.doSomthing(uriInfo);
        Assert.assertEquals("http://localhost:8080/test", response);
    }
    

    You'll need to add this dependency

    <dependency>
        <groupId>org.mockito</groupId>
        <artifactId>mockito-all</artifactId>
        <version>1.9.0</version>
    </dependency>
    

If you want to do an integration test, where the actual UriInfo is injected, you should look into Jersey Test Framework

Here's a complete example with the Jersey Test Framework

public class ResourceTest extends JerseyTest {

    @Path("test")
    public static class TestResource {
        @GET
        public Response doSomthing(@Context UriInfo uriInfo) {
            return Response.ok(uriInfo.getAbsolutePath().toString()).build();
        }
    }

    @Override
    public Application configure() {
        return new ResourceConfig(TestResource.class);
    }

    @Test
    public void test() {
        String response = target("test").request().get(String.class);
        Assert.assertTrue(response.contains("test"));
    }
}

Just add this dependency

<dependency>
    <groupId>org.glassfish.jersey.test-framework.providers</groupId>
    <artifactId>jersey-test-framework-provider-inmemory</artifactId>
    <version>${jersey2.version}</version>
</dependency>

It uses an in-memory container, which is the most efficient for small tests. There are other containers with Servlet support if needed. Just see the link I posted above.

Share:
19,542

Related videos on Youtube

Syed Aqeel Ashiq
Author by

Syed Aqeel Ashiq

Updated on June 04, 2022

Comments

  • Syed Aqeel Ashiq
    Syed Aqeel Ashiq almost 2 years

    Is there any implementation of javax.ws.rs.core.UriInfo which I can use to create an instance quickly for testing. This interface is long, I just need to test something. I don't want to waste time on whole implementation of this interface.

    UPDATE: I want to write a unit test for a function similar to this:

    @GET
    @Path("/my_path")
    @Produces(MediaType.TEXT_XML)
    public String webserviceRequest(@Context UriInfo uriInfo);
    
  • Syed Aqeel Ashiq
    Syed Aqeel Ashiq about 9 years
    Actually I want to write a junit test for a function similar to your doSomthing() function.
  • Paul Samsotha
    Paul Samsotha about 9 years
    Ahh I missed that part. You can use a Mocking framework like Mockito, or just create a stub, implementing only the methods you are using. That's the only thing I can think of for a unit test. For an integration test, you could use the Jersey Test Framework, and it will launch the app and be fully functional for the tests (injections included)