Interface ApplicationAuthenticationService
- All Known Implementing Classes:
ApplicationAuthenticationServiceImpl
public interface ApplicationAuthenticationService
Service for creating persistent sessions for specified users in the specified application. When creating sessions for
Crowd users
CrowdApplicationAuthenticationService
can be used for added convenience.- Since:
- 7.0
-
Method Summary
Modifier and TypeMethodDescriptionauthenticate
(Application application, String username, List<ValidationFactor> validationFactors) Authenticates the user to the specified application.
-
Method Details
-
authenticate
@Nonnull AuthenticationToken authenticate(@Nonnull Application application, @Nonnull String username, @Nullable List<ValidationFactor> validationFactors) throws ApplicationAccessDeniedException, OperationFailedException, InactiveAccountException, InvalidAuthenticationException Authenticates the user to the specified application. This method will result in generating a session token, which can be used to access the specified application. The user's credentials will not be verified - it is the caller's responsibility to ensure the user can authenticate.- Parameters:
application
- the application for which the token should be createdusername
- the name of the user who should be treated as authenticatedvalidationFactors
- validation factors to use when generating the token- Throws:
InvalidAuthenticationException
- if the authentication was not successful.OperationFailedException
- if the error was thrown by directory implementation when attempting to find or authenticate the user.InactiveAccountException
- if the user account is inactive.ApplicationAccessDeniedException
- if the user does not have access to authenticate with the Crowd application.
-