iaik.pdf.parameters

Class LegalContentAttestation

java.lang.Object

iaik.pdf.parameters.LegalContentAttestation

public class LegalContentAttestation
extends java.lang.Object

A Legal Content Attestation can be added when creating certification signatures, in order to specify the PDF capabilities which may affect the signed document (e.g. JavaScript). In the attestation text the author can provide further information about the document's integrity.

See Also:

PdfSignatureInstance.certify(iaik.pdf.signature.CertificationSignature.ModificationPermission, LegalContentAttestation)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LegalContentAttestation.ContentType Possible PDF content types that may effect the presentation of the document's content.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	attestation Identifier for the attestation string entry.
static java.lang.String	optionalContent Identifier for the optional content entry.

Constructor Summary

Constructors

Constructor and Description
LegalContentAttestation() Create a new empty legal content attestation.

Method Summary

Modifier and Type	Method and Description
void	addEntry(LegalContentAttestation.ContentType content, int occurrences) Add entry for the given content type
java.lang.String	getAttestationString() The attestation text contained in this legal content attestation.
static java.lang.String	getContentName(LegalContentAttestation.ContentType content) Get the identifier for the entry of this content type
static LegalContentAttestation.ContentType	getContentType(java.lang.String content) Get the corresponding content type for the given identifier.
java.util.HashMap<LegalContentAttestation.ContentType,java.lang.Integer>	getEntries()
boolean	getOptionalContentFlag()
void	setAttestationString(java.lang.String attestation) Set the attestation text, giving some more information about the document's integrity.
void	setOptionalContentFlag(boolean included) Set whether document contains object of PDF type "optional content"

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

optionalContent

public static final java.lang.String optionalContent

Identifier for the optional content entry.

See Also:

Constant Field Values

attestation

public static final java.lang.String attestation

Identifier for the attestation string entry.

See Also:

Constant Field Values

Constructor Detail

LegalContentAttestation

public LegalContentAttestation()

Create a new empty legal content attestation.

Method Detail

addEntry

public void addEntry(LegalContentAttestation.ContentType content,
                     int occurrences)

Add entry for the given content type

Parameters:

content - the content type contained in the document

occurrences - number, how often content of this type occurs in the document

setAttestationString

public void setAttestationString(java.lang.String attestation)

Set the attestation text, giving some more information about the document's integrity.

Parameters:

attestation - the attestation text

getAttestationString

public java.lang.String getAttestationString()

The attestation text contained in this legal content attestation.

Returns:

the attestation text

setOptionalContentFlag

public void setOptionalContentFlag(boolean included)

Set whether document contains object of PDF type "optional content"

Parameters:

included - set to true, if such objects are contained

getOptionalContentFlag

public boolean getOptionalContentFlag()

Returns:

true, if this legal content attestation claims, that document contains objects of PDF type "optional content".

getEntries

public java.util.HashMap<LegalContentAttestation.ContentType,java.lang.Integer> getEntries()

Returns:

Stated content types, to be contained in the document, and their number of occurrences

getContentName

public static java.lang.String getContentName(LegalContentAttestation.ContentType content)

Get the identifier for the entry of this content type

Parameters:

content - the content type

Returns:

the identifier

getContentType

public static LegalContentAttestation.ContentType getContentType(java.lang.String content)
                                                          throws PdfSignatureException

Get the corresponding content type for the given identifier.

Parameters:

content - Identifier used for this content type.

Returns:

The corresponding content type

Throws:

PdfSignatureException - If the given identifier is not defined by the PDF specification