org.pac4j.core.credentials.authenticator

Interface TokenAuthenticator

All Superinterfaces:

Authenticator<TokenCredentials>

All Known Implementing Classes:

IpRegexpAuthenticator, JwtAuthenticator, SimpleTestDigestAuthenticator, SimpleTestTokenAuthenticator

public interface TokenAuthenticator
extends Authenticator<TokenCredentials>

This interface represents the contract to validate a token credentials.

Since:

1.8.0

Author:

Jerome Leleu

Method Summary

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

Method Detail

validate

void validate(TokenCredentials credentials,
              WebContext context)
       throws HttpAction

Description copied from interface: Authenticator

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

Specified by:

validate in interface Authenticator<TokenCredentials>

Parameters:

credentials - the given credentials

context - the web context

Throws:

HttpAction - requires a specific HTTP action if necessary