Package org.pac4j.core.credentials.authenticator

Interface Authenticator

All Known Implementing Classes:

AbstractProfileService, InMemoryProfileService, LocalCachingAuthenticator

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Authenticator

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

Since:

1.7.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
static final Authenticator	ALWAYS_VALIDATE
static final Authenticator	NEVER_VALIDATE

Method Summary

Modifier and Type	Method	Description
Optional<Credentials>	validate(CallContext ctx, Credentials credentials)	Validate the credentials.

Field Details

ALWAYS_VALIDATE

static final Authenticator ALWAYS_VALIDATE

NEVER_VALIDATE

static final Authenticator NEVER_VALIDATE

Method Details

validate

Optional<Credentials> validate(CallContext ctx,
 Credentials credentials)

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

Parameters:

ctx - the context

credentials - the given credentials

Returns:

the credentials