org.pac4j.core.credentials.authenticator

Interface Authenticator<C extends Credentials>

All Known Implementing Classes:

AbstractProfileService, CasAuthenticator, CasRestAuthenticator, CouchProfileService, DbAuthenticator, DbProfileService, InMemoryProfileService, IpRegexpAuthenticator, JwtAuthenticator, KerberosAuthenticator, LdapAuthenticator, LdapProfileService, LocalCachingAuthenticator, MongoAuthenticator, MongoProfileService, OAuth10Authenticator, OAuth20Authenticator, OidcAuthenticator, RestAuthenticator, SAML2Authenticator, SimpleTestDigestAuthenticator, SimpleTestTokenAuthenticator, SimpleTestUsernamePasswordAuthenticator, YahooAuthenticator

public interface Authenticator<C extends Credentials>

An authenticator is responsible for validating Credentials and should throw a CredentialsException if the authentication fails.

Since:

1.7.0

Author:

Jerome Leleu

Method Summary

Modifier and Type	Method and Description
void	validate(C credentials, WebContext context) Validate the credentials.

Method Detail

validate

void validate(C credentials,
              WebContext context)
       throws HttpAction,
              CredentialsException

Validate the credentials. It should throw a CredentialsException in case of failure.

Parameters:

credentials - the given credentials

context - the web context

Throws:

HttpAction - requires a specific HTTP action if necessary

CredentialsException - the credentials are invalid