com.pdftools.crypto.providers.Provider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pdftools-sdk Show documentation
The Pdftools SDK is a comprehensive development library that lets developers integrate advanced PDF functionalities into in-house applications.
The newest version!
/****************************************************************************
 *
 * File:            Provider.java
 *
 * Description:     PDFTOOLS Provider Class
 *
 * Author:          PDF Tools AG
 * 
 * Copyright:       Copyright (C) 2023 - 2024 PDF Tools AG, Switzerland
 *                  All rights reserved.
 * 
 * Notice:          By downloading and using this artifact, you accept PDF Tools AG's
 *                  [license agreement](https://www.pdf-tools.com/license-agreement/),
 *                  [privacy policy](https://www.pdf-tools.com/privacy-policy/),
 *                  and allow PDF Tools AG to track your usage data.
 *
 ***************************************************************************/

package com.pdftools.crypto.providers;

import com.pdftools.sys.*;
import com.pdftools.internal.*;
import java.util.EnumSet;
import java.time.OffsetDateTime;
/**
 * Base class for cryptographic providers
 * 
 * The cryptographic provider manages certificates, their private keys and implements cryptographic algorithms.
 * 
 * This SDK supports various different cryptographic providers.
 * The following list shows the signing certificate type that can be used for each provider.
 * 
 * 

 * 
 * 
 * Soft Certificate:
 * 
 * Soft certificates are typically PKCS#12 files that have the extension {@code .pfx} or {@code .p12} and contain
 * the signing certificate as well as the private key and trust chain (issuer certificates).
 * Soft certificates can be used with the {@link com.pdftools.crypto.providers.builtin.Provider builtin.Provider}, where they can be loaded using
 * {@link com.pdftools.crypto.providers.builtin.Provider#createSignatureFromCertificate builtin.Provider.createSignatureFromCertificate}.
 * 
 * 
 * 
 * Hardware Security Module (HSM):
 * 
 * HSMs always offer very good PKCS#11 support, so the {@link com.pdftools.crypto.providers.pkcs11.Session pkcs11.Session} is suitable.
 * For more information and installation instructions, consult the separate document "TechNotePKCS11.pdf".
 * 
 * 
 * 
 * USB Token or Smart Card:
 * 
 * These devices typically offer a PKCS#11 interface, so the recommended provider is the {@link com.pdftools.crypto.providers.pkcs11.Session pkcs11.Session}.
 * Note that in any case, signing documents is only possible in an interactive user session.
 * So these devices cannot be used in a service or web application environment.
 * 
 * 
 * 
 * Swisscom Signing Service:
 * 
 * The {@link com.pdftools.crypto.providers.swisscomsigsrv.Session swisscomsigsrv.Session} supports both static and on-demand signing certificates.
 * 
 * 
 * 
 * GlobalSign Digital Signing Service:
 * 
 * The {@link com.pdftools.crypto.providers.globalsigndss.Session globalsigndss.Session} supports all features of the service.
 * 
 * 

 */
public abstract class Provider extends NativeObject implements AutoCloseable 
{
    protected Provider(long handle) 
    {
        super(handle);
    }

    /**
     * @hidden
     */
    public static Provider createDynamicObject(long handle)
    {
        int type = getType(handle);
        switch (type)
        {
            case 1:
                return com.pdftools.crypto.providers.globalsigndss.Session.createDynamicObject(handle);
            case 2:
                return com.pdftools.crypto.providers.swisscomsigsrv.Session.createDynamicObject(handle);
            case 3:
                return com.pdftools.crypto.providers.pkcs11.Session.createDynamicObject(handle);
            case 4:
                return com.pdftools.crypto.providers.builtin.Provider.createDynamicObject(handle);
            default:
                return null;
        }
    }





    private static native int getType(long handle);
    /**
     * Close the object
     * Release all resources associated with the object.
     * @throws com.pdftools.PdfToolsException only explicitly stated in a superclass
     */
    public void close() 
        throws com.pdftools.PdfToolsException, 
               java.io.IOException
    {
        try
        {
            if (!close(getHandle()))
                throwLastError();
        }
        finally
        {
            setHandle(0);
        }
    }

    private native boolean close(long hObject);
}