org.apache.isis.core.runtime.authentication.standard

Interface Authenticator

All Superinterfaces:

ApplicationScopedComponent, Component

All Known Subinterfaces:

Registrar

All Known Implementing Classes:

AuthenticatorAbstract, PasswordRequestAuthenticatorAbstract

public interface Authenticator
extends ApplicationScopedComponent

Method Summary

Methods

Modifier and Type	Method and Description
AuthenticationSession	authenticate(AuthenticationRequest request, String code)
boolean	canAuthenticate(Class<? extends AuthenticationRequest> authenticationRequestClass) Whether the provided AuthenticationRequest is recognized by this Authenticator.
boolean	isValid(AuthenticationRequest request) Deprecated.

Methods inherited from interface org.apache.isis.core.commons.components.ApplicationScopedComponent

init, shutdown

Method Detail

canAuthenticate

boolean canAuthenticate(Class<? extends AuthenticationRequest> authenticationRequestClass)

Whether the provided AuthenticationRequest is recognized by this Authenticator.

isValid

@Deprecated
boolean isValid(AuthenticationRequest request)

Deprecated.

UNUSED ... IMPLEMENTATIONS SHOULD PROVIDE A STUB METHOD ONLY.

This method is only ever called from AuthenticatorAbstract, and as such should not be defined as part of the API.

TODO: remove in 2.0.0 [ISIS-292]

authenticate

AuthenticationSession authenticate(AuthenticationRequest request,
                                 String code)

Parameters:

code - - a hint; is guaranteed to be unique, but the authenticator decides whether to use it or not.