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

Class AuthenticationManagerStandard

java.lang.Object

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

All Implemented Interfaces:

ApplicationScopedComponent, Component, Debuggable, DebuggableWithTitle, AuthenticationManager

public class AuthenticationManagerStandard
extends Object
implements AuthenticationManager, DebuggableWithTitle

Constructor Summary

Constructors

Constructor and Description
AuthenticationManagerStandard(IsisConfiguration configuration)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAuthenticator(Authenticator authenticator) Adds an Authenticator.
protected void	addAuthenticatorToStart(Authenticator authenticator) Adds an Authenticator to the start of the list (not API).
protected void	addDefaultAuthenticators() optional hook method
AuthenticationSession	authenticate(AuthenticationRequest request) Caches and returns an authentication AuthenticationSession if the request is valid; otherwise returns null.
void	closeSession(AuthenticationSession session)
void	debugData(DebugBuilder debug) Debug details describing the object being investigated
String	debugTitle() The title for the debug information
List<Authenticator>	getAuthenticators()
protected IsisConfiguration	getConfiguration()
RandomCodeGenerator	getRandomCodeGenerator() The RandomCodeGenerator in use.
List<Registrar>	getRegistrars()
void	init() Will default the RandomCodeGenerator, but Authenticator(s) must have been added or injected.
boolean	isSessionValid(AuthenticationSession session) Whether the provided AuthenticationSession is still valid.
boolean	register(RegistrationDetails registrationDetails)
void	setAuthenticators(List<Authenticator> authenticators) Provide direct injection.
void	setRandomCodeGenerator(RandomCodeGenerator randomCodeGenerator) For injection; will default otherwise.
void	shutdown() Indicates to the component that it will no longer be used and should shut itself down cleanly.
boolean	supportsRegistration(Class<? extends RegistrationDetails> registrationDetailsClass)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationManagerStandard

public AuthenticationManagerStandard(IsisConfiguration configuration)

Method Detail

init

public final void init()

Will default the RandomCodeGenerator, but Authenticator(s) must have been added or injected.

Specified by:

init in interface ApplicationScopedComponent

addDefaultAuthenticators

protected void addDefaultAuthenticators()

optional hook method

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 final AuthenticationSession authenticate(AuthenticationRequest request)

Description copied from interface: AuthenticationManager

Caches and returns an authentication AuthenticationSession if the request is valid; otherwise returns null.

Specified by:

authenticate in interface AuthenticationManager

isSessionValid

public final boolean isSessionValid(AuthenticationSession session)

Description copied from interface: AuthenticationManager

Whether the provided AuthenticationSession is still valid.

Specified by:

isSessionValid in interface AuthenticationManager

closeSession

public void closeSession(AuthenticationSession session)

Specified by:

closeSession in interface AuthenticationManager

addAuthenticator

public final void addAuthenticator(Authenticator authenticator)

Adds an Authenticator.

Use either this or alternatively inject the full list of Authenticators.

addAuthenticatorToStart

protected void addAuthenticatorToStart(Authenticator authenticator)

Adds an Authenticator to the start of the list (not API).

setAuthenticators

public void setAuthenticators(List<Authenticator> authenticators)

Provide direct injection.

Use either this or programmatically addAuthenticator(Authenticator).

getAuthenticators

public List<Authenticator> getAuthenticators()

register

public boolean register(RegistrationDetails registrationDetails)

Specified by:

register in interface AuthenticationManager

supportsRegistration

public boolean supportsRegistration(Class<? extends RegistrationDetails> registrationDetailsClass)

Specified by:

supportsRegistration in interface AuthenticationManager

getRegistrars

public List<Registrar> getRegistrars()

getRandomCodeGenerator

public RandomCodeGenerator getRandomCodeGenerator()

The RandomCodeGenerator in use.

setRandomCodeGenerator

public void setRandomCodeGenerator(RandomCodeGenerator randomCodeGenerator)

For injection; will default otherwise.

debugTitle

public String debugTitle()

Description copied from interface: DebuggableWithTitle

The title for the debug information

Specified by:

debugTitle in interface DebuggableWithTitle

debugData

public void debugData(DebugBuilder debug)

Description copied from interface: Debuggable

Debug details describing the object being investigated

Specified by:

debugData in interface Debuggable

toString

public String toString()

Overrides:

toString in class Object

getConfiguration

protected IsisConfiguration getConfiguration()