org.apache.camel.component.xmlsecurity.processor
Class XmlSignerConfiguration

java.lang.Object
  org.apache.camel.component.xmlsecurity.processor.XmlSignatureConfiguration
      org.apache.camel.component.xmlsecurity.processor.XmlSignerConfiguration

All Implemented Interfaces:

Cloneable, org.apache.camel.CamelContextAware

public class XmlSignerConfiguration
extends XmlSignatureConfiguration

Constructor Summary

XmlSignerConfiguration()

Method Summary

XmlSignerConfiguration	copy()
Boolean	getAddKeyInfoReference()
AlgorithmMethod	getCanonicalizationMethod()
String	getCanonicalizationMethodName()
String	getContentObjectId()
String	getContentReferenceType()
String	getContentReferenceUri()
String	getDigestAlgorithm()
KeyAccessor	getKeyAccessor()
String	getKeyAccessorName()
String	getParentLocalName()
String	getParentNamespace()
Boolean	getPlainText()
String	getPlainTextEncoding()
String	getPrefixForXmlSignatureNamespace()
XmlSignatureProperties	getProperties()
String	getPropertiesName()
String	getSignatureAlgorithm()
List<AlgorithmMethod>	getTransformMethods()
String	getTransformMethodsName()
void	setAddKeyInfoReference(Boolean addKeyInfoReference) In order to protect the KeyInfo element from tampering you can add a reference to the signed info element so that it is protected via the signature value.
void	setCamelContext(org.apache.camel.CamelContext camelContext)
void	setCanonicalizationMethod(AlgorithmMethod canonicalizationMethod)
void	setCanonicalizationMethod(String canonicalizationMethodName) Sets the reference name for a AlgorithmMethod that can be found in the registry.
void	setCanonicalizationMethodName(String canonicalizationMethodName)
void	setContentObjectId(String contentObjectId)
void	setContentReferenceType(String referenceType)
void	setContentReferenceUri(String referenceUri)
void	setDigestAlgorithm(String digestAlgorithm)
void	setKeyAccessor(KeyAccessor keyAccessor)
void	setKeyAccessor(String keyAccessorName) Sets the reference name for a KeyAccessor that can be found in the registry.
void	setKeyAccessorName(String keyAccessorName)
void	setParentLocalName(String parentLocalName) Local name of the parent element to which the XML signature element will be added.
void	setParentNamespace(String parentNamespace) Namespace of the parent element to which the XML signature element will be added.
void	setPlainText(Boolean plainText)
void	setPlainTextEncoding(String plainTextEncoding)
void	setPrefixForXmlSignatureNamespace(String prefixForXmlSignatureNamespace) Namespace prefix for the XML signature namespace "http://www.w3.org/2000/09/xmldsig#".
void	setProperties(String propertiesName) Sets the reference name for a XmlSignatureProperties that can be found in the registry.
void	setProperties(XmlSignatureProperties properties)
void	setPropertiesName(String propertiesName)
void	setSignatureAlgorithm(String signatureAlgorithm) Signature algorithm.
void	setTransformMethods(List<AlgorithmMethod> transformMethods)
void	setTransformMethods(String transformMethodsName) Sets the reference name for a List that can be found in the registry.
void	setTransformMethodsName(String transformMethodsName)

Methods inherited from class org.apache.camel.component.xmlsecurity.processor.XmlSignatureConfiguration

getBaseUri, getCamelContext, getClearHeaders, getCryptoContextProperties, getDisallowDoctypeDecl, getOmitXmlDeclaration, getUriDereferencer, setBaseUri, setClearHeaders, setCryptoContextProperties, setDisallowDoctypeDecl, setOmitXmlDeclaration, setUriDereferencer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlSignerConfiguration

public XmlSignerConfiguration()

Method Detail

copy

public XmlSignerConfiguration copy()

setCamelContext

public void setCamelContext(org.apache.camel.CamelContext camelContext)

Specified by:

setCamelContext in interface org.apache.camel.CamelContextAware

Overrides:

setCamelContext in class XmlSignatureConfiguration

getKeyAccessor

public KeyAccessor getKeyAccessor()

setKeyAccessor

public void setKeyAccessor(KeyAccessor keyAccessor)

setKeyAccessor

