Class DOMReference

java.lang.Object

org.apache.jcp.xml.dsig.internal.dom.DOMStructure

org.apache.jcp.xml.dsig.internal.dom.DOMReference

All Implemented Interfaces:

DOMURIReference, Reference, URIReference, XMLStructure

public final class DOMReference
extends DOMStructure
implements Reference, DOMURIReference

DOM-based implementation of Reference.

Field Summary

Fields

Modifier and Type	Field	Description
private List<Transform>	allTransforms
private final Data	appliedTransformData
private byte[]	calcDigestValue
private Data	derefData
private boolean	digested
private final DigestMethod	digestMethod
private byte[]	digestValue
private InputStream	dis
private Attr	here
private final String	id
private static final org.slf4j.Logger	LOG
static final int	MAXIMUM_TRANSFORM_COUNT	The maximum number of transforms per reference, if secure validation is enabled.
private MessageDigest	md
private Provider	provider
private Element	refElem
private final List<Transform>	transforms
private final String	type
private final String	uri
private static boolean	useC14N11	Look up useC14N11 system property.
private boolean	validated
private boolean	validationStatus

Constructor Summary

Constructors

Constructor	Description
DOMReference(String uri, String type, DigestMethod dm, List<? extends Transform> transforms, String id, Provider provider)	Creates a Reference from the specified parameters.
DOMReference(String uri, String type, DigestMethod dm, List<? extends Transform> appliedTransforms, Data result, List<? extends Transform> transforms, String id, byte[] digestValue, Provider provider)
DOMReference(String uri, String type, DigestMethod dm, List<? extends Transform> appliedTransforms, Data result, List<? extends Transform> transforms, String id, Provider provider)
DOMReference(Element refElem, XMLCryptoContext context, Provider provider)	Creates a DOMReference from an element.

Method Summary

Modifier and Type	Method	Description
private static Data	copyDerefData(Data dereferencedData)
private Data	dereference(XMLCryptoContext context)
void	digest(XMLSignContext signContext)
boolean	equals(Object o)
byte[]	getCalculatedDigestValue()
Data	getDereferencedData()
InputStream	getDigestInputStream()
DigestMethod	getDigestMethod()
byte[]	getDigestValue()
Node	getHere()
String	getId()
List<Transform>	getTransforms()
String	getType()
String	getURI()
int	hashCode()
(package private) boolean	isDigested()
void	marshal(Node parent, String dsPrefix, DOMCryptoContext context)
private byte[]	transform(Data dereferencedData, XMLCryptoContext context)
boolean	validate(XMLValidateContext validateContext)

Methods inherited from class DOMStructure

isFeatureSupported

Methods inherited from class Object

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

Methods inherited from interface XMLStructure

isFeatureSupported

Field Details

MAXIMUM_TRANSFORM_COUNT

public static final int MAXIMUM_TRANSFORM_COUNT

The maximum number of transforms per reference, if secure validation is enabled.

See Also:

• Constant Field Values

useC14N11

private static boolean useC14N11

Look up useC14N11 system property. If true, an explicit C14N11 transform will be added if necessary when generating the signature. See section 3.1.1 of http://www.w3.org/2007/xmlsec/Drafts/xmldsig-core/ for more info. If true, overrides the same property if set in the XMLSignContext.

LOG

private static final org.slf4j.Logger LOG

digestMethod

private final DigestMethod digestMethod

id

private final String id

transforms

private final List<Transform> transforms

allTransforms

private List<Transform> allTransforms

appliedTransformData

private final Data appliedTransformData

here

private Attr here

uri

private final String uri

type

private final String type

digestValue

private byte[] digestValue

calcDigestValue

private byte[] calcDigestValue

refElem

private Element refElem

digested

private boolean digested

validated

private boolean validated

validationStatus

private boolean validationStatus

derefData

private Data derefData

dis

private InputStream dis

md

private MessageDigest md

provider

private Provider provider

Constructor Details

DOMReference

public DOMReference(String uri,
 String type,
 DigestMethod dm,
 List<? extends Transform> transforms,
 String id,
 Provider provider)

Creates a Reference from the specified parameters.

Parameters:

uri - the URI (may be null)

type - the type (may be null)

dm - the digest method

transforms - a list of Transforms. The list is defensively copied to protect against subsequent modification. May be null or empty.

id - the reference ID (may be null)

Throws:

NullPointerException - if dm is null

ClassCastException - if any of the transforms are not of type Transform

DOMReference

public DOMReference(String uri,
 String type,
 DigestMethod dm,
 List<? extends Transform> appliedTransforms,
 Data result,
 List<? extends Transform> transforms,
 String id,
 Provider provider)

DOMReference

public DOMReference(String uri,
 String type,
 DigestMethod dm,
 List<? extends Transform> appliedTransforms,
 Data result,
 List<? extends Transform> transforms,
 String id,
 byte[] digestValue,
 Provider provider)

DOMReference

public DOMReference(Element refElem,
 XMLCryptoContext context,
 Provider provider)
             throws MarshalException

Creates a DOMReference from an element.

Parameters:

refElem - a Reference element

Throws:

MarshalException

Method Details

getDigestMethod

public DigestMethod getDigestMethod()

Specified by:

getDigestMethod in interface Reference

getId

public String getId()

Specified by:

getId in interface Reference

getURI

public String getURI()

Specified by:

getURI in interface URIReference

getType

public String getType()

Specified by:

getType in interface URIReference

getTransforms

public List<Transform> getTransforms()

Specified by:

getTransforms in interface Reference

getDigestValue

public byte[] getDigestValue()

Specified by:

getDigestValue in interface Reference

getCalculatedDigestValue

public byte[] getCalculatedDigestValue()

Specified by:

getCalculatedDigestValue in interface Reference

marshal

public void marshal(Node parent,
 String dsPrefix,
 DOMCryptoContext context)
             throws MarshalException

Specified by:

marshal in class DOMStructure

Throws:

MarshalException

digest

public void digest(XMLSignContext signContext)
            throws XMLSignatureException

Throws:

XMLSignatureException

validate

public boolean validate(XMLValidateContext validateContext)
                 throws XMLSignatureException

Specified by:

validate in interface Reference

Throws:

XMLSignatureException

getDereferencedData

public Data getDereferencedData()

Specified by:

getDereferencedData in interface Reference

getDigestInputStream

public InputStream getDigestInputStream()

Specified by:

getDigestInputStream in interface Reference

dereference

private Data dereference(XMLCryptoContext context)
                  throws XMLSignatureException

Throws:

XMLSignatureException

transform

private byte[] transform(Data dereferencedData,
 XMLCryptoContext context)
                  throws XMLSignatureException

Throws:

XMLSignatureException

getHere

public Node getHere()

Specified by:

getHere in interface DOMURIReference

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isDigested

boolean isDigested()

copyDerefData

private static Data copyDerefData(Data dereferencedData)