Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict

Modifier and Type	Field and Description
private final COSDictionary	dictionary

Access	Constructor and Description
public	PDPropBuildDataDict() Default constructor.
public	PDPropBuildDataDict(COSDictionary The signature dictionary. dict) Constructor.

Method Summary

Modifier and Type	Method and Description
public COSDictionary	Returns: The COS dictionary that matches this Java object. getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Convert this standard java object to a COS dictionary.
public String	Returns: the build date of the software module getDate() The build date of the software module.
public long	Returns: the revision of the software module getMinimumRevision() The software module revision number, used to determinate the minimum version of software that is required in order to process this signature.
public String	Returns: the name of the software module getName() The name of the software module that was used to create the signature.
public boolean	Returns: true if NonEFontNoWarn is set to true getNonEFontNoWarn() If there is a LegalPDF dictionary in the catalog of the PDF file and the NonEmbeddedFonts attribute in this dictionary has a non zero value, and the viewing application has a preference set to suppress the display of this warning then the value of this attribute will be set to true.
public String	Returns: the operating system id or name. getOS() Indicates the operating system.
public boolean	Returns: true if the software module or signature handler was a pre release. getPreRelease() A flag that can be used by the signature handler or software module to indicate that this signature was created with unrelease software.
public long	Returns: the revision of the software module getRevision() The software module revision number, corresponding to the Date attribute.
public boolean	Returns: true if the application was in trusted mode while signing. default: false getTrustedMode() If true, the application was in trusted mode when signing took place.
public String	Returns: the application implementation version getVersion() A text string indicating the version of the application implementation, as described by the `/Name` attribute in this dictionary.
public void	setDate(String is the build date of the software module date) The build date of the software module.
public void	setMinimumRevision(long is the software module revision number revision) The software module revision number, used to determinate the minimum version of software that is required in order to process this signature.
public void	setName(String is the name of the software module name) The name of the software module that was used to create the signature.
public void	setNonEFontNoWarn(boolean true if there is a Legal dictionary in the catalog and the NonEmbeddedFonts attribute has a non-zero value Documentation says: (Optional; PDF 1.5) If there is a LegalPDF dictionary in the catalog of the PDF file and the NonEmbeddedFonts attribute in this dictionary has a non zero value, and the viewing application has a preference set to suppress the display of this warning then the value of this attribute will be set to true. noEmbedFontWarning) If true, the reader should not display a warning about fonts not being embedded.
public void	setOS(String is a string with the system id or name. os) Indicates the operating system.
public void	setPreRelease(boolean is true if the signature was created with a unrelease software, otherwise false. preRelease) A flag that can be used by the signature handler or software module to indicate that this signature was created with unrelease software.
public void	setRevision(long is the software module revision number revision) The software module revision number, corresponding to the Date attribute.
public void	setTrustedMode(boolean true if the application is in trusted mode. trustedMode) If true, the application was in trusted mode when signing took place.
public void	setVersion(String the application implementation version applicationVersion) A text string indicating the version of the application implementation, as described by the `Name` attribute in this dictionary.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

dictionary	back to summary
private final COSDictionary dictionary

PDPropBuildDataDict	back to summary
public PDPropBuildDataDict() Default constructor.

PDPropBuildDataDict	back to summary
public PDPropBuildDataDict(COSDictionary dict) Constructor. Parameters dict:COSDictionary The signature dictionary.

Method Detail

getCOSObject	back to summary
public COSDictionary getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Convert this standard java object to a COS dictionary. Returns:COSDictionary The COS dictionary that matches this Java object. Annotations @Override

getCOSObject

back to summary

public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS dictionary.

Returns:COSDictionary

The COS dictionary that matches this Java object.

Annotations

@Override

getDate	back to summary
public String getDate() The build date of the software module. This string is normally produced by the compiler that is used to compile the software, for example using the Date and Time preprocessor flags. As such, this not likely to be in PDF Date format. Returns:String the build date of the software module

getDate

back to summary

public String getDate()

The build date of the software module. This string is normally produced by the compiler that is used to compile the software, for example using the Date and Time preprocessor flags. As such, this not likely to be in PDF Date format.

Returns:String: the build date of the software module

getMinimumRevision	back to summary
public long getMinimumRevision() The software module revision number, used to determinate the minimum version of software that is required in order to process this signature. Note this entry is deprecated for PDF v1.7 Returns:long the revision of the software module

