com.codeborne.security.mobileid

Class MobileIDAuthenticator

java.lang.Object

com.codeborne.security.mobileid.MobileIDAuthenticator

Direct Known Subclasses:

MobileIDAuthenticatorStub

public class MobileIDAuthenticator
extends java.lang.Object

Authenticates with Mobile-ID.
Can be used as a preconfigured singleton (eg Spring bean).

Use startLogin(java.lang.String, java.lang.String) to initiate the login session and display challenge to the user, then waitForLogin(MobileIDSession) to wait for the authentication to complete.

Various setters can be used to configure the behaviour.

Constructor Summary

Constructors

Constructor and Description
MobileIDAuthenticator()
MobileIDAuthenticator(java.lang.String digidocServiceURL)
MobileIDAuthenticator(java.lang.String digidocServiceURL, java.lang.String serviceName)
MobileIDAuthenticator(java.net.URL digidocServiceURL)
MobileIDAuthenticator(java.net.URL digidocServiceURL, java.lang.String serviceName)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	generateSPChallenge()
boolean	isLoginComplete(MobileIDSession session) Checks whether login is already complete.
MobileIDAuthenticator	setDigidocServiceURL(java.lang.String digidocServiceURL)
MobileIDAuthenticator	setDigidocServiceURL(java.net.URL digidocServiceURL)
void	setLanguage(java.lang.String language)
void	setLoginMessage(java.lang.String loginMessage)
void	setPollIntervalMs(int pollIntervalMs)
void	setRetryCount(int retryCount)
void	setServiceName(java.lang.String serviceName)
MobileIDSession	startLogin(java.lang.String phone) Initiates the login session.
MobileIDSession	startLogin(java.lang.String personalCode, java.lang.String countryCode) Initiates the login session.
protected MobileIDSession	startLogin(java.lang.String personalCode, java.lang.String countryCode, java.lang.String phone)
MobileIDSession	waitForLogin(MobileIDSession session) Waits until user confirms their identity using the mobile device.

Methods inherited from class java.lang.Object

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

Constructor Detail

MobileIDAuthenticator

public MobileIDAuthenticator()

MobileIDAuthenticator

public MobileIDAuthenticator(java.lang.String digidocServiceURL)

MobileIDAuthenticator

public MobileIDAuthenticator(java.lang.String digidocServiceURL,
                             java.lang.String serviceName)

MobileIDAuthenticator

public MobileIDAuthenticator(java.net.URL digidocServiceURL)

MobileIDAuthenticator

public MobileIDAuthenticator(java.net.URL digidocServiceURL,
                             java.lang.String serviceName)

Method Detail

setDigidocServiceURL

public final MobileIDAuthenticator setDigidocServiceURL(java.lang.String digidocServiceURL)

setDigidocServiceURL

public final MobileIDAuthenticator setDigidocServiceURL(java.net.URL digidocServiceURL)

setLanguage

public void setLanguage(java.lang.String language)

setServiceName

public void setServiceName(java.lang.String serviceName)

setLoginMessage

public void setLoginMessage(java.lang.String loginMessage)

setRetryCount

public void setRetryCount(int retryCount)

setPollIntervalMs

public void setPollIntervalMs(int pollIntervalMs)

startLogin

public MobileIDSession startLogin(java.lang.String personalCode,
                                  java.lang.String countryCode)

Initiates the login session. Note: returned session already contains user's info, but the authenticity is not yet verified.

Parameters:

personalCode - user's personal code

countryCode - two letter country code, eg EE

Returns:

MobileIDSession instance containing CHALLENGE ID that should be shown to the user

Throws:

AuthenticationException - is authentication unsuccessful

startLogin

public MobileIDSession startLogin(java.lang.String phone)

Initiates the login session. Note: returned session already contains user's info, but the authenticity is not yet verified.

Parameters:

phone - phone number with country code (eg "+37255667788" or "37255667788").

Returns:

MobileIDSession instance containing CHALLENGE ID that should be shown to the user

Throws:

AuthenticationException - is authentication unsuccessful

startLogin

protected MobileIDSession startLogin(java.lang.String personalCode,
                                     java.lang.String countryCode,
                                     java.lang.String phone)

generateSPChallenge

protected java.lang.String generateSPChallenge()

waitForLogin

public MobileIDSession waitForLogin(MobileIDSession session)

Waits until user confirms their identity using the mobile device.

This is a blocking version of isLoginComplete(MobileIDSession)

Parameters:

session - previously returned by startLogin(java.lang.String, java.lang.String)

Returns:

MobileIDSession instance containing user name and personal code

Throws:

AuthenticationException - is authentication unsuccessful

isLoginComplete

public boolean isLoginComplete(MobileIDSession session)

Checks whether login is already complete.

This is a non-blocking version of waitForLogin(MobileIDSession)

Parameters:

session - previously returned by startLogin(java.lang.String, java.lang.String)

Returns:

true if login successful