iaik.xml.crypto.dsig

Class ReferenceType

java.lang.Object

javax.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dsig.DOMURIReferenceImpl

iaik.xml.crypto.dsig.ReferenceType

All Implemented Interfaces:

DOMURIReference, URIReference, XMLStructure

Direct Known Subclasses:

CipherReferenceImpl, ReferenceImpl, RetrievalMethodImpl

public abstract class ReferenceType
extends DOMURIReferenceImpl

A base class for elements that contain a URI reference and a number of Transforms and are processed according to the reference processing model of XMLDSig.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ReferenceType.SubTreeNodeSetFix

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

DOMStructure.NodeWrapper

Field Summary

Fields

Modifier and Type	Field and Description
protected CachedData	cachedCanonInputData_ The (NodeSet) data before the last canonicalization transform (implicit or explicit).
protected CachedData	cachedDereferencedData_ The cached dereferenced data.
protected CachedInputStream	cachedDigestInput_ The cached digest input.
protected String	id_ The Id-attribute value.
protected Data	result_ The result of processing any transforms that have already been applied to the referenced data.
protected TransformsType	transforms_ The Transforms.

Fields inherited from class iaik.xml.crypto.dsig.DOMURIReferenceImpl

type_, uri_

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

implMap_, state_, STATE_CREATED, STATE_MARSHALED, STATE_UNINITIALIZED, STATE_UNMARSHALED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReferenceType(Node node) Creates a new instance of this ReferenceType with the specified node.
protected	ReferenceType(String uri, List appliedTransforms, Data result, List transforms, String type, String id) Creates a new instance of this ReferenceType with the specified URI reference, a list of TransformImpls that have already been applied, the result of the processing of the sequence of appliedTransforms, Type-attribute value and Id-attribute value.
protected	ReferenceType(String uri, List transforms, String type, String id) Creates a new instance of this ReferenceType with the specified URI reference, a list of Transform s, Type-attribute value and Id-attribute value.
protected	ReferenceType(String uri, String type) Creates a new instance of this ReferenceType with the specified URI and Type-attribute value.
protected	ReferenceType(String uri, TransformsType transforms, String type, String id) Creates a new instance of this ReferenceType with the specified URI reference, transforms of TransformsType containing a list of Transforms, Type -attribute value and Id-attribute value.

Method Summary

Modifier and Type	Method and Description
Data	dereference(XMLCryptoContext context) Dereferences this ReferenceType according to reference processing rules of XMLDSig.
InputStream	dereferenceAndCanonicalize(XMLCryptoContext context) Dereferences this ReferenceType according to the reference processing rules of XMLDSig and applies a final canonicalization if a node-set is returned by the last applied transform.
Data	dereferenceButDontTransform(XMLCryptoContext context) Dereferences this ReferenceType according to reference processing rules of XMLDSig, with the exception that Transforms are not applied.
Data	getCanonInputData() Returns the cached input data into the final canonicalization if caching this data is enabled.
protected List	getChildStructures() Returns a list containing the TransformsImpl child structure.
Data	getDereferencedData() Returns the dereferenced data if reference caching is enabled.
String	getId() Returns the optional Id-attribute of this reference.
String	getLocalName() Returns the local name of the represented XML element.
List	getTransforms() Returns an unmodifiable list of Transforms that are contained in this reference.
protected Attr	marshalIDAttribute(DOMCryptoContext context, Element parent) Marshals the XML representation of an optional Id-attribute represented by this DOMStructure.
protected void	putChildStructure(DOMStructure childStructure) Puts the TransformsImpl child structure.
protected void	unmarshalAttributes(NamedNodeMap attributes, DOMCryptoContext context) Unmarshals the URI and Type attributes.

Methods inherited from class iaik.xml.crypto.dsig.DOMURIReferenceImpl

getHere, getType, getURI, marshalAttributes

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

addBytesToElement, addBytesToElement, clearMarshalling, clearMarshalling, getBytesFromElement, getBytesFromElementStream, getChildStructureVersion, getImplClass, getInstance, getInstance, getNamespace, getNode, getParentStructure, getParentStructureOf, getQualifiedName, getQualifiedName, hasNSDeclAttrInScope, isFeatureSupported, isNSDeclInScope, marshal, marshalElement, newIDforLookUp, putImplClass, setBackToCompatibilityPrior1_14, setNode, setParentStructure, toString, unmarshal, unmarshalElement, unmarshalIDAttribute, unmarshalStructures, wrapNode

Methods inherited from class java.lang.Object

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

Field Detail

transforms_

protected TransformsType transforms_

The Transforms.

result_

protected Data result_

The result of processing any transforms that have already been applied to the referenced data.

id_

protected String id_

The Id-attribute value.

cachedDigestInput_

protected CachedInputStream cachedDigestInput_

The cached digest input.

cachedDereferencedData_

protected CachedData cachedDereferencedData_

The cached dereferenced data.

cachedCanonInputData_

protected CachedData cachedCanonInputData_

The (NodeSet) data before the last canonicalization transform (implicit or explicit).

Constructor Detail

ReferenceType

protected ReferenceType(Node node)

Creates a new instance of this ReferenceType with the specified node.

Parameters:

node - the node

ReferenceType

protected ReferenceType(String uri,
                        String type)

Creates a new instance of this ReferenceType with the specified URI and Type-attribute value.

Parameters:

uri - the URI

type - the Type-attribute value

ReferenceType

