Class EmrtdReader

    • Constructor Detail

      • EmrtdReader

        EmrtdReader(EmrtdReader.StepProgressListener stepProgressListener)

        Initialize an EmrtdReader.

        Parameters:
        stepProgressListener - listener implementation will be notified when the eMRTD Sessionstatus changes and will be informed on file read progress.
      • EmrtdReader

        EmrtdReader()

        Initialize an EmrtdReader without providing an StepProgressListener implementation. You will not be informed about Step and Progress updates.

    • Method Detail

      • getTracer

         static Tracer getTracer()

        Gets the currently used OpenTelemetry tracer.

        Returns:

        The tracer.

      • setTracerProvider

         static void setTracerProvider(TracerProvider tracerProvider)

        Sets a OpenTelemetry tracer provider that is used to provide traces. If none is set, a no-op implementation is used.

        Parameters:
        tracerProvider - The provider to set.
      • readMasterList

         void readMasterList(Array<InputStream> masterListFileInputStreams)

        Read one or multiple MasterList file(s) from the given InputStream(s).

        A MasterList contains a list of trusted Country Certificates. With these Certificates it is possible to verify whether an eMRTD was officially produced on behalf of the nation that issued it and whether the data it contains has been changed in any way since its production.

        Parameters:
        masterListFileInputStreams - one InputStream or multiple InputStream.
      • readAndVerify

         EmrtdResult readAndVerify(IsoDep isoDep, String documentNumber, String dateOfBirth, String dateOfExpiry)

        Read and verify an eMRTD.

        Parameters:
        isoDep - IsoDep of an ISO7816 Tag with the eMRTD applet.
        documentNumber - document number from the MRZ.
        dateOfBirth - date of birth from the MRZ (Format: yyMMDD)
        dateOfExpiry - date of expiry from the MRZ (Format: yyMMDD)
        Returns:

        EmrtdResult holding eMRTD data and check results

      • read

         EmrtdResult read(IsoDep isoDep, String documentNumber, String dateOfBirth, String dateOfExpiry)

        Read an eMRTD.

        Parameters:
        isoDep - IsoDep of an ISO7816 Tag with the eMRTD applet.
        documentNumber - document number from the MRZ.
        dateOfBirth - date of birth from the MRZ (Format: yyMMDD)
        dateOfExpiry - date of expiry from the MRZ (Format: yyMMDD)
        Returns:

        EmrtdResult holding eMRTD data

      • readAndVerify

         EmrtdResult readAndVerify(IsoDep isoDep, String can)

        Read and verify an eMRTD.

        Parameters:
        isoDep - IsoDep of an ISO7816 Tag with the eMRTD applet.
        can - CAN, a 6 digit number, printed on the front of the document.
        Returns:

        EmrtdResult holding eMRTD data and check results

      • read

         EmrtdResult read(IsoDep isoDep, String can)

        Read an eMRTD.

        Parameters:
        isoDep - IsoDep of an ISO7816 Tag with the eMRTD applet.
        can - CAN, a 6 digit number, printed on the front of the document.
        Returns:

        EmrtdResult holding eMRTD data