How to add custom argument in Spring controller method argument (like: @RequestParam, Model)?

Question

This is a typical Spring controller method.

public ResponseEntity<RestApiResponse<OTPResponse>> sendOtp(HttpServletRequest request) {
        UserDetails userDetails = (UserDetails) request.getSession().getAttribute(SessionKey.USER_DETAILS);
        // Do some work
        //...
}

To get the username I have to copy the bellow line over and over again in every other controller method.

UserDetails userDetails = (UserDetails) request.getSession().getAttribute(SessionKey.USER_DETAILS);

Can I do this as follows ?

// @UserDetails is some kind of imaginary annotation 
public ResponseEntity<RestApiResponse<OTPResponse>> sendOtp(@UserDetails UserDetails userDetails) {
        userDetails.getUsername();
        // Do some work
        //....
}

Can I intercept the request, get the userDetails from request and inject that as controller method argument?

Jaganath Kamble · Accepted Answer · 2020-01-31 12:52:14Z

2

you can use below code as util method

public UserDetails getUser(){
    Authentication auth = SecurityContextHolder.getContext().getAuthentication();
    if (!(auth instanceof AnonymousAuthenticationToken)) {
        return (UserDetails) auth.getPrincipal();
    }
    return null;
}

Another way of doing same.

@RequestMapping(method = RequestMethod.GET)   
 public ModelAndView anyMethodNameGoesHere(Principal principal) {
        final String loggedInUserName = principal.getName();

 }

edited Jan 31, 2020 at 12:52

answered Jan 31, 2020 at 12:45

Jaganath Kamble

5562 silver badges10 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Bohdan Levchenko Over a year ago

Nice one! The only drawback that this works only with Principal.

Bohdan Levchenko · Accepted Answer · 2020-01-31 16:40:04Z

1

You can intercept requests and do it yourself, however spring-security already have such feature. It is called @AuthenticationPrincipal.

You can use it as follow:

@GetMapping
String hello(@AuthenticationPrincipal java.security.Principal principal) {
    return principal.getName();
}

If having a Principal isn't enough for your usecase, User also works:

@GetMapping
String hello(@AuthenticationPrincipal org.springframework.security.core.userdetails.User user) {
    return user.getUsername();
}

You can even inject your custom user details this way if you want.

Please have a look at documentation.

answered Jan 31, 2020 at 16:40

Bohdan Levchenko

3,5912 gold badges28 silver badges31 bronze badges

Collectives™ on Stack Overflow

How to add custom argument in Spring controller method argument (like: @RequestParam, Model)?

2 Answers 2

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related