Serialized Form

  • Package eu.europa.esig.dss.pades

    • Class eu.europa.esig.dss.pades.AbstractDSSFont

      class AbstractDSSFont extends Object implements Serializable
      serialVersionUID:
      3565389650822834584L

      • Serialized Fields

        • size
          float size
          The size of the font

    • Class eu.europa.esig.dss.pades.DSSFileFont

      class DSSFileFont extends AbstractDSSFont implements Serializable
      serialVersionUID:
      -2631152291035404442L

      • Serialized Fields

        • embedFontSubset
          boolean embedFontSubset
          Defines whether only a subset of used glyphs should be embedded to a PDF, when a font file is used with a text information defined within a signature field. DEFAULT : FALSE (all glyphs from a font file are embedded to a PDF document) NOTE : this parameter will not take effect for DefaultPdfBoxVisibleSignatureDrawer
        • fileFont
          eu.europa.esig.dss.model.DSSDocument fileFont
          The font document
        • javaFont
          Font javaFont
          Java implementation of the font

    • Class eu.europa.esig.dss.pades.DSSJavaFont

      class DSSJavaFont extends AbstractDSSFont implements Serializable
      serialVersionUID:
      5555902178825682245L

      • Serialized Fields

        • javaFont
          Font javaFont
          The Java font

    • Class eu.europa.esig.dss.pades.PAdESProfileParameters

      class PAdESProfileParameters extends eu.europa.esig.dss.ProfileParameters implements Serializable
      serialVersionUID:
      852030281057208148L

      • Serialized Fields

        • pdfToBeSignedCache
          PdfSignatureCache pdfToBeSignedCache
          Internal cache used to accelerate the signature creation process

    • Class eu.europa.esig.dss.pades.PAdESSignatureParameters

      class PAdESSignatureParameters extends eu.europa.esig.dss.cades.CAdESSignatureParameters implements Serializable
      serialVersionUID:
      -1632557456487796227L

      • Serialized Fields

        • appName
          String appName
          The signing app name
        • contactInfo
          String contactInfo
          The contact info
        • includeVRIDictionary
          boolean includeVRIDictionary
          Defines whether the VRI dictionary should be included to a PAdES signature on extension within its LT-level revision (DSS-revision) Default: FALSE (VRI dictionary is not included)
        • location
          String location
          The signer's location
        • passwordProtection
          char[] passwordProtection
          Password used to encrypt a PDF
        • permission
          eu.europa.esig.dss.enumerations.CertificationPermission permission
          This attribute allows to create a "certification signature". That allows to remove permission(s) in case of future change(s).
        • reason
          String reason
          The signature creation reason
        • signatureFilter
          String signatureFilter
          This attribute allows to override the used Filter for a Signature. Default value is Adobe.PPKLite
        • signatureImageParameters
          SignatureImageParameters signatureImageParameters
          This attribute is used to create visible signature in PAdES form
        • signatureSize
          int signatureSize
          Defines the preserved space for a signature context Default : 9472 (default value in pdfbox)
        • signatureSubFilter
          String signatureSubFilter
          This attribute allows to override the used subFilter for a Signature. Default value is ETSI.CAdES.detached
        • signerName
          String signerName
          This attribute allows to explicitly specify the SignerName (name for the Signature). The person or authority signing the document.
        • signingTimeZone
          TimeZone signingTimeZone
          The time-zone used for signature creation Default: TimeZone.getDefault()

    • Class eu.europa.esig.dss.pades.PAdESTimestampParameters

      class PAdESTimestampParameters extends eu.europa.esig.dss.cades.signature.CAdESTimestampParameters implements Serializable

      • Serialized Fields

        • appName
          String appName
          The signing app name
        • passwordProtection
          char[] passwordProtection
          Password used to encrypt a PDF
        • pdfSignatureCache
          PdfSignatureCache pdfSignatureCache
          The internal signature processing variable
        • timestampDate
          Date timestampDate
          Date of the timestamp
        • timestampFilter
          String timestampFilter
          This attribute allows to override the used Filter for a Timestamp. Default value is Adobe.PPKLite
        • timestampImageParameters
          SignatureImageParameters timestampImageParameters
          This attribute is used to create a visible timestamp in PAdES form
        • timestampSize
          int timestampSize
          This attribute defines a length of a reserved space for the timestamp inside a /Contents attribute Default value is 9472 (from PDFBox)
        • timestampSubFilter
          String timestampSubFilter
          This attribute allows to override the used subFilter for a Timestamp. Default value is ETSI.RFC3161

    • Class eu.europa.esig.dss.pades.SignatureFieldParameters

      class SignatureFieldParameters extends Object implements Serializable
      serialVersionUID:
      4032195150617714778L

      • Serialized Fields

        • fieldId
          String fieldId
          Signature field id/name (optional)
        • height
          float height
          Signature field height
        • originX
          float originX
          Coordinate X where to add the signature field (origin is top/left corner)
        • originY
          float originY
          Coordinate Y where to add the signature field (origin is top/left corner)
        • page
          int page
          Page number where the signature field is added
        • rotation
          eu.europa.esig.dss.enumerations.VisualSignatureRotation rotation
          Use rotation on the PDF page, where the signature field will be created
        • width
          float width
          Signature field width

    • Class eu.europa.esig.dss.pades.SignatureImageParameters

      class SignatureImageParameters extends Object implements Serializable
      serialVersionUID:
      -327971057134928889L

      • Serialized Fields

        • alignmentHorizontal
          eu.europa.esig.dss.enumerations.VisualSignatureAlignmentHorizontal alignmentHorizontal
          Horizontal alignment of the visual signature on the pdf page
        • alignmentVertical
          eu.europa.esig.dss.enumerations.VisualSignatureAlignmentVertical alignmentVertical
          Vertical alignment of the visual signature on the pdf page
        • backgroundColor
          Color backgroundColor
          This variable defines the color of the image
        • dpi
          Integer dpi
          This variable defines the DPI of the image
        • fieldParameters
          SignatureFieldParameters fieldParameters
          This variable defines a SignatureFieldParameters like field positions and dimensions
        • image
          eu.europa.esig.dss.model.DSSDocument image
          This variable contains the image to use (company logo,...)
        • imageScaling
          eu.europa.esig.dss.enumerations.ImageScaling imageScaling
          Defines the image scaling behavior within a signature field with a fixed size DEFAULT : ImageScaling.STRETCH (stretches the image in both directions to fill the signature field)
        • textParameters
          SignatureImageTextParameters textParameters
          This variable is use to defines the text to generate on the image
        • zoom
          int zoom
          This variable defines a percent to zoom the image (100% means no scaling). Note: This do not touch zooming of the text representation.

    • Class eu.europa.esig.dss.pades.SignatureImageTextParameters

      class SignatureImageTextParameters extends Object implements Serializable
      serialVersionUID:
      727438728149346847L

      • Serialized Fields

        • backgroundColor
          Color backgroundColor
          This variable defines the background of a text bounding box
        • dssFont
          DSSFont dssFont
          This variable defines the font to use (default is PTSerifRegular)
        • padding
          float padding
          This variable defines a padding in pixels to bound text around (default is 5)
        • signerTextHorizontalAlignment
          eu.europa.esig.dss.enumerations.SignerTextHorizontalAlignment signerTextHorizontalAlignment
          This variable set the more line text horizontal alignment
        • signerTextPosition
          eu.europa.esig.dss.enumerations.SignerTextPosition signerTextPosition
          This variable allows to add signer name on the image (by default, LEFT)
        • signerTextVerticalAlignment
          eu.europa.esig.dss.enumerations.SignerTextVerticalAlignment signerTextVerticalAlignment
          This variable is define the image from text vertical alignment in connection with the image

          It has effect when the SignerPosition is LEFT or RIGHT
        • text
          String text
          This variable defines the text to sign
        • textColor
          Color textColor
          This variable defines the text color to use (default is BLACK) (PAdES visual appearance: allow null as text color, preventing graphic operators)
        • textWrapping
          eu.europa.esig.dss.enumerations.TextWrapping textWrapping
          This variable defines how the given text should be wrapped within the signature field's box Default : TextWrapping.FONT_BASED - the text is computed based on the dssFont configuration

  • Package eu.europa.esig.dss.pades.exception

  • Package eu.europa.esig.dss.pades.signature

  • Package eu.europa.esig.dss.pades.validation

  • Package eu.europa.esig.dss.pades.validation.dss

    • Class eu.europa.esig.dss.pades.validation.dss.PdfCompositeDssDictCertificateSource

      class PdfCompositeDssDictCertificateSource extends eu.europa.esig.dss.spi.x509.TokenCertificateSource implements Serializable

      • Serialized Fields

        • certMap
          Map<Long,Set<eu.europa.esig.dss.model.x509.CertificateToken>> certMap
          Composite map of certificate tokens extracted from different /DSS revisions

    • Class eu.europa.esig.dss.pades.validation.dss.PdfCompositeDssDictCRLSource

      class PdfCompositeDssDictCRLSource extends eu.europa.esig.dss.spi.x509.revocation.crl.OfflineCRLSource implements Serializable

      • Serialized Fields

        • crlBinaryByIdMap
          Map<Long,Set<eu.europa.esig.dss.crl.CRLBinary>> crlBinaryByIdMap
          Composite map of CRL tokens extracted from different /DSS revisions by id
        • crlBinaryByObjectMap
          Map<eu.europa.esig.dss.model.identifier.EncapsulatedRevocationTokenIdentifier<eu.europa.esig.dss.model.x509.revocation.crl.CRL>,Set<Long>> crlBinaryByObjectMap
          Composite map of CRL tokens extracted from different /DSS revisions by encoded object binaries
        • crlTokenMap
          Map<eu.europa.esig.dss.spi.x509.revocation.RevocationToken<eu.europa.esig.dss.model.x509.revocation.crl.CRL>,Set<Long>> crlTokenMap
          Cached map of created CRLTokens and corresponding PDF object ids

    • Class eu.europa.esig.dss.pades.validation.dss.PdfCompositeDssDictionary

      class PdfCompositeDssDictionary extends Object implements Serializable

    • Class eu.europa.esig.dss.pades.validation.dss.PdfCompositeDssDictOCSPSource

      class PdfCompositeDssDictOCSPSource extends eu.europa.esig.dss.spi.x509.revocation.ocsp.OfflineOCSPSource implements Serializable

      • Serialized Fields

        • ocspBinaryByIdMap
          Map<Long,Set<eu.europa.esig.dss.spi.x509.revocation.ocsp.OCSPResponseBinary>> ocspBinaryByIdMap
          Composite map of OCSP tokens extracted from different /DSS revisions by object id
        • ocspBinaryByObjectMap
          Map<eu.europa.esig.dss.model.identifier.EncapsulatedRevocationTokenIdentifier<eu.europa.esig.dss.model.x509.revocation.ocsp.OCSP>,Set<Long>> ocspBinaryByObjectMap
          Composite map of OCSP tokens extracted from different /DSS revisions by encoded object binaries
        • ocspTokenMap
          Map<eu.europa.esig.dss.spi.x509.revocation.RevocationToken<eu.europa.esig.dss.model.x509.revocation.ocsp.OCSP>,Set<Long>> ocspTokenMap
          Cached map of created OCSPTokens and corresponding PDF object ids

    • Class eu.europa.esig.dss.pades.validation.dss.PdfDssDictCertificateSource

      class PdfDssDictCertificateSource extends eu.europa.esig.dss.spi.x509.TokenCertificateSource implements Serializable
      serialVersionUID:
      7254611440571170316L

      • Serialized Fields

        • compositeCertificateSource
          PdfCompositeDssDictCertificateSource compositeCertificateSource
          Merged certificate source combined from all /DSS revisions
        • dssDictionary
          PdfDssDict dssDictionary
          The DSS dictionary
        • relatedVRIDictionaryName
          String relatedVRIDictionaryName
          Name of the signature's VRI dictionary, when applicable

    • Class eu.europa.esig.dss.pades.validation.dss.PdfDssDictCRLSource

      class PdfDssDictCRLSource extends eu.europa.esig.dss.spi.x509.revocation.crl.OfflineCRLSource implements Serializable
      serialVersionUID:
      7920126699012690199L

      • Serialized Fields

        • compositeCRLSource
          PdfCompositeDssDictCRLSource compositeCRLSource
          Merged certificate source combined from all /DSS revisions
        • crlMap
          Map<Long,eu.europa.esig.dss.crl.CRLBinary> crlMap
          Cached CRL Map
        • dssDictionary
          PdfDssDict dssDictionary
          The DSS dictionary
        • relatedVRIDictionaryName
          String relatedVRIDictionaryName
          Name of the signature's VRI dictionary, when applicable

    • Class eu.europa.esig.dss.pades.validation.dss.PdfDssDictOCSPSource

      class PdfDssDictOCSPSource extends eu.europa.esig.dss.spi.x509.revocation.ocsp.OfflineOCSPSource implements Serializable
      serialVersionUID:
      1503525374769179608L

      • Serialized Fields

        • compositeOCSPSource
          PdfCompositeDssDictOCSPSource compositeOCSPSource
          Merged certificate source combined from all /DSS revisions
        • dssDictionary
          PdfDssDict dssDictionary
          The DSS dictionary
        • ocspMap
          Map<Long,eu.europa.esig.dss.spi.x509.revocation.ocsp.OCSPResponseBinary> ocspMap
          Cached OCSP Map
        • relatedVRIDictionaryName
          String relatedVRIDictionaryName
          Name of the signature's VRI dictionary, when applicable

    • Class eu.europa.esig.dss.pades.validation.dss.VriDictionaryTimestampIdentifierBuilder

      class VriDictionaryTimestampIdentifierBuilder extends eu.europa.esig.dss.spi.x509.tsp.TimestampIdentifierBuilder implements Serializable
      serialVersionUID:
      1258485021800079377L

      • Serialized Fields

        • name
          String name
          Identifier of the corresponding VRI dictionary in the PDF document

  • Package eu.europa.esig.dss.pades.validation.scope

  • Package eu.europa.esig.dss.pades.validation.timestamp

  • Package eu.europa.esig.dss.pdf

  • Package eu.europa.esig.dss.pdf.modifications

  • Package eu.europa.esig.dss.pdf.visible

    • Class eu.europa.esig.dss.pdf.visible.ImageResolution

      class ImageResolution extends Object implements Serializable
      serialVersionUID:
      -141396204517073379L

      • Serialized Fields

        • xDpi
          int xDpi
          X axis dpi
        • yDpi
          int yDpi
          Y axis dpi

    • Class eu.europa.esig.dss.pdf.visible.SignatureFieldDimensionAndPosition

      class SignatureFieldDimensionAndPosition extends Object implements Serializable
      serialVersionUID:
      5513776649702929990L

      • Serialized Fields

        • boxHeight
          float boxHeight
          Height of the signature bounding box
        • boxWidth
          float boxWidth
          Width of the signature bounding box
        • boxX
          float boxX
          Upper left X coordinate of the signature bounding box
        • boxY
          float boxY
          Upper left Y coordinate of the signature bounding box
        • globalRotation
          int globalRotation
          The global rotation of the page
        • imageBoxHeight
          float imageBoxHeight
          Height of the image bounding box
        • imageBoxWidth
          float imageBoxWidth
          Width of the image bounding box
        • imageBoxX
          float imageBoxX
          Upper left X coordinate of the image bounding box
        • imageBoxY
          float imageBoxY
          Upper left Y coordinate of the image bounding box
        • imageHeight
          float imageHeight
          Height of the image
        • imageResolution
          ImageResolution imageResolution
          ImageResolution
        • imageWidth
          float imageWidth
          Width of the image
        • imageX
          float imageX
          Upper left X coordinate of the image
        • imageY
          float imageY
          Upper left Y coordinate of the image
        • text
          String text
          The text string
        • textBoxHeight
          float textBoxHeight
          Height the text bounding box
        • textBoxWidth
          float textBoxWidth
          Width the text bounding box
        • textBoxX
          float textBoxX
          Upper left X coordinate of the text bounding box
        • textBoxY
          float textBoxY
          Upper left Y coordinate of the text bounding box
        • textHeight
          float textHeight
          Height of the text
        • textSize
          float textSize
          The text size
        • textWidth
          float textWidth
          Width of the text
        • textX
          float textX
          Upper left X coordinate of the text
        • textY
          float textY
          Upper left Y coordinate of the text