Categories: RESTTutorial

JAX-RS @QueryParam example

In this article we will explain about the JAX-RS, you can use @QueryParam annotation to inject URI query parameter into Java method. for example,

/employees/query?url=dineshonjava.com

In above URI pattern, query parameter is “url=dineshonjava.com”, and you can get the url value with @QueryParam(“url”).
1. @QueryParam example

See a full example of using @QueryParam in JAX-RS.

import java.util.List;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;

@Path("/employee")
public class EmployeeController {

@GET
@Path("/query")
public Response getEmployees(
@QueryParam("from") int from,
@QueryParam("to") int to,
@QueryParam("orderBy") List<String> orderBy) {

return Response
.status(200)
.entity("getEmployees is called, from : " + from + ", to : " + to
+ ", orderBy" + orderBy.toString()).build();

}

}

URI Pattern : “http://localhost:8181/sdnext/doj/employee/query?from=2300&to=3300&orderBy=age&orderBy=name”

getEmployees is called, from : 2300, to : 3300, orderBy[age, name]

2. Programmatic Query Parameter

Alternatively, you can get the query parameters grammatically, via “@Context UriInfo”. See equivalent version below :

import java.util.List;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriInfo;

@Path("/employee")
public class EmployeeController {

@GET
@Path("/uriinfo")
public Response getEmployees(@Context UriInfo info) {

String from = info.getQueryParameters().getFirst("from");
String to = info.getQueryParameters().getFirst("to");
List<String> orderBy = info.getQueryParameters().get("orderBy");

return Response
.status(200)
.entity("getEmployees is called, from : " + from + ", to : " + to
+ ", orderBy" + orderBy.toString()).build();

}

}

URI Pattern : “http://localhost:8181/sdnext/doj/employee/uriinfo?from=2300&to=3300&orderBy=age&orderBy=name”

getEmployees is called, from : 2300, to : 3300, orderBy[age, name]

3. @DefaultValue example

@DefaultValue is good for optional parameter.

import java.util.List;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;
 
@Path("/employee")
public class EmployeeController{
 
 @GET
 @Path("/default")
 public Response getEmployee(
  @DefaultValue("1000") @QueryParam("from") int from,
  @DefaultValue("999")@QueryParam("to") int to,
  @DefaultValue("name") @QueryParam("orderBy") List<String> orderBy) {
 
  return Response
     .status(200)
     .entity("getEmployees is called, from : " + from + ", to : " + to
   + ", orderBy" + orderBy.toString()).build();
 
 }
 
}

URI Pattern : “http://localhost:8181/sdnext/doj/employee/default”

getEmployees is called, from : 1000, to : 999, orderBy[name]

Download SourceCode
JAX-RS @QueryParam example.zip

References
1. JAVA REST Web Services
2. Wikipedia for REST Web Service

 

<<Previous <<   || Index ||   >>Next >>
Previous
Next
Dinesh Rajput

Dinesh Rajput is the chief editor of a website Dineshonjava, a technical blog dedicated to the Spring and Java technologies. It has a series of articles related to Java technologies. Dinesh has been a Spring enthusiast since 2008 and is a Pivotal Certified Spring Professional, an author of a book Spring 5 Design Pattern, and a blogger. He has more than 10 years of experience with different aspects of Spring and Java design and development. His core expertise lies in the latest version of Spring Framework, Spring Boot, Spring Security, creating REST APIs, Microservice Architecture, Reactive Pattern, Spring AOP, Design Patterns, Struts, Hibernate, Web Services, Spring Batch, Cassandra, MongoDB, and Web Application Design and Architecture. He is currently working as a technology manager at a leading product and web development company. He worked as a developer and tech lead at the Bennett, Coleman & Co. Ltd and was the first developer in his previous company, Paytm. Dinesh is passionate about the latest Java technologies and loves to write technical blogs related to it. He is a very active member of the Java and Spring community on different forums. When it comes to the Spring Framework and Java, Dinesh tops the list!

Share
Published by
Dinesh Rajput

Recent Posts

Strategy Design Patterns using Lambda

Strategy Design Patterns We can easily create a strategy design pattern using lambda. To implement…

2 years ago

Decorator Pattern using Lambda

Decorator Pattern A decorator pattern allows a user to add new functionality to an existing…

2 years ago

Delegating pattern using lambda

Delegating pattern In software engineering, the delegation pattern is an object-oriented design pattern that allows…

2 years ago

Spring Vs Django- Know The Difference Between The Two

Technology has emerged a lot in the last decade, and now we have artificial intelligence;…

2 years ago

TOP 20 MongoDB INTERVIEW QUESTIONS 2022

Managing a database is becoming increasingly complex now due to the vast amount of data…

2 years ago

Scheduler @Scheduled Annotation Spring Boot

Overview In this article, we will explore Spring Scheduler how we could use it by…

3 years ago