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

Class AuthenticatorAbstract

java.lang.Object

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

All Implemented Interfaces:

ApplicationScopedComponent, Component, Authenticator

Direct Known Subclasses:

PasswordRequestAuthenticatorAbstract

public abstract class AuthenticatorAbstract
extends Object
implements Authenticator

Constructor Summary

Constructors

Constructor and Description
AuthenticatorAbstract(IsisConfiguration configuration)

Method Summary

Methods

Modifier and Type	Method and Description
AuthenticationSession	authenticate(AuthenticationRequest request, String code) Default implementation returns a SimpleSession; can be overridden if required.
IsisConfiguration	getConfiguration()
void	init() Indicates to the component that it is to initialise itself.
abstract boolean	isValid(AuthenticationRequest request) Whether this Authenticator is valid in the running context (and optionally with respect to the provided AuthenticationRequest).
void	shutdown() Indicates to the component that it will no longer be used and should shut itself down cleanly.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.isis.core.runtime.authentication.standard.Authenticator

canAuthenticate

Constructor Detail

AuthenticatorAbstract

public AuthenticatorAbstract(IsisConfiguration configuration)

Method Detail

init

public void init()

Description copied from interface: ApplicationScopedComponent

Indicates to the component that it is to initialise itself.

Specified by:

init in interface ApplicationScopedComponent

shutdown

public void shutdown()

Description copied from interface: ApplicationScopedComponent

Indicates to the component that it will no longer be used and should shut itself down cleanly.

Specified by:

shutdown in interface ApplicationScopedComponent

authenticate

public AuthenticationSession authenticate(AuthenticationRequest request,
                                 String code)

Default implementation returns a SimpleSession; can be overridden if required.

Specified by:

authenticate in interface Authenticator

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

isValid

public abstract boolean isValid(AuthenticationRequest request)

Whether this Authenticator is valid in the running context (and optionally with respect to the provided AuthenticationRequest).

For example, the ExplorationAuthenticator (in the default runtime) is only available for authentication if running in exploration mode.

TODO: [ISIS-292] should change visibility to protected when remove from the API.

Specified by:

isValid in interface Authenticator

getConfiguration

public IsisConfiguration getConfiguration()