JAX-RS / Jersey comment personnaliser erreur de manipulation?

Il existe plusieurs approches pour personnaliser la gestion des erreurs de comportement avec JAX-RS. Voici trois de la plus simple des façons.

La première approche consiste à créer une classe d'Exception qui s'étend WebApplicationException.

Exemple:

public class NotAuthorizedException extends WebApplicationException {
     public NotAuthorizedException(String message) {
         super(Response.status(Response.Status.UNAUTHORIZED)
             .entity(message).type(MediaType.TEXT_PLAIN).build());
     }
}

Et pour lancer ce nouveau créer Exception, il vous suffit de:

@Path("accounts/{accountId}/")
    public Item getItem(@PathParam("accountId") String accountId) {
       //An unauthorized user tries to enter
       throw new NotAuthorizedException("You Don't Have Permission");
}

Avis, vous n'avez pas besoin de déclarer l'exception d'une clause throws parce que WebApplicationException est une Exception d'exécution. Ce sera de retour une réponse 401 pour le client.

La deuxième et la plus facile est de simplement construire une instance de la WebApplicationException directement dans votre code. Cette approche fonctionne aussi longtemps que vous n'avez pas à mettre en place votre propre application des Exceptions.

Exemple:

@Path("accounts/{accountId}/")
public Item getItem(@PathParam("accountId") String accountId) {
   //An unauthorized user tries to enter
   throw new WebApplicationException(Response.Status.UNAUTHORIZED);
}

Ce code trop renvoie un 401 pour le client.

De sûr, c'est juste un exemple simple. Vous pouvez faire de l'Exception beaucoup plus complexe si nécessaire, et vous pouvez générer ce code de réponse http, vous devez.

Une autre approche consiste à enrouler une Exception existante, peut-être un ObjectNotFoundException avec un petit emballage de la classe qui implémente l'ExceptionMapper interface annotée avec @Fournisseur d'annotation. Ceci dit à JAX-RS de l'exécution, que si la enveloppé Exception est levée, le retour de la réponse de code défini dans le ExceptionMapper.

Jersey jette un com.soleil.jersey.l'api.ParamException quand il ne parvient pas à unmarshall les paramètres, donc la seule solution est de créer un ExceptionMapper qui s'occupe de ces types d'exceptions:

@Provider
public class ParamExceptionMapper implements ExceptionMapper<ParamException> {
    @Override
    public Response toResponse(ParamException exception) {
        return Response.status(Status.BAD_REQUEST).entity(exception.getParameterName() + " incorrect type").build();
    }
}

Une solution évidente: prendre une Chaîne à convertir à Jour vous-même. De cette façon, vous pouvez définir le format que vous souhaitez, de capturer des exceptions et re-jeter ou de personnaliser l'erreur est envoyé.
Pour l'analyse, la SimpleDateFormat devrait fonctionner correctement.

Je suis sûr qu'il existe des moyens pour accrocher des gestionnaires pour les types de données trop, mais peut-être peu de code simple est tout ce que vous devez dans ce cas.

@QueryParam documentation dit

" Le type T de la annoté paramètre, le champ ou bien doit
soit:

1) Être un type primitif

2) Avoir un constructeur qui accepte un seul
Argument de la chaîne

3) Avoir une méthode statique nommée valueOf ou fromString
qui accepte un seul argument de type Chaîne (voir, par exemple,
Entier.valueOf(String))

4) Ont enregistré de mise en œuvre de
javax.ws.rs.ext.ParamConverterProvider JAX-RS extension de SPI qui
retourne un javax.ws.rs.ext.ParamConverter instance en charge de
"chaîne de conversion pour le type.

5) Liste de, Ensemble ou
SortedSet, où T satisfait à 2, 3 ou 4 ci-dessus. Le résultant
la collection est en lecture seule. "

Si vous voulez contrôler ce que la réponse va de l'utilisateur, lors de l'paramètre de requête dans la forme d'une Chaîne ne peut pas être convertie en fonction de votre type T, vous pouvez jeter WebApplicationException. Dropwizard est livré avec les éléments suivants: *Param classes que vous pouvez utiliser pour vos besoins.

BooleanParam, DateTimeParam, IntParam, LongParam, LocalDateParam, NonEmptyStringParam, UUIDParam. Voir https://github.com/dropwizard/dropwizard/tree/master/dropwizard-jersey/src/main/java/io/dropwizard/jersey/params

Si vous avez besoin de Joda DateTime, il suffit d'utiliser Dropwizard DateTimeParam.

Si la liste ci-dessus n'est pas de répondre à vos besoins, définir vos propres en étendant AbstractParam. Remplacer méthode d'analyse. Si vous avez besoin de contrôler l'erreur corps de la réponse, substituez la méthode d'erreur.

Bon article de Coda Hale sur ce qui est à http://codahale.com/what-makes-jersey-interesting-parameter-classes/

import io.dropwizard.jersey.params.AbstractParam;

import java.util.Date;

import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;

public class DateParam extends AbstractParam<Date> {

    public DateParam(String input) {
        super(input);
    }

    @Override
    protected Date parse(String input) throws Exception {
        return new Date(input);
    }

    @Override
    protected Response error(String input, Exception e) {
        //customize response body if you like here by specifying entity
        return Response.status(Status.BAD_REQUEST).build();
    }
}

Date(String arg) constructeur est obsolète. Je voudrais utiliser Java 8 classes de date si vous êtes sur l'île de Java 8. Sinon joda date heure est recommandée.

Comme une extension de @Steven Lavine réponse dans le cas où vous souhaitez ouvrir le navigateur de la fenêtre de connexion. J'ai trouvé difficile de retourner correctement la Réponse (MDN Authentification HTTP) du Filtre dans le cas où l'utilisateur n'est pas authentifié

Cela m'a aidé à construire la Réponse à la force du navigateur de connexion, remarque la modification des en-têtes. Ceci permettra de définir le code d'état à 401 et la tête qui provoque le navigateur pour ouvrir le nom d'utilisateur/mot de passe de boîte de dialogue.

//The extended Exception class
public class NotLoggedInException extends WebApplicationException {
  public NotLoggedInException(String message) {
    super(Response.status(Response.Status.UNAUTHORIZED)
      .entity(message)
      .type(MediaType.TEXT_PLAIN)
      .header("WWW-Authenticate", "Basic realm=SecuredApp").build()); 
  }
}

//Usage in the Filter
if(headers.get("Authorization") == null) { throw new NotLoggedInException("Not logged in"); }