JAX-RS @MatrixParam example

Matrix parameters are a set of “name=value” in URI path, for example,


/books/2011;author=mkyong

In above URI, the matrix parameter is “author=mkyong“, 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("/books")
public class BookService {

	@GET
	@Path("{year}")
	public Response getBooks(@PathParam("year") String year,
			@MatrixParam("author") String author,
			@MatrixParam("country") String country) {

		return Response
			.status(200)
			.entity("getBooks is called, year : " + year
				+ ", author : " + author + ", country : " + country)
			.build();

	}

}

See following URI patterns and result.

1. URI Pattern : “/books/2011/


getBooks is called, year : 2011, author : null, country : null

2. URI Pattern : “/books/2011;author=mkyong


getBooks is called, year : 2011, author : mkyong, country : null

3. URI Pattern : “/books/2011;author=mkyong;country=malaysia


getBooks is called, year : 2011, author : mkyong, country : malaysia

4. URI Pattern : “/books/2011;country=malaysia;author=mkyong


getBooks is called, year : 2011, author : mkyong, country : malaysia

Download Source Code

Download it – JAX-RS-MatrixParam-Example.zip (6 KB)

References

  1. JAX-RS MatrixParam JavaDoc

About the Author

author image
mkyong
Founder of Mkyong.com, love Java and open source stuff. Follow him on Twitter. If you like my tutorials, consider make a donation to these charities.

Comments

avatar
2 Comment threads
2 Thread replies
0 Followers
 
Most reacted comment
Hottest comment thread
3 Comment authors
ArunAnderson GomesJin Kwon Recent comment authors
newest oldest most voted
Jin Kwon
Guest
Jin Kwon

What about those matrix parameters in the middle of URL? Such as /aaa;bbb=ccc/ddd/eee.fff

Anderson Gomes
Guest
Anderson Gomes

You can read them the same way. The position of the method parameters don’t matter, @MatrixParam(“bbb”) will always get the value “ccc”.

Arun
Guest
Arun

Good

trackback
JAX-RS TUTORIALS | BUYWORKSELL

[…] JAX-RS @MatrixParam example Example to get matrix parameters in URI path. […]