public class

XmlSecurityModule

extends Object
java.lang.Object
   ↳ org.mule.module.xmlsecurity.XmlSecurityModule
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Generic module

Summary

Fields
private CanonicalizationAlgorithm canonicalizationAlgorithm Canonicalization Method For a canonicalization specification see @see{http://www.w3.org/TR/2009/WD-xmlsec-algorithms-20090226/#canonicalization-uris} Accepted Values: EXCLUSIVE, EXCLUSIVE_WITH_COMMENTS, INCLUSIVE, INCLUSE_WITH_COMMENTS,
private DigestMethodAlgorithm digestMethodAlgorithm Digest Method Algorithm For a reference on the Digest Method Algorithms see @see{http://www.w3.org/TR/2009/WD-xmlsec-algorithms-20090226/#digest-method-uris} ACCEPTED VALUES: RIPEMD160, SHA1, SHA256, SHA512
private String keyPairAlgorithm Algorithm used to generate a key Pair.
private String keystore Keystore path
private String keystoreKey Keystore key
private String password Private Key, if you shared a private key use it.
private String referenceURI Reference URI, if you wish to use an external reference URI for Detached signatures.
private String secretKeyAlgorithm The Algorithm which is used to encrypt the private key For example: HmacSHA256
private SignatureMethodAlgorithm signatureMethodAlgorithm Signature Method Algorithm For Signature Method Algorithms specification see @see{http://www.w3.org/TR/2009/WD-xmlsec-algorithms-20090226/#signature-method-uris} Accepted Values: RSA_SHA1, DSA_SHA1, HMAC_SHA1
private SignatureType signatureType The signature type ACCEPTED VALUES: DETACHED, ENVELOPED, ENVELOPING
Public Constructors
XmlSecurityModule()
Public Methods
void setCanonicalizationAlgorithm(CanonicalizationAlgorithm canonicalizationAlgorithm)
void setDigestMethodAlgorithm(DigestMethodAlgorithm digestMethodAlgorithm)
void setKeyPairAlgorithm(String keyPairAlgorithm)
void setKeystore(String keystore)
void setKeystoreKey(String keystoreKey)
void setPassword(String password)
void setReferenceURI(String referenceURI)
void setSecretKeyAlgorithm(String secretKeyAlgorithm)
void setSignatureMethodAlgorithm(SignatureMethodAlgorithm signatureMethodAlgorithm)
void setSignatureType(SignatureType signatureType)
String sign(Object payload)
Custom processor
boolean validate(Object payload)
Custom processor
[Expand]
Inherited Methods
From class java.lang.Object

Fields

private CanonicalizationAlgorithm canonicalizationAlgorithm

Canonicalization Method For a canonicalization specification see @see{http://www.w3.org/TR/2009/WD-xmlsec-algorithms-20090226/#canonicalization-uris} Accepted Values: EXCLUSIVE, EXCLUSIVE_WITH_COMMENTS, INCLUSIVE, INCLUSE_WITH_COMMENTS,

private DigestMethodAlgorithm digestMethodAlgorithm

Digest Method Algorithm For a reference on the Digest Method Algorithms see @see{http://www.w3.org/TR/2009/WD-xmlsec-algorithms-20090226/#digest-method-uris} ACCEPTED VALUES: RIPEMD160, SHA1, SHA256, SHA512

private String keyPairAlgorithm

Algorithm used to generate a key Pair. ACCEPTED VALUES: DSA, RSA

private String keystore

Keystore path

private String keystoreKey

Keystore key

private String password

Private Key, if you shared a private key use it. Otherwise the document will be signed with DSA512 algorithm, and sign information will be in the signature tag.

private String referenceURI

Reference URI, if you wish to use an external reference URI for Detached signatures.

private String secretKeyAlgorithm

The Algorithm which is used to encrypt the private key For example: HmacSHA256

private SignatureMethodAlgorithm signatureMethodAlgorithm

Signature Method Algorithm For Signature Method Algorithms specification see @see{http://www.w3.org/TR/2009/WD-xmlsec-algorithms-20090226/#signature-method-uris} Accepted Values: RSA_SHA1, DSA_SHA1, HMAC_SHA1

private SignatureType signatureType

The signature type ACCEPTED VALUES: DETACHED, ENVELOPED, ENVELOPING

Public Constructors

public XmlSecurityModule ()

Public Methods

public void setCanonicalizationAlgorithm (CanonicalizationAlgorithm canonicalizationAlgorithm)

Parameters
canonicalizationAlgorithm

public void setDigestMethodAlgorithm (DigestMethodAlgorithm digestMethodAlgorithm)

Parameters
digestMethodAlgorithm

public void setKeyPairAlgorithm (String keyPairAlgorithm)

Parameters
keyPairAlgorithm

public void setKeystore (String keystore)

Parameters
keystore

public void setKeystoreKey (String keystoreKey)

Parameters
keystoreKey

public void setPassword (String password)

Parameters
password

public void setReferenceURI (String referenceURI)

Parameters
referenceURI

public void setSecretKeyAlgorithm (String secretKeyAlgorithm)

Parameters
secretKeyAlgorithm

public void setSignatureMethodAlgorithm (SignatureMethodAlgorithm signatureMethodAlgorithm)

Parameters
signatureMethodAlgorithm

public void setSignatureType (SignatureType signatureType)

Parameters
signatureType

public String sign (Object payload)

Custom processor

Parameters
payload Content to be processed
Returns
  • Some string

public boolean validate (Object payload)

Custom processor

Parameters
payload Content to be processed
Returns
  • true/false