Skip to main content
Redhat Developers  Logo
  • Products

    Featured

    • Red Hat Enterprise Linux
      Red Hat Enterprise Linux Icon
    • Red Hat OpenShift AI
      Red Hat OpenShift AI
    • Red Hat Enterprise Linux AI
      Linux icon inside of a brain
    • Image mode for Red Hat Enterprise Linux
      RHEL image mode
    • Red Hat OpenShift
      Openshift icon
    • Red Hat Ansible Automation Platform
      Ansible icon
    • Red Hat Developer Hub
      Developer Hub
    • View All Red Hat Products
    • Linux

      • Red Hat Enterprise Linux
      • Image mode for Red Hat Enterprise Linux
      • Red Hat Universal Base Images (UBI)
    • Java runtimes & frameworks

      • JBoss Enterprise Application Platform
      • Red Hat build of OpenJDK
    • Kubernetes

      • Red Hat OpenShift
      • Microsoft Azure Red Hat OpenShift
      • Red Hat OpenShift Virtualization
      • Red Hat OpenShift Lightspeed
    • Integration & App Connectivity

      • Red Hat Build of Apache Camel
      • Red Hat Service Interconnect
      • Red Hat Connectivity Link
    • AI/ML

      • Red Hat OpenShift AI
      • Red Hat Enterprise Linux AI
    • Automation

      • Red Hat Ansible Automation Platform
      • Red Hat Ansible Lightspeed
    • Developer tools

      • Red Hat Trusted Software Supply Chain
      • Podman Desktop
      • Red Hat OpenShift Dev Spaces
    • Developer Sandbox

      Developer Sandbox
      Try Red Hat products and technologies without setup or configuration fees for 30 days with this shared Openshift and Kubernetes cluster.
    • Try at no cost
  • Technologies

    Featured

    • AI/ML
      AI/ML Icon
    • Linux
      Linux Icon
    • Kubernetes
      Cloud icon
    • Automation
      Automation Icon showing arrows moving in a circle around a gear
    • View All Technologies
    • Programming Languages & Frameworks

      • Java
      • Python
      • JavaScript
    • System Design & Architecture

      • Red Hat architecture and design patterns
      • Microservices
      • Event-Driven Architecture
      • Databases
    • Developer Productivity

      • Developer productivity
      • Developer Tools
      • GitOps
    • Secure Development & Architectures

      • Security
      • Secure coding
    • Platform Engineering

      • DevOps
      • DevSecOps
      • Ansible automation for applications and services
    • Automated Data Processing

      • AI/ML
      • Data Science
      • Apache Kafka on Kubernetes
      • View All Technologies
    • Start exploring in the Developer Sandbox for free

      sandbox graphic
      Try Red Hat's products and technologies without setup or configuration.
    • Try at no cost
  • Learn

    Featured

    • Kubernetes & Cloud Native
      Openshift icon
    • Linux
      Rhel icon
    • Automation
      Ansible cloud icon
    • Java
      Java icon
    • AI/ML
      AI/ML Icon
    • View All Learning Resources

    E-Books

    • GitOps Cookbook
    • Podman in Action
    • Kubernetes Operators
    • The Path to GitOps
    • View All E-books

    Cheat Sheets

    • Linux Commands
    • Bash Commands
    • Git
    • systemd Commands
    • View All Cheat Sheets

    Documentation

    • API Catalog
    • Product Documentation
    • Legacy Documentation
    • Red Hat Learning

      Learning image
      Boost your technical skills to expert-level with the help of interactive lessons offered by various Red Hat Learning programs.
    • Explore Red Hat Learning
  • Developer Sandbox

    Developer Sandbox

    • Access Red Hat’s products and technologies without setup or configuration, and start developing quicker than ever before with our new, no-cost sandbox environments.
    • Explore Developer Sandbox

    Featured Developer Sandbox activities

    • Get started with your Developer Sandbox
    • OpenShift virtualization and application modernization using the Developer Sandbox
    • Explore all Developer Sandbox activities

    Ready to start developing apps?

    • Try at no cost
  • Blog
  • Events
  • Videos

Handling Exception Scenarios in REST API developed using JAX-RS

October 2, 2017
Rahul Kumar
Related topics:
JavaMicroservices
Related products:
Red Hat Enterprise Linux

