eu.id3.bioseal

Class Bioseal

java.lang.Object

eu.id3.bioseal.Bioseal

All Implemented Interfaces:

java.io.Serializable, java.lang.AutoCloseable

public class Bioseal
extends java.lang.Object
implements java.lang.AutoCloseable, java.io.Serializable

Represents a BioSeal code.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Bioseal() Creates a new instance of the Bioseal class.
Bioseal(long handle) Creates a new instance of the Bioseal class.

Method Summary

Modifier and Type	Method and Description
protected static int	_decryptionCallbackStatic(long context, long args)
protected static int	_externalResourceCallbackStatic(long context, long args)
void	buildHtmlView(java.lang.String language, boolean userAuthenticated) Builds the presentation view, in HTML format.
java.lang.String	buildVdsAsJson(java.lang.String indentation) Builds a representation of the VDS, in JSON format.
java.lang.String	buildVdsAsXml(java.lang.String language) Builds a representation of the VDS, in a XML format.
void	clear() Clears all internal data.
void	clearDownloadCache() Clears the internal download cache.
void	close() Releases all resources used by this Bioseal.
static java.lang.String	computeSha256(byte[] data) Computes SHA256.
protected void	finalize() Finalizer for this class.
FieldList	findBiometrics(BiometricDataType biometricDataType, java.lang.String biometricFormat) Finds the biometric field in payload.
FieldList	findFieldsByExtension(FieldExtensionType fieldExtensionType) Finds fields by extension type.
FieldList	findFieldsByExtensionName(java.lang.String extensionName) Finds fields by extension name.
Field	getAuxData() Gets the the auxiliary data containing additional information specific to the BioSeal.
BiometricVerificationRules	getBiometricVerificationRules() Gets the the list of biometric verification rules.
java.lang.String	getCertificateAuthorityReference() Gets the the issuing reference of the certificate authority.
java.lang.String	getCertificateIdentifier() Gets the the identifier of the certificate.
CertificateInformation	getCertificateInformation() Gets the the detailed certificate information.
boolean	getContainsAuxData() Gets the indicates whether the BioSeal contains auxiliary data.
boolean	getContainsBiometrics() Gets the indicates whether the BioSeal contains biometric data.
boolean	getContainsExtensions() Gets the indicates whether the BioSeal contains extensions.
boolean	getContainsFaceTemplates() Gets the indicates whether the BioSeal contains face templates.
boolean	getContainsFingerTemplates() Gets the indicates whether the BioSeal contains finger templates.
boolean	getContainsImages() Gets the indicates whether the BioSeal contains images.
boolean	getContainsPortraits() Gets the indicates whether the BioSeal contains portraits.
byte[]	getData() Gets the the data of the VDS as a binary array.
java.lang.String	getDocumentDescription(java.lang.String language) Gets the description of the document.
java.lang.String	getDocumentIssuingCountry() Gets the the identifier of the country issuing the document.
DateTime	getDocumentIssuingDate() Gets the the document issuing date.
java.lang.String	getDocumentName(java.lang.String language) Gets the name of the document.
java.lang.String	getDocumentScope() Gets the the identification code of the scope on which the document type is defined.
java.lang.String	getDocumentType() Gets the the document type identification code.
DateTime	getExpirationDate() Gets the the BioSeal expiration date.
BiosealFormat	getExtendedFormat() Gets the the BioSeal format with prefix information.
BiosealFormat	getFormat() Gets the the BioSeal format without prefix information.
long	getHandle() Gets the native handle.
boolean	getHasPrefix() Gets the prefix is present.
int	getHeaderVersion() Gets the the header version.
java.lang.String	getHtmlView() Gets the the presentation view, in HTML format, created from the manifest and the data contained in the BioSeal.
java.lang.String	getIssuingAgencyCode() Gets the the Issuing Agency Code (IAC).
Log	getLog() Gets the the log.
java.lang.String	getLotlUrl() Gets the the URL to the LoTL (List of Trust List).
Manifest	getManifest() Gets the the manifest information.
int	getManifestId() Gets the the manifest ID in ISO 22385 format.
java.lang.String	getManifestUrl() Gets the the URL to the manifest.
Field	getPayload() Gets the the payload containing the data specific to the BioSeal.
java.lang.String	getPrefix() Gets the the prefix.
DateTime	getSignatureDate() Gets the the BioSeal signature date.
StringArray	getSupportedLanguages() Gets the the list of supported languages declared in the manifest.
java.lang.String	getTslUrl() Gets the the URL to the TSL (Trust Service List).
UserAuthentication	getUserAuthentication() Gets the the user authentication parameters.
VerificationResult	getVerificationResult() Gets the the last verification result.
boolean	getVerifiesCrlUpdates() Gets the indicates whether the verification process should verify the next CRL update.
boolean	getVerifiesGovernance() Gets the indicates whether the governance certification chain is verified.
boolean	getVerifiesSignature() Gets the indicates whether the VDS signature is verified.
void	setDecryptionCallback(DecryptionCallbackHandler decryptionCallback) Sets the the callback used to decrypt a field.
void	setExternalResourceCallback(ResourceCallbackHandler externalResourceCallback) Sets the the callback used to retrieve an external resource (LoTL, TSL, certificate, manifest, CRL) with specified URI.
void	setLotlUrl(java.lang.String lotlUrl) Sets the the URL to the LoTL (List of Trust List).
void	setManifestUrl(java.lang.String manifestUrl) Sets the the URL to the manifest.
void	setTimeZoneOffset(int offsetInSeconds) Sets the time zone offset in seconds.
void	setTslUrl(java.lang.String tslUrl) Sets the the URL to the TSL (Trust Service List).
void	setVerifiesCrlUpdates(boolean verifiesCrlUpdates) Sets the indicates whether the verification process should verify the next CRL update.
void	setVerifiesGovernance(boolean verifiesGovernance) Sets the indicates whether the governance certification chain is verified.
void	setVerifiesSignature(boolean verifiesSignature) Sets the indicates whether the VDS signature is verified.
VerificationResult	verifyFromBuffer(byte[] data) Decodes and verifies the specified data buffer.
VerificationResult	verifyFromString(java.lang.String data) Decodes and verifies the specified string buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

