Categories: RESTTutorial

JAX-RS @MatrixParam example

In this tutorial we will discuss about Matrix parameters, these are a set of “name=value” in URI path,
for example-
/salary/21111;empname=dinesh

In above URI, the matrix parameter is “empname=dinesh”, separate by a semi colon “;”.
1. @MatrixParam example
See a full example of using @MatrixParam in JAX-RS.

import javax.ws.rs.GET;
import javax.ws.rs.MatrixParam;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.core.Response;
 
@Path("/employee")
public class EmployeeController {
 
 @GET
 @Path("{empid}")
 public Response getEmpSalary(@PathParam("empid") String empid,
   @MatrixParam("empname") String empname,
   @MatrixParam("jobtype") String jobtype) {
 
  return Response
   .status(200)
   .entity("getEmpSalary is called, empid : " + empid
    + ", empname : " + empname + ", jobtype : " + jobtype)
   .build();
 
 }
 
}

See following URI patterns and result.

1. URI Pattern : http://localhost:8181/sdnext/doj/employee/21212/

getEmpSalary is called, empid : 21212, empname : null, jobtype : null

2. URI Pattern : “http://localhost:8181/sdnext/doj/employee/21212;empname=dinesh

getEmpSalary is called, empid : 21212, empname : dinesh, jobtype : null

3. URI Pattern : “http://localhost:8181/sdnext/doj/employee/21212;empname=dinesh;jobtype=Software”

getEmpSalary is called, empid : 21212, empname : dinesh, jobtype : Software

4. URI Pattern : “http://localhost:8181/sdnext/doj/employee/21212;jobtype=Software;empname=dinesh”

getEmpSalary is called, empid : 21212, empname : dinesh, jobtype : Software

Download SourceCode
JAX-RS @MatrixParam 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…

2 years ago