How can I grab all query parameters in Jersey JaxRS?

Question

I am building a generic web service and need to grab all the query parameters into one string for later parsing. How can I do this?

score 168 · Accepted Answer · answered Apr 19 '11 at 15:30

You can access a single param via @QueryParam("name") or all of the params via the context:

@POST
public Response postSomething(@QueryParam("name") String name, @Context UriInfo uriInfo, String content) {
     MultivaluedMap<String, String> queryParams = uriInfo.getQueryParameters(); 
     String nameParam = queryParams.getFirst("name");
}

The key is the @Context jax-rs annotation, which can be used to access:

UriInfo, Request, HttpHeaders, SecurityContext, Providers

score 35 · Answer 2 · answered May 29 '13 at 09:31

35

The unparsed query part of the request URI can be obtained from the UriInfo object:

@GET
public Representation get(@Context UriInfo uriInfo) {
  String query = uriInfo.getRequestUri().getQuery();
  ...
}

answered May 29 '13 at 09:31

glerup

1,452
1
12
11

score 4 · Answer 3 · answered Jan 25 '19 at 08:55

4

Adding a bit more to the accepted answer. It is also possible to get all the query parameters in the following way without adding an additional parameter to the method which maybe useful when maintaining swagger documentation.

@Context
private UriInfo uriInfo;

@POST
public Response postSomething(@QueryParam("name") String name) {
     MultivaluedMap<String, String> queryParams = uriInfo.getQueryParameters(); 
     String nameParam = queryParams.getFirst("name");
}

ref

answered Jan 25 '19 at 08:55

Janak

436
4
14

While this works, i wouldn't recommend it. If you can keep code functional pure, you should try it - it's the better approach. – martyglaubitz Feb 20 '19 at 08:21
1

Although strictly correct, I'm using this approach with a superclass to automatically log parameters, and it works very nicely. Much cleaner than having to pass the parameters with each request. Sometimes functional purity needs to just look the other way for a few seconds while pragmatic programming takes control of the keyboard :) – Paul Russell Feb 20 '19 at 09:42

score 0 · Answer 4 · answered Jun 14 '21 at 12:30

we can send value client to server using query parameter like

http://localhost:8080/JerseyDemo/rest/user/12?p=10

Here p is query param value . we can get this value using @QueryParam("p") annotation

public adduser(@QueryParam("p") int page){
  //some code 
}

Sometime we send list of values in query parameter like

http://localhost:8080/JerseyDemo/rest/user/12?city=delhi&country=india&city=california

In this case we can retrieve all query parameter using @Context UriInfo

public String addUser( @Context UriInfo uriInfo){
        List<String> cityList = uriInfo.getQueryParameters().get("city");

 }

You can see full example with more details - QueryParam Annotation In Jersey Here you will see more other method for retrieve query parameter in jersey.

How can I grab all query parameters in Jersey JaxRS?

4 Answers4

Linked

Related