• Java
    • JAXB Tutorial
      • What is JAXB
      • JAXB Marshalling Example
      • JAXB UnMarshalling Example
  • Spring Tutorial
    • Spring Core Tutorial
    • Spring MVC Tutorial
      • Quick Start
        • Flow Diagram
        • Hello World Example
        • Form Handling Example
      • Handler Mapping
        • BeanNameUrlHandlerMapping
        • ControllerClassNameHandlerMapping
        • SimpleUrlHandlerMapping
      • Validation & Exception Handling
        • Validation+Annotations
        • Validation+ResourceBundle
        • @ExceptionHandler
        • @ControllerAdvice
        • Custom Exception Handling
      • Form Tag Library
        • Textbox Example
        • TextArea Example
        • Password Example
        • Dropdown Box Example
        • Checkboxes Example
        • Radiobuttons Example
        • HiddenValue Example
      • Misc
        • Change Config file name
    • Spring Boot Tutorial
  • Hibernate Tutorial
  • REST Tutorial
    • JAX-RS REST @PathParam Example
    • JAX-RS REST @QueryParam Example
    • JAX-RS REST @DefaultValue Example
    • JAX-RS REST @Context Example
    • JAX-RS REST @MatrixParam Example
    • JAX-RS REST @FormParam Example
    • JAX-RS REST @Produces Example
    • JAX-RS REST @Consumes Example
    • JAX-RS REST @Produces both XML and JSON Example
    • JAX-RS REST @Consumes both XML and JSON Example
  • Miscellaneous
    • JSON Parser
      • Read a JSON file
      • Write JSON object to File
      • Read / Write JSON using GSON
      • Java Object to JSON using JAXB
    • CSV Parser
      • Read / Write CSV file
      • Read/Parse/Write CSV File – OpenCSV
      • Export data into a CSV File
      • CsvToBean and BeanToCsv – OpenCSV

JavaInterviewPoint

Java Development Tutorials

JAX-RS @PathParam Example

January 21, 2015 by javainterviewpoint Leave a Comment

In this example, we will learn how to use the @PathParam annotation to get the Parameter passed in the URI in JAX-RS RESTful [email protected] parses the values of the parameter which is passed through @Path annotation. 

In general, there are two ways to pass the parameter in a GET request of the REST Service.
The first way is using @PathParam and the Other way is using @QueryParam. As of now, we will look at how to use @PathParam annotation.

We define a parameter with @Path(“/{parameter}”) annotation on to a method and through which we will get the value of the parameter by parsing it with @PathParam(“parameter”). We have already used it in our Jersey HelloWorld example.

Folder Structure

  1. Create a Dynamic Web Project RestfulExample and create a package for our src files “com.javainterviewpoint“
  2. Place the required jar files under WEB-INF/Lib 

    jersey-bundle-1.18.jar
    asm-3.1.jar

  3. Create the Java classes HelloWorld.java under com.javainterviewpoint folder.
  4. Place the web.xml  under the WEB-INF directory

@PathParam – Single Parameter

Here will pass a single parameter.

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.core.Response;

@Path("hello")
public class HelloWorld
{
	@GET
	@Path("{username}")
	public Response welcome(@PathParam("username")String name)
	{
		return Response.status(200).
				entity("Welcome to hello world program "+name).build();
	}
	
}

Here using @Path(“{username}”) we have defined a new path parameter with the name “username” , we will use @PathParam(“username”) to parse the parameter and push the value to the String “name”. 

Hit on the URI : “http://localhost:8080/RestfulExample/rest/hello/JavaInterviewPoint”

Welcome to hello world program JavaInterviewPoint

@PathParam – Multiple Parameter

Here we will parase multipe parameters (username,id,age)

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.core.Response;

@Path("hello")
public class HelloWorld
{
	@GET
	@Path("{username}/{id}/{age}")
	public Response getUserDetails(
			@PathParam("username")String name,
			@PathParam("id")int id,
			@PathParam("age")int age)
	{
		return Response.status(200).
				entity("Username : "+name+" ID : "+id+" Age : "+age).build();
	}
}

Hit on the URI : “http://localhost:8080/RestfulExample/rest/hello/JavaInterviewPoint/999/22”

Username : JavaInterviewPoint ID : 999 Age : 22

web.xml

