It is not possible to get the referer header field

[rnowosielski]

• Framework version: 1.2
• Implementations: Jersey

Scenario

I am trying to retrieve the header from the original request using the @HeaderParam("Referer") annotation e.g

@PUT
@Path("{url}")
@Produces("application/json")
public Response doSomething(@HeaderParam("Referer") String referer) throws Exception {
       logger.info("Referer: " + referer);
}

Expected behavior

The logger should log the value of the referer header that was passed when calling the endpoint

Actual behavior

The log entry states

[main] INFO LambdaHandler - Referer: null

Steps to reproduce

Create an endpoint according to the snippet in the "use case" section, and then call the endpoint by passing Referer header on the request.

[sapessi]

Hey @rnowosielski, I just wrote a quick unit test for this. A Referer header is indeed not injected by Jersey, even though I can see it in the event. Funnily enough, when I use the exact same method and @HeaderParam annotation for an X-Custom-Referer header it gets injected correctly. This looks like Jersey's doing. I'm investigating a little bit further.

[sapessi]

Never mind, investigated a bit more and it looks like it was indeed a bug. Committing a fix now.

The root cause is that from the JerseyHandlerFilter class I was happily calling the add method of the MultiValuesMap, expecting it to add values to the list and create the list if it didn't exists. It looks like Jersey's implementation does not override this behavior and simply sends to the addNull unimplemented method if the list doesn't already exist. Switched to the addAll method.

[rnowosielski]

@sapessi Is there a way to download the most recent snapshot version, so I could test it in my code without having to build it myself?

[sapessi]

Yes @rnowosielski, changes are committed to the core branch. Just download the code for that branch, mvn install, then add 1.3-SNAPSHOT as a dependency in your code.

[akrambek]

@sapessi I am having the same issue and seems to be caused by https://github.com/awslabs/aws-serverless-java-container/blob/master/aws-serverless-java-container-core/src/main/java/com/amazonaws/serverless/proxy/internal/servlet/AwsProxyHttpServletRequest.java#L808 Any reason why it is replaced with getIdentity().getCaller()?!

[sapessi]

Hey @akrambek, that's where API Gateway stores the caller/referer. Could you test with 1.3-SNAPSHOT from the core branch to see if that fixes your issue?

[akrambek]

hey @sapessi yep it works thanks! Looking forward to the official release.

[rnowosielski]

@sapessi do you have some rough estimate when 1.3 might go out ?

[sapessi]

@rnowosielski my best guess right now is end of December.

[rnowosielski]

👍 thanks for a quick response.

[sapessi]

Resolving in preparation for 1.3 release

[zsc347]

Hey @akrambek, that's where API Gateway stores the caller/referer. Could you test with 1.3-SNAPSHOT from the core branch to see if that fixes your issue?

Seems API Gateway do not store referer header to getIdentity().getCaller() anymore. But I can get it from multiValueHeaders. Could you check latest behavior?