Module dev.eidentification.bankid

Package dev.eidentification.bankid

Class BankId

java.lang.Object

dev.eidentification.bankid.BankId

public final class BankId
extends Object

The BankId class provides methods to initiate and process BankID authentication and signing orders. Most methods initiate an order and respond with orderRef and autoStartToken. Use the collect(CollectRequest) or collectAsync(CollectRequest) methods to query the status of the order.

Each method in the class comes in two forms: synchronous and asynchronous. The latter performs operation in a non-blocking manner and returns CompletableFuture.

See Also:

• CompletableFuture

Method Summary

Modifier and Type	Method	Description
AuthenticateResponse	authenticate(AuthenticationRequest request)	Initiates an authentication order.
CompletableFuture<AuthenticateResponse>	authenticateAsync(AuthenticationRequest request)	Initiates an authentication order asynchronous.
CancelResponse	cancel(CancelRequest request)	Cancels an ongoing sign or auth order.
CompletableFuture<CancelResponse>	cancelAsync(CancelRequest request)	Cancels an ongoing sign or auth order.
CollectResponse	collect(CollectRequest request)	Collects the result of a sign or auth order suing the orderRef as reference.
CompletableFuture<CollectResponse>	collectAsync(CollectRequest request)	Collects the result of a sign or auth order suing the orderRef as reference asynchronous.
static BankId	of(Configuration configuration)	Returns a BankId with the given configuration.
PhoneAuthenticateResponse	phoneAuthenticate(PhoneAuthenticationRequest request)	Initiates an authentication order when the user is talking to the RP over the phone.
CompletableFuture<PhoneAuthenticateResponse>	phoneAuthenticateAsync(PhoneAuthenticationRequest request)	Initiates an authentication order asynchronous when the user is talking to the RP over the phone.
PhoneSignResponse	phoneSign(PhoneSignRequest request)	Initiates a sign order over the phone.
CompletableFuture<PhoneSignResponse>	phoneSignAsync(PhoneSignRequest request)	Initiates a sign order over the phone.
SignResponse	sign(SignRequest request)	Initiates a sign order.
CompletableFuture<SignResponse>	signAsync(SignRequest request)	Initiates a sign order asynchronous.

Methods inherited from class java.lang.Object

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

Method Details

of

public static BankId of(Configuration configuration)

Returns a BankId with the given configuration.

Parameters:

configuration - the configuration

Returns:

an BankId instance

Throws:

NullPointerException - if configuration is null

BankIdException - if an error occurs during initialization

authenticate

public AuthenticateResponse authenticate(AuthenticationRequest request)

Initiates an authentication order.

Use the collect method to query the status of the order. If the request is successful, the orderRef and autoStartToken is returned.

Parameters:

request - the authentication request

Returns:

the authentication response

Throws:

NullPointerException - if request is null.

BankIdException - in case of an unexpected error.

BankIdApiErrorException - in case of an api error.

BankIdApiUnexpectedResponseException - in case of an unexpected api error.

authenticateAsync

public CompletableFuture<AuthenticateResponse> authenticateAsync(AuthenticationRequest request)

Initiates an authentication order asynchronous.

Use the collect method to query the status of the order. If the request is successful, the orderRef and autoStartToken is returned.

Propagates BankIdException if an error occurred during the authentication.

Parameters:

request - the authentication request

Returns:

a CompletableFuture that represents the asynchronous authentication operation

Throws:

NullPointerException - if request is null.

phoneAuthenticate

public PhoneAuthenticateResponse phoneAuthenticate(PhoneAuthenticationRequest request)

Initiates an authentication order when the user is talking to the RP over the phone.

Use the collect method to query the status of the order. If the request is successful, the orderRef and autoStartToken is returned.

Parameters:

request - the authentication request

Returns:

the phone authentication response

Throws:

NullPointerException - if request is null.

BankIdException - in case of an unexpected error.

BankIdApiErrorException - in case of an api error.

BankIdApiUnexpectedResponseException - in case of an unexpected api error.

phoneAuthenticateAsync

