org.springframework.security.core.userdetails
Interface UserDetailsChecker

All Known Implementing Classes:
AccountStatusUserDetailsChecker

public interface UserDetailsChecker

Called by classes which make use of a UserDetailsService to check the status of the loaded UserDetails object. Typically this will involve examining the various flags associated with the account and raising an exception if the information cannot be used (for example if the user account is locked or disabled), but a custom implementation could perform any checks it wished.

The intention is that this interface should only be used for checks on the persistent data associated with the user. It should not involved in making any authentication decisions based on a submitted authentication request.

Since:
2.0
See Also:
AccountStatusUserDetailsChecker, AccountStatusException

Method Summary
 void check(UserDetails toCheck)
          Examines the User
 

Method Detail

check

void check(UserDetails toCheck)
Examines the User

Parameters:
toCheck - the UserDetails instance whose status should be checked.