Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

JAX-RS jersey ExceptionMapper: How to know the method who threw the exception

Im using JAX-RS jersey ExceptionMapper, and I'm wondering if there is a way to know inside the method toResponse(), which method (from the API) threw the exception.

Example (dummy code)

@javax.ws.rs.Path(“/bookstore/books/{bookID}”)
public class Book {
    @javax.ws.rs.GET
    public String informationMethod(String user) {
        ...
            throw new Exception("Error");
        ....    
    }    
}



@Provider
public class SomeMapper implements ExceptionMapper<Exception> {
    @Override
    public Response toResponse(Exception ex) {

        //a way to get the method name that threw the exception. 
        //In the above example is: informationMethod.
        String methodName = //informationMethod

        return Response.status(500).entity(ex.getMessage()).type("text/plain")
                .build();
    }
}
like image 270
satellite satellite Avatar asked Dec 23 '16 12:12

satellite satellite


People also ask

How do you handle exceptions in JAX RS?

Thrown exceptions are handled by the JAX-RS runtime if you have registered an exception mapper. Exception mappers can convert an exception to an HTTP response. If the thrown exception is not handled by a mapper, it is propagated and handled by the container (i.e., servlet) JAX-RS is running within.

What is an Exception mapper?

ExceptionMappers are custom, application provided, components that can catch thrown application exceptions and write specific HTTP responses. The are classes annotated with @Provider and that implement this interface.


1 Answers

You can provide some information from context to your ExceptionMapper.

package your.rest.pckg;

import java.lang.reflect.Method;
import java.net.URI;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.ws.rs.Path;
import javax.ws.rs.container.ResourceInfo;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriBuilder;
import javax.ws.rs.core.UriInfo;
import javax.ws.rs.ext.ExceptionMapper;
import javax.ws.rs.ext.Provider;

@Provider
public class SomeMapper
                implements ExceptionMapper<Exception>
{

    @Context private HttpServletRequest request;

    @Context private HttpServletResponse response;

    @Context private ResourceInfo resourceInfo;

    @Context private UriInfo uriInfo;

    @Override
    public Response toResponse( Exception ex )
    {
        String method = request.getMethod();
        String pathInfo = request.getPathInfo();

        Class<?> resourceClass = resourceInfo.getResourceClass();
        Method resourceMethod = resourceInfo.getResourceMethod();
        URI resourcePath = getResourcePath( resourceClass, resourceMethod );

        URI requestUri = uriInfo.getRequestUri();
        MultivaluedMap<String, String> pathParams = uriInfo.getPathParameters();
        MultivaluedMap<String, String> queryParams = uriInfo.getQueryParameters();

        // define your object to provide data through response
        Object responseEntity = ex.getMessage(); 

        // do your stuff

        return Response.status( Response.Status.INTERNAL_SERVER_ERROR )
                       .entity( responseEntity )
                       .type( MediaType.APPLICATION_JSON )
                       .build();
    }

    private static URI getResourcePath( Class<?> clazz, Method method )
    {
        if ( clazz == null || !clazz.isAnnotationPresent( Path.class ) )
        {
            return null;
        }

        UriBuilder builder = UriBuilder.fromResource( clazz );
        if ( method != null && method.isAnnotationPresent( Path.class ) )
        {
            builder.path( method );
        }

        return builder.build();
    }
}

See

  • HttpServletRequest.java
  • HttpServletResponse.java
  • ResourceInfo.java
  • UriInfo.java

Instead of Excpetion you can also map Throwable.

To pass through WebApplicationExcpetions just add following if clause at the beginnig of toResponse() body:

if (ex instanceof WebApplicationException)
{
    return (( (WebApplicationException) ex ).getResponse());
}

You can also use all of the @Context fields in your resource class Book.

like image 76
phse Avatar answered Sep 25 '22 06:09

phse