at.gv.egiz.pdfas.api.sign

Class SignParameters

java.lang.Object

at.gv.egiz.pdfas.api.sign.SignParameters

Deprecated.

@Deprecated
public class SignParameters
extends java.lang.Object

Parameter object that holds the sign parameters.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	checkForPlaceholder Deprecated. The flag to de-/activate placeholder search
protected DataSource	document Deprecated. The document to be signed.
protected DataSink	output Deprecated. The output DataSink that will receive the signed document.
protected java.util.Properties	overrideProps Deprecated.
protected java.lang.String	placeholderId Deprecated. The id of the placeholder which should be replaced.
protected int	placeholderMatchMode Deprecated. The matching mode for placeholder extraction. If a placeholderId is set, the match mode determines what is to be done, if no matching placeholder is found in the document.
protected java.lang.String	signatureDevice Deprecated. The signature device to perform the actual signature.
protected java.lang.String	signatureKeyIdentifier Deprecated. The signature key identifier specifying which signature key should be used by the signature device to perform the signature.
protected SignaturePositioning	signaturePositioning Deprecated. The signature position.
protected java.lang.String	signatureProfileId Deprecated. The signature profile identifier identifying the profile to be used in the config file.
protected java.lang.String	signatureType Deprecated. The type of the signature.
protected TimeStamper	timeStamperImpl Deprecated.

Constructor Summary

Constructors

Constructor and Description
SignParameters() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
DataSource	getDocument() Deprecated.
DataSink	getOutput() Deprecated.
java.lang.String	getPlaceholderId() Deprecated. The id of the placeholder to replace.
int	getPlaceholderMatchMode() Deprecated. Get the placeholder matching mode.
java.util.Properties	getProfileOverrideProperties() Deprecated. Get override values created via setProfileOverrideValue(String, String)
java.lang.String	getSignatureDevice() Deprecated.
java.lang.String	getSignatureKeyIdentifier() Deprecated.
SignaturePositioning	getSignaturePositioning() Deprecated.
java.lang.String	getSignatureProfileId() Deprecated.
java.lang.String	getSignatureType() Deprecated.
TimeStamper	getTimeStamperImpl() Deprecated. setTimeStamperImpl(TimeStamper)
java.lang.Boolean	isCheckForPlaceholder() Deprecated. Get the value of the checkForPlaceholder flag.
void	setCheckForPlaceholder(java.lang.Boolean searchForPlaceHolder) Deprecated. Set this to true, if you want a search for placeholder images to be performed and appropriate images to be replaced.
void	setDocument(DataSource document) Deprecated.
void	setOutput(DataSink output) Deprecated.
void	setPlaceholderId(java.lang.String placeholderId) Deprecated. Set an explicit placeholder id.
void	setPlaceholderMatchMode(int placeholderMatchMode) Deprecated. Set the behavior if no exactly matching placeholder could be found. Exactly matching meaning: If a placeholderId is set: a placeholder which has exactly this id embedded If no placeholderId is set: a placeholder without an embedded id is found
void	setProfileOverrideValue(java.lang.String key, java.lang.String value) Deprecated. Override user defined values from the used signature profile like "value.SIG_META".
void	setSignatureDevice(java.lang.String signatureDevice) Deprecated.
void	setSignatureKeyIdentifier(java.lang.String signatureKeyIdentifier) Deprecated.
void	setSignaturePositioning(SignaturePositioning signaturePositioning) Deprecated.
void	setSignatureProfileId(java.lang.String signatureProfileId) Deprecated.
void	setSignatureType(java.lang.String signatureType) Deprecated.
void	setTimeStamperImpl(TimeStamper timeStamperImpl) Deprecated. Set a TimeStamper to create a timestamp on the signature value.

Methods inherited from class java.lang.Object

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

Field Detail

document

protected DataSource document

Deprecated.

The document to be signed.

