javax.xml.crypto.dsig
Interface XMLSignature
All Superinterfaces:
- public interface XMLSignature
- extends XMLStructure
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.
See Also:
XMLSignatureFactory.newXMLSignature(SignedInfo, KeyInfo)
,
XMLSignatureFactory.newXMLSignature(SignedInfo, KeyInfo, List, String, String)
Nested Class Summary
Modifier and Type | Interface and Description |
---|---|
|
XMLSignature.SignatureValue
A representation of the XML
SignatureValue element as
defined in the
W3C Recommendation for XML-Signature Syntax and Processing.
|
Field Summary
Modifier and Type | Field and Description |
---|---|
|
XMLNS
The XML Namespace URI of the W3C Recommendation for XML-Signature
Syntax and Processing.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getId()
Returns the optional Id of this
XMLSignature .
|
getKeyInfo()
Returns the key info of this
XMLSignature .
|
|
getKeySelectorResult()
Returns the result of the
KeySelector , if specified, after
this XMLSignature has been signed or validated.
|
|
|
getObjects()
|
getSignatureValue()
Returns the signature value of this
XMLSignature .
|
|
getSignedInfo()
Returns the signed info of this
XMLSignature .
|
|
|
sign(XMLSignContext signContext)
Signs this
XMLSignature .
|
|
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 java.lang.String XMLNS
The XML Namespace URI of the W3C Recommendation for XML-Signature
Syntax and Processing.
See Also:
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 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.
Parameters:
validateContext
- the validating context Returns:
true
if the signature passed core validation,
otherwise false
Throws:
java.lang.ClassCastException
- if the type of validateContext
is not compatible with this XMLSignature
java.lang.NullPointerException
- if validateContext
is
null
XMLSignatureException
- if an unexpected error occurs during
validation that prevented the validation operation from completing getKeyInfo
- KeyInfo getKeyInfo()
Returns the key info of this
XMLSignature
.
Returns:
the key info (may be
null
if not specified) getSignedInfo
- SignedInfo getSignedInfo()
Returns the signed info of this
XMLSignature
.
Returns:
the signed info (never
null
) getObjects
- java.util.List getObjects()
Returns:
an unmodifiable list of
XMLObject
s (may be empty
but never null
) getId
- java.lang.String getId()
Returns the optional Id of this
XMLSignature
.
Returns:
the Id (may be
null
if not specified) getSignatureValue
- XMLSignature.SignatureValue getSignatureValue( )
Returns the signature value of this
XMLSignature
.
Returns:
the signature value
sign
- void sign(XMLSignContext signContext)
- throws MarshalException
- XMLSignatureException
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.
Parameters:
signContext
- the signing context Throws:
java.lang.ClassCastException
- if the type of signContext
is
not compatible with this XMLSignature
java.lang.NullPointerException
- if signContext
is
null
MarshalException
- if an exception occurs while marshalling XMLSignatureException
- if an unexpected exception occurs while
generating the signature getKeySelectorResult
- KeySelectorResult getKeySelectorResult( )
Returns the result of the
KeySelector
, if specified, after
this XMLSignature
has been signed or validated.
Returns:
the key selector result, or
null
if a key
selector has not been specified or this XMLSignature
has not been signed or validated