JAX / Джерси Пользовательский код ошибки в ответе - PullRequest
Новая
       21

JAX / Джерси Пользовательский код ошибки в ответе

23 голосов
/ 07 января 2010

В Джерси, как мы можем «заменить» строку состояния, связанную с известным кодом состояния?

, например 

return Response.status(401).build();

генерирует HTTP-ответ, содержащий: 

HTTP/1.1 401 Unauthorized

Я (не я, а клиентское приложение) хотел бы видеть ответ как: 

HTTP/1.1 401 Authorization Required

Я попробовал следующие подходы, но тщетно:

1) Это просто добавляет строку в теле HTTP-ответа 

return Response.status(401).entity("Authorization Required").build();

2) Тот же результат с этим тоже: 

ResponseBuilder rb = Response.status(401);
rb = rb.tag("Authorization Required");
return rb.build();

Ценю вашу помощь!

-spd

Ответы [ 2 ]

38 голосов
/ 31 января 2010

Чтобы сделать это в Джерси, у вас есть концепция класса WebApplicationException.Один из методов - просто расширить этот класс и все один из методов, чтобы установить возвращаемый текст ошибки.В вашем случае это будет: 

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


public class UnauthorizedException extends WebApplicationException {

    /**
      * Create a HTTP 401 (Unauthorized) exception.
     */
     public UnauthorizedException() {
         super(Response.status(Status.UNAUTHORIZED).build());
     }

     /**
      * Create a HTTP 404 (Not Found) exception.
      * @param message the String that is the entity of the 404 response.
      */
     public UnauthorizedException(String message) {
         super(Response.status(Status.UNAUTHORIZED).entity(message).type("text/plain").build());
     }

}

Теперь в вашем коде, который реализует службу отдыха, вы просто выбросите новое исключение этого типа, передав текстовое значение в конструктор, например 

throw new UnauthorizedException("Authorization Required");

Это может создать такой класс для каждого из ваших веб-исключений и генерировать аналогичным образом.

Это также объясняется в руководстве пользователя на Джерси - хотя код на самом деле немного неверный:

https://jersey.github.io/nonav/documentation/latest/user-guide.html/#d4e435

4 голосов
/ 22 августа 2013

Я не уверен JSR 339: JAX-RS 2.0: Java API для RESTful Web Services уже рассмотрел это или нет.

Возможно, для этого вам придется расширить Response.StatusType . 

public abstract class AbstractStatusType implements StatusType {

    public AbstractStatusType(final Family family, final int statusCode,
                              final String reasonPhrase) {
        super();

        this.family = family;
        this.statusCode = statusCode;
        this.reasonPhrase = reasonPhrase;
    }

    protected AbstractStatusType(final Status status,
                                 final String reasonPhrase) {
        this(status.getFamily(), status.getStatusCode(), reasonPhrase);
    }

    @Override
    public Family getFamily() { return family; }

    @Override
    public String getReasonPhrase() { return reasonPhrase; }

    @Override
    public int getStatusCode() { return statusCode; }

    public ResponseBuilder responseBuilder() { return Response.status(this); }

    public Response build() { return responseBuilder().build(); }

    public WebApplicationException except() {
        return new WebApplicationException(build());
    }

    private final Family family;
    private final int statusCode;
    private final String reasonPhrase;
}

А вот несколько расширенных типов статов. 

public class BadRequest400 extends AbstractStatusType {

    public BadRequest400(final String reasonPhrase) {
        super(Status.BAD_REQUEST, reasonPhrase);
    }
}

public class NotFound404 extends AbstractStatusType {

    public NotFound404(final String reasonPhrase) {
        super(Status.NOT_FOUND, reasonPhrase);
    }
}

Вот как я. 

@POST
public Response create(final MyEntity entity) {

    throw new BadRequest400("bad ass").except();
}

@GET
public MyEntity read(@QueryParam("id") final long id) {

    throw new NotFound404("ass ignorant").except();
}

// Disclaimer
// I'm not a native English speaker.
// I don't know what 'bad ass' or 'ass ignorant' means.
...