UserDetailsService implementation in Spring Boot - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the UserDetailsService interface in Spring Security?

UserDetailsService is used to load user-specific data during authentication. It provides a method to fetch user details by username.

beginner

Which method must be implemented when creating a custom UserDetailsService?

The method loadUserByUsername(String username) must be implemented. It returns a UserDetails object for the given username.

beginner

What does the UserDetails object represent in Spring Security?

UserDetails holds user information such as username, password, and authorities (roles). It is used by Spring Security to perform authentication and authorization.

intermediate

How do you handle a user not found scenario in a UserDetailsService implementation?

You throw a UsernameNotFoundException when the user is not found in the data source.

intermediate

Why is it important to return a fully populated UserDetails object in loadUserByUsername?

Because Spring Security uses this object to check credentials and roles. Missing information can cause authentication or authorization failures.

Which interface do you implement to customize user loading in Spring Security?

A UserDetailsService

B AuthenticationProvider

C PasswordEncoder

D UserRepository

UserDetailsService is the interface used to load user data by username.

What exception should be thrown if a user is not found in loadUserByUsername?

A UserNotFoundException

B AuthenticationException

C UsernameNotFoundException

D IllegalArgumentException

UsernameNotFoundException is the standard exception to indicate user absence.

What does the UserDetails object NOT contain?

A User's email verification status

B Username

C Password

D Authorities (roles)

UserDetails does not include email verification status by default.

Which method signature belongs to UserDetailsService?

A User findUserByEmail(String email)

B UserDetails loadUserByUsername(String username)

C boolean checkUserExists(String username)

D void authenticateUser(String username)

loadUserByUsername(String username) is the required method.

What is the main role of UserDetailsService in authentication?

A Authorize user roles

B Encrypt passwords

C Manage user sessions

D Load user data for authentication

UserDetailsService loads user data needed for authentication.

Explain how to implement a custom UserDetailsService in Spring Boot.

Think about the steps to load user info for Spring Security.

Describe the role of the UserDetails object in Spring Security authentication.

Focus on what information Spring Security needs from the user.

Practice

1.

What is the main purpose of implementing UserDetailsService in Spring Boot?

easy

A. To configure database connections

B. To load user-specific data during authentication

C. To handle HTTP requests

D. To manage application properties

Solution

1. Step 1: Understand the role of UserDetailsService

   UserDetailsService is used by Spring Security to load user data during login.

2. Step 2: Identify its main function

   It fetches user details like username, password, and roles for authentication.

3. Final Answer:

   To load user-specific data during authentication -> Option B

4. Quick Check:

   UserDetailsService purpose = Load user data [OK]

Hint: UserDetailsService always loads user info for login [OK]

Common Mistakes:

• Confusing UserDetailsService with database config
• Thinking it handles HTTP requests
• Assuming it manages app properties

2.

Which method must be overridden when implementing UserDetailsService?

easy

A. findUserByEmail(String email)

B. getUserRoles(String username)

C. authenticateUser(User user)

D. loadUserByUsername(String username)

Solution

1. Step 1: Recall UserDetailsService interface

   It declares a single method named loadUserByUsername.

2. Step 2: Confirm method signature

   The method takes a username string and returns UserDetails or throws exception.

3. Final Answer:

   loadUserByUsername(String username) -> Option D

4. Quick Check:

   Method to override = loadUserByUsername [OK]

Hint: Only loadUserByUsername is required in UserDetailsService [OK]

Common Mistakes:

• Trying to override non-existent methods
• Confusing with repository methods
• Using wrong method signatures

3.

Given this UserDetailsService implementation snippet, what happens if the user is not found?

public UserDetails loadUserByUsername(String username) {
    Optional<User> user = userRepository.findByUsername(username);
    if (user.isEmpty()) {
        throw new UsernameNotFoundException("User not found");
    }
    return new CustomUserDetails(user.get());
}

medium

A. Throws UsernameNotFoundException stopping login

B. Returns null and allows login

C. Returns empty UserDetails object

D. Logs error but continues login

Solution

1. Step 1: Check user existence condition

   If user is not found, user.isEmpty() is true.

2. Step 2: Analyze exception throwing

   Throws UsernameNotFoundException which stops authentication process.

3. Final Answer:

   Throws UsernameNotFoundException stopping login -> Option A

4. Quick Check:

   User not found = Exception thrown [OK]

Hint: User not found must throw exception to block login [OK]

Common Mistakes:

• Returning null instead of throwing exception
• Ignoring empty user Optional
• Not handling exception properly

4.

Identify the error in this UserDetailsService implementation:

public UserDetails loadUserByUsername(String username) {
    User user = userRepository.findByUsername(username);
    if (user == null) {
        return null;
    }
    return new CustomUserDetails(user);
}

medium

A. Returning null instead of throwing UsernameNotFoundException

B. Using Optional incorrectly

C. Missing @Override annotation

D. Not calling super.loadUserByUsername

Solution

1. Step 1: Check handling of missing user

   Returning null on user not found is incorrect for Spring Security.

2. Step 2: Correct approach for missing user

   Should throw UsernameNotFoundException to stop authentication properly.

3. Final Answer:

   Returning null instead of throwing UsernameNotFoundException -> Option A

4. Quick Check:

   Missing user must throw exception, not return null [OK]

Hint: Never return null; always throw UsernameNotFoundException [OK]

Common Mistakes:

• Returning null causes NullPointerException later
• Ignoring exception requirement
• Assuming @Override is mandatory (optional but recommended)

5.

You want to implement UserDetailsService to load users from a database and assign roles dynamically. Which approach correctly combines fetching user data and setting roles?

public UserDetails loadUserByUsername(String username) {
    User user = userRepository.findByUsername(username)
        .orElseThrow(() -> new UsernameNotFoundException("User not found"));
    List<GrantedAuthority> authorities = user.getRoles().stream()
        .map(role -> new SimpleGrantedAuthority(role.getName()))
        .toList();
    return new org.springframework.security.core.userdetails.User(
        user.getUsername(), user.getPassword(), authorities);
}

hard

A. Returns user without roles assigned

B. Fails to throw exception if user missing

C. Correctly fetches user and maps roles to authorities

D. Uses deprecated method toList() causing error

Solution

1. Step 1: Verify user fetching with exception

   Uses orElseThrow to throw UsernameNotFoundException if user missing, correct behavior.

2. Step 2: Check role mapping to authorities

   Maps user roles to GrantedAuthority list properly using stream and SimpleGrantedAuthority.

3. Step 3: Confirm UserDetails creation

   Creates Spring Security User object with username, password, and authorities as expected.

4. Final Answer:

   Correctly fetches user and maps roles to authorities -> Option C

5. Quick Check:

   User fetch + role mapping = Correct implementation [OK]

Hint: Use orElseThrow and map roles to authorities for UserDetails [OK]

Common Mistakes:

• Not throwing exception on missing user
• Forgetting to map roles to authorities
• Using deprecated or incorrect stream methods