public class

TimestampingConfiguration

extends Object
implements AutoCloseable
java.lang.Object
   ↳ com.pdftron.pdf.TimestampingConfiguration

Class Overview

A class representing a set of options for timestamping a document.

Summary

Public Constructors
TimestampingConfiguration(long impl_ptr)
TimestampingConfiguration(String in_url)
Constructor.
Public Methods
long __GetHandle()
void close()
Frees the native memory of the object.
void destroy()
Frees the native memory of the object.
void setTimestampAuthorityServerPassword(String in_password)
Setter for a password to use during timestamping.
void setTimestampAuthorityServerURL(String in_url)
Setter to change the timestamp authority (TSA) URL to use during timestamping.
void setTimestampAuthorityServerUsername(String in_username)
Setter for a username to use during timestamping.
void setUseNonce(boolean in_use_nonce)
Setter for whether to use a nonce (unique random number) during timestamping.
TimestampingResult testConfiguration(VerificationOptions in_opts)
Tests a timestamping configuration for usability and reports any failures.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.lang.AutoCloseable

Public Constructors

public TimestampingConfiguration (long impl_ptr)

public TimestampingConfiguration (String in_url)

Constructor.

Parameters
in_url -- a string representing a URL of a timestamp authority (TSA) to use during timestamping
Throws
PDFNetException

Public Methods

public long __GetHandle ()

public void close ()

Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.

Throws
PDFNetException

public void destroy ()

Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.

Throws
PDFNetException

public void setTimestampAuthorityServerPassword (String in_password)

Setter for a password to use during timestamping.

Parameters
in_password -- a string representing a password.
Throws
PDFNetException

public void setTimestampAuthorityServerURL (String in_url)

Setter to change the timestamp authority (TSA) URL to use during timestamping.

Parameters
in_url -- a string representing a URL of a timestamp authority.
Throws
PDFNetException

public void setTimestampAuthorityServerUsername (String in_username)

Setter for a username to use during timestamping.

Parameters
in_username -- a string representing a username.
Throws
PDFNetException

public void setUseNonce (boolean in_use_nonce)

Setter for whether to use a nonce (unique random number) during timestamping. This is on by default, and should be on whenever a timestamp authority supports it, because it helps prevent replay attacks.

Parameters
in_use_nonce -- a boolean value representing whether or not to use a nonce
Throws
PDFNetException

public TimestampingResult testConfiguration (VerificationOptions in_opts)

Tests a timestamping configuration for usability and reports any failures. This function does not throw on many common failures, unlike the real signing, thereby allowing early diagnosis of things like connectivity issues with timestamp authorities.

Parameters
in_opts -- a set of verification options to try to use
Returns
  • A result object containing information about the status of the configuration test and any errors that occurred during it.
Throws
PDFNetException