com.adaptris.core.transform

Class ObjectMetadataParameter

java.lang.Object

com.adaptris.core.transform.ObjectMetadataParameter

All Implemented Interfaces:

XmlTransformParameter

public class ObjectMetadataParameter
extends java.lang.Object
implements XmlTransformParameter

XmlTransformParameter implementation that makes object metadata available as transform parameters

Internally, the adapter uses String keys for object metadata; however this is not enforced for custom services, so behaviour may vary depending on what custom components are in use as the key names may not be consistent or predictable.

In the adapter configuration file this class is aliased as xml-transform-object-parameter which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
ObjectMetadataParameter()
ObjectMetadataParameter(java.lang.String regexp)

Method Summary

Modifier and Type	Method and Description
java.util.Map	createParameters(AdaptrisMessage msg, java.util.Map existingParams) Create a Map that will be passed into XmlTransformer.transform(Transformer , Reader , Writer , String , Map )
java.lang.String	getObjectMetadataKeyRegexp()
void	setObjectMetadataKeyRegexp(java.lang.String s)

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectMetadataParameter

public ObjectMetadataParameter()

ObjectMetadataParameter

public ObjectMetadataParameter(java.lang.String regexp)

Method Detail

createParameters

public java.util.Map createParameters(AdaptrisMessage msg,
                                      java.util.Map existingParams)
                               throws ServiceException

Description copied from interface: XmlTransformParameter

Create a Map that will be passed into XmlTransformer.transform(Transformer , Reader , Writer , String , Map )

Specified by:

createParameters in interface XmlTransformParameter

Parameters:

msg - the AdaptrisMessage used to build the parameters.

existingParams - any existing parameters that might already be configured, null otherwise.

Returns:

the parameters to pass into the transform.

Throws:

ServiceException

getObjectMetadataKeyRegexp

public java.lang.String getObjectMetadataKeyRegexp()

setObjectMetadataKeyRegexp

public void setObjectMetadataKeyRegexp(java.lang.String s)