protected ReferenceType(String uri,
                        TransformsType transforms,
                        String type,
                        String id)

Creates a new instance of this ReferenceType with the specified URI reference, transforms of TransformsType containing a list of Transforms, Type -attribute value and Id-attribute value.

Parameters:

uri - the URI reference

transforms - of TransformsType containing a list of Transforms (may be null or empty). The transforms object is not defensively copied.

type - the value of the Type-attribute

id - the value of the Id-attribute

Throws:

IllegalArgumentException - if uri is not RFC 2396 compliant

ReferenceType

protected ReferenceType(String uri,
                        List transforms,
                        String type,
                        String id)

Creates a new instance of this ReferenceType with the specified URI reference, a list of Transform s, Type-attribute value and Id-attribute value.

Parameters:

uri - the URI reference

transforms - a list of Transforms (may be null or empty)

type - the value of the Type-attribute

id - the value of the Id-attribute

Throws:

IllegalArgumentException - if uri is not RFC 2396 compliant

ReferenceType

protected ReferenceType(String uri,
                        List appliedTransforms,
                        Data result,
                        List transforms,
                        String type,
                        String id)

Creates a new instance of this ReferenceType with the specified URI reference, a list of TransformImpls that have already been applied, the result of the processing of the sequence of appliedTransforms, Type-attribute value and Id-attribute value.

Parameters:

uri - the URI reference

appliedTransforms - a list of TransformImpls that have already been applied

result - the result of processing the sequence of appliedTransforms

transforms - a list of Transforms (may be null or empty)

type - the value of the Type-attribute

id - the value of the Id-attribute

Throws:

ClassCastException - if appliedTransforms or transforms contains any elements not of type TransformImpl

NullPointerException - if appliedTransforms is null

IllegalArgumentException - if appliedTransforms is empty

IllegalArgumentException - if uri is not RFC 2396 compliant

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()

getTransforms

public List getTransforms()

Returns an unmodifiable list of Transforms that are contained in this reference.

Returns:

an unmodifiable list of Transforms (may be empty but never null)

See Also:

Reference.getTransforms()

getId

public String getId()

Returns the optional Id-attribute of this reference.

Returns:

the Id attribute (may be null if not specified)

See Also:

Reference.getId()

getDereferencedData

public Data getDereferencedData()

Returns the dereferenced data if reference caching is enabled. This is the result of dereferencing the this reference. In the case the reference was created using ReferenceType(String, List, Data, List, String, String) and appliedtransforms != null && ! appliedtransforms.isEmpty() it returns the result (the data fed into the Reference)

Returns:

the dereferenced data, or null if reference caching is not enabled or this reference has not yet been dereferenced.

See Also:

Reference.getDereferencedData()

getCanonInputData

public Data getCanonInputData()

Returns the cached input data into the final canonicalization if caching this data is enabled. This is the result of dereferencing the reference and appliying all transforms except of the final canonicalization.
Note, that the property DOMCryptoContext.CACHE_CANON_INPUT_DATA must be set to cache the canonicalization input data and that the data is only cached if it is an instance of NodeSetData.

Returns:

the input data into the (final) canonicalization, or null if caching canonicalization input data is not enabled or the data is not an instance of DOMNodeSetData.

dereferenceButDontTransform

public Data dereferenceButDontTransform(XMLCryptoContext context)
                                 throws URIReferenceException,
                                        TransformException

Dereferences this ReferenceType according to reference processing rules of XMLDSig, with the exception that Transforms are not applied.

Parameters:

context - the context

Returns:

the Data after dereferencing this ReferenceType

Throws:

URIReferenceException - if an exception occurs during dereferencing

TransformException - if an exception occurs during transformation

dereference

public Data dereference(XMLCryptoContext context)
                 throws URIReferenceException,
                        TransformException

Dereferences this ReferenceType according to reference processing rules of XMLDSig.

Parameters:

context - the context

Returns:

the Data after dereferencing this ReferenceType

Throws:

URIReferenceException - if an exception occurs during dereferencing

TransformException - if an exception occurs during transformation

dereferenceAndCanonicalize

public InputStream dereferenceAndCanonicalize(XMLCryptoContext context)
                                       throws NoSuchAlgorithmException,
                                              URIReferenceException,
                                              TransformException

Dereferences this ReferenceType according to the reference processing rules of XMLDSig and applies a final canonicalization if a node-set is returned by the last applied transform.

Parameters:

context - the context

Returns:

an input stream providing the dereferenced (and optionally canonicalized) data

Throws:

NoSuchAlgorithmException - if no implementation of the canonicalization algorithm can be found

URIReferenceException - if an exception occurs during dereferencing

TransformException - if an exception occurs during transformation

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(DOMCryptoContext, Element)

unmarshalAttributes

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

Description copied from class: DOMURIReferenceImpl

Unmarshals the URI and Type attributes.

Overrides:

unmarshalAttributes in class DOMURIReferenceImpl

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, DOMCryptoContext)

getChildStructures

protected List getChildStructures()

Returns a list containing the TransformsImpl child structure.

Overrides:

getChildStructures in class DOMStructure

Returns:

a list of DOMStructures (may be empty, but never null)

putChildStructure

protected void putChildStructure(DOMStructure childStructure)
                          throws MarshalException

Puts the TransformsImpl child structure.

Overrides:

putChildStructure in class DOMStructure

Parameters:

childStructure - the unmarshalled child structure

Throws:

MarshalException