Package com.skava.service.authenticator

Interface UserAuthenticatorService

All Known Implementing Classes:

CustomUserAuthenticatorServiceImpl, DefaultUserAuthenticatorServiceImpl

public interface UserAuthenticatorService

An interface to define the authenticator for authenticating an user.

Author:

Infosys Equinox

Method Summary

Modifier and Type	Method	Description
AuthenticatedUser	authenticate(UserAuthRequest request, AuthenticationConfig config, UserCommonServices userCommonServices)	This method is used to authenticate the given credentials.
default AuthenticatedUser	authenticate(UserAuthRequest request, AuthenticationConfig config, UserCommonServices userCommonServices, CollectionCommonServices collectionCommonServices, com.skava.core.event.EventClientComponent eventClientComponent)	This method is used to authenticate the given credentials.
default boolean	checkPasswordExpiry(UserAuthRequest request, CollectionCommonServices collectionCommonServices, UserCommonServices userCommonServices, AuthenticationConfig authenticationConfig)

Method Details

authenticate

AuthenticatedUser authenticate(UserAuthRequest request,
 AuthenticationConfig config,
 UserCommonServices userCommonServices)

This method is used to authenticate the given credentials.

Parameters:

request - Holds UserAuthRequest object for authenticating the given credentials.

config - Holds AuthenticationConfig object.

userCommonServices - Holds UserCommonServices object for authenticating the given credentials.

Returns:

AuthenticatedUser The UsersEntity object on successful authentication, else throws the validate exception.

authenticate

default AuthenticatedUser authenticate(UserAuthRequest request,
 AuthenticationConfig config,
 UserCommonServices userCommonServices,
 CollectionCommonServices collectionCommonServices,
 com.skava.core.event.EventClientComponent eventClientComponent)

This method is used to authenticate the given credentials.

Parameters:

request - Holds UserAuthRequest object for authenticating the given credentials.

config - Holds AuthenticationConfig object.

userCommonServices - Holds UserCommonServices object for authenticating the given credentials.

eventClientComponent - holds EventClientComponent object

collectionCommonServices - holds CollectionCommonServices object

Returns:

AuthenticatedUser The UsersEntity object on successful authentication, else throws the validate exception.

checkPasswordExpiry

default boolean checkPasswordExpiry(UserAuthRequest request,
 CollectionCommonServices collectionCommonServices,
 UserCommonServices userCommonServices,
 AuthenticationConfig authenticationConfig)

Parameters:

request - request

collectionCommonServices - collectionCommonServices

userCommonServices - userCommonServices

authenticationConfig - authenticationConfig

Returns:

boolean