Bioseal

public Bioseal()
        throws BiosealException

Creates a new instance of the Bioseal class.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

Bioseal

public Bioseal(long handle)
        throws BiosealException

Creates a new instance of the Bioseal class.

Parameters:

handle - Handle to the Bioseal.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

Method Detail

close

public void close()

Releases all resources used by this Bioseal.

Specified by:

close in interface java.lang.AutoCloseable

finalize

protected void finalize()

Finalizer for this class. Finalizers are deprecated since Java 9+. This method is not guaranteed to be called. To release all memory held by this class please be sure to call the close() method.

Overrides:

finalize in class java.lang.Object

getHandle

public long getHandle()

Gets the native handle.

Returns:

The native handle.

_externalResourceCallbackStatic

protected static int _externalResourceCallbackStatic(long context,
                                                     long args)

_decryptionCallbackStatic

protected static int _decryptionCallbackStatic(long context,
                                               long args)

getFormat

public BiosealFormat getFormat()
                        throws BiosealException

Gets the the BioSeal format without prefix information.

Returns:

The BioSeal format without prefix information.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getExtendedFormat

public BiosealFormat getExtendedFormat()
                                throws BiosealException

Gets the the BioSeal format with prefix information.

Returns:

The BioSeal format with prefix information.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getDocumentIssuingDate

public DateTime getDocumentIssuingDate()
                                throws BiosealException

Gets the the document issuing date.

Returns:

The document issuing date.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getSignatureDate

public DateTime getSignatureDate()
                          throws BiosealException

Gets the the BioSeal signature date.

Returns:

The BioSeal signature date.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getDocumentType

public java.lang.String getDocumentType()
                                 throws BiosealException

