xades4j.providers
Interface SignaturePropertiesCollector

public interface SignaturePropertiesCollector

Interface for the collector of signature properties.

Author:

Luís

See Also:

SignaturePropertiesProvider.provideProperties(xades4j.providers.SignaturePropertiesCollector)

Method Summary

void	addCounterSignature(CounterSignatureProperty counterSig) Adds a CounterSignature unsigned property.
void	addOtherSignatureProperty(OtherSignedSignatureProperty otherSignedProp) Adds a custom signed property.
void	addOtherSignatureProperty(OtherUnsignedSignatureProperty otherUnsignedProp) Adds a custom unsigned property.
void	setSignatureProductionPlace(SignatureProductionPlaceProperty sigProdPlace) Sets the SignatureProductionPlace signed property.
void	setSignerRole(SignerRoleProperty signerRole) Sets the SignerRole signed property.
void	setSigningTime(SigningTimeProperty sigTime) Sets the SigningTime signed property.

Method Detail

setSigningTime

void setSigningTime(SigningTimeProperty sigTime)

Sets the SigningTime signed property. This can be set only once.

Parameters:

sigTime - the SigningTime property

Throws:

NullPointerException - if sigTime is null

PropertyTargetException - if SigningTime is set more than once

setSignatureProductionPlace

void setSignatureProductionPlace(SignatureProductionPlaceProperty sigProdPlace)

Sets the SignatureProductionPlace signed property. This can be set only once.

Parameters:

sigProdPlace - the SignatureProductionPlace property

Throws:

NullPointerException - if sigProdPlace is null

PropertyTargetException - if SignatureProductionPlace is set more than once

setSignerRole

void setSignerRole(SignerRoleProperty signerRole)

Sets the SignerRole signed property. This can be set only once.

Parameters:

signerRole - the SignerRole property.

Throws:

NullPointerException - if signerRole is null

PropertyTargetException - if SignerRole is set more than once

addCounterSignature

void addCounterSignature(CounterSignatureProperty counterSig)

Adds a CounterSignature unsigned property. Multiple counter signatures can be added.

Parameters:

counterSig - the CounterSignature property

Throws:

NullPointerException - if counterSig is null

PropertyTargetException - if the property (instance) is already present

addOtherSignatureProperty

void addOtherSignatureProperty(OtherSignedSignatureProperty otherSignedProp)

Adds a custom signed property. Multiple custom signed properties can be added. The purpose of this method is extensibility.

Each custom property needs a corresponding PropertyDataObjectGenerator which can be supplied through XadesSigningProfile.

Parameters:

otherSignedProp - the custom property

Throws:

NullPointerException - if otherSignedProp is null

PropertyTargetException - if the property (instance) is already present

IllegalArgumentException - if the property is not properly annotated

addOtherSignatureProperty

void addOtherSignatureProperty(OtherUnsignedSignatureProperty otherUnsignedProp)

Adds a custom unsigned property. Multiple custom unsigned properties can be added. The purpose of this method is extensibility.

Each custom property needs a corresponding PropertyDataObjectGenerator which can be supplied through XadesSigningProfile.

Parameters:

otherUnsignedProp - the custom property

Throws:

NullPointerException - if otherUnsignedProp is null

PropertyTargetException - if the property (instance) is already present

IllegalArgumentException - if the property is not properly annotated