Module dev.eidentification.bankid

Package dev.eidentification.bankid.client.model

Record Class CompletionData

java.lang.Object

java.lang.Record

dev.eidentification.bankid.client.model.CompletionData

Record Components:

user - Information related to the user.

device - Information related to the device.

bankIdIssueDate - The date the BankID was issued to the user. The issue date of the ID expressed using ISO 8601 date format YYYY-MM-DD with a UTC time zone offset.

stepUp - Information about extra verifications that were part of the transaction. mrtd: Indicate if there was a check of the mrtd (machine readable travel document). Boolean. True if the mrtd check was performed and passed. False if the mrtd check was performed but failed.

signature - The signature as described in the BankID Signature Profile specification. String. Base64-encoded. XML signature.

ocspResponse - The OCSP response. String. Base64-encoded. The OCSP response is signed by a certificate that has the same issuer as the certificate being verified. The OSCP response has an extension for Nonce. The nonce is calculated as: SHA-1 hash over the base 64 XML signature encoded as UTF-8. 12 random bytes is added after the hash. The nonce is 32 bytes (20 + 12).

public record CompletionData(User user, Device device, LocalDate bankIdIssueDate, boolean stepUp, String signature, String ocspResponse)
extends Record

A final state when an order is successful. The user has provided the security code and completed the order. The completionData includes signature, user information and the OCSP response. RP should verify user information to proceed. RP should retain completion data for future reference, compliance and audit purposes.

Constructor Summary

Constructors

Constructor	Description
CompletionData(User user, Device device, LocalDate bankIdIssueDate, boolean stepUp, String signature, String ocspResponse)	Creates an instance of a CompletionData record class.

Method Summary

Modifier and Type	Method	Description
LocalDate	bankIdIssueDate()	Returns the value of the bankIdIssueDate record component.
Device	device()	Returns the value of the device record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	ocspResponse()	Returns the value of the ocspResponse record component.
String	signature()	Returns the value of the signature record component.
boolean	stepUp()	Returns the value of the stepUp record component.
final String	toString()	Returns a string representation of this record class.
User	user()	Returns the value of the user record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CompletionData

public CompletionData(User user,
 Device device,
 LocalDate bankIdIssueDate,
 boolean stepUp,
 String signature,
 String ocspResponse)

Creates an instance of a CompletionData record class.

Parameters:

user - the value for the user record component

device - the value for the device record component

bankIdIssueDate - the value for the bankIdIssueDate record component

stepUp - the value for the stepUp record component

signature - the value for the signature record component

ocspResponse - the value for the ocspResponse record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

user

public User user()

Returns the value of the user record component.

Returns:

the value of the user record component

device

public Device device()

Returns the value of the device record component.

Returns:

the value of the device record component

bankIdIssueDate

public LocalDate bankIdIssueDate()

Returns the value of the bankIdIssueDate record component.

Returns:

the value of the bankIdIssueDate record component

stepUp

public boolean stepUp()

Returns the value of the stepUp record component.

Returns:

the value of the stepUp record component

signature

public String signature()

Returns the value of the signature record component.

Returns:

the value of the signature record component

ocspResponse

public String ocspResponse()

Returns the value of the ocspResponse record component.

Returns:

the value of the ocspResponse record component