Package org.opensaml.xmlsec.signature.impl

Class SignatureImpl

java.lang.Object

org.opensaml.core.xml.AbstractXMLObject

org.opensaml.xmlsec.signature.impl.SignatureImpl

All Implemented Interfaces:

XMLObject, Signature

public class SignatureImpl
extends AbstractXMLObject
implements Signature

XMLObject representing an enveloped or detached XML Digital Signature, version 20020212, Signature element.

Field Summary

Fields

Modifier and Type	Field	Description
private String	canonicalizationAlgorithm	Canonicalization algorithm used in signature.
private List<ContentReference>	contentReferences	References to content to be signed.
private Integer	hmacOutputLength	Optional HMAC output length parameter to the signature algorithm.
private KeyInfo	keyInfo	Public key information to embed in the signature.
private String	signatureAlgorithm	Algorithm used to generate the signature.
private Credential	signingCredential	Key used to sign the signature.
private org.apache.xml.security.signature.XMLSignature	xmlSignature	Constructed Apache XML Security signature object.

Fields inherited from interface org.opensaml.xmlsec.signature.Signature

DEFAULT_ELEMENT_LOCAL_NAME, DEFAULT_ELEMENT_NAME, TYPE_LOCAL_NAME, TYPE_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SignatureImpl(String namespaceURI, String elementLocalName, String namespacePrefix)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getCanonicalizationAlgorithm()
List<ContentReference>	getContentReferences()
Integer	getHMACOutputLength()
KeyInfo	getKeyInfo()
List<XMLObject>	getOrderedChildren()
String	getSignatureAlgorithm()
Credential	getSigningCredential()
org.apache.xml.security.signature.XMLSignature	getXMLSignature()	Get the Apache XML Security signature instance held by this object.
void	releaseDOM()
void	setCanonicalizationAlgorithm(String newAlgorithm)
void	setHMACOutputLength(Integer length)
void	setKeyInfo(KeyInfo newKeyInfo)
void	setSignatureAlgorithm(String newAlgorithm)
void	setSigningCredential(Credential newCredential)
void	setXMLSignature(org.apache.xml.security.signature.XMLSignature signature)	Set the Apache XML Security signature instance held by this object.

Methods inherited from class org.opensaml.core.xml.AbstractXMLObject

detach, ensureDOM, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, manageQualifiedAttributeNamespace, prepareAttributeValueForAssignment, prepareElementContentForAssignment, prepareForAssignment, prepareForAssignment, prepareForAssignment, registerOwnID, releaseChildrenDOM, releaseParentDOM, releaseThisAndChildrenDOM, releaseThisandParentDOM, resolveID, resolveIDFromRoot, setDOM, setElementNamespacePrefix, setElementQName, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation, setSchemaType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensaml.core.xml.XMLObject

detach, ensureDOM, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

Field Details

canonicalizationAlgorithm

@Nullable
private String canonicalizationAlgorithm

Canonicalization algorithm used in signature.

signatureAlgorithm

@Nullable
private String signatureAlgorithm

Algorithm used to generate the signature.

hmacOutputLength

@Nullable
private Integer hmacOutputLength

Optional HMAC output length parameter to the signature algorithm.

signingCredential

@Nullable
private Credential signingCredential

Key used to sign the signature.

keyInfo

@Nullable
private KeyInfo keyInfo

Public key information to embed in the signature.

contentReferences

@Nonnull
private List<ContentReference> contentReferences

References to content to be signed.

xmlSignature

@Nullable
private org.apache.xml.security.signature.XMLSignature xmlSignature

Constructed Apache XML Security signature object.

Constructor Details

SignatureImpl

protected SignatureImpl(@Nullable
 String namespaceURI,
 @Nonnull
 String elementLocalName,
 @Nullable
 String namespacePrefix)

Constructor.

Parameters:

namespaceURI - the namespace the element is in

elementLocalName - the local name of the XML element this Object represents

namespacePrefix - the prefix for the given namespace

Method Details

getCanonicalizationAlgorithm

@Nullable
public String getCanonicalizationAlgorithm()

Specified by:

getCanonicalizationAlgorithm in interface Signature

setCanonicalizationAlgorithm

public void setCanonicalizationAlgorithm(@Nullable
 String newAlgorithm)

Specified by:

setCanonicalizationAlgorithm in interface Signature

getSignatureAlgorithm

@Nullable
public String getSignatureAlgorithm()

Specified by:

getSignatureAlgorithm in interface Signature

setSignatureAlgorithm

public void setSignatureAlgorithm(@Nullable
 String newAlgorithm)

Specified by:

setSignatureAlgorithm in interface Signature

getHMACOutputLength

@Nullable
public Integer getHMACOutputLength()

Specified by:

getHMACOutputLength in interface Signature

setHMACOutputLength

public void setHMACOutputLength(@Nullable
 Integer length)

Specified by:

setHMACOutputLength in interface Signature

getSigningCredential

@Nullable
public Credential getSigningCredential()

Specified by:

getSigningCredential in interface Signature

setSigningCredential

public void setSigningCredential(@Nullable
 Credential newCredential)

Specified by:

setSigningCredential in interface Signature

getKeyInfo

@Nullable
public KeyInfo getKeyInfo()

Specified by:

getKeyInfo in interface Signature

setKeyInfo

public void setKeyInfo(@Nullable
 KeyInfo newKeyInfo)

Specified by:

setKeyInfo in interface Signature

getContentReferences

@Nonnull
@Live
public List<ContentReference> getContentReferences()

Specified by:

getContentReferences in interface Signature

getOrderedChildren

@Nullable
@Unmodifiable
@NotLive
public List<XMLObject> getOrderedChildren()

Specified by:

getOrderedChildren in interface XMLObject

releaseDOM

public void releaseDOM()

Specified by:

releaseDOM in interface XMLObject

Overrides:

releaseDOM in class AbstractXMLObject

getXMLSignature

@Nullable
public org.apache.xml.security.signature.XMLSignature getXMLSignature()

Get the Apache XML Security signature instance held by this object.

Returns:

an Apache XML Security signature object

setXMLSignature

public void setXMLSignature(@Nullable
 org.apache.xml.security.signature.XMLSignature signature)

Set the Apache XML Security signature instance held by this object.

Parameters:

signature - an Apache XML Security signature object