iaik.ixsil.core

Interface SignerSignedInfo

public interface SignerSignedInfo

This interface provides a specialized view on a SignedInfo. This view is used by the application in the signature creation use case.

See Also:

SignerSignature.getSignerSignedInfo()

Method Summary

Methods

Modifier and Type	Method and Description
SignerReference	addReference(SignerReference reference) Adds a completely configured reference object to the signed information.
SignerReference	createReference() Create an empty reference object.
CanonicalizationAlgorithm	getCanonicalizationAlgorithm() Gets the canonicalization algorithm employed by this signed information.
java.lang.String	getId() Gets the Id attribute value of the SignedInfo element.
SignatureAlgorithm	getSignatureAlgorithm() Gets the signature algorithm employed by this signed information.
SignerReference[]	getSignerReferences() Gets an array containing all reference objects registered in the context of this signed information.
SignerReference	removeReference(SignerReference reference) Removes a reference object from this signed information.
void	setCanonicalizationAlgorithm(CanonicalizationAlgorithm canonicalizationAlgorithm) Sets the canonicalization algorithm for this signed information.
void	setId(java.lang.String id) Sets the Id attribute value of the SignedInfo element.
void	setSignatureAlgorithm(SignatureAlgorithm signatureAlgorithm) Sets the signature algorithm for this signed information.

Method Detail

createReference

SignerReference createReference()
                                throws SignedInfoException

Create an empty reference object.

Returns:

an interface to the newly created reference object, fitting for the signing use case.

Throws:

SignedInfoException - if crating the reference object fails for any reason.

addReference

SignerReference addReference(SignerReference reference)
                             throws SignedInfoException

Adds a completely configured reference object to the signed information. If the reference has already been added to a SignerManifest or SignerSignedInfo container, this method will have no effect.

Parameters:

reference - The reference to be added. Must not be null.

Returns:

the added reference, or null if adding the reference is impossible (see above).

Throws:

SignedInfoException - if a reference without its URI attribute set already exists within this signed information, or if adding the reference fails for any other reason.

removeReference

SignerReference removeReference(SignerReference reference)

Removes a reference object from this signed information. If the specified reference does not exist in the context of this signed information, this method will have no effect.

Parameters:

reference - The signing use case interface to the reference to be removed from the signed information.

Returns:

the signing use case interface to the removed reference, null if the reference to be removed does not exist in the context of this signed information.

getSignerReferences

SignerReference[] getSignerReferences()

Gets an array containing all reference objects registered in the context of this signed information.

Returns:

an array of interfaces to the registered reference objects, fitting for the signing use case, or null if there are no references available.

setId

void setId(java.lang.String id)

Sets the Id attribute value of the SignedInfo element. If the attribute has already been set, it will be overwritten. If the id parameter equals null, the possibly existing Id attribute will be removed.

Parameters:

id - The value for the Id attribute of the SignedInfo element.

getId

java.lang.String getId()

Gets the Id attribute value of the SignedInfo element.

Returns:

the attribute value or null if the Id attribute is not available.

setSignatureAlgorithm

void setSignatureAlgorithm(SignatureAlgorithm signatureAlgorithm)
                           throws SignedInfoException

Sets the signature algorithm for this signed information. If the algorithm has already been set, the value is overwritten.

Parameters:

signatureAlgorithm - The signature algorithm which will be used to compute the signature value of the XML signature. Must not be null.

Throws:

SignedInfoException - if requesting the DOM element representation from the specified signature algorithm fails.

getSignatureAlgorithm

SignatureAlgorithm getSignatureAlgorithm()

Gets the signature algorithm employed by this signed information.

Returns:

the signature algorithm employed by this signed information, or null if it has not been specified yet.

setCanonicalizationAlgorithm

void setCanonicalizationAlgorithm(CanonicalizationAlgorithm canonicalizationAlgorithm)
                                  throws SignedInfoException

Sets the canonicalization algorithm for this signed information. If the algorithm has already been set, the value is overwritten.

Parameters:

canonicalizationAlgorithm - The canonicalization algorithm used to create the canonicalization of all the signed information, which will be used as the input of the signature algorithm. Must not be null.

Throws:

SignedInfoException - if requesting the DOM element representation from the canonicalization algorithm fails.

getCanonicalizationAlgorithm

CanonicalizationAlgorithm getCanonicalizationAlgorithm()

Gets the canonicalization algorithm employed by this signed information.

Returns:

the canonicalization algorithm employed by this signed information, or null if it has not been specified yet.