Package se.swedenconnect.bankid.rpapi.service

Class AuthenticateRequest

java.lang.Object

se.swedenconnect.bankid.rpapi.service.AuthenticateRequest

public class AuthenticateRequest
extends Object

Representation of the parameters required for an authenticate call.

Author:

Martin Lindström, Felix Hellman

Constructor Summary

Constructors

Constructor	Description
AuthenticateRequest(String endUserIp, UserVisibleData userVisibleData, Requirement requirement)	Creates parameter object for an BankIDClient.authenticate(AuthenticateRequest) call.

Method Summary

Modifier and Type	Method	Description
String	getEndUserIp()	Gets the user IP address as seen by the relying party.
Requirement	getRequirement()	Gets the authentication requirements.
UserVisibleData	getUserVisibleData()	Gets the data to display to the user during authentication.

Methods inherited from class java.lang.Object

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

Constructor Details

AuthenticateRequest

public AuthenticateRequest(String endUserIp,
 UserVisibleData userVisibleData,
 Requirement requirement)

Creates parameter object for an BankIDClient.authenticate(AuthenticateRequest) call.

Parameters:

endUserIp - the user IP address as seen by the relying party

userVisibleData - data to display to the user during authentication (optional)

requirement - used by the relying party to set requirements how the authentication operation must be performed. Default rules are applied if omitted

Throws:

BankIDException - for errors

Method Details

getEndUserIp

public String getEndUserIp()

Gets the user IP address as seen by the relying party.

Returns:

the user IP

getUserVisibleData

public UserVisibleData getUserVisibleData()

Gets the data to display to the user during authentication.

Returns:

the data to display or null

getRequirement

public Requirement getRequirement()

Gets the authentication requirements.

Returns:

the Requirement or null