| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
XMLSignatureFactory fac = …;
SignedInfo si = …;
KeyInfo ki = …;
XMLSignature signature = fac.newXMLSignature(si, ki);
Based on 56 examples
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
{@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.
Nested Class Summary | |
---|---|
static interface |
A representation of the XML SignatureValue element as
defined in the
W3C Recommendation for XML-Signature Syntax and Processing. |
Field Summary | |
---|---|
static String |
XMLNS
The XML Namespace URI of the W3C Recommendation for XML-Signature Syntax and Processing. |
Method Summary | |
---|---|
String |
getId() Returns the optional Id of this XMLSignature .
|
KeyInfo |
Returns the key info of this XMLSignature .
|
KeySelectorResult |
Returns the result of the javax.xml.crypto.KeySelector, if specified, after this XMLSignature has been signed or validated.
|
List |
Returns an java.util.Collections.unmodifiableList of javax.xml.crypto.dsig.XMLObjects contained in this XMLSignature .
|
XMLSignature.SignatureValue |
Returns the signature value of this XMLSignature .
|
SignedInfo |
Returns the signed info of this XMLSignature .
|
void |
sign(XMLSignContext signContext) Signs this XMLSignature .
|
boolean |
validate(XMLValidateContext validateContext) Validates the signature according to the core validation processing rules. |
Methods inherited from class javax.xml.crypto.XMLStructure |
---|
isFeatureSupported |
Field Detail |
---|
public static final String XMLNS
Method Detail |
---|
public String getId()
XMLSignature
.
null
if not specified)public KeyInfo getKeyInfo()
XMLSignature
.
null
if not specified)public KeySelectorResult getKeySelectorResult()
XMLSignature
has been signed or validated.
null
if a key
selector has not been specified or this XMLSignature
has not been signed or validatedpublic List getObjects()
XMLSignature
.
XMLObject
s (may be empty
but never null
)public XMLSignature.SignatureValue getSignatureValue()
XMLSignature
.
public SignedInfo getSignedInfo()
XMLSignature
.
null
)public void sign(XMLSignContext signContext) throws MarshalException, XMLSignatureException
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.
signContext
- the signing contextMarshalException
- if an exception occurs while marshallingXMLSignatureException
- if an unexpected exception occurs while
generating the signaturepublic boolean validate(XMLValidateContext validateContext) throws XMLSignatureException
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.
validateContext
- the validating contexttrue
if the signature passed core validation,
otherwise false
XMLSignatureException
- if an unexpected error occurs during
validation that prevented the validation operation from completing
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |