iaik.xml.crypto.dsig

Class XMLSignatureImpl.SignatureValueImpl

java.lang.Object

javax.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.XmldsigDOMStructure

iaik.xml.crypto.dsig.XMLSignatureImpl.SignatureValueImpl

All Implemented Interfaces:

XMLSignature.SignatureValue, XMLStructure

Enclosing class:

XMLSignatureImpl

protected class XMLSignatureImpl.SignatureValueImpl
extends XmldsigDOMStructure
implements XMLSignature.SignatureValue

An implementation of the SignatureValue element that supports the DOM XML representation and marshaling mechanism.

Nested Class Summary

Nested classes/interfaces inherited from class iaik.xml.crypto.dom.DOMStructure

DOMStructure.NodeWrapper

Field Summary

Fields

Modifier and Type	Field and Description
protected String	id_ The id-attribute value.
protected boolean	valid_ Is the signature value valid?
protected boolean	validated_ Has the signature value been validated?
protected byte[]	value_ The signature value.

Fields inherited from class iaik.xml.crypto.dom.DOMStructure

implMap_, state_, STATE_CREATED, STATE_MARSHALED, STATE_UNINITIALIZED, STATE_UNMARSHALED

Constructor Summary

Constructors

Constructor and Description
SignatureValueImpl(byte[] value, String id) Creates a new instance of this SignatureValueImpl with the specified provider config, signature value and id-attribute value.
SignatureValueImpl(DOMCryptoContext context, Node node) Creates a new instance of this SignatureValueImpl with the specified provider config, context and node to unmarshal from.
SignatureValueImpl(String id) Creates a new instance of this SignatureValueImpl with the specified provider config and id-attribute value.

Method Summary

Modifier and Type	Method and Description
void	appendValue(DOMCryptoContext context, byte[] value)
String	getId() Returns the optional Id attribute of this SignatureValue, which permits this element to be referenced from elsewhere.
String	getLocalName() Returns the local name of the represented XML element.
byte[]	getValue() Returns the signature value of this SignatureValue.
protected Element	marshalElement(DOMCryptoContext context, Node parent, Node nextSibling) Marshals the XML representation of the Element represented by this DOMStructure and returns it.
protected Attr	marshalIDAttribute(DOMCryptoContext context, Element parent) Marshals the XML representation of an optional Id-attribute represented by this DOMStructure.
protected void	unmarshalAttributes(NamedNodeMap attributes, DOMCryptoContext context) Unmarshal the given attributes.
protected void	unmarshalElement(DOMCryptoContext context, Element element) Unmarshals the given element.
boolean	validate(XMLValidateContext validateContext) Validates the signature value.

Methods inherited from class iaik.xml.crypto.dom.XmldsigDOMStructure

getNamespace, init

Methods inherited from class iaik.xml.crypto.dom.DOMStructure

addBytesToElement, addBytesToElement, clearMarshalling, clearMarshalling, getBytesFromElement, getBytesFromElementStream, getChildStructures, getChildStructureVersion, getHere, getImplClass, getInstance, getInstance, getNode, getParentStructure, getParentStructureOf, getQualifiedName, getQualifiedName, hasNSDeclAttrInScope, isFeatureSupported, isNSDeclInScope, marshal, marshalAttributes, newIDforLookUp, putChildStructure, putImplClass, setBackToCompatibilityPrior1_14, setNode, setParentStructure, toString, unmarshal, unmarshalIDAttribute, unmarshalStructures, wrapNode

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.xml.crypto.XMLStructure

isFeatureSupported

Field Detail

id_

protected String id_

The id-attribute value.

value_

protected byte[] value_

The signature value.

validated_

protected boolean validated_

Has the signature value been validated?

valid_

protected boolean valid_

Is the signature value valid?

Constructor Detail

SignatureValueImpl

public SignatureValueImpl(DOMCryptoContext context,
                          Node node)
                   throws MarshalException

Creates a new instance of this SignatureValueImpl with the specified provider config, context and node to unmarshal from.

Parameters:

context - the context

node - the node to unmarshal from

Throws:

MarshalException - if an exception occurs during unmarshaling

SignatureValueImpl

public SignatureValueImpl(String id)

Creates a new instance of this SignatureValueImpl with the specified provider config and id-attribute value.

Parameters:

id - the id-attribute value (may be null)

Throws:

NullPointerException - if config is null

SignatureValueImpl

public SignatureValueImpl(byte[] value,
                          String id)

Creates a new instance of this SignatureValueImpl with the specified provider config, signature value and id-attribute value.

Parameters:

value - the raw signature value

id - the id-attribute value

Method Detail

getLocalName

public String getLocalName()

Description copied from class: DOMStructure