getMinimumRevision

back to summary

public long getMinimumRevision()

The software module revision number, used to determinate the minimum version of software that is required in order to process this signature.

Note

this entry is deprecated for PDF v1.7

Returns:long: the revision of the software module

getName	back to summary
public String getName() The name of the software module that was used to create the signature. Returns:String the name of the software module

getName

back to summary

public String getName()

The name of the software module that was used to create the signature.

Returns:String: the name of the software module

getNonEFontNoWarn back to summary

getNonEFontNoWarn	back to summary
public boolean getNonEFontNoWarn() If there is a LegalPDF dictionary in the catalog of the PDF file and the NonEmbeddedFonts attribute in this dictionary has a non zero value, and the viewing application has a preference set to suppress the display of this warning then the value of this attribute will be set to true. Returns:boolean true if NonEFontNoWarn is set to true See Also `setNonEFontNoWarn(boolean)`

public boolean getNonEFontNoWarn()

If there is a LegalPDF dictionary in the catalog of the PDF file and the NonEmbeddedFonts attribute in this dictionary has a non zero value, and the viewing application has a preference set to suppress the display of this warning then the value of this attribute will be set to true.

Returns:boolean: true if NonEFontNoWarn is set to true
See Also: setNonEFontNoWarn(boolean)

getOS back to summary

getOS	back to summary
public String getOS() Indicates the operating system. The string format isn't specified yet. In its PDF Signature Build Dictionary Specifications Adobe differently specifies the value type to store operating system string: Specification for PDF v1.5 specifies type as string; Specification for PDF v1.7 specifies type as array and provided example for `/PropBuild` dictionary indicate it as array of names. This method supports both types to retrieve the value. Returns:String the operating system id or name.

public String getOS()

Indicates the operating system. The string format isn't specified yet. In its PDF Signature Build Dictionary Specifications Adobe differently specifies the value type to store operating system string:

Specification for PDF v1.5 specifies type as string;
Specification for PDF v1.7 specifies type as array and provided example for /PropBuild dictionary indicate it as array of names.

This method supports both types to retrieve the value.

Returns:String: the operating system id or name.

getPreRelease	back to summary
public boolean getPreRelease() A flag that can be used by the signature handler or software module to indicate that this signature was created with unrelease software. Returns:boolean true if the software module or signature handler was a pre release.

getPreRelease

back to summary

public boolean getPreRelease()

A flag that can be used by the signature handler or software module to indicate that this signature was created with unrelease software.

Returns:boolean: true if the software module or signature handler was a pre release.

getRevision	back to summary
public long getRevision() The software module revision number, corresponding to the Date attribute. Returns:long the revision of the software module

getRevision

back to summary

public long getRevision()

The software module revision number, corresponding to the Date attribute.

Returns:long: the revision of the software module

getTrustedMode	back to summary
public boolean getTrustedMode() If true, the application was in trusted mode when signing took place. Returns:boolean true if the application was in trusted mode while signing. default: false

getTrustedMode

back to summary

public boolean getTrustedMode()

If true, the application was in trusted mode when signing took place.

Returns:boolean: true if the application was in trusted mode while signing. default: false

getVersion back to summary

getVersion	back to summary
public String getVersion() A text string indicating the version of the application implementation, as described by the `/Name` attribute in this dictionary. When set by Adobe Acrobat, this entry is in the format: major.minor.micro (for example 7.0.7). Returns:String the application implementation version

public String getVersion()

A text string indicating the version of the application implementation, as described by the /Name attribute in this dictionary. When set by Adobe Acrobat, this entry is in the format: major.minor.micro (for example 7.0.7).

Returns:String: the application implementation version

setDate	back to summary
public void setDate(String date) The build date of the software module. This string is normally produced by the compiler. Parameters date:String is the build date of the software module

setDate

back to summary

public void setDate(String date)

The build date of the software module. This string is normally produced by the compiler.

Parameters

date:String: is the build date of the software module

setMinimumRevision	back to summary
public void setMinimumRevision(long revision) The software module revision number, used to determinate the minimum version of software that is required in order to process this signature. Note this entry is deprecated for PDF v1.7 Parameters revision:long is the software module revision number

setMinimumRevision

