public class MultiPayloadStringInputParameter extends StringPayloadDataInputParameter implements DataInputParameter<java.lang.String>
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 and Description |
---|
MultiPayloadStringInputParameter() |
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.
|
public java.lang.String getPayloadId()
public void setPayloadId(java.lang.String payloadId)
payloadId
- The payload ID.public java.lang.String extract(InterlokMessage m) throws InterlokException
extract
in interface DataInputParameter<java.lang.String>
extract
in class StringPayloadDataInputParameter
InterlokException
public java.lang.String extract(java.lang.String id, MultiPayloadAdaptrisMessage m)
id
- The payload ID.m
- The multi-payload message.