Interface XMLSignature

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 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:

  ClassCastException - if the type of validateContext is not compatible with this XMLSignature

  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

  List getObjects()

  Returns an unmodifiable list of XMLObjects contained in this XMLSignature.

  Returns:

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

• getId

  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:

  ClassCastException - if the type of signContext is not compatible with this XMLSignature

  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