back to summary

public void setMinimumRevision(long revision)

The software module revision number, used to determinate the minimum version of software that is required in order to process this signature.

Note

this entry is deprecated for PDF v1.7

Parameters

revision:long: is the software module revision number

setName	back to summary
public void setName(String name) The name of the software module that was used to create the signature. Parameters name:String is the name of the software module

setName

back to summary

public void setName(String name)

The name of the software module that was used to create the signature.

Parameters

name:String: is the name of the software module

setNonEFontNoWarn back to summary

setNonEFontNoWarn	back to summary
public void setNonEFontNoWarn(boolean noEmbedFontWarning) If true, the reader should not display a warning about fonts not being embedded. Parameters noEmbedFontWarning:boolean true if there is a Legal dictionary in the catalog and the NonEmbeddedFonts attribute has a non-zero value Documentation says: (Optional; PDF 1.5) If there is a LegalPDF dictionary in the catalog of the PDF file and the NonEmbeddedFonts attribute in this dictionary has a non zero value, and the viewing application has a preference set to suppress the display of this warning then the value of this attribute will be set to true. See Also Digital Signature Build Dictionary Specification, `getNonEFontNoWarn()`, `COSName#NON_EFONT_NO_WARN`

public void setNonEFontNoWarn(boolean noEmbedFontWarning)

If true, the reader should not display a warning about fonts not being embedded.

Parameters

noEmbedFontWarning:boolean: true if there is a Legal dictionary in the catalog and the NonEmbeddedFonts attribute has a non-zero value Documentation says: (Optional; PDF 1.5) If there is a LegalPDF dictionary in the catalog of the PDF file and the NonEmbeddedFonts attribute in this dictionary has a non zero value, and the viewing application has a preference set to suppress the display of this warning then the value of this attribute will be set to true.

setOS	back to summary
public void setOS(String os) Indicates the operating system. The string format isn't specified yet. Value will be stored as first item of the array, as specified in PDF Signature Build Dictionary Specification for PDF v1.7. Parameters os:String is a string with the system id or name.

setOS

back to summary

public void setOS(String os)

Indicates the operating system. The string format isn't specified yet. Value will be stored as first item of the array, as specified in PDF Signature Build Dictionary Specification for PDF v1.7.

Parameters

os:String: is a string with the system id or name.

setPreRelease	back to summary
public void setPreRelease(boolean preRelease) A flag that can be used by the signature handler or software module to indicate that this signature was created with unrelease software. Parameters preRelease:boolean is true if the signature was created with a unrelease software, otherwise false.

setPreRelease

back to summary

public void setPreRelease(boolean preRelease)

A flag that can be used by the signature handler or software module to indicate that this signature was created with unrelease software.

Parameters

preRelease:boolean: is true if the signature was created with a unrelease software, otherwise false.

setRevision	back to summary
public void setRevision(long revision) The software module revision number, corresponding to the Date attribute. Parameters revision:long is the software module revision number

setRevision

back to summary

public void setRevision(long revision)

The software module revision number, corresponding to the Date attribute.

Parameters

revision:long: is the software module revision number

setTrustedMode	back to summary
public void setTrustedMode(boolean trustedMode) If true, the application was in trusted mode when signing took place. Parameters trustedMode:boolean true if the application is in trusted mode.

setTrustedMode

back to summary

public void setTrustedMode(boolean trustedMode)

If true, the application was in trusted mode when signing took place.

Parameters

trustedMode:boolean: true if the application is in trusted mode.

setVersion back to summary

setVersion	back to summary
public void setVersion(String applicationVersion) A text string indicating the version of the application implementation, as described by the `Name` attribute in this dictionary. When set by Adobe Acrobat, this entry is in the format: major.minor.micro (for example 7.0.7). Note Version value is specific for build data dictionary when used as the `App` dictionary in a build properties dictionary. Parameters applicationVersion:String the application implementation version

public void setVersion(String applicationVersion)

A text string indicating the version of the application implementation, as described by the Name attribute in this dictionary. When set by Adobe Acrobat, this entry is in the format: major.minor.micro (for example 7.0.7).

Note

Version value is specific for build data dictionary when used as the App dictionary in a build properties dictionary.

Parameters

applicationVersion:String: the application implementation version

public Class PDPropBuildDataDict

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail