1 /*
2 * Copyright (c) 2002-2024, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.plugins.rest.service.mapper;
35
36 import fr.paris.lutece.portal.service.util.AppLogService;
37
38 import javax.ws.rs.core.Response;
39 import javax.ws.rs.ext.ExceptionMapper;
40
41 import static javax.ws.rs.core.Response.Status;
42
43 /**
44 * Generic exception mapper, implementing {@link ExceptionMapper}, used to convert uncaught exceptions to a proper {@link Response} to return.<br/>
45 * To implement your own in a Lutece plugin or module using lutece-rest-plugin-rest, extend this class, annotate it with {@link javax.ws.rs.ext.Provider}, and
46 * add it as a bean in the context.xml file.
47 *
48 * @param <T>
49 * The sub-class of {@link Throwable} to catch
50 * @param <E>
51 * The entity type wanted in the {@link Response}
52 */
53 public abstract class GenericUncaughtExceptionMapper<T extends Throwable, E> implements ExceptionMapper<T>
54 {
55
56 public static final String ERROR_DURING_TREATMENT = "An error occurred during the treatment.";
57
58 @Override
59 public Response toResponse( final T exception )
60 {
61 AppLogService.error( "REST : Uncaught exception occured :: {}", exception.getMessage( ) );
62 return Response.status( getStatus( exception ) ).entity( getBody( exception ) ).type( getType( ) ).build( );
63 }
64
65 protected abstract Status getStatus( final T exception );
66
67 protected abstract E getBody( final T exception );
68
69 protected abstract String getType( );
70
71 }