com.adaptris.core.services.cache.translators

Class XpathCacheValueTranslator

java.lang.Object

com.adaptris.core.services.cache.translators.XpathCacheValueTranslator

All Implemented Interfaces:

CacheKeyTranslator, CacheValueTranslator<java.lang.String>

public class XpathCacheValueTranslator
extends java.lang.Object
implements CacheValueTranslator<java.lang.String>, CacheKeyTranslator

Implementation of CacheValueTranslator that retrieves a value from the supplied AdaptrisMessage using an XPath.

Note: this class only supports retrieval of data, not insertion

In the adapter configuration file this class is aliased as xpath-cache-value-translator which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
XpathCacheValueTranslator()
XpathCacheValueTranslator(java.lang.String xpath)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getKeyFromMessage(AdaptrisMessage msg)
KeyValuePairSet	getNamespaceContext()
java.lang.String	getValueFromMessage(AdaptrisMessage msg) Retrieves a value from a message
DocumentBuilderFactoryBuilder	getXmlDocumentFactoryConfig()
java.lang.String	getXpath()
void	setNamespaceContext(KeyValuePairSet namespaceContext) Specify a NamespaceContext to use when performing XPath queries
void	setXmlDocumentFactoryConfig(DocumentBuilderFactoryBuilder xml)
void	setXpath(java.lang.String s) Sets the XPath to use to query the message

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.services.cache.CacheValueTranslator

addValueToMessage

Constructor Detail

XpathCacheValueTranslator

public XpathCacheValueTranslator()

XpathCacheValueTranslator

public XpathCacheValueTranslator(java.lang.String xpath)

Method Detail

getValueFromMessage

public java.lang.String getValueFromMessage(AdaptrisMessage msg)
                                     throws CoreException

Description copied from interface: CacheValueTranslator

Retrieves a value from a message

Specified by:

getValueFromMessage in interface CacheValueTranslator<java.lang.String>

Returns:

the result of applying the configured xpath against the payload of this AdaptrisMessage

Throws:

CoreException

setXpath

public void setXpath(java.lang.String s)

Sets the XPath to use to query the message

Parameters:

s -

getXpath

public java.lang.String getXpath()

setNamespaceContext

public void setNamespaceContext(KeyValuePairSet namespaceContext)

Specify a NamespaceContext to use when performing XPath queries

Parameters:

namespaceContext -

getNamespaceContext

public KeyValuePairSet getNamespaceContext()

getXmlDocumentFactoryConfig

public DocumentBuilderFactoryBuilder getXmlDocumentFactoryConfig()

setXmlDocumentFactoryConfig

public void setXmlDocumentFactoryConfig(DocumentBuilderFactoryBuilder xml)

getKeyFromMessage

public java.lang.String getKeyFromMessage(AdaptrisMessage msg)
                                   throws CoreException

Specified by:

getKeyFromMessage in interface CacheKeyTranslator

Throws:

CoreException