Jersey：是否可以覆盖Jersey filter（）的返回类型？

Question

Here's my use case:

I have implemented a Jersey filter public void filter(ContainerRequestContext requestContext){ //do stuff } that will intercept all incoming requests to any Jersey endpoints I have registered. Based on some validation I do of the incoming request headers, I have been able to reject a request via the following:

Response response = Response.status(status).entity(errorMsg).build();
requestContext.abortWith(response);

This is how I have been doing it and it has worked for me. However, now I need to access certain information in the requestContext within the actual requested endpoint itself. I know this can be done like so:

@Path("/path")
@GET
public ReturnType endpoint(@Context ContainerRequestContext requestContext,
                           @CookieParam("cookieId") String cookieValue,
                           @HeaderParam("headerId") String headerValue, etc..){
    //do stuff
}

The problem is, if I do the above^ to access the request information on the endpoint, I can no longer abort the request in the filter if the filter validation fails because I get the following error:

java.lang.IllegalStateException: The request cannot be aborted as it is
already in the response processing phase.

It seems that if you define any kind of parameters on your Jersey endpoints that can be accessed within the ContainerRequestContext, it will not allow you to abort the filter chain within the filter.

One work around (that I haven't tried yet but assuming will work), would be to do this: Instead of attempting to abort the request within the filter if the filter validation fails, I can just add a custom header to the request. Then, on the endpoint itself, I can do a check to see if that header is set. If it's set, I know the filter validation failed, and then I can build a Response object and return that. If it's not set, I know the filter validation succeeded, and I can go ahead and process the request.

However, to avoid having to do this check manually on every single Jersey endpoint I have (hence the point of filters), it would be nice to just stop the request at the filter and return/abort the response right there. I thought that was the whole point of filters in the first place. However, the return type of the Jersey filter method is void , and I can't seem to override that.

Anyone have a solution to my dilemna?

Answer 1

Figured out what the root of the issue was. My filter was a response filter that looked like the following:

class ResponseFilter implements ContainerResponseFilter{
    public void filter(ContainerRequestContext requestContext,
                       ContainerResponseContext responseContext){
        MultivaluedMap<String, Object> headers = responseContext.getHeaders();
        headers.add("Access-Control-Allow-Origin", "http://localhost:9000");
        headers.add("Access-Control-Allow-Methods", "GET, POST, DELETE, PUT");
        headers.add("Access-Control-Allow-Headers", "Content-Type" );
        headers.add("Access-Control-Allow-Credentials", "true" );
        if(requestValidationFailed){
            Response response = Response.status(status).entity(error).build();
            requestContext.abortWith(response);
        }
    }
}

As you can see from the above code example, I'm already defining the response headers before I even get to the request validation check. By doing this, Jersey assumes I'm now in the 'response processing phase'. It makes sense that it won't let me abort the request when I'm already setting headers for a response.

There might be other ways to solve this, but I solved it by splitting my filter into two filters (two separate classes).

class RequestFilter implements ContainerRequestFilter{
    public void filter(ContainerRequestContext requestContext){
        if(requestValidationFailed){
            Response response = Response.status(status).entity(error).build();
            requestContext.abortWith(response);
        }
}

class ResponseFilter implements ContainerResponseFilter{
    public void filter(ContainerRequestContext requestContext,
                       ContainerResponseContext responseContext){
        MultivaluedMap<String, Object> headers = responseContext.getHeaders();
        headers.add("Access-Control-Allow-Origin", "http://localhost:9000");
        headers.add("Access-Control-Allow-Methods", "GET, POST, DELETE, PUT");
        headers.add("Access-Control-Allow-Headers", "Content-Type" );
        headers.add("Access-Control-Allow-Credentials", "true" );
    }
}

I can now pass @Context , @CookieParam , @HeaderParam , etc. parameters into my resource class functions without getting the java.io.IllegalStateException . The filter chain also gets successfully aborted when my requestValidationFailed check returns true and the resource function is never called.