com.adaptris.core.common

Class MultiPayloadStringInputParameter

java.lang.Object

com.adaptris.core.common.StringPayloadDataInputParameter

com.adaptris.core.common.MultiPayloadStringInputParameter

All Implemented Interfaces:

DataInputParameter<java.lang.String>

public class MultiPayloadStringInputParameter
extends StringPayloadDataInputParameter
implements DataInputParameter<java.lang.String>

This MultiPayloadDataInputParameter is used when you want to source data from the MultiPayloadAdaptrisMessage payload. An example might be specifying that the XML content required for the XPathService can be found in the payload of an MultiPayloadAdaptrisMessage.

In the adapter configuration file this class is aliased as multi-payload-string-input-parameter which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
MultiPayloadStringInputParameter()

Method Summary

Modifier and Type	Method and Description
java.lang.String	extract(InterlokMessage m) .
java.lang.String	extract(java.lang.String id, MultiPayloadAdaptrisMessage m) Extract the payload with the given ID from the multi-payload message.
java.lang.String	getPayloadId() Get the ID of the payload to extract.
void	setPayloadId(java.lang.String payloadId) Set the ID of the payload to extract.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiPayloadStringInputParameter

public MultiPayloadStringInputParameter()

Method Detail

getPayloadId

public java.lang.String getPayloadId()

Get the ID of the payload to extract.

Returns:

The payload ID.

setPayloadId

public void setPayloadId(java.lang.String payloadId)

Set the ID of the payload to extract.

Parameters:

payloadId - The payload ID.

extract

public java.lang.String extract(InterlokMessage m)
                         throws InterlokException

.

Specified by:

extract in interface DataInputParameter<java.lang.String>

Overrides:

extract in class StringPayloadDataInputParameter

Throws:

InterlokException

extract

public java.lang.String extract(java.lang.String id,
                                MultiPayloadAdaptrisMessage m)

Extract the payload with the given ID from the multi-payload message.

Parameters:

id - The payload ID.

m - The multi-payload message.

Returns:

The extracted payload.