Package eu.europa.esig.dss.pdf

Class PdfPermissionsChecker

java.lang.Object
eu.europa.esig.dss.pdf.PdfPermissionsChecker
public class PdfPermissionsChecker extends Object
This class is used to verify permissions of a PDF document and to check whether modifications are allowed

  • Constructor Details

    • PdfPermissionsChecker

      public PdfPermissionsChecker()
      Default constructor to instantiate the checker

  • Method Details

    • setAlertOnForbiddenSignatureCreation

      public void setAlertOnForbiddenSignatureCreation(StatusAlert alertOnForbiddenSignatureCreation)
      Sets a behavior to follow when creating a new signature in a document that forbids creation of new signatures Default : ExceptionOnStatusAlert - throw the exception
      Parameters:
      alertOnForbiddenSignatureCreation - StatusAlert to execute

    • checkDocumentPermissions

      public void checkDocumentPermissions(PdfDocumentReader documentReader, SignatureFieldParameters fieldParameters)
      This method checks if the document has the necessary permissions for the signature operation
      Parameters:
      documentReader - PdfDocumentReader
      fieldParameters - SignatureFieldParameters

    • checkSignatureRestrictionDictionaries

      public void checkSignatureRestrictionDictionaries(PdfDocumentReader documentReader, SignatureFieldParameters fieldParameters)
      This method verifies whether a new signature is permitted
      Parameters:
      documentReader - PdfDocumentReader
      fieldParameters - SignatureFieldParameters

    • isDocumentChangeForbidden

      protected boolean isDocumentChangeForbidden(CertificationPermission certificationPermission)
      This method verifies and returns whether changes within a document are forbidden according to the defined certificationPermission
      Parameters:
      certificationPermission - CertificationPermission to check
      Returns:
      TRUE if changes are forbidden within the document, FALSE otherwise

    • alertOnForbiddenSignatureCreation

      protected void alertOnForbiddenSignatureCreation(String message)
      Executes the alertOnForbiddenSignatureCreation with the given message
      Parameters:
      message - String containing an information about document permissions' failure

    • isSignatureFieldCreationForbidden

      protected boolean isSignatureFieldCreationForbidden(SigFieldPermissions sigFieldPermissions, String signatureFieldId)
      Checks and returns whether a signature field creation if forbidden according to the given configuration of the signatureFieldId
      Parameters:
      sigFieldPermissions - SigFieldPermissions permissions
      signatureFieldId - String providing the permission configuration
      Returns:
      TRUE of a signature field cretion is forbidden according to the configuration, FALSE otherwise