Package pl.edu.icm.unity.engine.api.authn

Class AuthenticationFlow

java.lang.Object

pl.edu.icm.unity.engine.api.authn.AuthenticationFlow

public class AuthenticationFlow
extends Object

Stores information about a authentication flow, as configured by administrator and selectable by a user or client. The flow contains a first factor authenticators, policy and optionally second factor authenticators. The policy decide how second factor authenticator is enforced.

This class is a working instance of what can be described by the AuthenticationFlowDefinition.

Implementation note: RBA is unimplemented yet. In future it will be extended.

Author:

K. Benedyczak

Constructor Summary

Constructors

Constructor	Description
AuthenticationFlow(String name, pl.edu.icm.unity.base.authn.AuthenticationFlowDefinition.Policy policy, Set<AuthenticatorInstance> firstFactorAuthenticators, List<AuthenticatorInstance> secondFactorAuthenticators, pl.edu.icm.unity.base.authn.AuthenticationPolicyConfiguration policyConfiguration, long revision)

Method Summary

Modifier and Type	Method	Description
void	checkIfAuthenticatorsAreAmongSupported(Set<String> supportedBindings)
void	destroy()
Set<AuthenticatorInstance>	getAllAuthenticators()
Set<AuthenticatorInstance>	getFirstFactorAuthenticators()
String	getId()
pl.edu.icm.unity.base.authn.AuthenticationFlowDefinition.Policy	getPolicy()
pl.edu.icm.unity.base.authn.AuthenticationPolicyConfiguration	getPolicyConfiguration()
long	getRevision()
List<AuthenticatorInstance>	getSecondFactorAuthenticators()

Methods inherited from class java.lang.Object

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

Constructor Details

AuthenticationFlow

public AuthenticationFlow(String name,
 pl.edu.icm.unity.base.authn.AuthenticationFlowDefinition.Policy policy,
 Set<AuthenticatorInstance> firstFactorAuthenticators,
 List<AuthenticatorInstance> secondFactorAuthenticators,
 pl.edu.icm.unity.base.authn.AuthenticationPolicyConfiguration policyConfiguration,
 long revision)

Method Details

getId

public String getId()

getFirstFactorAuthenticators

public Set<AuthenticatorInstance> getFirstFactorAuthenticators()

getSecondFactorAuthenticators

public List<AuthenticatorInstance> getSecondFactorAuthenticators()

Returns:

2ndary (typically 2nd factor) authenticator. Can be null if not defined.

getPolicy

public pl.edu.icm.unity.base.authn.AuthenticationFlowDefinition.Policy getPolicy()

getPolicyConfiguration

public pl.edu.icm.unity.base.authn.AuthenticationPolicyConfiguration getPolicyConfiguration()

destroy

public void destroy()

getAllAuthenticators

public Set<AuthenticatorInstance> getAllAuthenticators()

getRevision

public long getRevision()

checkIfAuthenticatorsAreAmongSupported

public void checkIfAuthenticatorsAreAmongSupported(Set<String> supportedBindings)
                                            throws pl.edu.icm.unity.base.exceptions.WrongArgumentException

Throws:

pl.edu.icm.unity.base.exceptions.WrongArgumentException