-
- All Superinterfaces:
- XMLStructure
public interface XMLSignature extends XMLStructure
A representation of the XMLSignature
element as defined in the W3C Recommendation for XML-Signature Syntax and Processing. This class contains methods for signing and validating XML signatures with behavior as defined by the W3C specification. The XML Schema Definition is defined as:<element name="Signature" type="ds:SignatureType"/> <complexType name="SignatureType"> <sequence> <element ref="ds:SignedInfo"/> <element ref="ds:SignatureValue"/> <element ref="ds:KeyInfo" minOccurs="0"/> <element ref="ds:Object" minOccurs="0" maxOccurs="unbounded"/> </sequence> <attribute name="Id" type="ID" use="optional"/> </complexType>
An
XMLSignature
instance may be created by invoking one of thenewXMLSignature
methods of theXMLSignatureFactory
class.If the contents of the underlying document containing the
XMLSignature
are subsequently modified, the behavior is undefined.Note that this class is named
XMLSignature
rather thanSignature
to avoid naming clashes with the existingjava.security.Signature
class.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface and Description static interface
XMLSignature.SignatureValue
A representation of the XMLSignatureValue
element as defined in the W3C Recommendation for XML-Signature Syntax and Processing.
-
Field Summary
Fields Modifier and Type Field and Description static String
XMLNS
The XML Namespace URI of the W3C Recommendation for XML-Signature Syntax and Processing.
-
Method Summary
Methods Modifier and Type Method and Description String
getId()
Returns the optional Id of thisXMLSignature
.KeyInfo
getKeyInfo()
Returns the key info of thisXMLSignature
.KeySelectorResult
getKeySelectorResult()
Returns the result of theKeySelector
, if specified, after thisXMLSignature
has been signed or validated.List
getObjects()
XMLSignature.SignatureValue
getSignatureValue()
Returns the signature value of thisXMLSignature
.SignedInfo
getSignedInfo()
Returns the signed info of thisXMLSignature
.void
sign(XMLSignContext signContext)
Signs thisXMLSignature
.boolean
validate(XMLValidateContext validateContext)
Validates the signature according to the core validation processing rules.-
Methods inherited from interface javax.xml.crypto.XMLStructure
isFeatureSupported
-
-
-
-
Field Detail
-
XMLNS
static final String XMLNS
The XML Namespace URI of the W3C Recommendation for XML-Signature Syntax and Processing.- See Also:
- Constant Field Values
-
-
Method Detail
-
validate
boolean validate(XMLValidateContext validateContext) throws XMLSignatureException
Validates the signature according to the core validation processing rules. This method validates the signature using the existing state, it does not unmarshal and reinitialize the contents of theXMLSignature
using the location information specified in the context.This method only validates the signature the first time it is invoked. On subsequent invocations, it returns a cached result.
- Parameters:
validateContext
- the validating context- Returns:
true
if the signature passed core validation, otherwisefalse
- Throws:
ClassCastException
- if the type ofvalidateContext
is not compatible with thisXMLSignature
NullPointerException
- ifvalidateContext
isnull
XMLSignatureException
- if an unexpected error occurs during validation that prevented the validation operation from completing
-
getKeyInfo
KeyInfo getKeyInfo()
Returns the key info of thisXMLSignature
.- Returns:
- the key info (may be
null
if not specified)
-
getSignedInfo
SignedInfo getSignedInfo()
Returns the signed info of thisXMLSignature
.- Returns:
- the signed info (never
null
)
-
getObjects
List getObjects()
- Returns:
- an unmodifiable list of
XMLObject
s (may be empty but nevernull
)
-
getId
String getId()
Returns the optional Id of thisXMLSignature
.- Returns:
- the Id (may be
null
if not specified)
-
getSignatureValue
XMLSignature.SignatureValue getSignatureValue()
Returns the signature value of thisXMLSignature
.- Returns:
- the signature value
-
sign
void sign(XMLSignContext signContext) throws MarshalException, XMLSignatureException
Signs thisXMLSignature
.If this method throws an exception, this
XMLSignature
and thesignContext
parameter will be left in the state that it was in prior to the invocation.- Parameters:
signContext
- the signing context- Throws:
ClassCastException
- if the type ofsignContext
is not compatible with thisXMLSignature
NullPointerException
- ifsignContext
isnull
MarshalException
- if an exception occurs while marshallingXMLSignatureException
- if an unexpected exception occurs while generating the signature
-
getKeySelectorResult
KeySelectorResult getKeySelectorResult()
Returns the result of theKeySelector
, if specified, after thisXMLSignature
has been signed or validated.- Returns:
- the key selector result, or
null
if a key selector has not been specified or thisXMLSignature
has not been signed or validated
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/xml/crypto/dsig/XMLSignature.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.