Jersery JAXRS resource path validation message for 404

Question

When using regex for @Path fragments, Jersey runtime results in returning 404 for the resources that do not match the regex pattern. Is there a way to customize this behaviour and return 400 (BAD_REQUEST) or add a meaningful message to the response?

@Path("users/{username: [a-zA-Z][a-zA-Z_0-9]}")

If the resource is invoked with users/1243 it results in 404. I would like to add a response message about the valid username patterns. I could move the validation inside the Restful method and validate. But this is tedious. I have dozens of the methods and I would need to call the validation from all these methods.

EDIT: Am using Jersey 1.17 and not can not use Jersey 2.0 due to application impact.

score 3 · Accepted Answer · answered Mar 26 '14 at 14:40

3

You can use a ContainerRequestFilter to catch requests before they hit the API, and use injected UriInfo to determine if there's a users path element. If there is, check the username's validity.

I would note, however, that I don't think 400 is a reasonable response. There's nothing wrong with the syntax of the request.

answered Mar 26 '14 at 14:40

Eric Stein

13,209
3
37
52

I agree. A 404 does not makes sense. The request is failing because it is a bad request. Customizing the message makes sense, but not changing the status code. – Edwin Dalorzo Mar 26 '14 at 15:08
Thnx Eric. I just made a edit to the question. Am using Jersey 1.17. Will search for ContainerRequestFilter usage in Jersey 1.x and give it a try. – suman j Mar 26 '14 at 16:00
@jack the documentation is not great, but the ContainerRequestFilter interface exists in the API javadoc. You may have to do some searching/playing around to get it to work. – Eric Stein Mar 26 '14 at 16:09
@Eric, `ContainerRequestFilter` is a feature of the new JAX-RS 2.0, and Jersey 1.0 implements JAX-RS 1.1. Anyway, an useful answer for some people. – V G Mar 26 '14 at 16:16
@Andreil Well, I confess I'm looking at Jersey and not JAX-RS, but clearly the interface is in there : https://jersey.java.net/apidocs/1.17/jersey/com/sun/jersey/spi/container/ContainerRequestFilter.html – Eric Stein Mar 26 '14 at 16:21

suman j · Answer 2 · 2014-03-26T18:10:14.587

To add to the @Eric Stein's response, having regex in @Path will result in 404 without execution reaching filter methods. So validation has to be pushed inside the filter method. In order to abort the call and return the customized response from filter used below code.



    //groovy code
    class MyCustomFilter implements ContainerRequestFilter
    {
      @Override
        public ContainerRequest filter(ContainerRequest request) {
    //do the validation for the resource URI and abort flow for errors
    throw new WebApplicationException(Response.status(Response.Status.NOT_FOUND).entity("Not valid input").build())
    ...
    .. 
     //for success scenarios, return the request with optional customization

            return request;
        }
    }
    @ResourceFilters(MyCustomFilter)
    @Path('/users/{userId}/scripts')
    class MyJaxRsResource {

    }

Learn something new every day. :-) – Eric Stein Mar 26 '14 at 19:13 — Eric Stein, Mar 26 '14 at 19:13

Jersery JAXRS resource path validation message for 404

2 Answers2