public void setKeyAccessor(String keyAccessorName)

Sets the reference name for a KeyAccessor that can be found in the registry.

getCanonicalizationMethod

public AlgorithmMethod getCanonicalizationMethod()

setCanonicalizationMethod

public void setCanonicalizationMethod(AlgorithmMethod canonicalizationMethod)

setCanonicalizationMethod

public void setCanonicalizationMethod(String canonicalizationMethodName)

Sets the reference name for a AlgorithmMethod that can be found in the registry.

getTransformMethods

public List<AlgorithmMethod> getTransformMethods()

setTransformMethods

public void setTransformMethods(List<AlgorithmMethod> transformMethods)

setTransformMethods

public void setTransformMethods(String transformMethodsName)

Sets the reference name for a List that can be found in the registry.

getSignatureAlgorithm

public String getSignatureAlgorithm()

setSignatureAlgorithm

public void setSignatureAlgorithm(String signatureAlgorithm)

Signature algorithm. Default value is "http://www.w3.org/2000/09/xmldsig#rsa-sha1".

Parameters:

signatureAlgorithm - signature algorithm

getDigestAlgorithm

public String getDigestAlgorithm()

setDigestAlgorithm

public void setDigestAlgorithm(String digestAlgorithm)

getAddKeyInfoReference

public Boolean getAddKeyInfoReference()

setAddKeyInfoReference

public void setAddKeyInfoReference(Boolean addKeyInfoReference)

In order to protect the KeyInfo element from tampering you can add a reference to the signed info element so that it is protected via the signature value. The default value is true.

Only relevant when a KeyInfo is returned by KeyAccessor. and KeyInfo.getId() is not null.

Parameters:

addKeyInfoReference - boolean value

getPrefixForXmlSignatureNamespace

public String getPrefixForXmlSignatureNamespace()

setPrefixForXmlSignatureNamespace

public void setPrefixForXmlSignatureNamespace(String prefixForXmlSignatureNamespace)

Namespace prefix for the XML signature namespace "http://www.w3.org/2000/09/xmldsig#". Default value is "ds". If null or an empty value is set then no prefix is used for the XML signature namespace.

See best practice http://www.w3.org/TR/xmldsig-bestpractices/#signing-xml- without-namespaces

Parameters:

prefixForXmlSignatureNamespace - prefix

getParentLocalName

public String getParentLocalName()

setParentLocalName

public void setParentLocalName(String parentLocalName)

Local name of the parent element to which the XML signature element will be added. Only relevant for enveloped XML signature. Default value is null. The value must be null for enveloping XML signature.

Parameters:

parentLocalName - local name

getParentNamespace

public String getParentNamespace()

setParentNamespace

public void setParentNamespace(String parentNamespace)

Namespace of the parent element to which the XML signature element will be added.

getContentObjectId

public String getContentObjectId()

setContentObjectId

public void setContentObjectId(String contentObjectId)

getContentReferenceUri

public String getContentReferenceUri()

setContentReferenceUri

public void setContentReferenceUri(String referenceUri)

getContentReferenceType

public String getContentReferenceType()

setContentReferenceType

public void setContentReferenceType(String referenceType)

getPlainText

public Boolean getPlainText()

setPlainText

public void setPlainText(Boolean plainText)

getPlainTextEncoding

public String getPlainTextEncoding()

setPlainTextEncoding

public void setPlainTextEncoding(String plainTextEncoding)

getProperties

public XmlSignatureProperties getProperties()

setProperties

public void setProperties(XmlSignatureProperties properties)

setProperties

public void setProperties(String propertiesName)

Sets the reference name for a XmlSignatureProperties that can be found in the registry.

getKeyAccessorName

public String getKeyAccessorName()

setKeyAccessorName

public void setKeyAccessorName(String keyAccessorName)

getCanonicalizationMethodName

public String getCanonicalizationMethodName()

setCanonicalizationMethodName

public void setCanonicalizationMethodName(String canonicalizationMethodName)

getTransformMethodsName

public String getTransformMethodsName()

setTransformMethodsName

public void setTransformMethodsName(String transformMethodsName)

getPropertiesName

public String getPropertiesName()

setPropertiesName

public void setPropertiesName(String propertiesName)