public CompletableFuture<PhoneAuthenticateResponse> phoneAuthenticateAsync(PhoneAuthenticationRequest request)

Initiates an authentication order asynchronous when the user is talking to the RP over the phone.

Use the collect method to query the status of the order. If the request is successful, the orderRef and autoStartToken is returned.

Propagates BankIdException if an error occurred during the authentication.

Parameters:

request - the authentication request

Returns:

a CompletableFuture that represents the asynchronous phone authentication operation

Throws:

NullPointerException - if request is null.

sign

public SignResponse sign(SignRequest request)

Initiates a sign order.

Use the collect method to query the status of the order. If the request is successful, the orderRef and autoStartToken is returned.

Parameters:

request - the sign request

Returns:

the sign response

Throws:

NullPointerException - if request is null.

BankIdException - in case of an unexpected error.

BankIdApiErrorException - in case of an api error.

BankIdApiUnexpectedResponseException - in case of an unexpected api error.

signAsync

public CompletableFuture<SignResponse> signAsync(SignRequest request)

Initiates a sign order asynchronous.

Use the collect method to query the status of the order. If the request is successful, the orderRef and autoStartToken is returned.

Propagates BankIdException if an error occurred during the sign.

Parameters:

request - the sign request

Returns:

a CompletableFuture that represents the asynchronous sign operation

Throws:

NullPointerException - if request is null.

phoneSign

public PhoneSignResponse phoneSign(PhoneSignRequest request)

Initiates a sign order over the phone.

Use the collect method to query the status of the order. If the request is successful, the orderRef and autoStartToken is returned.

Parameters:

request - the sign request

Returns:

the phone sign response

Throws:

NullPointerException - if request is null.

BankIdException - in case of an unexpected error.

BankIdApiErrorException - in case of an api error.

BankIdApiUnexpectedResponseException - in case of an unexpected api error.

phoneSignAsync

public CompletableFuture<PhoneSignResponse> phoneSignAsync(PhoneSignRequest request)

Initiates a sign order over the phone.

Use the collect method to query the status of the order. If the request is successful, the orderRef and autoStartToken is returned.

Propagates BankIdException if an error occurred during the phone sign.

Parameters:

request - the sign request

Returns:

a CompletableFuture that represents the asynchronous phone sign operation

Throws:

NullPointerException - if request is null.

collect

public CollectResponse collect(CollectRequest request)

Collects the result of a sign or auth order suing the orderRef as reference.

RP should keep calling collect every two seconds as long as status indicates pending. RP must abort if status indicates failed. The user identity is returned when complete.

Parameters:

request - the collect request

Returns:

the collect response

Throws:

NullPointerException - if request is null.

BankIdException - in case of an unexpected error.

BankIdApiErrorException - in case of an api error.

BankIdApiUnexpectedResponseException - in case of an unexpected api error.

collectAsync

public CompletableFuture<CollectResponse> collectAsync(CollectRequest request)

Collects the result of a sign or auth order suing the orderRef as reference asynchronous.

RP should keep calling collect every two seconds as long as status indicates pending. RP must abort if status indicates failed. The user identity is returned when complete.

Propagates BankIdException if an error occurred during the collect.

Parameters:

request - the collect request

Returns:

a CompletableFuture that represents the asynchronous collect operation

Throws:

NullPointerException - if request is null.

cancel

public CancelResponse cancel(CancelRequest request)

Cancels an ongoing sign or auth order.

This is typically used if the user cancels the order in your service or app.

Parameters:

request - the cancel request

Returns:

the cancel response

Throws:

NullPointerException - if request is null.

BankIdException - in case of an unexpected error.

BankIdApiErrorException - in case of an api error.

BankIdApiUnexpectedResponseException - in case of an unexpected api error.

cancelAsync

public CompletableFuture<CancelResponse> cancelAsync(CancelRequest request)

Cancels an ongoing sign or auth order.

This is typically used if the user cancels the order in your service or app.

Propagates BankIdException if an error occurred during the cancel.

Parameters:

request - the cancel request

Returns:

a CompletableFuture that represents the asynchronous cancel operation

Throws:

NullPointerException - if request is null.