-
- All Superinterfaces:
- URIReference, XMLStructure
public interface Reference extends URIReference, XMLStructure
A representation of theReference
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 thenewReference
methods of theXMLSignatureFactory
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
Methods Modifier and Type Method and Description byte[]
getCalculatedDigestValue()
Returns the calculated digest value of thisReference
after a validation operation.Data
getDereferencedData()
Returns the dereferenced data, if reference caching is enabled.InputStream
getDigestInputStream()
Returns the pre-digested input stream, if reference caching is enabled.DigestMethod
getDigestMethod()
Returns the digest method of thisReference
.byte[]
getDigestValue()
Returns the digest value of thisReference
.String
getId()
Returns the optionalId
attribute of thisReference
, which permits this reference to be referenced from elsewhere.List
getTransforms()
boolean
validate(XMLValidateContext validateContext)
Validates this reference.-
Methods inherited from interface javax.xml.crypto.XMLStructure
isFeatureSupported
-
-
-
-
Method Detail
-
getTransforms
List getTransforms()
- Returns:
- an unmodifiable list of
Transform
s (may be empty but nevernull
)
-
getDigestMethod
DigestMethod getDigestMethod()
Returns the digest method of thisReference
.- Returns:
- the digest method
-
getId
String getId()
Returns the optionalId
attribute of thisReference
, which permits this reference to be referenced from elsewhere.- Returns:
- the
Id
attribute (may benull
if not specified)
-
getDigestValue
byte[] getDigestValue()
Returns the digest value of thisReference
.- Returns:
- the raw digest value, or
null
if this reference has not been digested yet. Each invocation of this method returns a new clone to protect against subsequent modification.
-
getCalculatedDigestValue
byte[] getCalculatedDigestValue()
Returns the calculated digest value of thisReference
after a validation operation. This method is useful for debugging if the reference fails to validate.- Returns:
- the calculated digest value, or
null
if this reference has not been validated yet. Each invocation of this method returns a new clone to protect against subsequent modification.
-
validate
boolean validate(XMLValidateContext validateContext) throws XMLSignatureException
Validates this reference. This method verifies the digest of this reference.This method only validates the reference the first time it is invoked. On subsequent invocations, it returns a cached result.
- Parameters:
validateContext
- the validating context- Returns:
true
if this reference was validated successfully;false
otherwise- Throws:
NullPointerException
- ifvalidateContext
isnull
XMLSignatureException
- if an unexpected exception occurs while validating the reference
-
getDereferencedData
Data getDereferencedData()
Returns the dereferenced data, if reference caching is enabled. This is the result of dereferencing the URI of this reference during a validation or generation operation.- Returns:
- the dereferenced data, or
null
if reference caching is not enabled or this reference has not been generated or validated
-
getDigestInputStream
InputStream getDigestInputStream()
Returns the pre-digested input stream, if reference caching is enabled. This is the input to the digest operation during a validation or signing operation.- Returns:
- an input stream containing the pre-digested input, or
null
if reference caching is not enabled or this reference has not been generated or validated
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
05/11/2024 05:36:03 Cette version de la page est en cache (à la date du 05/11/2024 05:36:03) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 11/06/2005, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/xml/crypto/dsig/Reference.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.