- All Superinterfaces:
XMLStructure
public interface XMLSignature extends 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
newXMLSignature
methods of the
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
java.security.Signature
class.
-
Nested Class Summary
Nested Classes Modifier and Type Interface 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
-
Method Summary
Modifier and Type Method 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<XMLObject>
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 declared in interface javax.xml.crypto.XMLStructure
isFeatureSupported
-
Field Details
-
XMLNS
The XML Namespace URI of the W3C Recommendation for XML-Signature Syntax and Processing.- See Also:
- Constant Field Values
-
-
Method Details
-
validate
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
- 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
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
-