Add binder for annotated custom Principal

[jeremyg484]

A new @User annotation is added that can be used to bind a custom Principal object to a method parameter for the
currently active login.

This allows for users to provide their own custom authentication object and still be able to bind it to @Controller
method parameters as long as the parameter is annotated with @User and matches the type of the authentication
stored in the request.

For example:

@Post("/{var1}/method")
fun method(
        @PathVariable var1: String,
        @Body request: SomeOurRequest,
        @User userToken: our.package.TokenAuthentication,
    ): HttpResponse<Unit>

would work without requiring the user to supply their own RequestArgumentBinder

This resolves #1430

[jeremyg484]

@sdelamo Note that I have not added documentation for this enhancement yet - wanted to see what you think of the idea first.

[sdelamo]

I am not sure about this. it will require to create a custom authentication response.

[sdelamo]

why this change?

[jeremyg484]

It seemed more appropriate since that is the binder that gets used when the method argument is Authentication.

[sdelamo]

all of these methods return Publisher. we could just return String. Returning Single is unrelated with what is under test.

[jeremyg484]

I agree. I wasn't sure if the original spec author was explicitly trying to make sure it worked with Publisher for some non-obvious reason since it was explicitly being called out in the spec method descriptions.

[sdelamo]

I have created a PR with docs #1524 for the current behaviour.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

80.0% Coverage
0.0% Duplication

[jeremyg484]

I am not sure about this. it will require to create a custom authentication response.

@sdelamo I wouldn't say it requires it so much as it supports it. I assume that must be what the user in #1430 is already doing in order to generate their custom Authentication subtype, right?

[sdelamo]

Closing this for now. I am not sure about this feature.