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

Class AuthenticationOption

java.lang.Object

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

public class AuthenticationOption
extends Object

Stores information about a single authentication option, as configured by administrator and selectable by a user or client. The option contains a primary authenticator and optionally advanced settings related to MFA or RBA.

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

Implementation note: as RBA is unimplemented yet and MFA is simplistic this class doesn't hold much. In future it will be extended.

Author:

K. Benedyczak

Constructor Summary

Constructors

Constructor and Description
AuthenticationOption(BindingAuthn primaryAuthenticator, BindingAuthn mandatory2ndAuthenticator)

Method Summary

Modifier and Type	Method and Description
void	checkIfAuthenticatorsAreAmongSupported(Set<String> supportedBindings)
String	getId()
BindingAuthn	getMandatory2ndAuthenticator()
BindingAuthn	getPrimaryAuthenticator()

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationOption

public AuthenticationOption(BindingAuthn primaryAuthenticator,
                            BindingAuthn mandatory2ndAuthenticator)

Method Detail

getId

public String getId()

getPrimaryAuthenticator

public BindingAuthn getPrimaryAuthenticator()

getMandatory2ndAuthenticator

public BindingAuthn getMandatory2ndAuthenticator()

Returns:

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

checkIfAuthenticatorsAreAmongSupported

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

Throws:

pl.edu.icm.unity.exceptions.WrongArgumentException