Returns the local name of the represented XML element.

Specified by:

getLocalName in class DOMStructure

Returns:

the local name of the represented XML element

See Also:

DOMStructure.getLocalName()

getId

public String getId()

Description copied from interface: javax.xml.crypto.dsig.XMLSignature.SignatureValue

Returns the optional Id attribute of this SignatureValue, which permits this element to be referenced from elsewhere.

Specified by:

getId in interface XMLSignature.SignatureValue

Returns:

the Id attribute (may be null if not specified)

See Also:

XMLSignature.SignatureValue.getId()

getValue

public byte[] getValue()

Description copied from interface: javax.xml.crypto.dsig.XMLSignature.SignatureValue

Returns the signature value of this SignatureValue.

Specified by:

getValue in interface XMLSignature.SignatureValue

Returns:

the signature value (may be null if the XMLSignature has not been signed yet). Each invocation of this method returns a new clone of the array to prevent subsequent modification.

See Also:

XMLSignature.SignatureValue.getValue()

validate

public boolean validate(XMLValidateContext validateContext)
                 throws XMLSignatureException

Description copied from interface: javax.xml.crypto.dsig.XMLSignature.SignatureValue

Validates the signature value. This method performs a cryptographic validation of the signature calculated over the SignedInfo of the XMLSignature.

This method only validates the signature the first time it is invoked. On subsequent invocations, it returns a cached result.

Specified by:

validate in interface XMLSignature.SignatureValue

Parameters:

validateContext - the validating context

Returns:

true if the signature was validated successfully; false otherwise

Throws:

XMLSignatureException - if an unexpected exception occurs while validating the signature

See Also:

XMLSignature.SignatureValue.validate(javax.xml.crypto.dsig.XMLValidateContext)

marshalIDAttribute

protected Attr marshalIDAttribute(DOMCryptoContext context,
                                  Element parent)

Description copied from class: DOMStructure

Marshals the XML representation of an optional Id-attribute represented by this DOMStructure.

This method is called by DOMStructure.marshal(DOMCryptoContext, Node, Node).

A subclass has to overwrite this method in order to marshal an Id-attribute.

Overrides:

marshalIDAttribute in class DOMStructure

Parameters:

context - the marshal context

parent - the element is the parent of the attribute node created however, an the attribute node is not a child of it's parent element. see XPath.

Returns:

the marshaled Id-attribute if any, otherwise null

See Also:

DOMStructure.marshalIDAttribute(javax.xml.crypto.dom.DOMCryptoContext, Element)

marshalElement

protected Element marshalElement(DOMCryptoContext context,
                                 Node parent,
                                 Node nextSibling)
                          throws MarshalException

Description copied from class: DOMStructure

Marshals the XML representation of the Element represented by this DOMStructure and returns it.

This method is called by DOMStructure.marshal(DOMCryptoContext, Node, Node).

Overrides:

marshalElement in class DOMStructure

Parameters:

context - the marshal context

parent - where to place the marshalled element

nextSibling - before which to place the marshalled node

Returns:

the marshaled Element

Throws:

MarshalException - if an exception occurs during marshaling

See Also:

DOMStructure.marshalElement(DOMCryptoContext, Node, Node)

appendValue

public void appendValue(DOMCryptoContext context,
                        byte[] value)
                 throws MarshalException

Parameters:

context -

value -

Throws:

MarshalException

unmarshalAttributes

protected void unmarshalAttributes(NamedNodeMap attributes,
                                   DOMCryptoContext context)
                            throws MarshalException

Description copied from class: DOMStructure

Unmarshal the given attributes.

This method is called by DOMStructure.unmarshal(DOMCryptoContext).

A subclass has to overwrite this method to perform any special unmarshaling required.

Overrides:

unmarshalAttributes in class DOMStructure

Parameters:

attributes - the Attributes to unmarshal

context - the marshal context

Throws:

MarshalException - if an exception occurs during unmarshaling

See Also:

DOMStructure.unmarshalAttributes(org.w3c.dom.NamedNodeMap, javax.xml.crypto.dom.DOMCryptoContext)

unmarshalElement

protected void unmarshalElement(DOMCryptoContext context,
                                Element element)
                         throws MarshalException

Description copied from class: DOMStructure

Unmarshals the given element.

This method is called by DOMStructure.unmarshal(DOMCryptoContext).

A subclass has to overwrite this method to perform any special unmarshaling required.

Overrides:

unmarshalElement in class DOMStructure

Parameters:

context - the marshal context

element - the element to be unmarshal

Throws:

MarshalException - if an exception occurs during unmarshaling

See Also:

DOMStructure.unmarshalElement(javax.xml.crypto.dom.DOMCryptoContext, Element)