Unreal user Unreal user - 4 years ago 169
Java Question

Can we have more than one @Path annotation for same REST method

Can we have more than one

annotation for same REST method i.e. the method executed is the same, but it is executed on accessing more than one URL?

E.g.: I want to run the
method on both

Answer Source

You can't have mutliple @Path annotations on a single method. It causes a "duplicate annotation" syntax error.

However, there's a number of ways you can effectively map two paths to a method.

Solution for simple paths - regular expressions in @Path annotation

The @Path annotation in JAX-RS accepts parameters, whose values can be restricted using regular expressions.

This annotation:

@Path("a/{parameter: path1|path2}")

would enable the method to be reached by requests for both /a/path1 and /a/path2. Unfortunately, this solution only works when path1 and path2 are simple path segments that contain no slashes.

Serving responses with a redirection status code

Alternatively, you could set up a redirection. Here's a way to do it in Jersey (the reference implementation of JAX-RS), by defining another subresource. This is just an example, if you prefer a different way of handling redirections, feel free to use it.

public class YourBaseResource {

  //this gets injected after the class is instantiated by Jersey    
  UriInfo uriInfo; 

  public Responce method1(){
    return Response.ok("blah blah").build();

  public Response method2(){
    UriBuilder addressBuilder = uriInfo.getBaseUriBuilder();
    return Response.seeOther(addressBuilder.build()).build();


Using a servlet filter to rewrite URLs

If you're going to need such functionality often, I suggest intercepting the incoming requests using a servlet filter and rewriting the paths on the fly. This should help you keep all redirections in one place. Ideally, you could use a ready library. UrlRewriteFilter can do the trick, as long as you're fine with a BSD license (check out their google code site for details)

Another option is to handle this with a proxy set up in front of your Java app. You can set up an Apache server to offer basic caching and rewrite rules without complicating your Java code.

Recommended from our users: Dynamic Network Monitoring from WhatsUp Gold from IPSwitch. Free Download