<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://java.sun.com/xml/ns/j2ee" 
xmlns:web="http://xmlns.jcp.org/xml/ns/javaee" 
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee	
http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd	http://java.sun.com/xml/ns/j2ee	
http://java.sun.com/xml/ns/j2ee/web-app_2_5.xsd" id="WebApp_ID" version="2.5">
 
 	<display-name>Restful Web Application</display-name>
	<servlet>
	 	<servlet-name>jersey-serlvet</servlet-name>
	 	<servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
	 	<init-param>
	 		<param-name>com.sun.jersey.config.property.packages</param-name>
		 	<param-value>com.javainterviewpoint</param-value>
	 	</init-param>
	 	<load-on-startup>1</load-on-startup>
	</servlet>
 	<servlet-mapping>
	 	<servlet-name>jersey-serlvet</servlet-name>
	 	<url-pattern>/rest/*</url-pattern>
 	</servlet-mapping>
</web-app>

We register our Jersey container “com.sun.jersey.spi.container.servlet.ServletContainer” in the servlet-class of our web.xml and we will mention the source files location as the value of the init param “com.sun.jersey.config.property.packages” so that the container will scan for annotations of the class files within that package.
REST

Other interesting articles which you may like …

  • JAX-RS @PathParam Example
  • Jersey RESTful Web Services Client – Getting List of Object (GenericType)
  • Jersey Jackson JSON Tutorial
  • JAX-RS @Context Example
  • JAX-RS @DefaultValue Example
  • JAX-RS REST @MatrixParam Example
  • JAX-RS REST @FormParam Example
  • JAX-RS REST @Produces Example
  • JAX-RS REST @Consumes Example
  • JAX-RS REST @Produces both XML and JSON Example
  • JAX-RS REST @Consumes both XML and JSON Example
  • RESTful Java Client With Jersey Client
  • RESTEasy Hello World Example with Apache Tomcat
  • RESTful Java client with RESTEasy client
  • Spring RESTful Web Services Hello World XML Example
  • Springfox Swagger 2 for Spring RESTful Web Services

Filed Under: J2EE, Java, JAX-RS, REST Tagged With: @PathParam, JAX-RS, Jersey

Leave a Reply Cancel reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Java Basics

  • JVM Architecture
  • Object in Java
  • Class in Java
  • How to Set Classpath for Java in Windows
  • Components of JDK
  • Decompiling a class file
  • Use of Class.forName in java
  • Use Class.forName in SQL JDBC

Oops Concepts

  • Inheritance in Java
  • Types of Inheritance in Java
  • Single Inheritance in Java
  • Multiple Inheritance in Java
  • Multilevel Inheritance in Java
  • Hierarchical Inheritance in Java
  • Hybrid Inheritance in Java
  • Polymorphism in Java – Method Overloading and Overriding
  • Types of Polymorphism in java
  • Method Overriding in Java
  • Can we Overload static methods in Java
  • Can we Override static methods in Java
  • Java Constructor Overloading
  • Java Method Overloading Example
  • Encapsulation in Java with Example
  • Constructor in Java
  • Constructor in an Interface?
  • Parameterized Constructor in Java
  • Constructor Chaining with example
  • What is the use of a Private Constructors in Java
  • Interface in Java
  • What is Marker Interface
  • Abstract Class in Java

Java Keywords

  • Java this keyword
  • Java super keyword
  • Final Keyword in Java
  • static Keyword in Java
  • Static Import
  • Transient Keyword

Miscellaneous

  • newInstance() method
  • How does Hashmap works internally in Java
  • Java Ternary operator
  • How System.out.println() really work?
  • Autoboxing and Unboxing Examples
  • Serialization and Deserialization in Java with Example
  • Generate SerialVersionUID in Java
  • How to make a class Immutable in Java
  • Differences betwen HashMap and Hashtable
  • Difference between Enumeration and Iterator ?
  • Difference between fail-fast and fail-safe Iterator
  • Difference Between Interface and Abstract Class in Java
  • Difference between equals() and ==
  • Sort Objects in a ArrayList using Java Comparable Interface
  • Sort Objects in a ArrayList using Java Comparator

Follow

  • Coding Utils

Useful Links

  • Spring 4.1.x Documentation
  • Spring 3.2.x Documentation
  • Spring 2.5.x Documentation
  • Java 6 API
  • Java 7 API
  • Java 8 API
  • Java EE 5 Tutorial
  • Java EE 6 Tutorial
  • Java EE 7 Tutorial
  • Maven Repository
  • Hibernate ORM

About JavaInterviewPoint

javainterviewpoint.com is a tech blog dedicated to all Java/J2EE developers and Web Developers. We publish useful tutorials on Java, J2EE and all latest frameworks.

All examples and tutorials posted here are very well tested in our development environment.

Connect with us on Facebook | Privacy Policy | Sitemap

Copyright ©2023 · Java Interview Point - All Rights Are Reserved ·