GroupDocs.Signature for Java 23.12 Release Notes

/// <summary>
/// Implement searching for signatures within the Archives
/// </summary>
Signature signature = new Signature(filePath);
{
    // create list of signature options
    BarcodeSearchOptions bcOptions = new BarcodeSearchOptions(BarcodeTypes.Code128);
    QrCodeSearchOptions qrOptions = new QrCodeSearchOptions(QrCodeTypes.QR);

    // setup search options
    List<SearchOptions> listOptions = new ArrayList<SearchOptions>();
    listOptions.add(bcOptions);
    listOptions.add(qrOptions);

    // search archive for documents
    SearchResult searchResult = signature.search(listOptions);

    // check the result                
    System.out.print("\nList of successfully processed documents:");
    int number = 1;
    for (BaseSignature o : searchResult.getSucceeded())
    {
        DocumentResultSignature document = (DocumentResultSignature)o;
        System.out.print("Document #"+number++ +": "+document.getFileName()+". Processed: "+document.getProcessingTime()+", mls");
        for (BaseSignature temp : document.getSucceeded())
        {
            System.out.print("\t\t#"+temp.getSignatureId()+": "+temp.getSignatureType());
        }
    }
    if (searchResult.getFailed().size() > 0)
    {
        System.out.print("\nList of failed documents:");
        number = 1;
        for (BaseSignature o : searchResult.getFailed())
        {
            DocumentResultSignature document = (DocumentResultSignature)o;
            System.out.print("ERROR in Document #"+number++ +"-"+document.getFileName()+": "+document.getErrorMessage()+", mls");
        }
    }
}

/// <summary>
/// Search multi-layer image document for signatures.
/// This example provided for formats like DICOM
/// </summary>
Signature signature = new Signature("signed.dcm");
{
    // setup search options
    QrCodeSearchOptions searchOptions = new QrCodeSearchOptions();
    {
        // enable grabbing image content feature
        searchOptions.setReturnContent(true);
        // specify exact image type to be returned
        searchOptions.setReturnContentType(FileType.PNG);
    };
    // search multi-layer document
    List<QrCodeSignature> signatures = signature.search(QrCodeSignature.class, searchOptions);
    System.out.print("\nSource document ['"+fileName+"'] contains following QR-code signature(s).");
    // output signatures
    for (QrCodeSignature qrSignature : signatures)
    {
        // due to multi-layers each signature will contain the page number
        System.out.print("Found Qr-Code "+qrSignature.getText()+" signature at page "+qrSignature.getPageNumber()+" and id# "+qrSignature.getSignatureId()+".");
        System.out.print("Location at "+qrSignature.getLeft()+"-"+qrSignature.getTop()+". Size is "+qrSignature.getWidth()+"x"+qrSignature.getHeight()+".");
    }
}

/// <summary>
/// Obtain information from multi-layer image document.
/// This example provided for formats like DICOM
/// </summary>
Signature signature = new Signature(filePath);
{
    IDocumentInfo documentInfo = signature.getDocumentInfo();
    System.out.print("Document properties "+ filePath);
    System.out.print(" - format : "+documentInfo.getFileType().getFileFormat());
    System.out.print(" - extension : "+documentInfo.getFileType().getExtension());
    System.out.print(" - size : "+documentInfo.getSize());
    System.out.print(" - page count : "+documentInfo.getPageCount());
    for (PageInfo pageInfo : documentInfo.getPages())
    {
        System.out.print(" - page-"+pageInfo.getPageNumber()+" Width "+pageInfo.getWidth()+", Height "+pageInfo.getHeight());
    }
}

/// <summary>
/// Sign multi-layer image document.
/// </summary>
Signature signature = new Signature("sample.dcm");
{
    QrCodeSignOptions options = new QrCodeSignOptions("Patient #36363393. R: No-Issues");
    {
        Padding padding = new  Padding();
        // set signature position 
        padding.setRight(5);
        padding.setLeft(5);
        options.setMargin(tmp0);
        // set signature rectangle
        options.setWidth(100);
        options.setHeight(100);
    };
    // sign document to file
    SignResult signResult = signature.sign(outputFilePath, options);
    System.out.print("\nSource document signed successfully with "+signResult.getSucceeded().size()+" signature(s).\nFile saved at "+outputFilePath);
    System.out.print("\nList of newly created signatures:");
    for (BaseSignature temp : signResult.getSucceeded())
    {
        System.out.print(temp.getSignatureType()+" at page #"+temp.getPageNumber()+": Id:"+temp.getSignatureId()+".");
    }
}