Share:

    Prerequisite: Hands on Knowledge of REST API Development using JAX-RS.

    REST Services has been an integral part of complex enterprise applications for several years. Developers generally prefer two APIs listed below for building REST API in their enterprise applications.

    1. JAX-RS – Part of JEE Specification with different implementations like RestEasy, Jersey, Restlet etc.
    2. Spring Boot – An OpenSource Spring Community Project best suited for Microservices-based applications.

    In this Article, we will learn how to handle Exceptions gracefully in Rest APIs which are built using JAX-RS.

    Example

    Lets take an example of an Social Media application like Twitter, deployed in some Application/Web server like Tomcat. A sample REST Endpoint in Twitter API could be like so:

    /tweet/{tweetID}
    // Gives Client a particular tweet based on tweet ID provided.

    Now what if the Client sends a tweetID for which there is no tweet available in database. For example:

    /tweet/25
    // no content(as Response)

    It's not something that the Client of the Rest Service wants to see. In such cases, we can create our own custom exceptions. This way, if someone tries to access a tweet that's not available in server, we simply throw an exception rather return empty content.

    STEP 1: Create Custom Exception

    public class INFONotFoundException extends RuntimeException {
        private static final long serialVersionUID = 1L;
    
        public INFONotFoundException(String message) {
            super(message);
        }
    }

    Now if we access /tweet/25 but the particular tweet ID isn't available, we get the Tomcat Error Page because we are throwing INFONotFoundException in our business class but not catching it. It bubbles up in JAX_RS, which also doesn't know what to do with this exception, so it goes up to servlet container which has a default behavior to show standard error page in case something wrong happened in server side code.

    We don't want an HTML error Page for the exception as the response of Rest API End Point, though. We want a JSON payload as the response so it is useful to the client who is consuming the REST API, so they can parse it accordingly. For this, we would like JAX-RS framework to catch it and return a JSON payload before it goes up to servlet container.

    STEP 2:  Map Custom Exception to JSON Payload(e.g ErrorResponse) using JAX-RS ExceptionMapper

    public class ErrorResponse {
      String errorMessage;
      String errorCode;
      String documentationLink;
      
      public ErrorResponse(String errorMessage, String errorCode, String documentationLink) {
        super();
        this.errorMessage = errorMessage;
        this.errorCode = errorCode;
        this.documentationLink = documentationLink;
      }
      
      public ErrorResponse() {
      
      }
      // Getters and Setters
    }
    @Provider
    public class INFONotFoundExceptionMapper implements ExceptionMapper<INFONotFoundException> {
      @Override
      public Response toResponse(INFONotFoundException ex) {
        ErrorResponse response = new ErrorResponse(ex.getMessage(), "503",
          "https://docs.oracle.com/javaee/7/api/javax/ws/rs/ext/ExceptionMapper.html");
        return Response.ok().entity(response).build();
      }
    }

    Now, when JAX-RS sees any INFONotFoundException in the application, it searches all ExceptionMapper's annotated with @Provider in application and tries to find a mapper which could map the INFONotFoundException to a ErrorResponse. Once it finds a suitable ExceptionMapper, it passes the thrown Exception to the method argument of toResponse(Exception ex) in ExceptionMapper and builds a JSON payload by calling toResponse(Exception e) method of ExceptionMapper.

    Now, the client does not see an HTML error page anymore and JAX-RS gives a nice JSON payload which can help the client with troubleshooting.

    Note:

    1. We can include ExceptionMapper in our REST API in order to address specific Exceptions to be more helpful to the client.

    2. It's always good practice to create a generic ExceptionMapper in case the developer doesn't want to create multiple mappers for each exception thrown in application. This way, no matter what goes wrong in our server side REST API (e.g NullPointerException, DataNotFoundException, etc.), JAX-RS always tries to map it with GenericExceptionMapper and we never see the HTML Error page but instead a JSON payload which can be helpful for the service client.

    @Provider
    public class GenericExceptionMapper implements ExceptionMapper<Throwable> {
      
      @Override
      public Response toResponse(Throwable arg0) {
        // TODO Auto-generated method stub
        return null;
      }
    }
    Last updated: June 8, 2021

    Recent Posts

    • More Essential AI tutorials for Node.js Developers

    • How to run a fraud detection AI model on RHEL CVMs

    • How we use software provenance at Red Hat

    • Alternatives to creating bootc images from scratch

    • How to update OpenStack Services on OpenShift

    Red Hat Developers logo LinkedIn YouTube Twitter Facebook

    Products

    • Red Hat Enterprise Linux
    • Red Hat OpenShift
    • Red Hat Ansible Automation Platform

    Build

    • Developer Sandbox
    • Developer Tools
    • Interactive Tutorials
    • API Catalog

    Quicklinks

    • Learning Resources
    • E-books
    • Cheat Sheets
    • Blog
    • Events
    • Newsletter

    Communicate

    • About us
    • Contact sales
    • Find a partner
    • Report a website issue
    • Site Status Dashboard
    • Report a security problem

    RED HAT DEVELOPER

    Build here. Go anywhere.

    We serve the builders. The problem solvers who create careers with code.

    Join us if you’re a developer, software engineer, web designer, front-end designer, UX designer, computer scientist, architect, tester, product manager, project manager or team lead.

    Sign me up

    Red Hat legal and privacy links

    • About Red Hat
    • Jobs
    • Events
    • Locations
    • Contact Red Hat
    • Red Hat Blog
    • Inclusion at Red Hat
    • Cool Stuff Store
    • Red Hat Summit

    Red Hat legal and privacy links

    • Privacy statement
    • Terms of use
    • All policies and guidelines
    • Digital accessibility

    Report a website issue