• 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

RESTEasy Hello World Example with Apache Tomcat

March 15, 2016 by javainterviewpoint Leave a Comment

RESTEasy is one of the implementation of JAX-RS specification provided by  JBOSS for building RESTful Web Services. In this tutorial we will create a simple hello world web service with the JAX-RS reference implementation RESTEasy.

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 

    resteasy-jaxrs-3.0.4.Final.jar
    jaxrs-api-3.0.4.Final.jar
    javassist-3.20.0-GA.jar
    scannotation-1.0.2.jar
    jboss-logging-3.3.0.Final.jar

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

HelloWorld_RESTEasy.java

package com.javainterviewpoint;

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_RESTEasy
{
    @GET
    @Path("/sayHello/{user}")
    public Response dispMessage(@PathParam("user") String msg)
    {
        String message = "Welcome " + msg+"!!!";

        return Response.status(200).entity(message).build();

    }
}
  • We have annotated @Path(“/hello”) at the class level, which means our RESTEasy service can be reached through the URL …/hello
  • All the GET Request will be handled by the dispMessage() method, which we have annotated with @GET
  • @Path(“sayHello/{user}”) will hold the value which will be passed in the URL after ../hello/sayHello/XXXX, Using the @PathParam we will get the value of the “user” and will be assigned to String msg.
  • Finally we are appending the “user” with Welcome string and send our Response back.

Other Posts which you may like …

  • Jackson 2 JSON Parser – Convert JSON to/from Java Object
  • How to Convert JSON to / from Java Map using JACKSON
  • Jackson Tree Model Example – JsonNode
  • Jackson Streaming API Example | Read and Write JSON
  • Jackson JSON Example | ObjectMapper and @JSONView
  • How to Parse JSON to/from Java Object using Boon JSON Parser
  • How to Read and Write JSON using GSON
  • How to write JSON object to File in Java?
  • How to read JSON file in Java – JSONObject and JSONArray
  • Jersey Jackson JSON Tutorial
  • Spring REST Hello World Example – JSON and XML responses
  • How to Convert Java Object to JSON using JAXB
  • JAX-RS REST @Consumes both XML and JSON Example
  • JAX-RS REST @Produces both XML and JSON Example

web.xml

<web-app id="WebApp_ID" version="2.4"
	xmlns="http://java.sun.com/xml/ns/j2ee"	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee	
 	http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
	<display-name>RESTEasy Restful Web Application</display-name>

	<servlet>
		<servlet-name>resteasy-servlet</servlet-name>
		<servlet-class>
			org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher
		</servlet-class>
	</servlet>

	<servlet-mapping>
		<servlet-name>resteasy-servlet</servlet-name>
		<url-pattern>/rest/*</url-pattern>
	</servlet-mapping>

	<!-- Auto scanning REST service -->
	<context-param>
		<param-name>resteasy.scan</param-name>
		<param-value>true</param-value>
	</context-param>

	<!-- Prefix need to be set if url pattern is not /* -->
	<context-param>
		<param-name>resteasy.servlet.mapping.prefix</param-name>
		<param-value>/rest</param-value>
	</context-param>

	<listener>
		<listener-class>
			org.jboss.resteasy.plugins.server.servlet.ResteasyBootstrap
		</listener-class>
	</listener>

</web-app>
  • In our “web.xml” file, we have registered “org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher” as our servlet container
  • We have also registered a listener “org.jboss.resteasy.plugins.server.servlet.ResteasyBootstrap”.
  • The ResteasyBootstrap listener is responsible for initializing the basic components of RESTeasy as well as scanning for annotation classes. It also reads the configuration options from <context-param> elements of the “web.xml” file.
  • The configuration prefix must be set if the url-pattern of the <servlet-mapping> is not “/*”.  This will be taken care by “resteasy.servlet.mapping.prefix”, the value provided should same as the url-pattern of the servlet-mapping except “/*”. In our case we have url-pattern as “/rest/*” and hence the “resteasy.servlet.mapping.prefix” value should be “/rest”
  • One more configuration is added “resteasy.scan”, when this values is set to “true”, this will tell ResteasyBootstrap to automatically search for REST Services Implementation, both @Provider and JAX-RS resource classes (@Path, @GET, @POST etc…) and register them.

Lets run our application

Now are good to run our application, add the project to the server. I use Tomcat as my server you are free to choose your own.
        http://localhost:8080/RestfulExample/rest/hello/sayHello/<<parameter passed>>

The request url has to match http://<<server location>>:<<port>>/<<url-pattern if any>>/<<Path mentioned in java @Path>>/{any value}

Once i hit the url in POSTMAN client

RESTEasy HelloWorld Example

Alternate way of Registering RESTEasy WebService

In the above code we have registerd our register REST service via ResteasyBootstrap listener. Here is another way of registering the RESTEasy WebService manually. We need to create class and extends “javax.ws.rs.core.Application” and add our REST service manually.

package com.javainterviewpoint;

import java.util.HashSet;
import java.util.Set;

import javax.ws.rs.core.Application;

public class RestApplication extends Application
{
    private Set<Object> singletons = new HashSet<Object>();

    public RestApplication() {
        singletons.add(new HelloWorld_RESTEasy());
    }

    @Override
    public Set<Object> getSingletons()
    {
        return singletons;
    }
}

We have defined our Application class as a Set that which will hold all the root resource and provider classes.

We need to modifiy our web.xml accordingly.

<web-app id="WebApp_ID" version="2.4"
 xmlns="http://java.sun.com/xml/ns/j2ee" 
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee%20
 http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
 <display-name>RESTEasy Restful Web Application</display-name>

 <servlet>
 <servlet-name>resteasy-servlet</servlet-name>
 <servlet-class>
 org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher
 </servlet-class>
 <init-param>
 <param-name>javax.ws.rs.Application</param-name>
 <param-value>com.javainterviewpoint.RestApplication</param-value>
 </init-param>
 </servlet>
 
 <servlet-mapping>
 <servlet-name>resteasy-servlet</servlet-name>
 <url-pattern>/rest/*</url-pattern>
 </servlet-mapping>
 

 <!-- Prefix need to be set if url pattern is not /* -->
 <context-param>
 <param-name>resteasy.servlet.mapping.prefix</param-name>
 <param-value>/rest</param-value>
 </context-param>

 
</web-app>

In the web.xml we do not need to add a listener or enable the auto scan service feature as we have defined our own application implementation as a parameter in the servlet definition(init-param).

Filed Under: J2EE, Java, JAX-RS, REST Tagged With: RESTEasy, RESTEasy Service, RESTful Web Service

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 ·