| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Reference extends XMLStructure
A representation of the Reference
element as defined in the
W3C Recommendation for XML-Signature Syntax and Processing.
The XML schema is defined as:
<element name="Reference" type="ds:ReferenceType"/>
<complexType name="ReferenceType">
<sequence>
<element ref="ds:Transforms" minOccurs="0"/>
<element ref="ds:DigestMethod"/>
<element ref="ds:DigestValue"/>
</sequence>
<attribute name="Id" type="ID" use="optional"/>
<attribute name="URI" type="anyURI" use="optional"/>
<attribute name="Type" type="anyURI" use="optional"/>
</complexType>
<element name="DigestValue" type="ds:DigestValueType"/>
<simpleType name="DigestValueType">
<restriction base="base64Binary"/>
</simpleType>
A Reference
instance may be created by invoking one of the
{@link XMLSignatureFactory#newReference newReference} methods of the
{@link XMLSignatureFactory} class; for example:
XMLSignatureFactory factory = XMLSignatureFactory.getInstance("DOM"); Reference ref = factory.newReference ("http://www.ietf.org/rfc/rfc3275.txt", factory.newDigestMethod(DigestMethod.SHA1, null));
Method Summary | |
---|---|
byte[] |
Returns the calculated digest value of this Reference
after a validation operation.
|
Data |
Returns the dereferenced data, if reference caching is enabled. |
InputStream |
Returns the pre-digested input stream, if reference caching is enabled. |
DigestMethod |
Returns the digest method of this Reference .
|
byte[] |
Returns the digest value of this Reference .
|
String |
getId() Returns the optional Id attribute of this
Reference , which permits this reference to be
referenced from elsewhere.
|
List |
Returns an java.util.Collections.unmodifiableList of javax.xml.crypto.dsig.Transforms that are contained in this Reference .
|
boolean |
validate(XMLValidateContext validateContext) Validates this reference. |
Methods inherited from class javax.xml.crypto.XMLStructure |
---|
isFeatureSupported |
Method Detail |
---|
public byte[] getCalculatedDigestValue()
Reference
after a validation operation. This method is useful for debugging if
the reference fails to validate.
null
if this
reference has not been validated yet. Each invocation of this method
returns a new clone to protect against subsequent modification.public Data getDereferencedData()
null
if reference
caching is not enabled or this reference has not been generated or
validatedpublic InputStream getDigestInputStream()
null
if reference caching is not enabled or this
reference has not been generated or validatedpublic DigestMethod getDigestMethod()
Reference
.
public byte[] getDigestValue()
Reference
.
null
if this reference has
not been digested yet. Each invocation of this method returns a new
clone to protect against subsequent modification.public String getId()
Id
attribute of this
Reference
, which permits this reference to be
referenced from elsewhere.
Id
attribute (may be null
if not
specified)public List getTransforms()
Reference
.
Transform
s
(may be empty but never null
)public boolean validate(XMLValidateContext validateContext) throws XMLSignatureException
This method only validates the reference the first time it is invoked. On subsequent invocations, it returns a cached result.
validateContext
- the validating contexttrue
if this reference was validated successfully;
false
otherwiseXMLSignatureException
- if an unexpected exception occurs while
validating the reference
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |