org.opensaml.xmlsec.signature.support

Class URIContentReference

java.lang.Object

org.opensaml.xmlsec.signature.support.URIContentReference

All Implemented Interfaces:

ConfigurableContentReference, ContentReference

Direct Known Subclasses:

DocumentInternalIDContentReference

public class URIContentReference
extends java.lang.Object
implements ConfigurableContentReference

A generic content reference that uses a URI to reference the content to be signed.

The default digest algorithm used is SignatureConstants.ALGO_ID_DIGEST_SHA256.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	digestAlgorithm Algorithm used to digest the content .
private org.slf4j.Logger	log Logger.
private java.lang.String	referenceID Element reference ID.
private java.util.List<java.lang.String>	transforms Transforms applied to the content.

Constructor Summary

Constructors

Constructor and Description
URIContentReference(java.lang.String refID) Constructor.

Method Summary

Modifier and Type	Method and Description
void	createReference(org.apache.xml.security.signature.XMLSignature signature) Called by the signature marshaller to allow references to be added to the signature.
java.lang.String	getDigestAlgorithm() Gets the algorithm used to digest the content.
java.util.List<java.lang.String>	getTransforms() Gets the transforms applied to the content prior to digest generation.
void	setDigestAlgorithm(java.lang.String newAlgorithm) Sets the algorithm used to digest the content.

Methods inherited from class java.lang.Object

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

Field Detail

log

private final org.slf4j.Logger log

Logger.

referenceID

private final java.lang.String referenceID

Element reference ID.

digestAlgorithm

private java.lang.String digestAlgorithm

Algorithm used to digest the content .

transforms

private final java.util.List<java.lang.String> transforms

Transforms applied to the content.

Constructor Detail

URIContentReference

public URIContentReference(@Nullable
                           java.lang.String refID)

Constructor. The anchor designator (#) must not be included in the ID.

Parameters:

refID - the reference ID of the element to be signed

Method Detail

getTransforms

@Nonnull
public java.util.List<java.lang.String> getTransforms()

Gets the transforms applied to the content prior to digest generation.

Returns:

the transforms applied to the content prior to digest generation

getDigestAlgorithm

@Nullable
public java.lang.String getDigestAlgorithm()

Gets the algorithm used to digest the content..

Specified by:

getDigestAlgorithm in interface ConfigurableContentReference

Returns:

the algorithm used to digest the content

setDigestAlgorithm

public void setDigestAlgorithm(@Nonnull
                               java.lang.String newAlgorithm)

Sets the algorithm used to digest the content..

Specified by:

setDigestAlgorithm in interface ConfigurableContentReference

Parameters:

newAlgorithm - the algorithm used to digest the content

createReference

public void createReference(@Nonnull
                            org.apache.xml.security.signature.XMLSignature signature)

Called by the signature marshaller to allow references to be added to the signature.

Specified by:

createReference in interface ContentReference

Parameters:

signature - the signature object