Gets the the document type identification code. For AFNOR XP Z42-101 only.

Returns:

The document type identification code. For AFNOR XP Z42-101 only.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getDocumentScope

public java.lang.String getDocumentScope()
                                  throws BiosealException

Gets the the identification code of the scope on which the document type is defined. For AFNOR XP Z42-101 only.

Returns:

The identification code of the scope on which the document type is defined. For AFNOR XP Z42-101 only.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getDocumentIssuingCountry

public java.lang.String getDocumentIssuingCountry()
                                           throws BiosealException

Gets the the identifier of the country issuing the document. For AFNOR XP Z42-101 only.

Returns:

The identifier of the country issuing the document. For AFNOR XP Z42-101 only.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getManifestId

public int getManifestId()
                  throws BiosealException

Gets the the manifest ID in ISO 22385 format.

Returns:

The manifest ID in ISO 22385 format.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getPayload

public Field getPayload()
                 throws BiosealException

Gets the the payload containing the data specific to the BioSeal.

Returns:

The payload containing the data specific to the BioSeal.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getManifest

public Manifest getManifest()
                     throws BiosealException

Gets the the manifest information.

Returns:

The manifest information.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getContainsImages

public boolean getContainsImages()
                          throws BiosealException

Gets the indicates whether the BioSeal contains images.

Returns:

Indicates whether the BioSeal contains images.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getContainsPortraits

public boolean getContainsPortraits()
                             throws BiosealException

Gets the indicates whether the BioSeal contains portraits.

Returns:

Indicates whether the BioSeal contains portraits.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getContainsBiometrics

public boolean getContainsBiometrics()
                              throws BiosealException

Gets the indicates whether the BioSeal contains biometric data.

Returns:

Indicates whether the BioSeal contains biometric data.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getContainsFaceTemplates

public boolean getContainsFaceTemplates()
                                 throws BiosealException

Gets the indicates whether the BioSeal contains face templates.

Returns:

Indicates whether the BioSeal contains face templates.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getContainsFingerTemplates

public boolean getContainsFingerTemplates()
                                   throws BiosealException

Gets the indicates whether the BioSeal contains finger templates.

Returns:

Indicates whether the BioSeal contains finger templates.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getContainsExtensions

public boolean getContainsExtensions()
                              throws BiosealException

Gets the indicates whether the BioSeal contains extensions.

Returns:

Indicates whether the BioSeal contains extensions.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getSupportedLanguages

public StringArray getSupportedLanguages()
                                  throws BiosealException

Gets the the list of supported languages declared in the manifest.

Returns:

The list of supported languages declared in the manifest.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getHtmlView

public java.lang.String getHtmlView()
                             throws BiosealException

Gets the the presentation view, in HTML format, created from the manifest and the data contained in the BioSeal.

Returns:

The presentation view, in HTML format, created from the manifest and the data contained in the BioSeal.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

setExternalResourceCallback

public void setExternalResourceCallback(ResourceCallbackHandler externalResourceCallback)
                                 throws BiosealException

Sets the the callback used to retrieve an external resource (LoTL, TSL, certificate, manifest, CRL) with specified URI.

Parameters:

externalResourceCallback - The callback used to retrieve an external resource (LoTL, TSL, certificate, manifest, CRL) with specified URI.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getCertificateAuthorityReference

public java.lang.String getCertificateAuthorityReference()
                                                  throws BiosealException

Gets the the issuing reference of the certificate authority.

Returns:

The issuing reference of the certificate authority.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getCertificateIdentifier

public java.lang.String getCertificateIdentifier()
                                          throws BiosealException

Gets the the identifier of the certificate.

Returns:

The identifier of the certificate.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getCertificateInformation

public CertificateInformation getCertificateInformation()
                                                 throws BiosealException

Gets the the detailed certificate information.

Returns:

The detailed certificate information.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getExpirationDate

public DateTime getExpirationDate()
                           throws BiosealException

Gets the the BioSeal expiration date.

Returns:

The BioSeal expiration date.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getContainsAuxData