The DataSource implementation encapsulates the actual representaion of the data. E.g. the DataSource may be File based or byte array based. See package at.gv.egiz.pdfas.framework.input and at.gv.pdfas.impl.input

signatureType

protected java.lang.String signatureType

Deprecated.

The type of the signature.

May be Constants.SIGNATURE_TYPE_BINARY or Constants.SIGNATURE_TYPE_TEXTUAL.

signatureDevice

protected java.lang.String signatureDevice

Deprecated.

The signature device to perform the actual signature.

May be Constants.SIGNATURE_DEVICE_MOA or Constants.SIGNATURE_DEVICE_BKU.

signatureProfileId

protected java.lang.String signatureProfileId

Deprecated.

The signature profile identifier identifying the profile to be used in the config file.

Note: In near future it will be possible to provide a full specified profile here instead of the profile id.

signatureKeyIdentifier

protected java.lang.String signatureKeyIdentifier

Deprecated.

The signature key identifier specifying which signature key should be used by the signature device to perform the signature.

Providing a null value (default) means that no explicit signature key identifier is provided. The selected signature device will then use its default mechanism for retrieving this information (which is usually to read the key from the provided signature profile).

Note that not all signature devices may support this parameter. If a signature device doesn't support this parameter the value should be null.

This key is usually passed straight through to the signature device and thereby has to contain an appropriate value for the signature device chosen.

Currently, only the Constants.SIGNATURE_DEVICE_MOA signature device evaluates this parameter and passes the provided String to MOA as the MOA key group identifier. If null is provided, the MOA signature device will determine the signature key identifier to be used from the provided profile and, if not specified there either, from the MOA default configuration.

signaturePositioning

protected SignaturePositioning signaturePositioning

Deprecated.

The signature position. Consult the PDF-AS documentation section Commandline.

output

protected DataSink output

Deprecated.

The output DataSink that will receive the signed document.

timeStamperImpl

protected TimeStamper timeStamperImpl

Deprecated.

checkForPlaceholder

protected java.lang.Boolean checkForPlaceholder

Deprecated.

The flag to de-/activate placeholder search

placeholderId

protected java.lang.String placeholderId

Deprecated.

The id of the placeholder which should be replaced.

placeholderMatchMode

protected int placeholderMatchMode

Deprecated.

The matching mode for placeholder extraction.
If a placeholderId is set, the match mode determines what is to be done, if no matching placeholder is found in the document.
Defaults to Constants.PLACEHOLDER_MATCH_MODE_MODERATE.

overrideProps

protected java.util.Properties overrideProps

Deprecated.

Constructor Detail

SignParameters

public SignParameters()

Deprecated.

Method Detail

getTimeStamperImpl

public TimeStamper getTimeStamperImpl()

Deprecated.

setTimeStamperImpl(TimeStamper)

Returns:

setTimeStamperImpl

public void setTimeStamperImpl(TimeStamper timeStamperImpl)

Deprecated.

Set a TimeStamper to create a timestamp on the signature value. Will be called after sign. For binary signatures only. Timestamp will be embedded in egiz dict /TimeStamp.

Parameters:

timeStamperImpl -

getDocument

public DataSource getDocument()

Deprecated.

Returns:

the document

setDocument

public void setDocument(DataSource document)

Deprecated.

Parameters:

document - the document to set

getSignatureType

public java.lang.String getSignatureType()

Deprecated.

Returns:

the signatureType

setSignatureType

public void setSignatureType(java.lang.String signatureType)

Deprecated.

Parameters:

signatureType - the signatureType to set

getSignatureDevice

public java.lang.String getSignatureDevice()

Deprecated.

Returns:

the signatureDevice

setSignatureDevice

public void setSignatureDevice(java.lang.String signatureDevice)

Deprecated.

Parameters:

signatureDevice - the signatureDevice to set

getSignatureProfileId

public java.lang.String getSignatureProfileId()

Deprecated.

Returns:

