Package com.adobe.granite.auth.oauth
Interface CredentialsValidator
-
@ConsumerType public interface CredentialsValidator
This interface is intended to be implemented by an application which wants to customize the validation of the users based on their credential.
A
CredentialsValidator
is passed toProvider
providers ifProvider.getId()
equalsgetId()
orgetId()
is equals toALL_ID
-
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ALL_ID
Id used to register a validator to all providersstatic java.lang.String
FAILED_VALIDATION_REASON
Credentials Attribute Id used to store the reason why it is not considered valid
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getId()
Provider identifier used to map this credential validator to it.boolean
validate(org.apache.jackrabbit.oak.spi.security.authentication.credentials.AbstractCredentials credentials)
Check the validity of a user credential.
-
-
-
Field Detail
-
ALL_ID
static final java.lang.String ALL_ID
Id used to register a validator to all providers- See Also:
- Constant Field Values
-
FAILED_VALIDATION_REASON
static final java.lang.String FAILED_VALIDATION_REASON
Credentials Attribute Id used to store the reason why it is not considered valid
-
-
Method Detail
-
validate
boolean validate(org.apache.jackrabbit.oak.spi.security.authentication.credentials.AbstractCredentials credentials) throws javax.security.auth.login.LoginException
Check the validity of a user credential. If the user credential is not valid, an optional credential attribute is stored with key @{code- Parameters:
credentials
- the nonnull
credential- Returns:
true
if the credential is valid ;false
otherwise- Throws:
javax.security.auth.login.LoginException
- if the user could not be authenticated
-
getId
java.lang.String getId()
Provider identifier used to map this credential validator to it.- Returns:
- the provider identifier to map this credentials validator to it or ALL_ID if applies to every provider.
-
-