public boolean getContainsAuxData()
                           throws BiosealException

Gets the indicates whether the BioSeal contains auxiliary data.

Returns:

Indicates whether the BioSeal contains auxiliary data.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getAuxData

public Field getAuxData()
                 throws BiosealException

Gets the the auxiliary data containing additional information specific to the BioSeal.

Returns:

The auxiliary data containing additional information specific to the BioSeal.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getBiometricVerificationRules

public BiometricVerificationRules getBiometricVerificationRules()
                                                         throws BiosealException

Gets the the list of biometric verification rules.

Returns:

The list of biometric verification rules.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getLog

public Log getLog()
           throws BiosealException

Gets the the log.

Returns:

The log.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getUserAuthentication

public UserAuthentication getUserAuthentication()
                                         throws BiosealException

Gets the the user authentication parameters.

Returns:

The user authentication parameters.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getHeaderVersion

public int getHeaderVersion()
                     throws BiosealException

Gets the the header version.

Returns:

The header version.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

setDecryptionCallback

public void setDecryptionCallback(DecryptionCallbackHandler decryptionCallback)
                           throws BiosealException

Sets the the callback used to decrypt a field.

Parameters:

decryptionCallback - The callback used to decrypt a field.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getVerifiesGovernance

public boolean getVerifiesGovernance()
                              throws BiosealException

Gets the indicates whether the governance certification chain is verified. Hint: Default value is true.

Returns:

Indicates whether the governance certification chain is verified.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

setVerifiesGovernance

public void setVerifiesGovernance(boolean verifiesGovernance)
                           throws BiosealException

Sets the indicates whether the governance certification chain is verified. Hint: Default value is true.

Parameters:

verifiesGovernance - Indicates whether the governance certification chain is verified.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getVerifiesSignature

public boolean getVerifiesSignature()
                             throws BiosealException

Gets the indicates whether the VDS signature is verified. Hint: Default value is true.

Returns:

Indicates whether the VDS signature is verified.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

setVerifiesSignature

public void setVerifiesSignature(boolean verifiesSignature)
                          throws BiosealException

Sets the indicates whether the VDS signature is verified. Hint: Default value is true.

Parameters:

verifiesSignature - Indicates whether the VDS signature is verified.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getVerifiesCrlUpdates

public boolean getVerifiesCrlUpdates()
                              throws BiosealException

Gets the indicates whether the verification process should verify the next CRL update. Hint: Default value is true.

Returns:

Indicates whether the verification process should verify the next CRL update.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

setVerifiesCrlUpdates

public void setVerifiesCrlUpdates(boolean verifiesCrlUpdates)
                           throws BiosealException

Sets the indicates whether the verification process should verify the next CRL update. Hint: Default value is true.

Parameters:

verifiesCrlUpdates - Indicates whether the verification process should verify the next CRL update.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getVerificationResult

public VerificationResult getVerificationResult()
                                         throws BiosealException

Gets the the last verification result.

Returns:

The last verification result.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getLotlUrl

public java.lang.String getLotlUrl()
                            throws BiosealException

Gets the the URL to the LoTL (List of Trust List).

Returns:

The URL to the LoTL (List of Trust List).

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

setLotlUrl

public void setLotlUrl(java.lang.String lotlUrl)
                throws BiosealException

Sets the the URL to the LoTL (List of Trust List).

Parameters:

lotlUrl - The URL to the LoTL (List of Trust List).

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getTslUrl

public java.lang.String getTslUrl()
                           throws BiosealException

Gets the the URL to the TSL (Trust Service List).

Returns:

The URL to the TSL (Trust Service List).

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

setTslUrl

public void setTslUrl(java.lang.String tslUrl)
               throws BiosealException

Sets the the URL to the TSL (Trust Service List).

Parameters:

tslUrl - The URL to the TSL (Trust Service List).

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getManifestUrl

public java.lang.String getManifestUrl()
                                throws BiosealException

Gets the the URL to the manifest.

Returns:

The URL to the manifest.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

setManifestUrl

public void setManifestUrl(java.lang.String manifestUrl)
                    throws BiosealException

Sets the the URL to the manifest.

Parameters:

manifestUrl - The URL to the manifest.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getIssuingAgencyCode

public java.lang.String getIssuingAgencyCode()
                                      throws BiosealException

Gets the the Issuing Agency Code (IAC). For ISO 22376:2023 format only.

Returns:

The Issuing Agency Code (IAC). For ISO 22376:2023 format only.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getHasPrefix

public boolean getHasPrefix()
                     throws BiosealException

Gets the prefix is present.

Returns:

Prefix is present.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getPrefix

public java.lang.String getPrefix()
                           throws BiosealException

Gets the the prefix.

Returns:

The prefix.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getData

public byte[] getData()
               throws BiosealException

Gets the the data of the VDS as a binary array.

Returns:

The data of the VDS as a binary array.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

clear

public void clear()
           throws BiosealException

Clears all internal data.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

verifyFromBuffer

public VerificationResult verifyFromBuffer(byte[] data)
                                    throws BiosealException

Decodes and verifies the specified data buffer.

Parameters:

data - The data buffer containing the BioSeal code.

Returns:

Receives the verification results.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

verifyFromString

public VerificationResult verifyFromString(java.lang.String data)
                                    throws BiosealException

Decodes and verifies the specified string buffer.

Parameters:

data - The string buffer containing the BioSeal code.

Returns:

Receives the verification results.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

buildHtmlView

public void buildHtmlView(java.lang.String language,
                          boolean userAuthenticated)
                   throws BiosealException

Builds the presentation view, in HTML format.

Parameters:

language - The expected language.

userAuthenticated - A value indicating whether the user is authenticated.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getDocumentName

public java.lang.String getDocumentName(java.lang.String language)
                                 throws BiosealException

Gets the name of the document.

Parameters:

language - The expected language.

Returns:

The name of the document.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getDocumentDescription

public java.lang.String getDocumentDescription(java.lang.String language)
                                        throws BiosealException

Gets the description of the document.

Parameters:

language - The expected language.

Returns:

The description of the document.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

findFieldsByExtension

public FieldList findFieldsByExtension(FieldExtensionType fieldExtensionType)
                                throws BiosealException

Finds fields by extension type.

Parameters:

fieldExtensionType - The field extension type.

Returns:

The list of fields with the extension.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

findFieldsByExtensionName

public FieldList findFieldsByExtensionName(java.lang.String extensionName)
                                    throws BiosealException

Finds fields by extension name.

Parameters:

extensionName - A string that identifies the extension name.

Returns:

The list of fields with the extension.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

findBiometrics

public FieldList findBiometrics(BiometricDataType biometricDataType,
                                java.lang.String biometricFormat)
                         throws BiosealException

Finds the biometric field in payload.

Parameters:

biometricDataType - The type of biometric data.

biometricFormat - The format of the biometric data.

Returns:

The list of fields containing biometric data.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

buildVdsAsJson

public java.lang.String buildVdsAsJson(java.lang.String indentation)
                                throws BiosealException

Builds a representation of the VDS, in JSON format.

Parameters:

indentation - The indentation of the json string.

Returns:

The result.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

buildVdsAsXml

public java.lang.String buildVdsAsXml(java.lang.String language)
                               throws BiosealException

Builds a representation of the VDS, in a XML format.

Parameters:

language - The expected language.

Returns:

The result.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

clearDownloadCache

public void clearDownloadCache()
                        throws BiosealException

Clears the internal download cache.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

setTimeZoneOffset

public void setTimeZoneOffset(int offsetInSeconds)
                       throws BiosealException

Sets the time zone offset in seconds.

Parameters:

offsetInSeconds - The time zone offset in seconds.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

computeSha256

public static java.lang.String computeSha256(byte[] data)
                                      throws BiosealException

Computes SHA256.

Parameters:

data - Input data.

Returns:

The result.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.