the signatureProfileId

setSignatureProfileId

public void setSignatureProfileId(java.lang.String signatureProfileId)

Deprecated.

Parameters:

signatureProfileId - the signatureProfileId to set

getSignaturePositioning

public SignaturePositioning getSignaturePositioning()

Deprecated.

Returns:

the signaturePositioning

setSignaturePositioning

public void setSignaturePositioning(SignaturePositioning signaturePositioning)

Deprecated.

Parameters:

signaturePositioning - the signaturePositioning to set

getOutput

public DataSink getOutput()

Deprecated.

Returns:

the output

setOutput

public void setOutput(DataSink output)

Deprecated.

Parameters:

output - the output to set

getSignatureKeyIdentifier

public java.lang.String getSignatureKeyIdentifier()

Deprecated.

Returns:

the signatureKeyIdentifier

setSignatureKeyIdentifier

public void setSignatureKeyIdentifier(java.lang.String signatureKeyIdentifier)

Deprecated.

Parameters:

signatureKeyIdentifier - the signatureKeyIdentifier to set

setProfileOverrideValue

public void setProfileOverrideValue(java.lang.String key,
                           java.lang.String value)

Deprecated.

Override user defined values from the used signature profile like "value.SIG_META". You cannot override pre defined values like SIG_VALUE, SIG_DATE SignatureTypes.REQUIRED_SIG_KEYS. The override values are bound to the SignParameters instance.

Sample usage:

      SignParameters sp = new SignParameters();
      . . .

      sp.setSignatureProfileId("SIGNATURBLOCK_DE");

      // expressions do not work on binary signature fields without phlength setting!!
      sp.setProfileOverrideValue("SIG_META", "It's nice to be important, but it is more important to be nice ${subject.L}");;
      sp.setProfileOverrideValue("SIG_LABEL", "./images/signatur-logo_en.png");

      // execute sign using the overrides
      pdfAs.sign(sp);
  

Parameters:

key - the name of the setting to override e.g. "SIG_META"

value - The new value

getProfileOverrideProperties

public java.util.Properties getProfileOverrideProperties()

Deprecated.

Get override values created via setProfileOverrideValue(String, String)

Returns:

isCheckForPlaceholder

public java.lang.Boolean isCheckForPlaceholder()

Deprecated.

Get the value of the checkForPlaceholder flag.

Returns:

setCheckForPlaceholder

public void setCheckForPlaceholder(java.lang.Boolean searchForPlaceHolder)

Deprecated.

Set this to true, if you want a search for placeholder images to be performed and appropriate images to be replaced. If this is not set, a search will only be performed if the configuration property "enable_placeholder_search" is set to true.

Parameters:

check -

setPlaceholderId

public void setPlaceholderId(java.lang.String placeholderId)

Deprecated.

Set an explicit placeholder id. Only placeholder images that have a matching ID property embedded will be considered for replacement.

Parameters:

placeholderId -

getPlaceholderId

public java.lang.String getPlaceholderId()

Deprecated.

The id of the placeholder to replace.

Returns:

the placeholderId

setPlaceholderMatchMode

public void setPlaceholderMatchMode(int placeholderMatchMode)

Deprecated.

Set the behavior if no exactly matching placeholder could be found.
Exactly matching meaning:

• If a placeholderId is set: a placeholder which has exactly this id embedded
• If no placeholderId is set: a placeholder without an embedded id is found

Parameters:

placeholderMatchMode -

See Also:

Constants.PLACEHOLDER_MATCH_MODE_LENIENT, Constants.PLACEHOLDER_MATCH_MODE_MODERATE, Defaults to {@link Constants#PLACEHOLDER_MATCH_MODE_MODERATE}.

getPlaceholderMatchMode

public int getPlaceholderMatchMode()

Deprecated.

Get the placeholder matching mode.

Returns:

the placeholderMatchMode

See Also:

getPlaceholderMatchMode()