com.helger.security.authentication.credentials

Interface IAuthCredentialValidatorSPI

@IsSPIInterface
public interface IAuthCredentialValidatorSPI

This SPI needs to be implemented by all implementing application to validate the specified credentials.
Note: each class implementing this file needs to register itself in a file called /META-INF/services/com.helger.photon.basic.auth.credentials.IAuthCredentialValidatorSPI

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
boolean	supportsCredentials(IAuthCredentials aCredentials) Check if this implementation supports the passed credentials.
ICredentialValidationResult	validateCredentials(IAuthCredentials aCredentials) Validate the specified credentials.

Method Detail

supportsCredentials

boolean supportsCredentials(@Nonnull
                            IAuthCredentials aCredentials)

Check if this implementation supports the passed credentials.

Parameters:

aCredentials - The credentials to be validated. May not be null.

Returns:

true if this implementation supports the specified credentials.

validateCredentials

@Nonnull
ICredentialValidationResult validateCredentials(@Nonnull
                                                          IAuthCredentials aCredentials)

Validate the specified credentials. This method is only called if a previous call to supportsCredentials(IAuthCredentials) returned true .

Parameters:

aCredentials - The credentials to be validated. Never null.

Returns:

The credential validation result. May not be null.