FileDocCategorySizeDatePackage
XMLSignature.javaAPI DocJava SE 6 API8629Tue Jun 10 00:27:06 BST 2008javax.xml.crypto.dsig

XMLSignature

public interface XMLSignature implements XMLStructure
A representation of the XML Signature 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 the {@link XMLSignatureFactory#newXMLSignature newXMLSignature} methods of the {@link XMLSignatureFactory} 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 than Signature to avoid naming clashes with the existing {@link Signature java.security.Signature} class.

see
XMLSignatureFactory#newXMLSignature(SignedInfo, KeyInfo)
see
XMLSignatureFactory#newXMLSignature(SignedInfo, KeyInfo, List, String, String)
author
Joyce L. Leung
author
Sean Mullan
author
Erwin van der Koogh
author
JSR 105 Expert Group
since
1.6

Fields Summary
static final String
XMLNS
The XML Namespace URI of the W3C Recommendation for XML-Signature Syntax and Processing.
Constructors Summary
Methods Summary
public java.lang.StringgetId()
Returns the optional Id of this XMLSignature.

return
the Id (may be null if not specified)

public javax.xml.crypto.dsig.keyinfo.KeyInfogetKeyInfo()
Returns the key info of this XMLSignature.

return
the key info (may be null if not specified)

public javax.xml.crypto.KeySelectorResultgetKeySelectorResult()
Returns the result of the {@link KeySelector}, if specified, after this XMLSignature has been signed or validated.

return
the key selector result, or null if a key selector has not been specified or this XMLSignature has not been signed or validated

public java.util.ListgetObjects()
Returns an {@link java.util.Collections#unmodifiableList unmodifiable list} of {@link XMLObject}s contained in this XMLSignature.

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

public javax.xml.crypto.dsig.XMLSignature$SignatureValuegetSignatureValue()
Returns the signature value of this XMLSignature.

return
the signature value

public javax.xml.crypto.dsig.SignedInfogetSignedInfo()
Returns the signed info of this XMLSignature.

return
the signed info (never null)

public voidsign(javax.xml.crypto.dsig.XMLSignContext signContext)
Signs this XMLSignature.

If this method throws an exception, this XMLSignature and the signContext parameter will be left in the state that it was in prior to the invocation.

param
signContext the signing context
throws
ClassCastException if the type of signContext is not compatible with this XMLSignature
throws
NullPointerException if signContext is null
throws
MarshalException if an exception occurs while marshalling
throws
XMLSignatureException if an unexpected exception occurs while generating the signature

public booleanvalidate(javax.xml.crypto.dsig.XMLValidateContext validateContext)
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 the XMLSignature 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.

param
validateContext the validating context
return
true if the signature passed core validation, otherwise false
throws
ClassCastException if the type of validateContext is not compatible with this XMLSignature
throws
NullPointerException if validateContext is null
throws
XMLSignatureException if an unexpected error occurs during validation that prevented the validation operation from completing