/// <summary>
/// Search if certificate contain specific string from the serial number.
/// </summary>
Signature signature = new Signature(certificatePath, loadOptions);
{
    CertificateSearchOptions options = new CertificateSearchOptions();
    {
        // check the serial number
        options.setText("AAD0D15C628A");
        // find exact math
        options.setMatchType(TextMatchType.Contains);
    };

    // search for certificate data
    List<MetadataSignature> result = signature.search(MetadataSignature.class, options);
    if (result.size()>0)
    {
        System.out.print("\nCertificate contains following search results");
        for (MetadataSignature temp : result)
        {
            System.out.print("\t\t-"+temp.getName()+" - "+temp.getValue());
        }
    }
    else
    {
        System.out.print("\nCertificate failed search process.");
    }
}

/// <summary>
/// Support Succeeded and Failed list as result of processing archives
/// </summary>
Signature signature = new Signature("sample.zip");
{
    // create sign options
    TextSignOptions options = new TextSignOptions("signed!")
    {
        // set signature position
        options.setLeft(100);
        options.setTop(100);
    };
    // sign archive to new zip file
    SignResult result = signature.sign("output.zip", options);
    // analyze the failed documents
    for (BaseSignature o : result.getFailed())
    {
        DocumentResultSignature document = (DocumentResultSignature)o;
        System.out.print("ERROR in Document #"+number++ +"-"+document.getFileName()+": "+document.getErrorMessage());
    }
}

/// <summary>
/// Verify multi-layer image document for signatures.
/// This example provided for formats like DICOM
/// </summary>
Signature signature = new Signature("signed.dcm");
{
   QrCodeVerifyOptions options = new QrCodeVerifyOptions();
    {
        options.setAllPages(true);
        options.setText("Patient #36363393");
        options.setMatchType(TextMatchType.Contains);
    };

    VerificationResult result = signature.verify(options);
    if (result.isValid())
    {
        System.out.print("\nDICOM "+filePath+" has "+result.getSucceeded().size()+" successfully verified signatures!");
    }
    else
    {
        System.out.print("\nDocument "+filePath+" failed verification process.");
    }
}

/// <summary>
/// Generate preview for DICOM document 
/// </summary>
Signature signature = new Signature("signed.dcm"))
{
    PreviewOptions previewOption = new PreviewOptions(new PageStreamFactory() {
        @Override
        public OutputStream createPageStream(int pageNumber) {
            return generatePageStream(pageNumber);
        }

        @Override
        public void closePageStream(int pageNumber, OutputStream pageStream) {
            releasePageStream(pageNumber, pageStream);
            }
    });

    signature.generatePreview(previewOption);
    System.out.print("\nDICOM ['"+filePath+"'] pages previews were successfully generated!");
}

private static OutputStream generatePageStream(int pageNumber)
{
    try {
    String filePath = Constants.OutputPath +"\\SignDicomImageAdvanced\\image-"+pageNumber+".jpg";
        return new FileOutputStream(filePath);
    }catch (Exception e){
        throw new RuntimeException(e.getMessage());
    }
}

private static void releasePageStream(int pageNumber, OutputStream pageStream)
{
    try {
        pageStream.close();
        String imageFilePath = new File(Constants.OutputPath + "\\SignDicomImageAdvanced", "image-" +pageNumber +  ".jpg").getPath();
        System.out.print("Image file "+imageFilePath+" is ready for preview");
    }catch (Exception e){
        System.out.print(e.getMessage());
    }
}

/// <summary>
/// Sign multi-layer image document and add xmp metadata
/// </summary>
Signature signature = new Signature("sample.dcm"))
{
    QrCodeSignOptions options = new QrCodeSignOptions("Patient #36363393. R: No-Issues");
    {
        // set QR area
        options.setWidth(100);
        options.setHeight(100);
        // put right bottom corner
        options.setVerticalAlignment(VerticalAlignment.Bottom);
        options.setHorizontalAlignment(HorizontalAlignment.Right);
        Padding padding = new  Padding();
        padding.setRight(5);
        padding.setLeft(5);
        options.setMargin(padding);
    };

    DicomSaveOptions dicomSaveOptions = new DicomSaveOptions()
    List<DicomXmpEntry> list = new ArrayList<DicomXmpEntry>();
    list.add(new DicomXmpEntry(DicomXmpType.PatientName, "Patient #4"));
    dicomSaveOptions.setXmpEntries(list);

    SignResult signResult = signature.sign(outputFilePath, options, dicomSaveOptions);
}

/// <summary>
/// Gathering extended DICOM XmpData into the DocumentInfo
/// </summary>
Signature signature = new Signature("sample.dcm");
{
    System.out.print("\nList of DICOM xmp metadata:");
    IDocumentInfo signedDocumentInfo = signature.getDocumentInfo();
    for (MetadataSignature item : signedDocumentInfo.getMetadataSignatures())
    {
        System.out.print(item.toString());
    }
}